Add

Add a new CO Org Identity Link. A person must have an Org Identity and a CO Person record before they can be linked. Note that invitations are a separate operation.

Request Format

Method

POST

URL

/co_org_identity_links.<format>

Request Body

CoOrgIdentityLink Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of CoOrgIdentityLink

CoOrgIdentityLink created

400 Bad Request

 

CoOrgIdentityLink 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 CoPerson Does Not Exist

 

The specified CO Person does not exist

403 OrgIdentity Already Linked

 

The specified Org Identity is already a member of this CO

403 OrgIdentity Does Not Exist

 

The specified Org Identity does not exist

500 Other Error

 

Unknown error

Delete

Remove a CO Org Identity Link.

Request Format

Method

DELETE

URL

/co_org_identity_links/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 Deleted

 

CoOrgIdentityLink deleted

400 Invalid Fields

 

id not provided

401 Unauthorized

 

Authentication required

404 CoOrgIdentityLink Unknown

 

id not found

500 Other Error

 

Unknown error

Edit

Edit an existing CO Identity Link.

Request Format

Method

PUT

URL

/co_org_identity_links/<id>.<format>

Request Body

CoOrgIdentityLink Request

Response Format

HTTP Status

Response Body

Description

200 OK

 

CoOrgIdentityLink updated

400 Bad Request

 

CoOrgIdentityLink 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 CoPersonRole Does Not Exist

 

The specified CO Person Role does not exist

403 OrgIdentity Already Linked

 

The specified Org Identity is already a member of this CO

403 OrgIdentity Does Not Exist

 

The specified Org Identity does not exist

404 CoOrgIdentityLink Unknown

 

id not found

500 Other Error

 

Unknown error

View (all)

Retrieve all existing CO Identity Links.

Request Format

Method

GET

URL

/co_org_identity_links.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoOrgIdentityLink Response

CoOrgIdentityLinks returned

401 Unauthorized

 

Authentication required

500 Other Error

 

Unknown error

View (by identity)

Retrieve all existing CO Identity Links for a CO Person or an Org Identity.

Request Format

Method

GET

URL

/co_org_identity_links.<format>?copersonid=<copersonid>

/co_org_identity_links.<format>?orgidentityid=<orgidentityid>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoOrgIdentityLink Response

CoOrgIdentityLinks returned

401 Unauthorized

 

Authentication required

404 CO Person Unknown copersonid not found
404 Org Identity Unknown orgidentityid not found

500 Other Error

 

Unknown error

View (one)

Retrieve an existing CO Identity Link.

Request Format

Method

GET

URL

/co_org_identity_links/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoOrgIdentityLink Response

CoOrgIdentityLink returned

401 Unauthorized

 

Authentication required

404 CoOrgIdentityLink Unknown

 

id not found

500 Other Error

 

Unknown error

Notes

  • Response format requested is ignored where response is only via HTTP status, but must still be provided.

See Also

  • No labels