Organisations and contacts who manage their URNs and URLs with the URN-Service.
Returns the user details of a contact.
Access: Logged in organisations only.
| name | type | description | constraints |
|---|---|---|---|
| contactId | path | of the contact at the organisation | required |
| id | path | of the organisation to which the contact belongs | required |
| runas | query | optional login name whose identity is used to execute the request (only available to users with the RunAs privilege) |
| code | condition |
|---|---|
| 200 | if the request was completed successfully |
| 401 | if the user is not authenticated (error code 401001) |
| 403 | if the user is not authorised to view the contact (error code 403001) |
| 404 |
|
| media type | data type | description |
|---|---|---|
| application/json | Contact (JSON) | the user details of the contact |
GET /organisations/id/{id}/contacts/id/{contactId}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"self" : "http://example.org/organisations/id/1/contacts/id/1",
"created" : "2017-03-02T15:23:16.123Z",
"lastModified" : "2017-03-02T15:23:16.123Z",
"surname" : "Gödel",
"forename" : "Kurt",
"email" : "k.goedel@example.org",
"phone" : "+49 69 1525-0",
"function" : "system administrator",
"organisation" : "http://example.org/organisations/id/1",
"comment" : "This contact is used for testing purposes only"
}
Updates the registration information of a URN.
Access: System administrators only.
| name | type | description | constraints |
|---|---|---|---|
| contactId | path | of the contact at the organisation | required |
| id | path | of the organisation to which the contact belongs | required |
| runas | query | optional login name whose identity is used to execute the request (only available to users with the RunAs privilege) |
| media type | data type | description |
|---|---|---|
| application/json | UpdateContactRequest (JSON) | the user details which should be updated |
| application/merge-patch+json | UpdateContactRequest (JSON) |
| code | condition |
|---|---|
| 204 | if the contact details were updated successfully |
| 400 | if a field is not valid (error code 400007) |
| 401 | if the user is not authenticated (error code 401001) |
| 403 | if the user is not authorized to
|
| 404 |
|
PATCH /organisations/id/{id}/contacts/id/{contactId}
Content-Type: application/json
{
"surname" : "Gödel",
"forename" : "Kurt",
"email" : "k.goedel@example.org",
"phone" : "+49 69 1525-0",
"function" : "system administrator",
"comment" : "This contact is used for testing purposes only"
}
HTTP/1.1 204 No Content
Deletes a contact.
Access: System administrators only.
| name | type | description | constraints |
|---|---|---|---|
| contactId | path | of the contact at the organisation | required |
| id | path | of the organisation to which the contact belongs | required |
| runas | query | optional login name whose identity is used to execute the request (only available to users with the RunAs privilege) |
| code | condition |
|---|---|
| 204 | if the contact was deleted successfully |
| 401 | if the user is not authenticated (error code 401001) |
| 403 | if the user is not authorized to delete this contact (error code 403001) |
| 404 |
|
DELETE /organisations/id/{id}/contacts/id/{contactId}
Content-Type: */*
...
HTTP/1.1 204 No Content