Get Country List

POST 
/v1/api/Pull/GetCountryList

Retrive the country list

Request

application/json

Body

PrimaryLangID LanguageCodeEnum (int)

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

Default value: 8

Values (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 TargetEnum (int)required

Possible values: [0, 1]

The target environment for this request.

Values (TargetEnum): 0=Test | 1=Production.

Version number

Default value: 1

The version number of this request format.

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 LanguageCodeEnum (int)required
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Language of the warning message.
Values (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 (int)

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

Default value: 8

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

Success objectnullable
property name* string
Target TargetEnum (int)required

Possible values: [0, 1]

The environment target. The same value received in the request.

Values (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 LanguageCodeEnum (int)required
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Language of the warning message.
Values (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.
]
CountriesType objectrequired
Countries object[]required
List of countries.
Array [
Code object required
Code.
oneOf
MOD1
integer
MOD2
string
Name stringrequired
Name.
]

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"
      }
    ]
  },
  "CountriesType": {
    "Countries": [
      {
        "Code": 0,
        "Name": "string"
      }
    ]
  }
}

Loading...