Add
Add a new Identifier.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
NewObjectResponse with |
Identifier added |
|
|
Identifier Request not provided in POST body |
|
ErrorResponse with details in |
An error in one or more provided fields |
|
|
Authentication required |
|
|
An entry already exists with the specified identifier |
|
|
Either a CO Person or an Org Identity must be specified to attach the Address to |
|
|
The specified CO Person or Org Identity does not exist |
|
|
Unknown error |
Delete
Remove an Identifier.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
|
Identifier deleted |
|
|
|
|
|
Authentication required |
|
|
|
|
|
Unknown error |
Edit
Edit an existing Identifier.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
|
Identifier updated |
|
|
Identifier Request not provided in POST body |
|
ErrorResponse with details in |
An error in one or more provided fields |
|
|
Authentication required |
|
|
An entry already exists with the specified identifier |
|
|
Either a CO Person or an Org Identity must be specified to attach the Address to |
|
|
The specified CO Person or Org Identity does not exist |
|
|
|
|
|
Unknown error |
View (all)
Retrieve all existing Identifiers.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
Identifiers returned |
|
|
|
Authentication required |
|
|
Unknown error |
View (per person)
Retrieve Identifiers attached to a CO Person or Org Identity.
Request Format
Method |
|
||
---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="bdb14bb9-47e4-44cd-8b3d-b22833731e53"><ac:plain-text-body><![CDATA[ |
URL |
|
]]></ac:plain-text-body></ac:structured-macro> |
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
Identifier returned |
|
|
|
The requested CO Person was found, but has no identifiers attached |
|
|
The requested Org Identity was found, but has no identifiers attached |
|
|
Authentication required |
|
|
|
|
|
|
|
|
Unknown error |
View (one)
Retrieve an existing Identifier.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
Identifier returned |
|
|
|
Authentication required |
|
|
|
|
|
Unknown error |
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
See Also
- cm_identifiers data model definition