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 OrgIdentity

OrgIdentity created

400 Bad Request

 

OrgIdentity 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 CO Does Not Exist

 

The specified CO does not exist

500 Other Error

 

Unknown error

...

HTTP Status

Response Body

Description

200 Deleted

 

OrgIdentity deleted

400 Invalid Fields

 

id not provided

401 Unauthorized

 

Authentication required

403 CoPerson Exists

ErrorResponse with details in Memberships element. The CO ID will be in the Id attribute, and the CO Name in the Name element.

id must not be attached to any CoPerson. (Delete the CoPerson first.)

404 OrgIdentity Unknown

 

id not found

500 Other Error

 

Unknown error

...

HTTP Status

Response Body

Description

200 OK

OrgIdentity Response

OrgIdentity returned

401 Unauthorized

 

Authentication required

404 CO Unknown

 

id not found

500 Other Error

 

Unknown error

...

View (per Identifier)

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

Request Format

Method

GET

URL

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

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

OrgIdentity Response

OrgIdentity returned

401 Unauthorized

 

Authentication required

404 CO Unknown

 

id not found

500 Other Error

 

Unknown error

...

View (one)

Retrieve an existing Organizational Identity.

Request Format

Method

GET

URL

/org_identities/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

OrgIdentity Response

OrgIdentity returned

401 Unauthorized

 

Authentication required

404 OrgIdentity Unknown

 

id not found

500 Other Error

 

Unknown error

...