Each CO Person and each Org Identity must have exactly one Name flagged primary_name=true at all times.

Add

Add a new Name.

Request Format

Method

POST

URL

/names.<format>

Request Body

Name Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of Name

Name added

400 Bad Request

 

Name 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

 

Either a CO Person or an Org Identity must be specified to attach the Name to

403 Person Does Not Exist

 

The specified CO Person or Org Identity does not exist

500 Other Error

 

Unknown error

Delete

Remove a Name.

Request Format

Method

DELETE

URL

/names/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 Deleted

 

Name deleted

400 Invalid Fields

 

id not provided

401 Unauthorized

 

Authentication required

{{403 Primary Name Cannot Be Deleted

 

This Name is flagged as primary for the Org Identity or CO Person

404 Name Unknown

 

id not found

500 Other Error

 

Unknown error

Edit

Edit an existing Name.

Request Format

Method

PUT

URL

/names/<id>.<format>

Request Body

Name Request

Response Format

HTTP Status

Response Body

Description

200 OK

 

Name updated

400 Bad Request

 

Name 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

 

Either a CO Person or an Org Identity must be specified to attach the Name to

403 Person Does Not Exist

 

The specified CO Person or Org Identity does not exist

404 Name Unknown

 

id not found

500 Other Error

 

Unknown error

View (all)

Retrieve all existing Names.

Request Format

Method

GET

URL

/names.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

Name Response

Name returned

401 Unauthorized

 

Authentication required

500 Other Error

 

Unknown error

View (per person)

Retrieve Names attached to a CO Person or Org Identity.

Request Format

Method

GET

URL

/names.<format>?[copersonid|orgidentityid]=<id>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

Name Response

Name returned

401 Unauthorized

 

Authentication required

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 Name.

Request Format

Method

GET

URL

/names/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

Name Response

Name returned

401 Unauthorized

 

Authentication required

404 Name 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.

See Also

  • No labels