GetScheduleChangeList

Function Description

After the order is generated, the airline may send the flight change information. Types of message include:

Flight cancelled

Flight cancelled, with protected flight(s)

Flight schedule changed, it could be time change, equipment change, terminal change, etc.

Through GetScheduleChangeList API, you are able to request by a time schedule to get the schedule change information.
Note When you requested AcknowledageScheduleChange and AcceptScheduleChange API, we will clear this message. Then, you will not get same message again.
Note If the flight has token off, the message will be cleared automatically. So you will not get its message.
Note If you request with a order number to get schedule change information, we will response the message for this order only. In this case, you has a order for issuing ticket, then passenger requested to change, you will got the second order which is change order. Multiple Schedule change messages existed and belongs to two orders. If you want to receive all messages of 1 request by indicating the order number for issuing ticket, you may contact PKFARE's implementor to change the setting.
Note To limited the size of response, the duration of "messageCreateTimeStart" and "messageCreateTimeEnd" should be within 24 hours.

Appendix

Error Code List

errorCode	errorMsg	Description
0	ok	Request has been processed successfully.
S001	System error	System error.
P001	xxx is illegal	Request parameter is illegal, xxx will display request parameter
B002	Partner is not exists	Partner does not exist.
B003	Illegal sign	Illegal sign.
B035	Concurrency limited. Please contact PKFARE API support team for assistant.	Concurrent users contral. Please contact PKFARE API support for assistant.
B037	Order is not exist.	Order does not exist.
B048	Invalid buyer	Buyer is invalid.
B130	Message is not exist.	Schedule change message does not exist.

Cabin Class

Enum	Description
ECONOMY	Economy Class
PREMIUM ECONOMY	Premium Economy Class
BUSINESS	Business Class
FIRST	First Class

Type of Travel Document

Enum	Description
P	Passport
N	Chinese Identity
O	Others

Passenger Type

Enum	Description
ADT	adult
CHD	children[2-12 years old]

Gender

Enum	Description
M	Male
F	Female

Request

Body Params application/json

Example

{
    "Authentication": {
        "partnerId": "string",
        "sign": "string"
    },
    "data": {
        "messageId": "string",
        "orderNum": "string",
        "messageType": "string",
        "sensitivityLevel": "string",
        "messageCreateTimeStart": "string",
        "messageCreateTimeEnd": "string"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "errorCode": "0",
    "errorMsg": "ok",
    "data": [
        {
            "orderNum": "916766125109920601",
            "messageId": "2944668",
            "messageCreateTime": "2023-02-22 15:07:10",
            "sensitivityLevel": "1",
            "orderPnr": "TGBYHN",
            "orderAirlinePnr": "TGBYHN",
            "pnrList": [
                {
                    "segmentNo": 1,
                    "departure": "PEK",
                    "arrival": "HKG",
                    "flightNum": "391",
                    "cabinClass": "ECONOMY",
                    "bookingCode": "B",
                    "pnr": "TGBYHN",
                    "airPnr": "TGBYHN",
                    "ticketNums": [
                        {
                            "ticketNum": "123321",
                            "lastName": "YANGUJM",
                            "firstName": "TIFFANY",
                            "cardType": "PP",
                            "cardNum": "E07700466",
                            "sex": "F",
                            "birthday": "1990-08-23"
                        }
                    ]
                },
                {
                    "segmentNo": 2,
                    "departure": "HKG",
                    "arrival": "BKK",
                    "flightNum": "617",
                    "cabinClass": "ECONOMY",
                    "bookingCode": "A",
                    "pnr": "TGBYHN",
                    "airPnr": "TGBYHN",
                    "ticketNums": [
                        {
                            "ticketNum": "456456",
                            "lastName": "YANGUJM",
                            "firstName": "TIFFANY",
                            "cardType": "PP",
                            "cardNum": "E07700466",
                            "sex": "F",
                            "birthday": "1990-08-23"
                        }
                    ]
                }
            ],
            "passengers": [
                {
                    "birthday": "1990-08-23",
                    "cardType": "PP",
                    "cardNum": "E07700466",
                    "cardExpiredDate": "2024-03-17",
                    "lastName": "YANGUJM",
                    "firstName": "TIFFANY",
                    "nationality": "CN",
                    "psgType": "ADT",
                    "sex": "F",
                    "ticketNum": "123321"
                }
            ],
            "originFlightList": [
                {
                    "journeySeq": "1",
                    "segments": [
                        {
                            "airline": "CX",
                            "flightNum": "391",
                            "equipment": "333",
                            "cabinClass": "ECONOMY",
                            "bookingCode": "S",
                            "departure": "PEK",
                            "arrival": "HKG",
                            "departureDate": "2023-03-31",
                            "arrivalDate": "2023-03-31",
                            "departureTime": "13:40",
                            "arrivalTime": "17:35",
                            "flightTime": 235,
                            "stayTime": 0,
                            "codeShare": "N",
                            "messageType": "1"
                        },
                        {
                            "airline": "CX",
                            "flightNum": "617",
                            "equipment": "333",
                            "cabinClass": "ECONOMY",
                            "bookingCode": "S",
                            "departure": "HKG",
                            "arrival": "BKK",
                            "departureDate": "2023-03-31",
                            "arrivalDate": "2023-03-31",
                            "departureTime": "21:50",
                            "arrivalTime": "23:50",
                            "flightTime": 180,
                            "stayTime": 0,
                            "codeShare": "N",
                            "messageType": "1"
                        }
                    ]
                }
            ],
            "changeFlightList": [
                {
                    "journeySeq": "1",
                    "segments": [
                        {
                            "airline": "CX",
                            "flightNum": "391",
                            "equipment": "333",
                            "cabinClass": "ECONOMY",
                            "bookingCode": "B",
                            "departure": "PEK",
                            "arrival": "HKG",
                            "departureDate": "2023-03-31",
                            "arrivalDate": "2023-03-31",
                            "departureTime": "13:40",
                            "arrivalTime": "17:35",
                            "stayTime": 0,
                            "codeShare": "N",
                            "stopover": ""
                        },
                        {
                            "airline": "CX",
                            "flightNum": "617",
                            "equipment": "333",
                            "cabinClass": "ECONOMY",
                            "bookingCode": "A",
                            "departure": "HKG",
                            "arrival": "BKK",
                            "departureDate": "2023-03-31",
                            "arrivalDate": "2023-03-31",
                            "departureTime": "21:50",
                            "arrivalTime": "23:50",
                            "stayTime": 0,
                            "codeShare": "N",
                            "stopover": ""
                        }
                    ]
                }
            ]
        }
    ]
}

🟢200Error

Function Description#

Appendix#

Error Code List#

Cabin Class#

Type of Travel Document#

Passenger Type#

Gender#