countries
Operations addressed under /countries — 26 operations.
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.
query Parameters
orderByorderSortpageIndexpageSizeget-country-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.
alpha2alpha3flagidnamenumericcreate-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_1 | 400 | Cannot be defined with the same country numeric code. |
create-country › Request Body
alpha2alpha3flagnumericcreate-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.
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.
query Parameters
orderByorderSortpageIndexpageSizeget-country-address-type-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.
addressTypePermitted values — validated against the address_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | city | en: city · tr: il |
2 | town | en: town · tr: ilçe |
3 | neihgbourhood | en: neihgbourhood · tr: mahalle |
4 | street | en: street · tr: cadde/sokak |
5 | building | en: building · tr: bina |
6 | section | en: section |
countryIdidisActivesequenceNumberget-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. |
query Parameters
orderByorderSortpageIndexpageSizeget-country-address-item-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.
codecountryAddressTypeIdcountryIdidnameparentCodeparentCountryAddressItemIdtruncate-country-address-item
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
truncate-country-address-item › 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.
get-country-address-item-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 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_115 | 400 | COUNTRY_ADDRESS_ITEM_IS_NOT_FOUND | Parent address cannot be found. |
path Parameters
idget-country-address-item-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.
codecountryAddressTypeIdcountryIdidnameparentCodeparentCountryAddressItemIdhas-country-address-type-usage
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns bool, a scalar rather than an object. There is no field tree below because there are no fields: the body is the JSON literal true or false. This is a complete answer read from the declaration, not a gap.
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. |
path Parameters
idhas-country-address-type-usage › 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.
get-all-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<CountryDivisionDetailDto>.
| Field | Declared type | Nullable |
|---|---|---|
CountryId | int | no |
Divisions | IEnumerable<CountryDivisionDto> (collection) | no |
Member names are the service's declaration names.
get-all-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.
update-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 | Meaning | Message |
|---|---|---|---|
ERR_CORE_3 | 400 | COUNTRY_IS_NOT_FOUND | Country cannot be found. |
ERR_CORE_4 | 400 | — | {0} Numeric code is defined on another record. |
path Parameters
idupdate-country › Request Body
alpha2alpha3flagnumericupdate-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.
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
iddelete-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.
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
idquery Parameters
orderByorderSortpageIndexpageSizeget-country-address-type-list-by-country-id › 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.
addressTypePermitted values — validated against the address_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | city | en: city · tr: il |
2 | town | en: town · tr: ilçe |
3 | neihgbourhood | en: neihgbourhood · tr: mahalle |
4 | street | en: street · tr: cadde/sokak |
5 | building | en: building · tr: bina |
6 | section | en: section |
countryIdidisActivesequenceNumbercreate-country-address-type
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 AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_111 | 400 | ADDRESS_TYPE_IS_PREDEFINED_FOR_THIS_COUNTRY | The address type is predefined for this country. |
ERR_CORE_3 | 400 | COUNTRY_IS_NOT_FOUND | Country cannot be found. |
path Parameters
idcreate-country-address-type › Request Body
addressTypePermitted values — validated against the address_type parameter.
| Value | Meaning |
|---|---|
1 | city |
2 | town |
3 | neihgbourhood |
4 | street |
5 | building |
6 | section |
Permitted values — validated against the address_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | city | en: city · tr: il |
2 | town | en: town · tr: ilçe |
3 | neihgbourhood | en: neihgbourhood · tr: mahalle |
4 | street | en: street · tr: cadde/sokak |
5 | building | en: building · tr: bina |
6 | section | en: section |
sequenceNumbercreate-country-address-type › 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.
idget-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
idaddressTypeIdget-country-address-type-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.
addressTypePermitted values — validated against the address_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | city | en: city · tr: il |
2 | town | en: town · tr: ilçe |
3 | neihgbourhood | en: neihgbourhood · tr: mahalle |
4 | street | en: street · tr: cadde/sokak |
5 | building | en: building · tr: bina |
6 | section | en: section |
countryIdidisActivesequenceNumberupdate-country-address-type
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 | Meaning | Message |
|---|---|---|---|
ERR_CORE_111 | 400 | ADDRESS_TYPE_IS_PREDEFINED_FOR_THIS_COUNTRY | The address type is predefined for this country. |
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
idaddressTypeIdupdate-country-address-type › Request Body
addressTypePermitted values — validated against the address_type parameter.
| Value | Meaning |
|---|---|
1 | city |
2 | town |
3 | neihgbourhood |
4 | street |
5 | building |
6 | section |
Permitted values — validated against the address_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | city | en: city · tr: il |
2 | town | en: town · tr: ilçe |
3 | neihgbourhood | en: neihgbourhood · tr: mahalle |
4 | street | en: street · tr: cadde/sokak |
5 | building | en: building · tr: bina |
6 | section | en: section |
isActivesequenceNumberupdate-country-address-type › 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.
delete-country-address-type
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 | Meaning | Message |
|---|---|---|---|
ERR_CORE_113 | 400 | COUNTRY_ADDRESS_TYPE_IS_NOT_FOUND | Country address type cannot not be found. |
ERR_CORE_114 | 400 | COUNTRY_ADDRESS_ITEM_IS_FOUND | Since the address value of the {countryAdressTypeId} record has been entered, it cannot be deleted. |
ERR_CORE_3 | 400 | COUNTRY_IS_NOT_FOUND | Country cannot be found. |
path Parameters
idaddressTypeIddelete-country-address-type › 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.
create-country-address-item
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 | Meaning | Message |
|---|---|---|---|
ERR_CORE_113 | 400 | COUNTRY_ADDRESS_TYPE_IS_NOT_FOUND | Country address type cannot not be found. |
ERR_CORE_118 | 400 | COUNTRY_ADDRESS_ITEM_MUST_BE_UNIQUE | There is a record created with the same information. |
ERR_CORE_3 | 400 | COUNTRY_IS_NOT_FOUND | Country cannot be found. |
path Parameters
idcountryAddressTypeIdcreate-country-address-item › Request Body
codenameparentCodeparentCountryAddressItemIdcreate-country-address-item › 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.
idget-country-classification-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<CountryClassificationDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
CountryId | int | no |
SpecificClass | int | no |
Member names are the service's declaration names.
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-country-classification-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-country-classification
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 AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_183 | 400 | COUNTRY_CLASSIFICATION_EXIST | County classification exist. |
ERR_CORE_3 | 400 | COUNTRY_IS_NOT_FOUND | Country cannot be found. |
path Parameters
idcreate-country-classification › Request Body
specificClassPermitted values — validated against the specific_class parameter.
| Value | Meaning |
|---|---|
1 | Banned Country |
2 | CRS |
Permitted values — validated against the specific_class parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | BannedCountry | en: Banned Country · ar: الدولة المحظورة |
2 | CRS | en: CRS · ar: نظام المساهمة المشتركة |
create-country-classification › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-country-classification-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 CountryClassificationDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
CountryId | int | no |
SpecificClass | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_184 | 400 | COUNTRY_CLASSIFICATION_NOT_FOUND | Country classification not found. |
ERR_CORE_3 | 400 | COUNTRY_IS_NOT_FOUND | Country cannot be found. |
path Parameters
idclassificationIdget-country-classification-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-country-classification
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 | Meaning | Message |
|---|---|---|---|
ERR_CORE_183 | 400 | COUNTRY_CLASSIFICATION_EXIST | County classification exist. |
ERR_CORE_184 | 400 | COUNTRY_CLASSIFICATION_NOT_FOUND | Country classification not found. |
ERR_CORE_3 | 400 | COUNTRY_IS_NOT_FOUND | Country cannot be found. |
path Parameters
idclassificationIdupdate-country-classification › Request Body
specificClassPermitted values — validated against the specific_class parameter.
| Value | Meaning |
|---|---|
1 | Banned Country |
2 | CRS |
Permitted values — validated against the specific_class parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | BannedCountry | en: Banned Country · ar: الدولة المحظورة |
2 | CRS | en: CRS · ar: نظام المساهمة المشتركة |
update-country-classification › 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.
delete-country-classification
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 | Meaning | Message |
|---|---|---|---|
ERR_CORE_184 | 400 | COUNTRY_CLASSIFICATION_NOT_FOUND | Country classification not found. |
ERR_CORE_3 | 400 | COUNTRY_IS_NOT_FOUND | Country cannot be found. |
path Parameters
idclassificationIddelete-country-classification › 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.
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
idquery Parameters
pageIndexpageSizeget-country-division-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.
codedivisionCodeidnameparentDivisionCodetypeget-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
iddivisionIdget-country-division-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.
codedivisionCodeparentDivisionCodetypeupdate-country-division
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
iddivisionIdupdate-country-division › Request Body
codeparentDivisionCodetypeupdate-country-division › 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.
create-country-division
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 | Meaning | Message |
|---|---|---|---|
ERR_CORE_3 | 400 | COUNTRY_IS_NOT_FOUND | Country cannot be found. |
path Parameters
iddivisionIdcreate-country-division › Request Body
codeparentDivisionCodetypecreate-country-division › 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.
delete-country-division
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
iddivisionIddelete-country-division › 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.