Child pages
  • Identifier API

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of Identifier

Identifier added

400 Bad Request

 


Identifier Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized

 


Authentication required

403 Identifier In Use

 


An entry already exists with the specified identifier

403 No Person Specified

 


A CO Department, a CO Person, or an Org Identity must be specified to attach the Identifier to

403 Person Does Not Exist

 


The specified CO Department, CO Person, or Org Identity does not exist

500 Other Error

 


Unknown error

...

Assign

Assign Identifiers for a CO Person.

...

HTTP Status

Response Body

Description

200 OK

 


Identifiers assigned (one or more identifiers may already have existed)

400 Bad Request

 


Identifier Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized

 


Authentication required

403 No Person Specified

 


A CO Person must be specified to attach the Identifiers to

403 Person Does Not Exist

 


The specified CO Person does not exist

500 Other Error

 


Unknown error

...

Delete

Remove an Identifier.

...

Method

DELETE

URL

/identifiers/<id>.<format>

Request Body

 


Response Format

HTTP Status

Response Body

Description

200 Deleted

 


Identifier deleted

400 Invalid Fields

 


id not provided

401 Unauthorized

 


Authentication required

404 Identifier Unknown

 


id not found

500 Other Error

 


Unknown error

...

Edit

Edit an existing Identifier.

...

HTTP Status

Response Body

Description

200 OK

 


Identifier updated

400 Bad Request

 


Identifier Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized

 


Authentication required

403 Identifier In Use

 


An entry already exists with the specified identifier

403 No Person Specified

 


A CO Department, CO Person, or Org Identity must be specified to attach the Address to

403 Person Does Not Exist

 


The specified CO Department, CO Person, or Org Identity does not exist

404 Identifier Unknown

 


id not found

500 Other Error

 


Unknown error

...

View (all)

Retrieve all existing Identifiers.

...

Method

GET

URL

/identifiers.<format>

Request Body

 


Response Format

HTTP Status

Response Body

Description

200 OK

Identifier Response

Identifiers returned

401 Unauthorized

 


Authentication required

500 Other Error

 


Unknown error

...

View (per

...

entity)

Retrieve Identifiers attached to a CO Department, Co Group, CO Person, or Org Identity.

...

Method

GET

URL

/identifiers.<format>?[codeptid|cogroupid|copersonid|orgidentityid]=<id>

Request Body

 


Response Format

HTTP Status

Response Body

Description

200 OK

Identifier Response

Identifier returned

204 CO Department Has No Identifier 
The requested CO Department was found, but has no identifiers attached
204 CO Group Has No Identifier
The requested CO Group was found, but has no identifiers attached

204 CO Person Has No Identifier

 


The requested CO Person was found, but has no identifiers attached

204 Org Identity Has No Identifier

 


The requested Org Identity was found, but has no identifiers attached

401 Unauthorized

 


Authentication required

404 CO Department Unknown

 


id not found for CO Department

404 CO Group Unknown


id not found for CO Group

404 CO Person Unknown

 


id not found for CO Person

404 Org Identity Unknown

 


id not found for Org Identity

500 Other Error

 


Unknown error

...

View (one)

Retrieve an existing Identifier.

...

Method

GET

URL

/identifiers/<id>.<format>

Request Body

 


Response Format

HTTP Status

Response Body

Description

200 OK

Identifier Response

Identifier returned

401 Unauthorized

 


Authentication required

404 Identifier Unknown

 


id not found

500 Other Error

 


Unknown error

...

Notes

  • Response format requested is ignored where response is only via HTTP status, but must still be provided.

...