Add
Add a new CO Person.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
NewObjectResponse with |
CoPerson created |
|
|
CoPerson Request not provided in POST body |
|
ErrorResponse with details in |
An error in one or more provided fields |
|
|
Authentication required |
|
|
Unknown error |
Delete
Remove a CO Person. This method will also delete related data, such as CoPersonRoles, EmailAddresses, and Identifiers.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
|
CoPerson deleted |
|
|
|
|
|
Authentication required |
|
|
|
|
|
Unknown error |
Edit
Edit an existing CO Person.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
|
CoPerson updated |
|
|
CoPerson Request not provided in POST body |
|
ErrorResponse with details in |
An error in one or more provided fields |
|
|
Authentication required |
|
|
|
|
|
Unknown error |
View (all)
Retrieve all existing CO People.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
CoPerson returned |
|
|
|
Authentication required |
|
|
Unknown error |
View (one)
Retrieve an existing CO Person.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
CoPerson 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
- CoOrgIdentityLink API
- CoPersonRole API
- EmailAddress API (required for Invites)
- Identifier API
- OrgIdentity API
- TelephoneNumber API