DocumentGetEvents

POST 
/Document/DocumentGetEvents

DocumentGetEvents

Request

application/json

Body

required

globalDocumentId uuidrequired
countryDocumentId stringrequired
status stringrequired

text/json

Body

required

globalDocumentId uuidrequired
countryDocumentId stringrequired
status stringrequired

application/xml

Body

required

globalDocumentId uuidrequired
countryDocumentId stringrequired
status stringrequired

text/xml

Body

required

globalDocumentId uuidrequired
countryDocumentId stringrequired
status stringrequired

application/x-www-form-urlencoded

Body

required

globalDocumentId uuidrequired
countryDocumentId stringrequired
status stringrequired

Responses

200

OK

application/json

Schema

Schema

Success booleanrequired

True is Success

GlobalDocumentId uuidrequired
CountryDocumentId stringrequired
OtherData object
property name* stringrequired
Messages string[]required
ResponseValue stringrequired

Response value

Code int32required

Return Code

Description stringrequired

Code Description

ErrorException objectrequired

Error Exception

Example (from schema)

{
  "Success": true,
  "GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
  "CountryDocumentId": "string",
  "OtherData": {},
  "Messages": [
    "string"
  ],
  "ResponseValue": "string",
  "Code": 0,
  "Description": "string",
  "ErrorException": {}
}

text/json

Schema

Schema

Success booleanrequired

True is Success

GlobalDocumentId uuidrequired
CountryDocumentId stringrequired
OtherData object
property name* stringrequired
Messages string[]required
ResponseValue stringrequired

Response value

Code int32required

Return Code

Description stringrequired

Code Description

ErrorException objectrequired

Error Exception

Example (from schema)

{
  "Success": true,
  "GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
  "CountryDocumentId": "string",
  "OtherData": {},
  "Messages": [
    "string"
  ],
  "ResponseValue": "string",
  "Code": 0,
  "Description": "string",
  "ErrorException": {}
}

application/xml

Schema

Schema

Success booleanrequired

True is Success

GlobalDocumentId uuidrequired
CountryDocumentId stringrequired
OtherData object
property name* stringrequired
Messages string[]required
ResponseValue stringrequired

Response value

Code int32required

Return Code

Description stringrequired

Code Description

ErrorException objectrequired

Error Exception

Example (from schema)

<root>
  <Success>true</Success>
  <GlobalDocumentId>00000000-0000-0000-0000-000000000000</GlobalDocumentId>
  <CountryDocumentId>string</CountryDocumentId>
  <OtherData/>
  <Messages>string</Messages>
  <ResponseValue>string</ResponseValue>
  <Code>0</Code>
  <Description>string</Description>
  <ErrorException/>
</root>

text/xml

Schema

Schema

Success booleanrequired

True is Success

GlobalDocumentId uuidrequired
CountryDocumentId stringrequired
OtherData object
property name* stringrequired
Messages string[]required
ResponseValue stringrequired

Response value

Code int32required

Return Code

Description stringrequired

Code Description

ErrorException objectrequired

Error Exception

Example (from schema)

<root>
  <Success>true</Success>
  <GlobalDocumentId>00000000-0000-0000-0000-000000000000</GlobalDocumentId>
  <CountryDocumentId>string</CountryDocumentId>
  <OtherData/>
  <Messages>string</Messages>
  <ResponseValue>string</ResponseValue>
  <Code>0</Code>
  <Description>string</Description>
  <ErrorException/>
</root>

Loading...