| Resource | Names |
|---|---|
| URL | /api/v2/co_settings |
| Supported Standard Operations |
|
Attributes
- See co_settings for definitions of other attributes and elements
| Attribute | Value | Required? |
|---|---|---|
co_id | CO ID | Yes |
address_required_fields | Required address fields | Yes |
| name_default_type_id | Default name type | |
| name_permitted_fields | Permitted name fields | Yes |
| name_required_fields | Required name fields | Yes |
Sample Record
{
"name_default_type_id": 130,
"address_required_fields": "street",
"name_permitted_fields": "honorific,given,middle,family,suffix",
"name_required_fields": "given,family"
}
Supported Filters
Viewing all CO Settings without an additional filter is not supported.
View (all)
Additional filters:
co_id(This filter may be used to find the correct entry for the desired CO)
Example: Obtain the CO Settings for the specified CO
GET /registry/api/v2/co_settings?co_id=2
Implementation Notes
- Exactly one record per CO is expected, but the record ID may not correlate to the CO ID. Use View (all) to find the record ID from the CO ID.