Add a new Organizational Identity. A person must have an OrgIdentity before they can be added to a CO.
Method |
|
---|---|
URL |
|
Request Body |
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 |
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.
Method |
|
---|---|
URL |
|
Request Body |
|
HTTP Status | Response Body | Description |
---|---|---|
|
| OrgIdentity deleted |
|
|
|
|
| Authentication required |
| ErrorResponse with details in |
|
|
|
|
|
| Unknown error |
Edit an existing Organizational Identity.
Method |
|
---|---|
URL |
|
Request Body |
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 |
Retrieve all existing Organizational Identities.
Method |
|
---|---|
URL |
|
Request Body |
|
HTTP Status | Response Body | Description |
---|---|---|
| OrgIdentity returned | |
|
| Authentication required |
|
| Unknown error |
Retrieve all existing Organizational Identities for the specified CO.
Method |
|
---|---|
URL |
|
Request Body |
|
HTTP Status | Response Body | Description |
---|---|---|
| OrgIdentity returned | |
|
| Authentication required |
|
|
|
|
| Unknown error |
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.
Method |
|
---|---|
URL |
|
Request Body |
|
HTTP Status | Response Body | Description |
---|---|---|
| OrgIdentity returned | |
|
| Authentication required |
|
|
|
|
| Unknown error |
Retrieve an existing Organizational Identity.
Method |
|
---|---|
URL |
|
Request Body |
|
HTTP Status | Response Body | Description |
---|---|---|
| OrgIdentity returned | |
|
| Authentication required |
|
|
|
|
| Unknown error |