...
| Request Method | GET |
|---|---|
| URL |
where
|
| Alternate URL | GET https://$SERVER/registry/api/co/coid/core/v1/peopledepartments?identifier=identifier |
Index API Endpoint
| Request Method | GET |
|---|---|
| URL |
where
|
...
The Create and Update APIs accept the same attributes as returned by the Read API. Note that most metadata returned by the Read API is not permitted (and will be ignored) in the Write API. The exception is the sub-element id, which when present is used to indicated the update of an existing sub-element (such as an EmailAddress) rather than the creation of a new one.
Create API Endpoint
| Request Method | POST |
|---|---|
| URL |
where
|
Delete API Endpoint
| Request Method | DELETE |
|---|---|
| URL |
where
|
Update API Endpoint
| Request Method | PUT |
|---|---|
| URL |
where
|
Message Format
For the Create and Update APIs, the request is sent with Content-Type of application/json with a body containing a JSON document as described by this JSON Schema. An empty body or document is not valid for Create or Update. There is no request body for the Delete API.
...
The Match Callback API implements the COmanage Match Endpoint Notification Protocol in order to automate the reprocessing of records following a Match resolution. For more information, see Integrating With ID Match.
Organization Read API
The Organization Read API is a collection of two APIs that create a consolidated view of most attributes associated with an Organization. The Organization Read API is available as of Registry v4.2.0.
Supported attributes include:
- Address
- AdHocAttribute
- EmailAddress
- Identifier
- TelephoneNumber
- Url
The data returned by the Index API can be configured via the Response Type configuration:
- Full Profile: All available attributes (defined above) are returned.
- Identifier Only: Only the Identifier of the configured type is returned. The full record may be obtained using the Read API.
Read API Endpoint
| Request Method | GET |
|---|---|
| URL |
where
|
| Alternate URL | GET https://$SERVER/registry/api/co/coid/core/v1/organizations?identifier=identifier |
Index API Endpoint
| Request Method | GET |
|---|---|
| URL |
where
|
Message Format
The response is a JSON document as described by this JSON Schema.
Organization Write API
The Organization Write API is a collection of three APIs allow creation, updating, and deletion of Organization records. The Organization Write API is available as of Registry v4.2.0.
The Create and Update APIs accept the same attributes as returned by the Read API. Note that most metadata returned by the Read API is not permitted (and will be ignored) in the Write API. The exception is the sub-element id, which when present is used to indicated the update of an existing sub-element (such as an EmailAddress) rather than the creation of a new one.
Create API Endpoint
| Request Method | POST |
|---|---|
| URL |
where
|
Delete API Endpoint
| Request Method | DELETE |
|---|---|
| URL |
where
|
Update API Endpoint
| Request Method | PUT |
|---|---|
| URL |
where
|
Message Format
For the Create and Update APIs, the request is sent with Content-Type of application/json with a body containing a JSON document as described by this JSON Schema. An empty body or document is not valid for Create or Update. There is no request body for the Delete API.
The Create request will include the newly assigned Identifier of the configured type in the response body.