address-types
Operations addressed under /address-types — 10 operations.
create-address-type
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the create-address-type service definition through POST /address-types.
create-address-type › Request Body
codenamecountrycreate-address-type › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
idupdate-address-type
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the update-address-type service definition through PUT /address-types/{id}.
path Parameters
idupdate-address-type › Request Body
isActivenamecountryupdate-address-type › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
delete-address-type
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the delete-address-type service definition through DELETE /address-types/{id}.
path Parameters
iddelete-address-type › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
get-address-type-field-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-address-type-field-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
fieldKeyidisActiveisMandatoryseparatorMarksequenceNumbertypeIdcreate-address-type-field
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idcreate-address-type-field › Request Body
fieldKeyisMandatorysequenceNumberisVisibleseparatorMarkcreate-address-type-field › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
idget-address-type-field-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idfieldIdget-address-type-field-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
fieldKeyidisActiveisMandatoryseparatorMarksequenceNumbertypeIdupdate-address-type-field
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idfieldIdupdate-address-type-field › Request Body
fieldKeyisActiveisMandatorysequenceNumberisVisibleseparatorMarkupdate-address-type-field › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
delete-address-type-field
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the delete-address-type-field service definition through DELETE /address-types/{id}/fields/{fieldId}.
path Parameters
idfieldIddelete-address-type-field › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
has-address-field-usage
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idfieldIdhas-address-field-usage › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.