Notifications and Webhook

Register Webhook

post

Endpoint: https://sandbox.atriptech.com/updateWebhookURL.do

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

application/json

urlstringRequired

The URL for receiving webhook notifications

Responses

200Success

application/json

statusintegerRequired

msgstring · nullableOptional

It serves as an additional description of the response result. Especially when the interface reports an error (status !=0), it is usually a human-readable error message. Note: Do not use this field in any programming scenarios. For example, do not judge whether the interface responds successfully based on this field. Instead, you should only determine it by checking whether the status is equal to0at any time.

post

/updateWebhookURL.do

HTTPcURLJavaScriptPython

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

{
  "cid": "XXXXXXXX",
  "url": "https://xxx.com/xxxx"
}

200Success

{
  "status": 0,
  "msg": "success"
}

Incident List

post

Endpoint: https://sandbox.atriptech.com/event/getPageList.do

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

application/json

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

statusintegerRequired

msgstring · nullableOptional

pageIndexstringRequired

Current pagination

pageSizestringRequired

Page size

totalstringRequired

Total number of records

post

/event/getPageList.do

HTTPcURLJavaScriptPython

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

{
  "eventId": "",
  "orderNo": "",
  "eventType": "",
  "eventStatus": [
    0,
    1
  ],
  "airline": "",
  "eventTimeStart": "2023-04-01 00:00:00",
  "eventTimeEnd": "2023-05-01 00:00:00",
  "depTimeStart": null,
  "depTimeEnd": null,
  "pageIndex": 1,
  "pageSize": 100
}

200Success

{

    "records": [

        {

            "eventId": "20230401003644225YJQGR",

            "orderNo": "HCNMN20230227142411968",

            "subOrderNo": "HCNMN20230227142411968_1",

            "eventType": "email.schedulechange",

            "eventStatus": 0,

            "eventTime": "Apr 1, 2023 12:36:44 AM",

            "extraInfo": "4775822",

            "confirmedResult": null,

            "confirmedRemark": null,

            "clientCode": "TAC00001",

            "createTime": "Apr 1, 2023 12:36:44 AM",

            "updateIme": "Apr 1, 2023 12:36:44 AM",

            "airline": "F9",

            "depTime": "Mar 31, 2023 11:12:00 AM",

            "confirmTime": null,

            "confirmUsr": null,

            "notified": 1,

            "pnr": "G7ZNW5",

            "paxName": "SOWERS/REBECCA MUSETTA,STEPHENS/DAVID JEROME",

            "paxEmail": "[email protected]"

        },

    …

    ]

}