Versions Compared

Key

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

...

HTTP Status

Response Body

Description

200 OK

CoPerson Response

CoPerson returned (zero or more matches may be returned)

401 Unauthorized

 

Authentication required

404 CO Unknown

 

id not found
(warning)  Not currently implemented -- unknown CO will return an empty set

500 Other Error

 

Unknown error

...

HTTP Status

Response Body

Description

200 OK

CoPerson Response

CoPeople returned

401 Unauthorized

 

Authentication required

404 CO Unknown

 

id not found

500 Other Error

 

Unknown error

...

View (per Identifier)

Retrieve all existing CO People attached to the specified identifier. Note the specified identifier must be attached to a CO Person, not an Org Identity.

Request Format

Method

GET

URL

/co_people.<format>?coid=<id>&search.identifier=<identifier>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoPerson Response

CoPeople returned

401 Unauthorized

 

Authentication required

404 CO Unknown

 

id not found

500 Other Error

 

Unknown error

...

View (one)

Retrieve an existing CO Person.

Request Format

Method

GET

URL

/co_people/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoPerson Response

CoPerson returned

401 Unauthorized

 

Authentication required

404 CoPerson Unknown

 

id not found

500 Other Error

 

Unknown error

...