Travel Agency Address API Reference

POST

ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/addaddress

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

Base path:

Pre-production https://api.pp.travelport.com/11/air/

Production https://api.travelport.com/11/air/

Put

ticket/travelagency /reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/updateaddress

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

For {travelagencyID} send the agency identifier returned in TravelAgency/Identifier/value in the Workbench Create and Workbench Retrieve responses.

Base path:

Pre-production https://api.pp.travelport.com/11/air/

Production https://api.travelport.com/11/air/

DEL

ticket/travelagency /reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/deleteaddress{addressID}

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

For {travelagencyID} send the agency identifier returned in TravelAgency/Identifier/value in the Workbench Create and Workbench Retrieve responses.

Base path:

Pre-production https://api.pp.travelport.com/11/air/

Production https://api.travelport.com/11/air/

Request

Also see Authorization and Common Headers.

Query Parameters

None.

Request Body

Use the following request for both the add and update operations; note the different endpoints for each operation per above.

The delete request does not have a message body.

Show Request Body Table

Object	Description	Required/Optional
TravelAgencyQueryTravelAgencyAddressWrapper	Top level object.	Required
TravelAgencyQueryTravelAgencyAddress	Top level object.	Required
Address	Top level object for address data. Key value pair: role: Role of the address. Includes AddressLine, City, StateProv, Country, PostalCode, Addressee objects.	Required
role	Role for this address.	Optional
AddressLine	The street address.	Required
City	The city of the address.	Required
StateProv	The state or province of the address. Key value pair: name: Name of the state or province.	Required
Country	The country of the address. name: Name of the country.	Required
PostalCode	The postal code of the address.	Required
Addressee	Contact name at the address.	Optional

Response

The response returns an identifier for the travel agency.

Show Response Body Table

Object	Description
TravelAgencyResponse	Top level object. Includes TravelAgency object.
TravelAgency	Corporate code value. Key value pair: id: System-assigned internal id for this travel agency. Must be sent in any subsequent update or delete request for the address added. This id is not associated with the internal id generated if a corporate ID is added for the same travel agency. The two ids are separate; the value returned here is used only in subsequent update or delete requests for this address.
Identifier	System-generated identifier for the travel agency; use this in subsequent update and delete request: authority: Source of information. value: Unique system-generated identifier.
Address	Id for the address sent in the add or update request. Key value pair: id: System-assigned internal id for this address. Must be sent in any subsequent update or delete request for this address.

Example Request

Use the following request for both the add and update operations; note the different endpoints for each operation per above.

Show Example add travel agency address request

{
 "TravelAgencyQueryTravelAgencyAddressWrapper": {
  "TravelAgencyQueryTravelAgencyAddress": {
   "Address": {
    "@type": "AddressDetail",
    "AddressLine": "28 BROAD STREET",
    "City": "ENGLEWOOD",
    "StateProv": {
     "name": "COLORADO"
    },
    "Country": {
     "name": "US"
    },
    "PostalCode": "80111",
    "Addressee": "ONE TEST"
    "role": "Business"
   }
  }
 }
}

Example Response

The following response is returned for the add and update operations.

Show Example add or update travel agency address response

{
 "TravelAgencyResponse": {
  "TravelAgency": {
   "@type": "TravelAgencyDetail",
   "id": "travelagency_1",
   "Identifier": {
    "value": "fc9ab7f1-c6ec-4787-a978-ae7f793704d6",
    "authority": "Travelport"
   },
   "Address": [
    {
     "@type": "AddressDetail",
     "id": "address_1"
    }
   ]
  }
 }
}

The delete response returns a No Content message.