Notifications and Webhook

Register Webhook

post

Header parameters

AcceptstringRequiredExample: application/json

Content-TypestringRequiredExample: application/json

Accept-EncodingstringRequiredExample: gzip

x-atlas-client-idstringRequiredExample: <YOUR_CLIENT_ID>

x-atlas-client-secretstringRequiredExample: <YOUR_CLIENT_SECRET>

Body

urlstringRequired

The URL for receiving webhook notifications

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /updateWebhookURL.do HTTP/1.1
Host: 
Accept: text
Content-Type: application/json
Accept-Encoding: text
x-atlas-client-id: text
x-atlas-client-secret: text
Content-Length: 14

{
  "url": "text"
}

200Success

{
  "status": 1,
  "msg": "text"
}

Incident List

post

Header parameters

AcceptstringRequiredExample: application/json

Content-TypestringRequiredExample: application/json

Accept-EncodingstringRequiredExample: gzip

x-atlas-client-idstringRequiredExample: <YOUR_CLIENT_ID>

x-atlas-client-secretstringRequiredExample: <YOUR_CLIENT_SECRET>

Body

eventIdstringOptional

Incident ID

orderNostringOptional

Order number

eventTypestringOptional

Incident type:

• email.schedulechange: Schedule Change-Email Notification
• abnormal.cancelled: Unacounted Cancellation
• order.schedulechange: Schedule Change-API Notification

pnrstringOptional

Order's pnr.

paxNamestringOptional

Order's passenger names.

paxEmailstringOptional

Order's passenger Email. Email address passed to the Airline.

airlinestringOptional

Airline IATA code.

eventStatusinteger[]Optional

A list containing incident stauses

• 0: Unconfirmed
• 1: Confirmed

eventTimeStartstringOptional

Incident Receiving Time Start Format: yyyy-MM-dd HH:mm:ss UTC+08:00

eventTimeEndstringOptional

Incident Receiving Time End Format: yyyy-MM-dd HH:mm:ss UTC+08:00

depTimeStartstringOptional

Departure Time Start(Departure local time) Format: yyyy-MM-dd HH:mm:ss

depTimeEndstringOptional

Departure Time End(Departure local time) Format: yyyy-MM-dd HH:mm:ss

updateTimeStartstringOptional

pageIndexinteger | nullableOptional

Pagination

Default: 1

pageSizeintegerRequired

Number of records per page

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /event/getPageList.do HTTP/1.1
Host: 
Accept: text
Content-Type: application/json
Accept-Encoding: text
x-atlas-client-id: text
x-atlas-client-secret: text
Content-Length: 277

{
  "eventId": "text",
  "orderNo": "text",
  "eventType": "text",
  "pnr": "text",
  "paxName": "text",
  "paxEmail": "text",
  "airline": "text",
  "eventStatus": [
    1
  ],
  "eventTimeStart": "text",
  "eventTimeEnd": "text",
  "depTimeStart": "text",
  "depTimeEnd": "text",
  "updateTimeStart": "text",
  "pageIndex": 1,
  "pageSize": 1
}

200Success

{
  "status": 1,
  "msg": "text",
  "records": [
    {
      "eventId": "text",
      "orderNo": "text",
      "eventType": "text",
      "eventStatus": 1,
      "eventTime": "text",
      "confirmedResult": "text",
      "confirmedRemark": "text",
      "createTime": "text",
      "airline": "text",
      "depTime": "text",
      "confirmTime": "text",
      "notified": 1,
      "pnr": "text",
      "paxName": "text",
      "paxEmail": "text"
    }
  ],
  "pageIndex": "text",
  "pageSize": "text",
  "total": "text"
}