Chilkat Online Tools

PureBasic / Booking Management API v2021.12 / createBooking - Air with remarks and other services

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "agency": {
    ;     "address": {
    ;       "name": "John Smith",
    ;       "street": "1230 Ellen Ave, apt 10",
    ;       "city": "Dallas",
    ;       "stateProvince": "TX",
    ;       "postalCode": "75063",
    ;       "countryCode": "US",
    ;       "freeText": "John Smith\n1230 Ellen Ave, apt 10\nDallas, TX 75063\nUS"
    ;     },
    ;     "agencyCustomerNumber": "1234567",
    ;     "ticketingPolicy": "TODAY"
    ;   },
    ;   "travelers": [
    ;     {
    ;       "givenName": "John",
    ;       "surname": "Smith",
    ;       "birthDate": "1970-01-23",
    ;       "passengerCode": "ADT",
    ;       "identityDocuments": [
    ;         {
    ;           "documentNumber": "0123456789",
    ;           "documentType": "PASSPORT",
    ;           "expiryDate": "2024-07-09",
    ;           "issuingCountryCode": "US",
    ;           "residenceCountryCode": "US",
    ;           "givenName": "John",
    ;           "middleName": "Jack",
    ;           "surname": "Smith",
    ;           "birthDate": "1980-12-02",
    ;           "gender": "MALE"
    ;         }
    ;       ]
    ;     }
    ;   ],
    ;   "contactInfo": {
    ;     "emails": [
    ;       "travel@sabre.com",
    ;       "travel2@sabre.com"
    ;     ],
    ;     "phones": [
    ;       "+123456"
    ;     ]
    ;   },
    ;   "flightDetails": {
    ;     "flights": [
    ;       {
    ;         "flightNumber": 463,
    ;         "airlineCode": "EY",
    ;         "fromAirportCode": "MEL",
    ;         "toAirportCode": "AUH",
    ;         "departureDate": "{{start_date}}",
    ;         "departureTime": "16:15",
    ;         "bookingClass": "Y",
    ;         "marriageGroup": false,
    ;         "flightStatusCode": "NN"
    ;       },
    ;       {
    ;         "flightNumber": 460,
    ;         "airlineCode": "EY",
    ;         "fromAirportCode": "AUH",
    ;         "toAirportCode": "MEL",
    ;         "departureDate": "{{end_date}}",
    ;         "departureTime": "21:45",
    ;         "bookingClass": "Y",
    ;         "marriageGroup": false,
    ;         "flightStatusCode": "NN"
    ;       }
    ;     ],
    ;     "flightPricing": [
    ;       {
    ;         "qualifiers": {
    ;           "validatingAirlineCode": "EY"
    ;         }
    ;       }
    ;     ]
    ;   },
    ;   "remarks": [
    ;     {
    ;       "type": "GENERAL",
    ;       "text": "TEST REMARK"
    ;     }
    ;   ],
    ;   "otherServices": [
    ;     {
    ;       "airlineCode": "EY",
    ;       "travelerIndex": 1,
    ;       "serviceMessage": "TEST OTHER SERVICE"
    ;     }
    ;   ]
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"agency.address.name","John Smith")
    CkJsonObject::ckUpdateString(json,"agency.address.street","1230 Ellen Ave, apt 10")
    CkJsonObject::ckUpdateString(json,"agency.address.city","Dallas")
    CkJsonObject::ckUpdateString(json,"agency.address.stateProvince","TX")
    CkJsonObject::ckUpdateString(json,"agency.address.postalCode","75063")
    CkJsonObject::ckUpdateString(json,"agency.address.countryCode","US")
    CkJsonObject::ckUpdateString(json,"agency.address.freeText","John Smith" + Chr(10) + "1230 Ellen Ave, apt 10" + Chr(10) + "Dallas, TX 75063" + Chr(10) + "US")
    CkJsonObject::ckUpdateString(json,"agency.agencyCustomerNumber","1234567")
    CkJsonObject::ckUpdateString(json,"agency.ticketingPolicy","TODAY")
    CkJsonObject::ckUpdateString(json,"travelers[0].givenName","John")
    CkJsonObject::ckUpdateString(json,"travelers[0].surname","Smith")
    CkJsonObject::ckUpdateString(json,"travelers[0].birthDate","1970-01-23")
    CkJsonObject::ckUpdateString(json,"travelers[0].passengerCode","ADT")
    CkJsonObject::ckUpdateString(json,"travelers[0].identityDocuments[0].documentNumber","0123456789")
    CkJsonObject::ckUpdateString(json,"travelers[0].identityDocuments[0].documentType","PASSPORT")
    CkJsonObject::ckUpdateString(json,"travelers[0].identityDocuments[0].expiryDate","2024-07-09")
    CkJsonObject::ckUpdateString(json,"travelers[0].identityDocuments[0].issuingCountryCode","US")
    CkJsonObject::ckUpdateString(json,"travelers[0].identityDocuments[0].residenceCountryCode","US")
    CkJsonObject::ckUpdateString(json,"travelers[0].identityDocuments[0].givenName","John")
    CkJsonObject::ckUpdateString(json,"travelers[0].identityDocuments[0].middleName","Jack")
    CkJsonObject::ckUpdateString(json,"travelers[0].identityDocuments[0].surname","Smith")
    CkJsonObject::ckUpdateString(json,"travelers[0].identityDocuments[0].birthDate","1980-12-02")
    CkJsonObject::ckUpdateString(json,"travelers[0].identityDocuments[0].gender","MALE")
    CkJsonObject::ckUpdateString(json,"contactInfo.emails[0]","travel@sabre.com")
    CkJsonObject::ckUpdateString(json,"contactInfo.emails[1]","travel2@sabre.com")
    CkJsonObject::ckUpdateString(json,"contactInfo.phones[0]","+123456")
    CkJsonObject::ckUpdateInt(json,"flightDetails.flights[0].flightNumber",463)
    CkJsonObject::ckUpdateString(json,"flightDetails.flights[0].airlineCode","EY")
    CkJsonObject::ckUpdateString(json,"flightDetails.flights[0].fromAirportCode","MEL")
    CkJsonObject::ckUpdateString(json,"flightDetails.flights[0].toAirportCode","AUH")
    CkJsonObject::ckUpdateString(json,"flightDetails.flights[0].departureDate","{{start_date}}")
    CkJsonObject::ckUpdateString(json,"flightDetails.flights[0].departureTime","16:15")
    CkJsonObject::ckUpdateString(json,"flightDetails.flights[0].bookingClass","Y")
    CkJsonObject::ckUpdateBool(json,"flightDetails.flights[0].marriageGroup",0)
    CkJsonObject::ckUpdateString(json,"flightDetails.flights[0].flightStatusCode","NN")
    CkJsonObject::ckUpdateInt(json,"flightDetails.flights[1].flightNumber",460)
    CkJsonObject::ckUpdateString(json,"flightDetails.flights[1].airlineCode","EY")
    CkJsonObject::ckUpdateString(json,"flightDetails.flights[1].fromAirportCode","AUH")
    CkJsonObject::ckUpdateString(json,"flightDetails.flights[1].toAirportCode","MEL")
    CkJsonObject::ckUpdateString(json,"flightDetails.flights[1].departureDate","{{end_date}}")
    CkJsonObject::ckUpdateString(json,"flightDetails.flights[1].departureTime","21:45")
    CkJsonObject::ckUpdateString(json,"flightDetails.flights[1].bookingClass","Y")
    CkJsonObject::ckUpdateBool(json,"flightDetails.flights[1].marriageGroup",0)
    CkJsonObject::ckUpdateString(json,"flightDetails.flights[1].flightStatusCode","NN")
    CkJsonObject::ckUpdateString(json,"flightDetails.flightPricing[0].qualifiers.validatingAirlineCode","EY")
    CkJsonObject::ckUpdateString(json,"remarks[0].type","GENERAL")
    CkJsonObject::ckUpdateString(json,"remarks[0].text","TEST REMARK")
    CkJsonObject::ckUpdateString(json,"otherServices[0].airlineCode","EY")
    CkJsonObject::ckUpdateInt(json,"otherServices[0].travelerIndex",1)
    CkJsonObject::ckUpdateString(json,"otherServices[0].serviceMessage","TEST OTHER SERVICE")

    CkHttp::ckSetRequestHeader(http,"Conversation-ID","{{conv_id}}")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/v1/trip/orders/createBooking","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "Conversation-ID: {{conv_id}}"
	-d '{
    "agency": {
        "address": {
            "name": "John Smith",
            "street": "1230 Ellen Ave, apt 10",
            "city": "Dallas",
            "stateProvince": "TX",
            "postalCode": "75063",
            "countryCode": "US",
            "freeText": "John Smith\n1230 Ellen Ave, apt 10\nDallas, TX 75063\nUS"
        },
        "agencyCustomerNumber": "1234567",
        "ticketingPolicy": "TODAY"
    },
    "travelers": [
        {
            "givenName": "John",
            "surname": "Smith",
            "birthDate": "1970-01-23",
            "passengerCode": "ADT",
            "identityDocuments": [
                {
                    "documentNumber": "0123456789",
                    "documentType": "PASSPORT",
                    "expiryDate": "2024-07-09",
                    "issuingCountryCode": "US",
                    "residenceCountryCode": "US",
                    "givenName": "John",
                    "middleName": "Jack",
                    "surname": "Smith",
                    "birthDate": "1980-12-02",
                    "gender": "MALE"
                }
            ]
        }
    ],
    "contactInfo": {
        "emails": [
            "travel@sabre.com",
            "travel2@sabre.com"
        ],
        "phones": [
            "+123456"
        ]
    },
    "flightDetails": {
        "flights": [
            {
                "flightNumber": 463,
                "airlineCode": "EY",
                "fromAirportCode": "MEL",
                "toAirportCode": "AUH",
                "departureDate": "{{start_date}}",
                "departureTime": "16:15",
                "bookingClass": "Y",
                "marriageGroup": false,
                "flightStatusCode": "NN"
            },
            {
                "flightNumber": 460,
                "airlineCode": "EY",
                "fromAirportCode": "AUH",
                "toAirportCode": "MEL",
                "departureDate": "{{end_date}}",
                "departureTime": "21:45",
                "bookingClass": "Y",
                "marriageGroup": false,
                "flightStatusCode": "NN"
            }
        ],
        "flightPricing": [
            {
                "qualifiers": {
                    "validatingAirlineCode": "EY"
                }
            }
        ]
    },
    "remarks": [
        {
            "type": "GENERAL",
            "text": "TEST REMARK"
        }
    ],
    "otherServices": [
        {
            "airlineCode": "EY",
            "travelerIndex": 1,
            "serviceMessage": "TEST OTHER SERVICE"
        }
    ]
}'
https://domain.com/v1/trip/orders/createBooking

