Get City List

POST 
/v1/api/Pull/GetCityList

Retrive the city list

Request

application/json

Body

PrimaryLangID LanguageCodeEnum

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

Default value: 8

LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de

EchoToken stringnullable

An arbitrary string returned in the response for tracking/debugging.

TimeStamp stringrequired

The date and time (ISO format) just before the request is sent.

Target TargetEnumrequired

Possible values: [0, 1]

The target environment for this request. TargetEnum: 0=Test | 1=Production

Version number

Default value: 1

The version number of this request format.

Country_UID stringrequired

The code of country.

StateSearchCode stringrequired

State search code.

CitiesDataUid stringnullable

Not yet implemented.

ZoneSearchCode stringnullable

Zone code. Not yet implemented.

Responses

200

application/json

Schema

Schema

EchoToken stringnullable

The same token received in the request.

ErrorsType objectnullable
Errors object[]
Array [
Code integerrequired
Error code associated with the warning.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Language of the warning message. LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de
ShortText stringrequired
Short description or summary of the warning.
]
PrimaryLangID LanguageCodeEnum

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

Default value: 8

LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de

Success objectnullable
property name* string
Target TargetEnumrequired

Possible values: [0, 1]

The environment target. The same value received in the request. TargetEnum: 0=Test | 1=Production

TimeStamp stringrequired

The date in ISO format right before the response is sent.

Version numberrequired

Version of the API being used. The same value received in the request.

WarningsType objectnullable
Warnings object[]
Array [
Code integerrequired
Error code associated with the warning.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Language of the warning message. LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de
ShortText stringrequired
Short description or summary of the warning.
]
PositionsType objectrequired
Positions object[]required
List of positions.
Array [
Latitude numbernullable
The measure of the angular distance on a meridian north or south of the equator.
Longitude numbernullable
The measure of the angular distance on a meridian east or west of the prime meridian.
Code object required
Code.
oneOf
MOD1
integer
MOD2
string
CountryUID integernullable
The code of country.
Name stringrequired
Name.
SearchCode object required
Name.
oneOf
MOD1
integer
MOD2
string
SearchZoneCode stringnullable
Zone code. Not yet implemented.
]

Example (from schema)

{
  "EchoToken": "string",
  "ErrorsType": {
    "Errors": [
      {
        "Code": 0,
        "Language": 8,
        "ShortText": "string"
      }
    ]
  },
  "PrimaryLangID": 8,
  "Success": {},
  "Target": 0,
  "TimeStamp": "string",
  "Version": 0,
  "WarningsType": {
    "Warnings": [
      {
        "Code": 0,
        "Language": 8,
        "ShortText": "string"
      }
    ]
  },
  "PositionsType": {
    "Positions": [
      {
        "Latitude": 0,
        "Longitude": 0,
        "Code": 0,
        "CountryUID": 0,
        "Name": "string",
        "SearchCode": 0,
        "SearchZoneCode": "string"
      }
    ]
  }
}

Loading...