Add
Add a new Organizational Identity. A person must have an OrgIdentity before they can be added to a CO.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| NewObjectResponse with | OrgIdentity created |
|
| OrgIdentity Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| Authentication required |
|
| The specified CO does not exist |
|
| Unknown error |
Delete
Remove an Organizational Identity. The person must be removed from any COs (CoPerson) before the OrgIdentity record can be removed. This method will also delete related data, such as Addresses, EmailAddresses, and TelephoneNumbers.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
|
| OrgIdentity deleted |
|
|
|
|
| Authentication required |
| ErrorResponse with details in |
|
|
|
|
|
| Unknown error |
Edit
Edit an existing Organizational Identity.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
---|---|---|
|
| OrgIdentity updated |
|
| OrgIdentity Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| Authentication required |
|
| The specified CO does not exist |
|
|
|
|
| Unknown error |
View (all)
Retrieve all existing Organizational Identities.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| OrgIdentity returned | |
|
| Authentication required |
|
| Unknown error |
View (per CO)
Retrieve all existing Organizational Identities for the specified CO.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| OrgIdentity returned | |
|
| Authentication required |
|
|
|
|
| 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 |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| OrgIdentity returned | |
|
| Authentication required |
|
|
|
|
| Unknown error |
View (one)
Retrieve an existing Organizational Identity.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| OrgIdentity 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_org_identities data model definition
- Address API
- CoOrgIdentityLink API
- CoPerson API
- CoPersonRole API
- EmailAddress API (required for Invites)
- TelephoneNumber API
- Url API