Postman Collection Item JSON

{
  "name": "createBooking - Air with remarks and other services",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "Conversation-ID",
        "type": "text",
        "value": "{{conv_id}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"agency\": {\n        \"address\": {\n            \"name\": \"John Smith\",\n            \"street\": \"1230 Ellen Ave, apt 10\",\n            \"city\": \"Dallas\",\n            \"stateProvince\": \"TX\",\n            \"postalCode\": \"75063\",\n            \"countryCode\": \"US\",\n            \"freeText\": \"John Smith\\n1230 Ellen Ave, apt 10\\nDallas, TX 75063\\nUS\"\n        },\n        \"agencyCustomerNumber\": \"1234567\",\n        \"ticketingPolicy\": \"TODAY\"\n    },\n    \"travelers\": [\n        {\n            \"givenName\": \"John\",\n            \"surname\": \"Smith\",\n            \"birthDate\": \"1970-01-23\",\n            \"passengerCode\": \"ADT\",\n            \"identityDocuments\": [\n                {\n                    \"documentNumber\": \"0123456789\",\n                    \"documentType\": \"PASSPORT\",\n                    \"expiryDate\": \"2024-07-09\",\n                    \"issuingCountryCode\": \"US\",\n                    \"residenceCountryCode\": \"US\",\n                    \"givenName\": \"John\",\n                    \"middleName\": \"Jack\",\n                    \"surname\": \"Smith\",\n                    \"birthDate\": \"1980-12-02\",\n                    \"gender\": \"MALE\"\n                }\n            ]\n        }\n    ],\n    \"contactInfo\": {\n        \"emails\": [\n            \"travel@sabre.com\",\n            \"travel2@sabre.com\"\n        ],\n        \"phones\": [\n            \"+123456\"\n        ]\n    },\n    \"flightDetails\": {\n        \"flights\": [\n            {\n                \"flightNumber\": 463,\n                \"airlineCode\": \"EY\",\n                \"fromAirportCode\": \"MEL\",\n                \"toAirportCode\": \"AUH\",\n                \"departureDate\": \"{{start_date}}\",\n                \"departureTime\": \"16:15\",\n                \"bookingClass\": \"Y\",\n                \"marriageGroup\": false,\n                \"flightStatusCode\": \"NN\"\n            },\n            {\n                \"flightNumber\": 460,\n                \"airlineCode\": \"EY\",\n                \"fromAirportCode\": \"AUH\",\n                \"toAirportCode\": \"MEL\",\n                \"departureDate\": \"{{end_date}}\",\n                \"departureTime\": \"21:45\",\n                \"bookingClass\": \"Y\",\n                \"marriageGroup\": false,\n                \"flightStatusCode\": \"NN\"\n            }\n        ],\n        \"flightPricing\": [\n            {\n                \"qualifiers\": {\n                    \"validatingAirlineCode\": \"EY\"\n                }\n            }\n        ]\n    },\n    \"remarks\": [\n        {\n            \"type\": \"GENERAL\",\n            \"text\": \"TEST REMARK\"\n        }\n    ],\n    \"otherServices\": [\n        {\n            \"airlineCode\": \"EY\",\n            \"travelerIndex\": 1,\n            \"serviceMessage\": \"TEST OTHER SERVICE\"\n        }\n    ]\n}"
    },
    "url": {
      "raw": "{{rest_endpoint}}/v1/trip/orders/createBooking",
      "host": [
        "{{rest_endpoint}}"
      ],
      "path": [
        "v1",
        "trip",
        "orders",
        "createBooking"
      ]
    },
    "description": "[//]: # \"Start\"\n\n<b>[Description](https://developer.sabre.com/docs/rest_apis/trip/orders/booking_management), [Resources](https://developer.sabre.com/docs/rest_apis/trip/orders/booking_management/reference-documentation), [Help](https://developer.sabre.com/docs/rest_apis/trip/orders/booking_management/help)</b>\n\n[//]: # \"End\""
  },
  "response": [
  ]
}