...
| Request Method | GET |
|---|---|
| URL |
where
|
Index API Endpoint
| Request Method | GET |
|---|---|
| URL |
where
|
Message Format
The response is a JSON document as described by this JSON Schema.
Identifier via Query Parameter
As of Registry v4.1.0, identifiers may be provided to the read API via query parameters. Effectively, all read requests will be treated as Index operations, though when an identifier is provided at most one record will be returned.
| Code Block |
|---|
GET https://$SERVER/registry/api/co/<coid>/core/v1/people?identifier=<foo> |
CO Person Write API
The CO Person Write API is a collection of three APIs allow creation, updating, and deletion of CO Person records.
...
| Note |
|---|
The Write API cannot be used to update attributes that are not normally modifiable via other mechanisms, including
|
Create API Endpoint
| Request Method | POST |
|---|---|
| URL |
where
|
Delete API Endpoint
| Request Method | DELETE |
|---|---|
| URL |
where
|
Update API Endpoint
| Request Method | PUT |
|---|---|
| URL |
where
|
...
The Create request will include the newly assigned Identifier of the configured type in the response body.
Identifier via Query Parameter
As of Registry v4.1.0, identifiers may be provided to the write API via query parameters.
| Code Block |
|---|
PUT https://$SERVER/registry/api/co/<coid>/core/v1/people?identifier=<foo>
DELETE https://$SERVER/registry/api/co/<coid>/core/v1/people?identifier=<foo> |