countries
Operations addressed under /countries — 13 operations.
aurax-bff-redirect-get-country-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<CountryDto>.
| Field | Declared type | Nullable |
|---|---|---|
Name | string | no |
Alpha2 | string | no |
Alpha3 | string | no |
Flag | string | no |
Numeric | int | no |
Translations | IEnumerable<CountryTranslationDto> (collection) | no |
Member names are the service's declaration names.
aurax-bff-redirect-get-country-list › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-get-country-address-type-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<CountryAddressTypeDto>.
| Field | Declared type | Nullable |
|---|---|---|
CountryId | int | no |
AddressType | int | no |
SequenceNumber | int? | yes |
IsActive | bool | no |
Member names are the service's declaration names.
aurax-bff-redirect-get-country-address-type-list › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-get-country-address-item-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<CountryAddressItemDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
CountryAddressTypeId | Guid | no |
Code | string | no |
Name | string | no |
ParentCode | string | no |
ParentCountryAddressItemId | Guid? | yes |
CountryId | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_3 | 400 | COUNTRY_IS_NOT_FOUND | Country cannot be found. |
aurax-bff-redirect-get-country-address-item-list › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-get-country-address-item-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as PagedResultDto<GetCountryAddressItemListDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | string | no |
CountryAddressTypeId | Guid | no |
Code | string | no |
Name | string | no |
ParentCode | string | no |
ParentCountryAddressItemId | Guid? | yes |
CountryId | int | no |
Member names are the service's declaration names.
aurax-bff-get-country-address-item-list › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-delete-country
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Message |
|---|---|---|
ERR_CORE_3 | 400 | Country cannot be found. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-delete-country › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-get-country-address-type-list-by-country-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<CountryAddressTypeDto>.
| Field | Declared type | Nullable |
|---|---|---|
CountryId | int | no |
AddressType | int | no |
SequenceNumber | int? | yes |
IsActive | bool | no |
Member names are the service's declaration names.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-country-address-type-list-by-country-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-country-address-type-create-ui-bpm
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-country-address-type-create-ui-bpm › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-get-country-address-type-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as CountryAddressTypeDto.
| Field | Declared type | Nullable |
|---|---|---|
CountryId | int | no |
AddressType | int | no |
SequenceNumber | int? | yes |
IsActive | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_113 | 400 | COUNTRY_ADDRESS_TYPE_IS_NOT_FOUND | Country address type cannot not be found. |
ERR_CORE_3 | 400 | COUNTRY_IS_NOT_FOUND | Country cannot be found. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
addressTypeIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-country-address-type-by-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-country-address-type-edit-ui-bpm
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
addressTypeIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-country-address-type-edit-ui-bpm › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-country-address-type-delete-ui-bpm
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
addressTypeIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-country-address-type-delete-ui-bpm › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-get-country-division-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as PagedResultDto<GetCountryDivisionListDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | string | no |
Member names are the service's declaration names.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-get-country-division-list › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-get-country-division-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<CountryDivisionDto>.
| Field | Declared type | Nullable |
|---|---|---|
Name | string | no |
Code | string | no |
Type | string | no |
ParentDivisionCode | string | no |
Alpha2 | string | no |
DivisionCode | string | no |
Translations | IEnumerable<CountryDivisionTranslationDto> (collection) | no |
Member names are the service's declaration names.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-country-division-list › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-get-country-division-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as CountryDivisionDto.
| Field | Declared type | Nullable |
|---|---|---|
Name | string | no |
Code | string | no |
Type | string | no |
ParentDivisionCode | string | no |
Alpha2 | string | no |
DivisionCode | string | no |
Translations | IEnumerable<CountryDivisionTranslationDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Message |
|---|---|---|
ERR_CORE_5 | 400 | Country Division cannot be found. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
divisionIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-country-division-by-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.