Ping

POST 
/v1/api/Pull/Ping

Request

application/json

Body

PrimaryLangID LanguageCodeEnum

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

Default value: 8

The primary language code for the request (e.g., 'BR' for Brazilian Portuguese). 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.

EchoData stringrequired

Responses

200

application/json

Schema

Schema

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

The same token received in the request.

TimeStamp stringrequired

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

Target TargetEnumrequired

Possible values: [0, 1]

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

Version numberrequired

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

Success objectnullable
property name* string
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.
]
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.
]
EchoData stringrequired

Example (from schema)

{
  "PrimaryLangID": 8,
  "EchoToken": "string",
  "TimeStamp": "string",
  "Target": 0,
  "Version": 0,
  "Success": {},
  "WarningsType": {
    "Warnings": [
      {
        "Code": 0,
        "Language": 8,
        "ShortText": "string"
      }
    ]
  },
  "ErrorsType": {
    "Errors": [
      {
        "Code": 0,
        "Language": 8,
        "ShortText": "string"
      }
    ]
  },
  "EchoData": "string"
}

Loading...