Agentivity API

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This is a documentation for Agentivity API. Agentivity API gives you access to all the reports available in Agentivity application just in API form.

API Authentication

Authentication

method="GET"
url="requestURL"
header="ContentType"
dateTime=$(date +"%F %T")
MESSAGE="$method$url$header$dateTime"
APIKEY="apikey"

apisig=`printf %s "$MESSAGE" | openssl dgst -sha256 -hmac "$APIKEY" -binary | 'base64'

using System.Security.Cryptography;

namespace Test
{
  public class MyHmac
  {
    private string CreateToken(string message, string apikey)
    {
      secret = apikey ?? "";
      string dt = webRequest.Date.ToUniversalTime().ToString("r");
      var message = string.Format("{0}{1}{2}{3}", webRequest.Method, webRequest.RequestUri.AbsoluteUri, webRequest.ContentType, dt);
      var encoding = new System.Text.ASCIIEncoding();
      byte[] keyByte = encoding.GetBytes(secret);
      byte[] messageBytes = encoding.GetBytes(message);
      using (var hmacsha256 = new HMACSHA256(keyByte))
      {
        byte[] hashmessage = hmacsha256.ComputeHash(messageBytes);
        return Convert.ToBase64String(hashmessage);
      }
    }
  }
}

import urllib.request
import datetime
import hashlib
import hmac
import base64
datetime = datetime.datetime.now().strftime("%Y-%m-%d, %H:%M:%S")

method = "GET"
url = "requestURL"
contenttype = "application/xml" 
message = bytes (method + url + contenttype + datetime, 'utf-8')
secret = bytes('apikey', 'utf-8')

signature = base64.b64encode(hmac.new(secret, message, digestmod=hashlib.sha256).digest())
print(signature)

import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import org.apache.commons.codec.binary.Base64;
import java.text.SimpleDateFormat;
import java.util.Date;

public class ApiSecurityExample {
  public static void main(String[] args) {
    try {
	 String secret = "apikey";
	 
	 String method = "GET";
	 String url = "requestURL";
	 String header = "ContentType";
	 final SimpleDateFormat sdf = new SimpleDateFormat("yyyy MM dd HH:mm:ss");
	 sdf.setTimeZone(TimeZone.getTimeZone("UTC"));
	 String dt = sdf.format(new Date());
	 StringBuilder sb= new StringBuilder();
	 sb.append(method).append(url).append(header).append(dt);
	 String message = sb.toString();
	 
	 Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
	 SecretKeySpec secret_key = new SecretKeySpec(secret.getBytes(), "HmacSHA256");
	 sha256_HMAC.init(secret_key);
	 
	 String hash = Base64.encodeBase64String(sha256_HMAC.doFinal(message.getBytes()));
	 System.out.println(hash);
    }
    catch (Exception e){
     System.out.println("Error");
    }
   }
}

You will be provided with a Username (X-AGENTIVTY-API-USERNAME) and a Secret Key (APIKEY). The secret key is only known to you and by the API.

Four headers are used to send a message to the API.

Header 1 is the Username
Header 2 is the Current Timestamp
Header 3 is the Content Type
Header 4 is a Signature that is a Unique Hash.

The Unique Hash is created using a combination of the Method, the URL, the Secret Key, the current Timestamp, and the Content Type that is encrypted using HMAC (Hash-based message authentication code). This means the Unique Hash is different for every request made.

The Timestamp is in UTC and should be of the format:

04 Apr 2016 14:55:34 GMT

You should use a method to convert your timestamp to UTC, e.g. webRequest.Date.ToUniversalTime().ToString("r")

The Content Type's accepted are: application/json; application/xml; text/csv

The Method is: GET

More information about HMAC can be found at: https://en.wikipedia.org/wiki/Hash-based_message_authentication_code

Example code for various programming languages can be found at: https://www.jokecamp.com/blog/examples-of-creating-base64-hashes-using-hmac-sha256-in-different-languages/

API Keys

You will be provided with the following details:
APIKEY
X-AGENTIVTY-API-USERNAME

Both APIKEY and X-AGENTIVTY-API-USERNAME are required for the authentication of the API Request that you are sending as part of the Header.

Header names that you should use with Agentivity API:

• APIKEY
• X-AGENTIVTY-API-USERNAME
• X-AGENTIVTY-API-SIGNATURE
• X-AGENTIVTY-API-DATE
• CONTENT-TYPE

When testing the API, it will help to know some of the following variables:

• Your own PCC’s e.g. 02LN
• Corporate account codes e.g. COMPANYNAME
• GDS Sign-on codes e.g. 02LNEM

These details can be found in Agentivity in the sections:
Settings > Company Settings > Back-Office
Settings > Company Settings > GDS Account Values
Settings > Company Settings > GDS Sign-ons

After you have authenticated to the API, you can send requests to the API using any programming language or program that can send HTTP requests. The base URL for all endpoints is https://api.agentivity.com

API documentation usage

Currently unavailalbe. Work in progress.

Currently unavailalbe. Work in progress.

Currently unavailalbe. Work in progress.

Currently unavailalbe. Work in progress.

Here you can find some description on how to use this API documentation.

The left panel window is Table Of Content, and you can find list of all endpoints available inside Agentivity API. You also have an option to search through them with search box at the top of that panel.

Central panel is dedicated to the information about the topic or endpoint you've selected inside Table Of Content. If you are looking into one of the endpoints you will see the overview on the selected endpoint with information about:

• url for given endpoint
• Table with the list of all parameters with name, where you should put it, type, is it mandatory and brief description of the parameter.
• Enumerated values with headers for that endpoint
• Small table with some information and the link for expected look of the response in JSON format

Righr panel is reserved for code examples in some of the frequent programming languages. In top right corner of the page you can select preffered programming language to be listed in right panel along with the current endpoint that you are looking into.

Below the code example there is the place for default response. Inside that area you should see expected response presented in JSON format. Notice that only one of the following two parts of the response will be seen in actual response.

ResponseReport
ResponseError

If you want to access the data in Excel or CSV, look here at the right panel for an example on how to do so. For this you also have to choose preffered programming language from the top right corner to get accurate information.

Release Notes

The current version of Agentivity API documentation is 1.0 and it is still in beta.

Endpoints

Account

AccountsHotelAttachmentSuccess

Code samples

# You can also use wget
curl -sG GET https://api.agentivity.com/AccountsHotelAttachmentSuccess/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/AccountsHotelAttachmentSuccess/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/AccountsHotelAttachmentSuccess/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: 
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/AccountsHotelAttachmentSuccess/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /AccountsHotelAttachmentSuccess/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Account": "string",
      "TotalAirBookings": 0,
      "TotalAirBookingsWithHotel": 0,
      "TotalEligibleAirBookingsWithoutHotel": 0,
      "HotelAttachmentRate": 0,
      "HotelAttachmentRateFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AccountsHotelAttachmentSuccessItemResponse

AccountsProductivity

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/AccountsProductivity/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/AccountsProductivity/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/AccountsProductivity/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/AccountsProductivity/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /AccountsProductivity/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Account": "string",
      "AverageItineraryChangesFormatted": "string",
      "TotalBookings": 0,
      "AverageItineraryChanges": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AccountsProductivityItemResponse

CorporateAccountTicketingActivityPerDayByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/corporateaccountticketingactivityperday/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/corporateaccountticketingactivityperday/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/corporateaccountticketingactivityperday/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/corporateaccountticketingactivityperday/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /corporateaccountticketingactivityperday/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
ActivityDate	query	string	true	Date in format YYYYMMDD
Account	query	string	true	GDS Account
CompanyID	query	number	false	ID of a Company (travel agency)
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "RecordLocator": "string",
      "OwningAgencyPseudo": "string",
      "Account": "string",
      "TicketNumber": "string",
      "TourCode": "string",
      "PrimaryPax": "string",
      "FOPFare": "string",
      "FareBasis": "string",
      "Taxes": "string",
      "IATA": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	CorporateAccountTicketingActivityPerDayByUserItemResponse

Agency

AgencyActivitiesByConsultant

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/agencyactivitybyconsultants/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/agencyactivitybyconsultants/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/agencyactivitybyconsultants/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/agencyactivitybyconsultants/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /agencyactivitybyconsultants/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
EventDateStart	query	string	true	Date in format YYYYMMDD
EventDateEnd	query	string	false	Date in format YYYYMMDD
OwningConsultantID	query	string	false	Id of the owning counsultant
FormatStyle	query	string	false	Format
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Items": [
        {
          "EventHour": 0,
          "EventType": "string",
          "TotalBookings": 0
        }
      ],
      "Formatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AgencyActivitiesByConsultantItemResponse

AgencyLocationsHotelAttachmentSuccess

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/AgencyLocationsHotelAttachmentSuccess \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/AgencyLocationsHotelAttachmentSuccess");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/AgencyLocationsHotelAttachmentSuccess', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/AgencyLocationsHotelAttachmentSuccess");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /AgencyLocationsHotelAttachmentSuccess

Parameters

Name	In	Type	Required	Description
OwningAgencyLocationID	query	string	true	Owning agency location ID
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningAgencyLocationID": "string",
      "TotalAirBookings": 0,
      "TotalAirBookingsWithHotel": 0,
      "TotalEligibleAirBookingsWithoutHotel": 0,
      "HotelAttachmentRate": 0,
      "HotelAttachmentRateFormatted": "string",
      "Country": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AgencyLocationsHotelAttachmentSuccessItemResponse

AgencyReviews

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/agencyreviews \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/agencyreviews");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/agencyreviews', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/agencyreviews");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /agencyreviews

Parameters

Name	In	Type	Required	Description
Account	query	string	false	GDS Account
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
OwningAgencyLocationID	query	string	false	Owning agency location ID
LoadOptions	query	string	false	Load options
AirlineSupportFormatStyle	query	string	false	Airline support format style
ExcludedCarrierCode	query	string	false	Carrier codes excluded from the response
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Summary": {
        "TicketedBookings": 0,
        "LCCTktBookings": 0,
        "NonTicketedBookings": 0,
        "TicketedBookingsPerc": 0,
        "NonTicketedBookingsPerc": 0,
        "OnlineBookings": 0,
        "OfflineBookings": 0,
        "CxlBookings": 0,
        "OffLineHtlBookings": 0,
        "BookingsWithHotelSegments": 0,
        "BookingsWithCarSegments": 0,
        "NonAirBookings": 0,
        "TotalBookings": 0,
        "AeroTouches": 0,
        "AverageItineraryChanges": 0,
        "AverageAccountBookingToTravelTime": 0,
        "TotalItineraryChangesBeforeTicketing": 0,
        "TotalItineraryChangesAfterTicketing": 0,
        "TotalItineraryChanges": 0,
        "OwningConsultantID": "string"
      },
      "AirlineSupport": {
        "AirlinesStats": [
          {
            "CarrierCode": "string",
            "Carrier": "string",
            "TotalSegments": 0
          }
        ],
        "TotalSegments": 0,
        "FormattedAirlineSupport": "string"
      }
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AgencyReviewsItemResponse

AgencyTicketingActivity

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/agencyticketingactivity/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/agencyticketingactivity/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/agencyticketingactivity/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/agencyticketingactivity/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /agencyticketingactivity/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
EventDateStart	query	string	true	Date in format YYYYMMDD
EventDateEnd	query	string	false	Date in format YYYYMMDD
OwningAgencyLocationID	query	string	false	Owning agency location ID
ItineraryFormatting	query	string	false	Indicate the required formatting: 0=None(Default), 1= Html, 2 = Chart
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyLocationID": "string",
      "Passengers": "string",
      "Account": "string",
      "Consultant": "string",
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AgencyTicketingActivityItemResponse

Airline

AirlineDemandsForTicketingByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/airlinedemandsticketing/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/airlinedemandsticketing/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/airlinedemandsticketing/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/airlinedemandsticketing/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /airlinedemandsticketing/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DueDate	query	string	true	Date in format YYYYMMDD
CompanyID	query	number	false	ID of a Company (travel agency)
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "RecordLocator": "string",
      "PrimaryPax": "string",
      "TransactionAgent": "string",
      "Account": "string",
      "AirlineCode": "string",
      "DueTime": "string",
      "AgentivityRef": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AirlineDemandsForTicketingByUserItemResponse

CompanyTicketRevenuePerPlatingCarrierService

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/revenueperplatingcarrier/company \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/revenueperplatingcarrier/company");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/revenueperplatingcarrier/company', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/revenueperplatingcarrier/company");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET revenueperplatingcarrier/company

Parameters

Name	In	Type	Required	Description
CompanyID	query	number	true	ID of a Company (travel agency)
TravelAgentID	query	number	false	ID of a travel agent
PlatingCarrier	query	string	false	Code for Plating Carrier
DepartureDateStart	query	string	true	Date in format YYYYMMDD
DepartureDateEnd	query	string	true	Date in format YYYYMMDD
FlightCouponStatus	query	boolean	true	4 letter code for flight coupon status
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "PlatingCarrier": "string",
    "AirlineShortName": "string",
    "PrintedCurrency": "string",
    "TotalFares": "string",
    "TotalTax": "string",
    "TotalBaseRevenue": "string"
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	Object

AirlineTicketRevenueByCompany

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/airlineticketrevenues \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/airlineticketrevenues");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/airlineticketrevenues', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/airlineticketrevenues");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /airlineticketrevenues

Parameters

Name	In	Type	Required	Description
TravelAgentID	query	string	false	ID of a travel agent
PlatingCarrier	query	string	true	Code for Plating Carrier
DepartureDateStart	query	string	true	Date in format YYYYMMDD
DepartureDateEnd	query	string	true	Date in format YYYYMMDD
FlightCouponStatus	query	string	true	4 letter code for flight coupon status
UserName	query	string	true	UserName in form of an email address
AirlineCode	query	string	true	Two letter airline code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "PlatingCarrier": "string",
      "AirlineShortName": "string",
      "TotalFares": 0,
      "TotalTax": 0,
      "TotalBaseRevenue": 0,
      "FormattedCarrierPlatingName": "string",
      "PrintedCurrency": "string",
      "FormattedTotalFares": "string",
      "FormattedTotalTax": "string",
      "FormattedTotalBaseRevenue": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AirlineTicketRevenueByCompanyItemResponse

Arrivals

ArrivalsWithDestinationsByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/arrivalswithdestinations/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/arrivalswithdestinations/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/arrivalswithdestinations/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/arrivalswithdestinations/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /arrivalswithdestinations/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
CompanyID	query	string	true	ID of a Company (travel agency)
ArrivalDateStart	query	string	true	Date in format YYYYMMDD
ArrivalDateEnd	query	string	false	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "TravelOrderIdentifier": "string",
      "RecordLocator": "string",
      "LastName": "string",
      "FirstName": "string",
      "Account": "string",
      "TravelDate": "string",
      "ArrivalDate": "string",
      "DaysAway": 0,
      "DestinationCountries": "string",
      "TransactionAgent": "string",
      "MobileList": "string",
      "EmailList": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	ArrivalsWithDestinationsByUserResponse

GetGDSDestinations

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/GDSDestinations \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/GDSDestinations");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/GDSDestinations', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/GDSDestinations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /GDSDestinations

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Destination": "string",
      "DestinationPCC": "string",
      "DestinationPCCQ": "string",
      "DestinationPCCQCategory": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	GDSDestinationsItemResponse

Bookings

BookingDetailsByRef

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookingdetails \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingdetails");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookingdetails', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookingdetails");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingdetails

Parameters

Name	In	Type	Required	Description
AgentivityRef	query	string	true	Agentivity refference
LoadOptions	query	string	true	Load options
Username	query	string	true	UserName in form of an email address
RecordLocator	query	integer	false	6 letter record locator
PnrCreationDate	query	string	false	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "string",
      "Account": "string",
      "OwningConsultantID": "string",
      "OwningConsultant": "string",
      "CrsDescription": "string",
      "LastActionConsultantID": "string",
      "LastActionAgencyLocationID": "string",
      "OwningAgencyLocationID": "string",
      "CreatingAgencyIata": "string",
      "Passengers": [
        {
          "Id": 0,
          "FirstName": "string",
          "LastName": "string",
          "FrequentFlyers": [
            {
              "Vendor": "string",
              "Number": "string",
              "FullNumber": "string"
            }
          ],
          "SequenceNbr": 0,
          "LastNameElement": 0,
          "IsVip": true
        }
      ],
      "Phones": [
        {
          "PhoneType": "string",
          "City": "string",
          "Number": "string",
          "SequenceNbr": 0
        }
      ],
      "Notepads": [
        {
          "Remark": "string",
          "CreatedDate": "2019-03-18T11:42:49Z",
          "CreatedTime": "string",
          "Qualifier": "string",
          "SequenceNbr": 0
        }
      ],
      "VendorRemarks": [
        {
          "DateStamp": "2019-03-18T11:42:49Z",
          "Remark": "string",
          "RemarkType": "string",
          "RmkNum": 0,
          "TimeStamp": "string",
          "TravelOrderIdentifier": 0,
          "Vendor": "string",
          "VendorType": "string",
          "VendorRemarkID": 0
        }
      ],
      "DiEntries": [
        {
          "SequenceNbr": 0,
          "Keyword": "string",
          "Remark": "string"
        }
      ],
      "Tickets": [
        {
          "SegmentNbr": 0,
          "TicketNumber": "string"
        }
      ],
      "Versions": [
        {
          "AgentivityRef": 0,
          "DataBaseTimeStamp": "2019-03-18T11:42:49Z",
          "EventType": "string",
          "PnrTicketed": "string",
          "LastActionAgentId": "string",
          "AirSegs": 0,
          "AirPSegs": 0,
          "HtlSegs": 0,
          "HtlPSegs": 0,
          "CarSegs": 0,
          "CarPSegs": 0
        }
      ],
      "VendorLocators": [
        {
          "AirSegmentNbr": 0,
          "CarrierCode": "string",
          "VendorLocator": "string"
        }
      ],
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      },
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingDetailsByRefItemResponse

BookingHistoryByBAR

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookinghistory/bar \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookinghistory/bar");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookinghistory/bar', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookinghistory/bar");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookinghistory/bar

Parameters

Name	In	Type	Required	Description
OwningAgencyLocationID	query	true	false	Owning agency location ID
BAR	query	string	true	Busness account record
MAR	query	string	true	Master account record
PAR	query	string	true	Passegner account record
TravelDateStart	query	string	false	Date in format YYYYMMDD
TravelDateEnd	query	string	false	Date in format YYYYMMDD
Count	query	string	false	Count
CityCode	query	string	false	3 letter city code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "AgentivityRef": "string",
      "RecordLocator": "string",
      "PNRCreationDate": "string",
      "TravelDate": "string",
      "PNRTicketed": "string",
      "PNRCancelled": "string",
      "Account": "string",
      "OwningConsultantID": "string",
      "OwningConsultant": "string",
      "LastActionConsultantID": "string",
      "DestinationCities": "string",
      "DestinationCountries": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingHistoryByBARResponse

BookingsBasicByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookingsbasic/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingsbasic/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookingsbasic/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookingsbasic/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingsbasic/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCancelled	query	boolean	false	Return only PNRs that are cancelled/all
PNRCancelledDateStart	query	string	false	Date in format YYYYMMDD
PNRCancelledDateEnd	query	string	false	Date in format YYYYMMDD
PNRCreationDateStart	query	true	false	Date in format YYYYMMDD
PNRCreationDateEnd	query	true	false	Date in format YYYYMMDD
PNRTicketed	query	string	boolean	Return only PNRs that are ticketed/all
TravelDateStart	query	string	false	Date in format YYYYMMDD
TravelDateEnd	query	string	false	Date in format YYYYMMDD
WithPax	query	boolean	false	Include items with pax locator in response
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "TravelDate": "string",
      "OwningConsultant": "string",
      "Account": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsBasicByUserResponse

BookingsBasicWithoutMobileByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookingsbasicwithoutmobile/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingsbasicwithoutmobile/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookingsbasicwithoutmobile/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookingsbasicwithoutmobile/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingsbasicwithoutmobile/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
Account	query	string	false	GDS account
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
TicketedDateStart	query	string	false	Date in format YYYYMMDD
TicketedDateEnd	query	string	false	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "TravelDate": "string",
      "OwningConsultant": "string",
      "Account": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsBasicWithoutMobileByUserResponse

BookingsBasicWithPaxByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookingsbasicwithpax/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingsbasicwithpax/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookingsbasicwithpax/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookingsbasicwithpax/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingsbasicwithpax/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCancelled	query	boolean	false	Return only PNRs that are cancelled/all
PNRCancelledDateStart	query	string	false	Date in format YYYYMMDD
PNRCancelledDateEnd	query	string	false	Date in format YYYYMMDD
PNRCreationDateStart	query	string	false	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	false	Date in format YYYYMMDD
PNRTicketed	query	boolean	false	Return only PNRs that are ticketed/all
TravelDateStart	query	string	true	Date in format YYYYMMDD
TravelDateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
        "Account": "string",
        "OwningConsultant": "string",
        "PaxList": "string",
        "RecordLocator": "string",
        "Routing": "string",
        "TravelDate": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	Object

BookingsByAccount

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/BookingsByAccount/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/BookingsByAccount/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/BookingsByAccount/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/BookingsByAccount/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /BookingsByAccount/user

Parameters

Name	In	Type	Required	Description
Account	query	string	true	GDS account
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
IncludeItinerary	query	boolean	false	Include Itinerary in the response
ItineraryFormatting	query	number	false	Indicate the required formatting: 0=None(Default), 1= Html, 2 = Chart
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyLocationID": "string",
      "Passengers": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "PNRTicketed": "string",
      "PNRCancelled": "string",
      "OrderNumber": "string",
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsByAccountItemResponse

BookingsByAirlineWithClassSupport

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/BookingsByAirlineWithClassSupport/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/BookingsByAirlineWithClassSupport/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/BookingsByAirlineWithClassSupport/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/BookingsByAirlineWithClassSupport/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /BookingsByAirlineWithClassSupport/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
CarrierCode	query	string	true	Two letter code for carrier
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "Account": "string",
      "OwningConsultant": "string",
      "TicketedStatusCode": "string",
      "TicketedStatus": "string",
      "BookingCodesBooked": "string",
      "FlightNumbers": "string",
      "Routing": "string",
      "TrackingCode": "string",
      "TktTourCode": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsByAirlineWithClassSupportItemResponse

BookingsByAirSegmentsCount

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookingbyairsegmentscounts \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingbyairsegmentscounts");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookingbyairsegmentscounts', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookingbyairsegmentscounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingbyairsegmentscounts

Parameters

Name	In	Type	Required	Description
Account	query	string	false	Comma Delimited List of GDS accounts
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
MinAirSegments	query	string	false	Return only PNRs that equal or exceed a certain number of air segments
PNRCancelled	query	string	false	Return only PNRs that are cancelled/all
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyPseudo": "string",
      "Passengers": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "AirSegmentsCount": 0,
      "TravelDate": "2019-03-18T11:42:49Z",
      "PNRTicketed": "string",
      "PNRCancelled": "string",
      "Itinerary": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsByAirSegmentsCountItemResponse

BookingsByConsultant

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/BookingsByConsultant \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/BookingsByConsultant");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/BookingsByConsultant', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/BookingsByConsultant");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /BookingsByConsultant

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
OwningConsultantID	query	string	true	Id of the owning counsultant
OwningConsultant	query	string	false	Owning consultant full name
IncludeItinerary	query	boolean	false	Include Itinerary in the response
ItineraryFormatting	query	number	false	Indicate the required formatting: 0=None(Default), 1= Html, 2 = Chart
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "CountryCountGroup": "string",
      "Passenger": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "PnrTicketed": "string",
      "PnrCancelled": "string",
      "AgentInitials": "string",
      "IsChurned": "string",
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      },
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsByConsultantItemResponse

BookingsByConsultantActivity

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/BookingsByConsultantActivity \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/BookingsByConsultantActivity");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/BookingsByConsultantActivity', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/BookingsByConsultantActivity");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /BookingsByConsultantActivity

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
OwningConsultantID	query	string	true	Id of the owning counsultant
OwningConsultant	query	string	false	Owning consultant full name
VipOnly	query	boolean	false	Return only segments that are flagged as VIP only
includeItinerary	query	boolean	false	Include Itinerary in the response
itineraryFormatting	query	number	false	Indicate the required formatting: 0=None(Default), 1= Html, 2 = Chart
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "CountryCountGroup": "string",
      "Passenger": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "PnrTicketed": "string",
      "PnrCancelled": "string",
      "AgentInitials": "string",
      "IsChurned": "string",
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      },
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsByConsultantActivityItemResponse

BookingsByGDSDestination

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookingsbygdsdestination \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingsbygdsdestination");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookingsbygdsdestination', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookingsbygdsdestination");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingsbygdsdestination

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PlacementDateStart	query	string	true	Date in format YYYYMMDD
PlacementDateEnd	query	string	true	Date in format YYYYMMDD
Destination	query	string	true	Destination
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyLocationID": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "OwningConsultantID": "string",
      "Source": "string",
      "Destination": "string",
      "RuleName": "string",
      "Success": "string",
      "LoggedDateTime": "2019-03-18T11:42:49Z",
      "FailureReason": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsByGDSDestinationItemResponse

BookingsByTraveller

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/BookingsByTraveller/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/BookingsByTraveller/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/BookingsByTraveller/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/BookingsByTraveller/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /BookingsByTraveller/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
TravelDateStart	query	string	false	Date in format YYYYMMDD
TravelDateEnd	query	string	false	Date in format YYYYMMDD
LastName	query	string	true	Last Name
FirstName	query	string	false	First Name
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "LastName": "string",
      "FirstName": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "PNRCancelled": "string",
      "PNRTicketed": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsByTravellerItemResponse

BookingsWithDestinationsByTraveller

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/1/bookingswithdestinations/traveller?TravellerReference=string \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingswithdestinations/traveller?TravellerReference=string");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/1/bookingswithdestinations/traveller', params={
  'TravellerReference': 'string'
}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/1/bookingswithdestinations/traveller?TravellerReference=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingswithdestinations/traveller GET /1/bookingswithdestinations/traveller

Parameters

Name	In	Type	Required	Description
CompanyID	query	string(int32)	false	ID for your Company
TravellerReference	query	string	true	Traveller Reference
PNRTicketed	query	string	false	True/False or Yes/No
TravellerEmail	query	string	false	Email of the traveller
TravellerPhoneNbr	query	string	false	Phone Number of the traveller
TravelDateStart	query	string	false	Start Date in format YYYYMMDD
TravelDateEnd	query	string	false	End Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "AgentivityRef": "string",
      "PNR": "string",
      "PNRCreationDate": "string",
      "RecordLocator": "string",
      "TravelDate": "string",
      "PNRTicketed": "string",
      "PNRCancelled": "string",
      "Account": "string",
      "OwningConsultantID": "string",
      "OwningConsultant": "string",
      "LastActionConsultantID": "string",
      "DestinationCities": "string",
      "DestinationCountries": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsWithDestinationsByTravellerResponse

BookingsWithReviewDueDate

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/BookingsWithReviewDueDate \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/BookingsWithReviewDueDate");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/BookingsWithReviewDueDate', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/BookingsWithReviewDueDate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /BookingsWithReviewDueDate

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DueDateStart	query	string	true	Date in format YYYYMMDD
DueDateEnd	query	string	false	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "Passenger": "string",
      "OwningAgencyLocationID": "string",
      "Queue": "string",
      "Text": "string",
      "DueDate": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsWithReviewDueDateItemResponse

BookingsWithTAUDateByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookingswithtaudate/user?UserName=string&TauDateStart=string&TauDateEnd=string&TravelDateStart=string&PNRTicketed=string \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingswithtaudate/user?PNRTicketed=string&TravelDateStart=string&TauDateEnd=string&TauDateStart=string&UserName=string");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookingswithtaudate/user', params={
  'UserName': 'string',  'TauDateStart': 'string',  'TauDateEnd': 'string',  'TravelDateStart': 'string',  'PNRTicketed': 'string'
}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookingswithtaudate/user?UserName=string&TauDateStart=string&TauDateEnd=string&TravelDateStart=string&PNRTicketed=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingswithtaudate/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	User's Email Address/Username
TauDateStart	query	string	true	TAU Date Range Start in format YYYYMMDD
TauDateEnd	query	string	true	TAU Date Range End in format YYYYMMDD
TravelDateStart	query	string	true	TAU Date Range End in format YYYYMMDD
PNRTicketed	query	string	true	PNRTicketed
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
        "AgentivityRef": "string",
        "RecordLocator": "string",
        "PNRCreationDate": "string",
        "TravelDate": "string",
        "PNRTicketed": "string",
        "PNRCancelled": "string",
        "TAUDate": "string",
        "Account": "string",
        "OwningConsultantID": "string",
        "OwningConsultant": "string",
        "LastActionConsultantID": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	Object

BookingsWithTicketDueDataByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookingswithticketduedata/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingswithticketduedata/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookingswithticketduedata/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookingswithticketduedata/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingswithticketduedata/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
AirlineTicketingDueDateStart	query	string	true	Date in format YYYYMMDD
AirlineTicketingDueDateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
        "AgentivityRef": string,
        "PNR": "string",
        "PNRCreationDate": "string",
        "Consultant": "string",
        "Account": "string",
        "OwningAgencyLocationID": "string",
        "CarrierCode": "string",
        "DueDate": "string",
        "DueTime": "string",
        "PrimaryPassenger": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	Object

BookingsWithTicketDueDataByUser2

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookingswithticketduedata2/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingswithticketduedata2/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookingswithticketduedata2/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookingswithticketduedata2/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingswithticketduedata2/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
TicketingDueDateStart	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PnrCreationDate": "string",
      "Passengers": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "OwningConsultant": "string",
      "OwningAgencyLocationID": "string",
      "CarrierCode": "string",
      "DueDate": "2019-03-18T11:42:49Z",
      "DueTime": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsWithTicketDueDataByUser2ItemResponse

BookingsCancelled

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookingscancelled \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingscancelled");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookingscancelled', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookingscancelled");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingscancelled

Parameters

Name	In	Type	Required	Description
Account	query	string	true	GDS account
UserName	query	string	true	UserName in form of an email address
PnrCancellationDateStart	query	string	true	Date in format YYYYMMDD
PnrCancellationDateEnd	query	string	false	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyLocationID": "string",
      "Passengers": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "PNRTicketed": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsCancelledItemResponse

BookingsCountsPerConsultant

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/BookingsCountsPerConsultant \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/BookingsCountsPerConsultant");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/BookingsCountsPerConsultant', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/BookingsCountsPerConsultant");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /BookingsCountsPerConsultant

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
OwningAgencyLocationID	query	string	false	Owning agency location ID
Team	query	string	false	Team
Qualifier	query	string	false	Qualifier
OnlyQCNotOK	query	string	false
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningConsultant": "string",
      "OwningConsultantID": "string",
      "TotalBookings": 0,
      "CancelledCount": 0,
      "ContainingAirCount": 0,
      "GDSTicketedCount": 0,
      "LowCostCarrierCount": 0,
      "ChurnCount": 0,
      "QualifierCount": 0,
      "CountryCount": "string",
      "RemarkDetailsList": [
        {
          "RecordLocator": "string",
          "Account": "string",
          "Passangers": "string",
          "TravelDate": "string",
          "Remark": "string"
        }
      ]
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsCountsPerConsultantItemResponse

BookingsCreated

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookingscreated?UserName=string&PNRCreationDateStart=string&PNRCreationDateEnd=string \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingscreated?PNRCreationDateEnd=string&PNRCreationDateStart=string&UserName=string");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookingscreated', params={
  'UserName': 'string',  'PNRCreationDateStart': 'string',  'PNRCreationDateEnd': 'string'
}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookingscreated?UserName=string&PNRCreationDateStart=string&PNRCreationDateEnd=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingscreated

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	false	Date in format YYYYMMDD
Account(s)	query	string	false	Comma Delimited List of Accounts
HasMobile	query	boolean	false	Return only PNRs with/without a mobile number
MissingEmailOrPhone	query	boolean	false	Return only PNRs with/without an email address OR a mobile number
HasHotel	query	boolean	false	Return only PNRs with/without a Hotel segment
HasAccount	query	boolean	false	Return only PNRs with/without an Account
IncludeItinerary	query	boolean	false	Include Itinerary in the response
ItineraryFormatting	query	integer	false	Indicaed the required formatting: 0=None(Default), 1= Html, 2 = Chart
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningAgencyLocationID": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "Passengers": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "Mobile": "string",
      "Emails": "string",
      "PNRTicketed": "string",
      "DestinationCount": 0,
      "IsVip": true,
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      },
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsCreatedItemResponse

BookingsTicketTravelDates

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/BookingsTicketTravelDates/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/BookingsTicketTravelDates/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/BookingsTicketTravelDates/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/BookingsTicketTravelDates/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /BookingsTicketTravelDates/user

Parameters

Name	In	Type	Required	Description
Account	query	string	true	GDS account
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningConsultant": "string",
      "Passengers": "string",
      "PNRCancelled": "string",
      "PNRTicketed": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "TicketingDate": "2019-03-18T11:42:49Z",
      "TravelDate": "2019-03-18T11:42:49Z",
      "BookingTravelDateGap": 0,
      "FirstDILine": "string",
      "Account": "string",
      "DivisionCode": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsTicketTravelDatesItemResponse

BookingsLapsedToEvent

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookingslapsedtoevent/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingslapsedtoevent/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookingslapsedtoevent/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookingslapsedtoevent/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingslapsedtoevent/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
EventDateStart	query	string	true	Date in format YYYYMMDD
EventDateEnd	query	string	false	Date in format YYYYMMDD
EventType	query	string	true	Type of event
CarrierCode	query	string	false	Two letter code for carrier
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyLocationID": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "Airlines": "string",
      "LapsedDateTime": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsLapsedToEventItemResponse

BookingsTravelling

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookingstravelling \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingstravelling");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookingstravelling', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookingstravelling");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingstravelling

Parameters

Name	In	Type	Required	Description
Account	query	string	true	GDS account
UserName	query	string	true	UserName in form of an email address
TravelDateStart	query	string	true	Date in format YYYYMMDD
TravelDateEnd	query	string	false	Date in format YYYYMMDD
HasMobile	query	boolean	false	Return only PNRs with/without a Mobile number
HasEmail	query	boolean	false	Return only PNRs with/without an email address
MissingEmailOrPhone	query	string	false	Return only PNRs with/without an email address OR a mobile number
HasHotel	query	boolean	false	Return only PNRs with/without a Hotel segment
HasAccount	query	boolean	false	Return only PNRs with/without an Account
IncludeItinerary	query	string	false	Include Itinerary in the response
MinSegments	query	number	false	Return only PNRs that equal or exceed a certain number of segments
ItineraryFormatting	query	number	false	Indicate the required formatting: 0=None(Default), 1= Html, 2 = Chart
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningAgencyLocationID": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "Passengers": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "Mobile": "string",
      "Emails": "string",
      "PNRTicketed": "string",
      "DestinationCount": 0,
      "ItineraryFormatted": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsTravellingResponse

BookingsTurnAround

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/bookingsturnaround \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/bookingsturnaround");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/bookingsturnaround', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/bookingsturnaround");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /bookingsturnaround

Parameters

Name	In	Type	Required	Description
Account	query	string	true	GDS account
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "TicketingDate": "2019-03-18T11:42:49Z",
      "ContainsAir": "string",
      "ContainsCar": "string",
      "ContainsHotel": "string",
      "DestinationCountriesCount": 0,
      "PNRTicketed": "string",
      "PNRCancelled": "string",
      "OwningConsultant": "string",
      "Passengers": "string",
      "TouchpointNotes": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingsTurnAroundItemResponse

DuplicateBookings

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/duplicatebookings \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/duplicatebookings");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/duplicatebookings', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/duplicatebookings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /duplicatebookings

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
OwningAgencyLocationID	query	string	false	Owning agency location ID
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "PNRCreationDateFormatted": "string",
      "PaxList": "string",
      "Account": "string",
      "OwningConsultantID": "string",
      "OwningAgencyLocationID": "string",
      "DuplicateRef": 0,
      "SharedRef": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	DuplicateBookingsItemResponse

EventBookingsRequest

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/eventBookings \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/eventBookings");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/eventBookings', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/eventBookings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /eventBookings

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
EventCode	query	string	true	Event code
SplitMultiplePassengers	query	string	false	Split multiple passangers
IncludeNotes	query	string	false	Include notes in the response
IncludeArrivalDepartures	query	string	false	Include arrival departures
FormattingStyle	query	string	false	Formatting style
ItinerarySegmentsToShow	query	string	false	Itinerary segments to show
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "PaxList": "string",
      "ItineraryFormatted": "string",
      "Notes": "string",
      "AgentivityRef": 0,
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      }
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	EventBookingsItemResponse

FindBookings

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/findbookings/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/findbookings/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/findbookings/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/findbookings/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /findbookings/user

Parameters

Name	In	Type	Required	Description
RecordLocator	query	string	true	6-digit record locator
AirlineLocator	query	string	false	Number that identifies reservation by airline
Surname	query	string	false	Surname
UserName	query	string	true	UserName in form of an email address
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "Passengers": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "PnrTicketed": "string",
      "PnrCancelled": "string",
      "IsFrequentFlyer": true,
      "ItineraryChanges": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	FindBookingsItemResponse

GetActiveUnsoldAirBookings

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/ActiveUnsoldAirBookings/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/ActiveUnsoldAirBookings/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/ActiveUnsoldAirBookings/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/ActiveUnsoldAirBookings/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /ActiveUnsoldAirBookings/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
TravelDateStart	query	string	true	Date in format YYYYMMDD
TravelDateEnd	query	string	false	Date in format YYYYMMDD
CarrierCode	query	string	false	Two letter code for carrier
PNRTicketed	query	boolean	false	Return only PNRs that are ticketed/all
IncludeItinerary	query	boolean	false	Include Itinerary in the response
ItineraryFormatting	query	string	false	Indicate the required formatting: 0=None(Default), 1= Html, 2 = Chart
Repeat	query	boolean	false	Repeat
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyLocationID": "string",
      "PrimaryPax": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "IATA": "string",
      "Routing": "string",
      "AgentivityRef": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	ActiveUnsoldAirBookingsResponse

GetBookingCountPerPcc

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/BookingCountPerPcc/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/BookingCountPerPcc/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/BookingCountPerPcc/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/BookingCountPerPcc/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /BookingCountPerPcc/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "OwningAgencyLocationID": "string",
      "BookingsCount": 0,
      "TicketedCount": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	BookingCountPerPccResponse

PartnerBookingsDataCapture

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/partnerbookingdatacaptures \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/partnerbookingdatacaptures");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/partnerbookingdatacaptures', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/partnerbookingdatacaptures");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /partnerbookingdatacaptures

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
PCCList	query	string	false	Comma Delimited List of PCCs
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "ADDRESS": "string",
      "AGENCY_IATA": "string",
      "AIR_BOOKED_FLAG": "string",
      "AIR_COMM_AMT": "string",
      "AIR_NO_ACCOMODATION_REASON_CODE": "string",
      "APPROVAL_CODE": "string",
      "APPROVER": "string",
      "AREA_CODE": "string",
      "CAR_BOOK_MODE": "string",
      "CAR_BOOKED_FLAG": "string",
      "CAR_GDS_PARTNER_CD_USED": "string",
      "CAR_ITINERARY_CD": "string",
      "CAR_REASON_CODE": "string",
      "CAR_RENT_RATE_CUR": "string",
      "CAR_VOUCHER_NO": "string",
      "CARRIER_CD": "string",
      "CHECKINDATE": "string",
      "CITY_COUNTRYCODE_ZIPCODE_PHONE": "string",
      "CLASS": "string",
      "COST_CENTER_CODE": "string",
      "CREDIT_CARD_COMPANY_CODE": "string",
      "CREDIT_CARD_NUMBER": "string",
      "CS_DATA1": "string",
      "CS_DATA2": "string",
      "CS_DATA3": "string",
      "CS_DATA4": "string",
      "CS_DATA7": "string",
      "CS_DATA8": "string",
      "DEPART_DATE": "2019-03-18T11:42:49Z",
      "DEPARTMENT_NUMBER": "string",
      "DEPARTURE_ARRIVAL_TIMES": "string",
      "EMPLOYEE_NUMBER": "string",
      "FARE_BASIS": "string",
      "FARE_PAID": "string",
      "FFLYR_NO": "string",
      "FULL_FARE": "string",
      "GDS_CAR_TYPE_CODE": "string",
      "GDS_MASTER_SUPPLIER_CODE": "string",
      "GDS_RECLOC": "string",
      "GDS_RM_TYPE_CODE": "string",
      "GLOBALCUST_NO": "string",
      "HOTEL_BOOK_MODE": "string",
      "HOTEL_BOOKED_FLAG": "string",
      "HOTEL_CHAIN_CODE": "string",
      "HOTEL_COMM_AMT": "string",
      "HOTEL_GDS_PARTNER_CD_USED": "string",
      "HOTEL_NAME": "string",
      "HOTEL_REASON_CODE": "string",
      "HOTEL_VOUCHER_NO": "string",
      "ITINERARY": "string",
      "ITINERARY_DATES": "string",
      "LOC_CUR": "string",
      "LOC_TAX": "string",
      "LOCALCUST_NO": "string",
      "LOW_FARE": "string",
      "MANAGER_SUPERIOR": "string",
      "NIGHT_STAYS": "string",
      "NO_OF_DOCUMENTS": 0,
      "OPR_FLT_NO": "string",
      "ORDER_REFERENCE": "string",
      "ORIGINAL_DOCUMENT": "string",
      "PAID_CAR_RENT_RATE_PER_DAY": "string",
      "PAID_ROOM_RATE_PER_NIGHT": "string",
      "PICKUPDATE": "string",
      "PNR_SEGMENT_NO": 0,
      "PROJECT_NUMBER": "string",
      "RAIL_FERRY_BOOKED_FLAG": "string",
      "RATE_TYPE_CODE": "string",
      "REASON_CODE": "string",
      "REASON_CODE_DENIED": "string",
      "REASON_OF_TRIP": "string",
      "REFUNDED_FARE": "string",
      "RENTAL_DAYS": "string",
      "RESERVATION_DATE": "2019-03-18T11:42:49Z",
      "RM_TYPE": "string",
      "ROOM_RATE_CUR": "string",
      "SALES_CHANNEL": "string",
      "STOPOVR_TRF_FLAG": "string",
      "SUPPLIER_NAME": "string",
      "TKT_NO": "string",
      "TKT_TYPE": "string",
      "TOUR_CODE": "string",
      "TRAVELLER_NAME": "string",
      "TRAVELLER_STATUS": "string",
      "TRVL_MTH": 0,
      "TRVL_YR": 0,
      "VALIDATING_CARRIER_CD": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	PartnerBookingsDataCaptureItemResponse

Consultants

ConsultantsGdsSegmentPerformance

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/ConsultantsGdsSegmentPerformance \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/ConsultantsGdsSegmentPerformance");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/ConsultantsGdsSegmentPerformance', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/ConsultantsGdsSegmentPerformance");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /ConsultantsGdsSegmentPerformance

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
OwningAgencyLocationID	query	string	true	Owning agency location ID
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningConsultantID": "string",
      "OwningConsultant": "string",
      "OwningAgencyLocationID": "string",
      "AirCount": 0,
      "HotelCount": 0,
      "CarCount": 0,
      "PassiveHotelCount": 0,
      "PassiveCarCount": 0,
      "TURCount": 0,
      "OtherCount": 0,
      "TotalBookings": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	ConsultantsGdsSegmentPerformanceItemResponse

ConsultantsProductivity

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/ConsultantsProductivity/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/ConsultantsProductivity/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/ConsultantsProductivity/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/ConsultantsProductivity/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /ConsultantsProductivity/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
OwningAgencyLocationID	query	string	false	Owning agency location ID
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningConsultant": "string",
      "OwningConsultantID": "string",
      "OwningAgencyLocationID": "string",
      "Location": "string",
      "Team": "string",
      "TotalCreated": 0,
      "TotalCancelled": 0,
      "TotalItinChanges": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	ConsultantProductivityItemResponse

GetConsultantPnrActivity

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/ConsultantPnrActivity/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/ConsultantPnrActivity/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/ConsultantPnrActivity/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/ConsultantPnrActivity/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /ConsultantPnrActivity/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
ActivityDateStart	query	string	true	Date in format YYYYMMDD
ActivityDateEnd	query	string	true	Date in format YYYYMMDD
OwningAgencyLocationID	query	string	false	Owning agency location ID
Team	query	string	false	Team
Qualifier	query	string	false	Qualifier
OnlySummary	query	boolean	false	List only summary if selected true
VipOnly	query	boolean	false	Return only segments that are flagged as VIP only
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Consultant": "string",
      "TransactionAgent": "string",
      "Location": "string",
      "Team": "string",
      "TotalBookings": 0,
      "Domestic": 0,
      "International": 0,
      "Land": 0,
      "Cancelled": 0,
      "Complex": 0,
      "ChangedOwnDomestic": 0,
      "ChangedOwnInternational": 0,
      "ChangedOtherDomestic": 0,
      "ChangedOtherInternational": 0,
      "WithAir": 0,
      "WithHotel": 0,
      "WithPassiveHotel": 0,
      "WithCar": 0,
      "TotalChangedBookings": 0,
      "TotalServicedBookings": 0,
      "TotalTicketedBookings": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	ConsultantPnrActivityResponse

Corporate

CorporateLongTermArrivals

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/CorporateLongTermArrivals \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/CorporateLongTermArrivals");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/CorporateLongTermArrivals', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/CorporateLongTermArrivals");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /CorporateLongTermArrivals

Parameters

Name	In	Type	Required	Description
Account	query	string	true	GDS account
UserName	query	string	true	UserName in form of an email address
ArrivalDateStart	query	string	true	Date in format YYYYMMDD
ArrivalDateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "ArrivalDate": "2019-03-18T11:42:49Z",
      "Days": 0,
      "LastName": "string",
      "FirstName": "string",
      "DestinationCountries": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	CorporateLongTermArrivalsItemResponse

CorporateTrackerBookings

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/CorporateTrackerBookings/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/CorporateTrackerBookings/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/CorporateTrackerBookings/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/CorporateTrackerBookings/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /CorporateTrackerBookings/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
TravelDateStart	query	string	true	Date in format YYYYMMDD
TravelDateEnd	query	string	true	Date in format YYYYMMDD
Account	query	string	false	GDS account
ItineraryFormatting	query	number	false	Indicate the required formatting: 0=None(Default), 1= Html, 2 = Chart
ItinerarySegmentsToShow	query	string	false	Itinerary segments to show
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "Passenger": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      },
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	CorporateTrackerBookingsItemResponse

Hotel

GetHotelWithNoRateCodeCreated

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/user/HotelWithNoRateCodeCreated \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/user/HotelWithNoRateCodeCreated");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/user/HotelWithNoRateCodeCreated', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/user/HotelWithNoRateCodeCreated");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /user/HotelWithNoRateCodeCreated

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Account": "string",
      "CheckInDate": "string",
      "CheckOutDate": "string",
      "City": "string",
      "ConfirmationNbr": "string",
      "CurrencyCode": "string",
      "HotelChainCode": "string",
      "HotelGalileoPropertyID": "string",
      "HotelName": "string",
      "Passengers": "string",
      "RateAmount": "string",
      "RecordLocator": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	HotelWithNoRateCodeCreatedResponse

HotelBookingsByRateCode

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/hotelbookings \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/hotelbookings");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/hotelbookings', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/hotelbookings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /hotelbookings

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	false	Date in format YYYYMMDD
Account	query	string	false	GDS account
HasRateCode	query	string	false	Return only PNRs with/without a Rate code
Formatting	query	string	false	Formatting
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "string",
      "Passengers": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	HotelBookingsByRateCodeItemResponse

MissedHotelOpportunitiesByCity

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/missedhotelopportunities/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/missedhotelopportunities/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/missedhotelopportunities/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/missedhotelopportunities/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /missedhotelopportunities/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
Account	query	string	false	GDS account
CityCode	query	string	false	3 letter city code
TravelDateStart	query	string	true	Date in format YYYYMMDD
TravelDateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "CityCode": "string",
      "Account": "string",
      "Passengers": "string",
      "OwningConsultant": "string",
      "From": "2019-03-18T11:42:49Z",
      "To": "2019-03-18T11:42:49Z",
      "NightsNumber": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	MissedHotelOpportunitiesByCityItemResponse

MissedHotelOpportunitiesPerCity

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/missedhotelopportunitiespercity/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/missedhotelopportunitiespercity/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/missedhotelopportunitiespercity/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/missedhotelopportunitiespercity/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /missedhotelopportunitiespercity/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
TravelDateStart	query	string	true	Date in format YYYYMMDD
TravelDateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "CityCode": "string",
      "Account": "string",
      "CityName": "string",
      "CountryCode": "string",
      "TotalMissed": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	MissedHotelOpportunitiesPerCityItemResponse

Itinerary Change

GetItineraryChangeEventsSummary

Code samples

# You can also use wget
curl --request GET \
  --url 'https://api.agentivity.com//ItineraryChangeEventsSummary/user?ChangeDateEnd=string&ChangeDateStart=string&UserName=string&Account%2528s%2529=string' \
  --header 'accept: application/json'

var client = new RestClient("https://api.agentivity.com/ItineraryChangeEventsSummary/user?ChangeDateEnd=string&ChangeDateStart=string&UserName=string&Account%2528s%2529=string");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/ItineraryChangeEventsSummary/user', params={
  'Account(s)': 'string',  'UserName': 'string',  'ChangeDateStart': 'string',  'ChangeDateEnd': 'string'
}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/ItineraryChangeEventsSummary/user?Account%28s%29=string&UserName=string&ChangeDateStart=string&ChangeDateEnd=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /ItineraryChangeEventsSummary/user

Parameters

Name	In	Type	Required	Description
Account(s)	query	string	true	Comma Delimited List of Accounts
UserName	query	string	true	UserName
ChangeDateStart	query	string	true	Start Date in format YYYYMMDD
ChangeDateEnd	query	string	true	End Date in format YYYYMMDD
AddDILine	query	string	false	Comma Delimited List of Accounts
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "EventType": "string",
      "Count": 0,
      "Ticketed": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	ItineraryChangeEventsSummaryItemResponse

ItineraryChangeEvents

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/ItineraryChangeEvents/user?Account%28s%29=string&UserName=string&ChangeDateStart=string&ChangeDateEnd=string \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/ItineraryChangeEvents/user?ChangeDateEnd=string&ChangeDateStart=string&UserName=string&Account%2528s%2529=string");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/ItineraryChangeEvents/user', params={
  'Account(s)': 'string',  'UserName': 'string',  'ChangeDateStart': 'string',  'ChangeDateEnd': 'string'
}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/ItineraryChangeEvents/user?Account%28s%29=string&UserName=string&ChangeDateStart=string&ChangeDateEnd=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /ItineraryChangeEvents/user

Parameters

Name	In	Type	Required	Description
Account(s)	query	string	true	Comma Delimited List of Accounts
UserName	query	string	true	UserName
ChangeDateStart	query	string	true	Start Date in format YYYYMMDD
ChangeDateEnd	query	string	true	End Date in format YYYYMMDD
AddDILine	query	string	false	AddDILine
Offset	query	string	false	Starting Record
Limit	query	string	false	Number of records to return (PageSize)
TotalRecords	query	string(int32)	false	Total Number of Records in a Full Reponse (if no paging)
ResponseRecords	query	string(int32)	false	Total NUmber of Records in this Reponse (on this page)
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": "string",
      "RecordLocator": "string",
      "LastActionConsultant": "string",
      "Passengers": "string",
      "EventDateTime": "2019-03-18T11:42:49Z",
      "EventDateTimeFormatted": "string",
      "EventTypeDetail": "string",
      "EventTypeGroup": "string",
      "OldData": "string",
      "NewData": "string",
      "PNRTicketed": "string",
      "FirstDILine": "string",
      "Account": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	ItineraryChangeEventsItemResponse

Log

GetRMQServicesLog

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/RMQServicesLog/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/RMQServicesLog/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/RMQServicesLog/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/RMQServicesLog/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /RMQServicesLog/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
RMQService	query	string	true	The name of RMQ service
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "LogDateTime": "2019-03-18T11:42:49Z",
      "LogDateTimeFormated": "string",
      "Message": "string",
      "RecordLocator": "string",
      "Gds": "string",
      "PCC": "string",
      "TransactionAgent": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	RMQServicesLogResponse

MirGenerationLogByAccount

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/mirgenerationlogs/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/mirgenerationlogs/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/mirgenerationlogs/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/mirgenerationlogs/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /mirgenerationlogs/user

Parameters

Name	In	Type	Required	Description
Account	query	string	true	GDS account
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	false	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyLocationID": "string",
      "Account": "string",
      "Success": true,
      "ResultMessage": "string",
      "EventType": "string",
      "EventTypeDesc": "string",
      "OwningConsultant": "string",
      "SiteId": 0,
      "SiteName": "string",
      "SiteQueue": "string",
      "DateTimeSent": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	MirGenerationLogByAccountItemResponse

QLogEm

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/QLogEm \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/QLogEm");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/QLogEm', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/QLogEm");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /QLogEm

Parameters

Name	In	Type	Required	Description
CompanyID	query	number	true	ID of a Company (travel agency)
QueueEntryID	query	string	true	ID for queue entry
LogDateStart	query	string	true	Date in format YYYYMMDD
LogDateEnd	query	string	false	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "EntryID": 0,
      "MatchedOn": "string",
      "RecordLocator": "string",
      "LogDate": "2019-03-18T11:42:49Z",
      "EventType": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	QLogEmItemResponse

QLogForward

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/QLogForward \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/QLogForward");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/QLogForward', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/QLogForward");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /QLogForward

Parameters

Name	In	Type	Required	Description
CompanyID	query	number	true	ID of a Company (travel agency)
QueueEntryID	query	string	true	ID for queue entry
LogDateStart	query	string	true	Date in format YYYYMMDD
LogDateEnd	query	string	false	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "LogID": 0,
      "MatchedOn": "string",
      "RecordLocator": "string",
      "Destination": "string",
      "LogDate": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	QLogForwardItemResponse

QLogIgnored

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/QLogIgnored \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/QLogIgnored");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/QLogIgnored', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/QLogIgnored");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /QLogIgnored

Parameters

Name	In	Type	Required	Description
SiteID	query	number	true	ID for site
Queue	query	string	false	Queue
LogDateStart	query	string	true	Date in format YYYYMMDD
LogDateEnd	query	string	false	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "LogID": 0,
      "LogTime": "2019-03-18T11:42:49Z",
      "SiteID": 0,
      "Queue": "string",
      "RecordLocator": "string",
      "RejectReason": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	QLogIgnoredItemResponse

QSorterLogErrors

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/QSorterLogErrors/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/QSorterLogErrors/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/QSorterLogErrors/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/QSorterLogErrors/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /QSorterLogErrors/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	false	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "SiteID": 0,
      "SitePCC": "string",
      "Queue": "string",
      "RuleName": "string",
      "FailureReason": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	QSorterLogErrorsItemResponse

Passenger

PassengerArrivals

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/PassengerArrivals/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/PassengerArrivals/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/PassengerArrivals/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/PassengerArrivals/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /PassengerArrivals/user

Parameters

Name	In	Type	Required	Description
Account	query	string	false	GDS account
UserName	query	string	true	UserName in form of an email address
ArrivalDateStart	query	string	true	Date in format YYYYMMDD
ArrivalDateEnd	query	string	false	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningConsultant": "string",
      "Passenger": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "ArrivalDate": "2019-03-18T11:42:49Z",
      "DaysAway": 0,
      "DestinationCountries": "string",
      "MobileList": "string",
      "EmailList": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	PassengerArrivalsItemResponse

PassengerAirSegmentsWithMaxTravellerFlagByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/passengerairsegmentswithmaxtravellerflag/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/passengerairsegmentswithmaxtravellerflag/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/passengerairsegmentswithmaxtravellerflag/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/passengerairsegmentswithmaxtravellerflag/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /passengerairsegmentswithmaxtravellerflag/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
Account	query	string	false	GDS account
DepartureDateStart	query	string	true	Date in format YYYYMMDD
DepartureDateEnd	query	string	true	Date in format YYYYMMDD
MaxTravellerIsExceededFlag	query	string	false	Maximum number of travellers above the limit
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Account": "string",
      "ArrivalCity": "string",
      "ArrivalDate": "string",
      "ArrivalTime": "string",
      "CostCentre": "string",
      "DepartureCity": "string",
      "DepartureDate": "string",
      "DepartureTime": "string",
      "FlightNbr": "string",
      "MaxTravellerCount": 0,
      "MaxTravellerCountExceededFlag": true,
      "OperatingCarrierCode": "string",
      "Passenger": "string",
      "PNRTicketed": "string",
      "RecordLocator": "string",
      "TravellerCount": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	PassengerAirSegmentsWithMaxTravellerFlagByUserResponse

PassengerAirSegmentsWithMaxTravellerMembersByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/PassengerAirSegmentsWithMaxTravellerMembers/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/PassengerAirSegmentsWithMaxTravellerMembers/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/PassengerAirSegmentsWithMaxTravellerMembers/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/PassengerAirSegmentsWithMaxTravellerMembers/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /PassengerAirSegmentsWithMaxTravellerMembers/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DepartureDateStart	query	string	true	Date in format YYYYMMDD
DepartureDateEnd	query	string	true	Date in format YYYYMMDD
Account	query	string	false	GDS account
GroupId	query	number	false	ID of a group
MaxTravellerIsExceededFlag	query	number	false	Maximum number of travellers above the limit
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Account": "string",
      "ArrivalCity": "string",
      "ArrivalDate": "string",
      "ArrivalTime": "string",
      "CostCentre": "string",
      "DepartureCity": "string",
      "DepartureDate": "string",
      "DepartureTime": "string",
      "FlightNbr": "string",
      "GroupName": "string",
      "MaxTravellerCount": 0,
      "MaxTravellerCountExceededFlag": true,
      "OperatingCarrierCode": "string",
      "Passenger": "string",
      "PNRTicketed": "string",
      "RecordLocator": "string",
      "TravellerCount": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	PassengerAirSegmentsWithMaxTravellerMembersByUserResponse

PassengerDepartures

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/PassengerDepartures/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/PassengerDepartures/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/PassengerDepartures/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/PassengerDepartures/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /PassengerDepartures/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
Account	query	string	false	GDS account
ClassName	query	string	false	Name of the class
Carrier	query	string	false	Carrier
TravelDateStart	query	string	true	Date in format YYYYMMDD
TravelDateEnd	query	string	false	Date in format YYYYMMDD
WithSMS	query	string	false	Include items with SMS sent in response
AddVouchers	query	string	false	Add vouchers
AddTransfers	query	string	false	Add transfers
IncludeItinerary	query	string	false	Include Itinerary in the response
IsVip	query	string	false	Return only PNRs that are or are not flagged as VIP bookings
ItineraryFormatting	query	number	false	Indicate the required formatting: 0=None(Default), 1= Html, 2 = Chart
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningConsultant": "string",
      "Passenger": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "TicketedStatusCode": "string",
      "TicketedStatus": "string",
      "SupplierReference": "string",
      "SMS": "string",
      "Vouchers": "string",
      "Transfers": "string",
      "IsVip": true,
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      },
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	PassengerDeparturesItemResponse

PassengerLocationHotelsByUserCity

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/PassengerLocationHotelsByUserCity \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/PassengerLocationHotelsByUserCity");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/PassengerLocationHotelsByUserCity', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/PassengerLocationHotelsByUserCity");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /PassengerLocationHotelsByUserCity

Parameters

Name	In	Type	Required	Description
CityCode	query	string	true	3 letter city code
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
UserName	query	string	true	UserName in form of an email address
InTransitOnly	query	string	false	Include passangers that are in transit only in response
Account	query	string	false	Comma delimited list of GDS Accounts
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	Object

PassengerLocationsByAirline

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/passengerLocationByAirlineCity \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/passengerLocationByAirlineCity");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/passengerLocationByAirlineCity', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/passengerLocationByAirlineCity");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /passengerLocationByAirlineCity

Parameters

Name	In	Type	Required	Description
Account	query	string	false	Comma Delimited List of GDS Accounts
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
CarrierCode	query	string	true	Two letter code for carrier
CityCode	query	string	false	3 letter city code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningConsultantID": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "PnrTicketed": "string",
      "PaxList": "string",
      "Account": "string",
      "DestinationCities": "string",
      "Connections": "string",
      "CarrierCodes": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	PassengerLocationsByAirlineItemResponse

PassengerLocationsByFlightNumber

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/passengerLocationByFlightNumber \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/passengerLocationByFlightNumber");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/passengerLocationByFlightNumber', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/passengerLocationByFlightNumber");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /passengerLocationByFlightNumber

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DepartureDateStart	query	string	true	Date in format YYYYMMDD
CarrierCode	query	string	true	Two letter code for carrier
FlightNumber	query	string	true	Flight number without spaces
Account	query	string	false	Comma delimited list of GDS Accounts
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PaxList": "string",
      "OwningConsultantID": "string",
      "Account": "string",
      "DepartureDate": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	PassengerLocationsByFlightNumberItemResponse

PassengerLocationsByUserAirport

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/passengerlocationsbyairport/user/airport \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/passengerlocationsbyairport/user/airport");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/passengerlocationsbyairport/user/airport', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/passengerlocationsbyairport/user/airport");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /passengerlocationsbyairport/user/airport

Parameters

Name	In	Type	Required	Description
AirportCode	query	string	true	Airport code
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
UserName	query	string	true	UserName in form of an email address
InTransitOnly	query	string	false	Include passangers that are in transit only in response
Account	query	string	false	Comma delimited list of GDS Accounts
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "PNR": "string",
      "TravelDate": "string",
      "DepartureDate": "string",
      "BoardPoint": "string",
      "OffPoint": "string",
      "PnrTicketed": "string",
      "Account": "string",
      "Consultant": "string",
      "PaxList": "string",
      "PhoneNbr": "string",
      "EmailAddress": "string",
      "DestinationCities": "string",
      "Connections": "string",
      "CarrierCodes": "string",
      "AgentivityRef": "string",
      "HotelsNames": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	PassengerLocationsByUserAirportItemResponse

PassengerLocationsByUserAirVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/passengerlocationsbyairport/user/airvendor \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/passengerlocationsbyairport/user/airvendor");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/passengerlocationsbyairport/user/airvendor', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/passengerlocationsbyairport/user/airvendor");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /passengerlocationsbyairport/user/airvendor

Parameters

Name	In	Type	Required	Description
AirportCode	query	string	true	Airport code
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
UserName	query	string	true	UserName in form of an email address
InTransitOnly	query	string	false	Include passangers that are in transit only in response
Account	query	string	false	Comma delimited list of GDS Accounts
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
        "PNR": "string",
        "TravelDate": "string",
        "DepartureDate": "string",
        "BoardPoint": "string",
        "OffPoint": "string",
        "PnrTicketed": "string",
        "Account": "string",
        "Consultant": "string",
        "PaxList": "string",
        "PhoneNbr": "string",
        "EmailAddress": "string",
        "DestinationCities": "string",
        "Connections": "string",
        "CarrierCodes": "string",
        "AgentivityRef": "string"
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	Object

PassengerLocationsByUserCity

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/passengerlocationsbycity/user/city \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/passengerlocationsbycity/user/city");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/passengerlocationsbycity/user/city', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/passengerlocationsbycity/user/city");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET //passengerlocationsbycity/user/city

Parameters

Name	In	Type	Required	Description
CityCode	query	string	true	3 letter city code
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
UserName	query	string	true	UserName in form of an email address
InTransitOnly	query	string	false	Include passangers that are in transit only in response
Account	query	string	false	Comma delimited list of GDS Accounts
WithHotel	query	string	false	Include items with hotel in response
HotelName	query	string	false	Name of the hotel
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "PNR": "string",
      "TravelDate": "string",
      "DepartureDate": "string",
      "BoardPoint": "string",
      "OffPoint": "string",
      "PnrTicketed": "string",
      "Account": "string",
      "Consultant": "string",
      "PaxList": "string",
      "PhoneNbr": "string",
      "EmailAddress": "string",
      "DestinationCities": "string",
      "Connections": "string",
      "CarrierCodes": "string",
      "AgentivityRef": "string",
      "HotelsNames": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	PassengerLocationsByUserCityItemResponse

PassengerLocationsByUserCountry

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/passengerlocationsbycity/user/country \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/passengerlocationsbycity/user/country");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/passengerlocationsbycity/user/country', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/passengerlocationsbycity/user/country");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /passengerlocationsbycity/user/country

Parameters

Name	In	Type	Required	Description
CountryCode	query	string	true	2 letter country code
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
UserName	query	string	true	UserName in form of an email address
InTransitOnly	query	string	false	Include passangers that are in transit only in response
Account	query	string	false	Comma delimited list of GDS Accounts
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	Object

PCC

SupplierPreferencesByOwningAgencyLocationID

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/supplierpreferences/owningagencylocation \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/supplierpreferences/owningagencylocation");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/supplierpreferences/owningagencylocation', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/supplierpreferences/owningagencylocation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /supplierpreferences/owningagencylocation

Parameters

Name	In	Type	Required	Description
OwningAgencyLocationID	query	string	true	Owning agency location ID
Account	query	string	false	GDS account
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "PNRSummary": {
      "RecordLocator": "string",
      "AirlineReferences": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "Vendor": "string",
          "VendorLocator": "string"
        }
      },
      "Tickets": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "TktNumber": "string",
          "Passenger": {
            "LastName": "string",
            "FirstName": "string"
          },
          "Coupons": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "CouponSequenceNbr": "string",
              "CouponBoardPoint": "string",
              "CouponOffPoint": "string",
              "Carrier": "string",
              "FlightNbr": "string",
              "FlightDate": "string",
              "FlightTime": "string"
            }
          }
        }
      }
    },
    "Segments": {
      "AirSegments": [
        {
          "AirSegmentNbr": 0,
          "ArrivalTime": "string",
          "BoardPoint": "string",
          "BookingCode": "string",
          "CarrierCode": "string",
          "ChangeOfDay": "string",
          "ConnectionIndicator": "string",
          "DepartureDate": "string",
          "DepartureTime": "string",
          "FlightNbr": "string",
          "JourneyTime": "string",
          "NbrSeats": 0,
          "OffPoint": "string",
          "OperatingCarrierCode": "string",
          "OperatingCarrierName": "string",
          "SeatingData": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "SeatLocation": "string",
              "SeatStatusCode": "string"
            }
          },
          "SegmentStatus": "string"
        }
      ],
      "CarSegments": [
        {
          "AirportCode": "string",
          "CarAddress": "string",
          "CarLocationCategory": "string",
          "CarRateCode": "string",
          "CarRateType": "string",
          "CarSegmentNbr": 0,
          "CarType": "string",
          "CarVendorCode": "string",
          "CarYieldManagementNbr": "string",
          "ConfirmationNbr": "string",
          "CurrencyCode": "string",
          "DistanceAllowance": "string",
          "DistanceRateAmount": "string",
          "DropOffDate": "string",
          "DropOffTime": "string",
          "MilesKilometerIndicator": "string",
          "NbrOfCars": 0,
          "PickUpDate": "string",
          "PickUpTime": "string",
          "RateAmount": "string",
          "RateGuaranteeIndicator": "string",
          "SegmentStatus": "string"
        }
      ],
      "HotelSegments": [
        {
          "HotelSegmentNbr": "string",
          "StatusCode": "string",
          "ArrivalDate": "string",
          "DepartureDate": "string",
          "PropertyName": "string",
          "ChainCode": "string",
          "ChainName": "string",
          "CityCode": "string",
          "CityName": "string",
          "CountryCode": "string",
          "CountryName": "string",
          "Passenger": "string",
          "Account": "string",
          "ConfirmationNbr": "string",
          "Currency": "string",
          "Rate": "string",
          "RoomBookingCode": "string",
          "NbrNights": 0,
          "MultiLevelRateCode": "string",
          "NbrRooms": 0,
          "BookedInName": "string",
          "ServiceInformation": "string",
          "PropertyCityCode": "string",
          "SegmentStatus": "string",
          "HotelVendorCode": "string"
        }
      ],
      "PassiveSegments": [
        {
          "Address": "string",
          "BookingReasonCode": "string",
          "BookingSource": "string",
          "CityCode": "string",
          "CommissionInformation": "string",
          "ConfirmationNumber": "string",
          "DepartureDate": "string",
          "NbrNights": "string",
          "Passenger": "string",
          "PropertyName": "string",
          "PropertyNumber": "string",
          "RateAccessCode": "string",
          "RateCode": "string",
          "RateQuoted": "string",
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceInformation": "string",
          "StartDate": "string",
          "Text": "string",
          "VendorCode": "string"
        }
      ]
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	SupplierPreferencesByOwningAgencyLocationIDResponse

UsersPCCsMapping

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/UsersPCCsMapping \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/UsersPCCsMapping");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/UsersPCCsMapping', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/UsersPCCsMapping");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /UsersPCCsMapping

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
OwningAgencyLocationID	query	string	false	Owning agency location ID
Deleted	query	boolean	false	Deleted
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "UserID": 0,
      "UserName": "string",
      "LastName": "string",
      "FirstName": "string",
      "LocationCountryCode": "string",
      "LocationCountryName": "string",
      "LastLogin": "2019-03-18T11:42:49Z",
      "PCCList": "string",
      "IsUserActive": true,
      "IsDeleted": true
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	UsersPCCsMappingItemResponse

Routing Instances

RoutingInstancesByCity

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/routinginstancesbycity/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/routinginstancesbycity/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/routinginstancesbycity/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/routinginstancesbycity/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /routinginstancesbycity/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
DestinationCity	query	string	true	Destination city 3 letters code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Routing": "string",
      "TotalInstances": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	RoutingInstancesByCityItemResponse

RoutingInstancesPerCity

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/routinginstancespercity/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/routinginstancespercity/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/routinginstancespercity/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/routinginstancespercity/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /routinginstancespercity/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "CityCode": "string",
      "CityName": "string",
      "TotalInstances": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	RoutingInstancesPerCityItemResponse

Segments

AirSegmentsPerAccountByVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/AirSegmentsPerAccountByVendor/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/AirSegmentsPerAccountByVendor/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/AirSegmentsPerAccountByVendor/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/AirSegmentsPerAccountByVendor/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /AirSegmentsPerAccountByVendor/user

Parameters

Name	In	Type	Required	Description
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
UserName	query	string	true	UserName in form of an email address
VendorCode	query	string	true	Vendor code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Account": "string",
      "TotalAirSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AirSegmentsPerAccountByVendorItemResponse

AirSegmentsPerBranchByVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/AirSegmentsPerBranchByVendor/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/AirSegmentsPerBranchByVendor/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/AirSegmentsPerBranchByVendor/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/AirSegmentsPerBranchByVendor/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /AirSegmentsPerBranchByVendor/user

Parameters

Name	In	Type	Required	Description
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
UserName	query	string	true	UserName in form of an email address
VendorCode	query	string	true	Vendor code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningAgencyLocation": "string",
      "OwningAgencyLocationID": "string",
      "TotalAirSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AirSegmentsPerBranchByVendorItemResponse

AirSegmentsPerCarrier

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/airsegmentspercarrier/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/airsegmentspercarrier/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/airsegmentspercarrier/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/airsegmentspercarrier/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /airsegmentspercarrier/user

Parameters

Name	In	Type	Required	Description
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
UserName	query	string	true	UserName in form of an email address
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "CarrierCode": "string",
      "CarrierName": "string",
      "TotalAirSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AirSegmentsPerCarrierItemResponse

AirSegmentsPerConsultantByVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/AirSegmentsPerConsultantByVendor/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/AirSegmentsPerConsultantByVendor/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/AirSegmentsPerConsultantByVendor/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/AirSegmentsPerConsultantByVendor/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /AirSegmentsPerConsultantByVendor/user

Parameters

Name	In	Type	Required	Description
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
UserName	query	string	true	UserName in form of an email address
VendorCode	query	string	true	Vendor code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningConsultant": "string",
      "OwningConsultantID": "string",
      "OwningAgencyLocation": "string",
      "TotalAirSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AirSegmentsPerConsultantByVendorItemResponse

AirSegmentsPerDestinationByVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/AirSegmentsPerDestinationByVendor/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/AirSegmentsPerDestinationByVendor/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/AirSegmentsPerDestinationByVendor/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/AirSegmentsPerDestinationByVendor/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /AirSegmentsPerDestinationByVendor/user

Parameters

Name	In	Type	Required	Description
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
UserName	query	string	true	UserName in form of an email address
VendorCode	query	string	true	Vendor code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "CityName": "string",
      "CityCode": "string",
      "CountryName": "string",
      "TotalInstances": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AirSegmentsPerDestinationByVendorItemResponse

AirSegmentsWithVendorLocatorsByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/airsegmentswithvendorlocators/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/airsegmentswithvendorlocators/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/airsegmentswithvendorlocators/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/airsegmentswithvendorlocators/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /airsegmentswithvendorlocators/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
Account	query	string	true	GDS account
DepartureDateStart	query	string	true	Date in format YYYYMMDD
DepartureDateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "PNRCreationDate": "string",
      "AgentivityRef": "string",
      "Account": "string",
      "OwningConsultantID": "string",
      "OwningConsultant": "string",
      "OwningAgencyLocationID": "string",
      "PaxList": "string",
      "AirSegmentNbr": "string",
      "SegmentStatus": "string",
      "BoardPoint": "string",
      "OffPoint": "string",
      "DepartureDate": "string",
      "DepartureTime": "string",
      "ArrivalTime": "string",
      "ChangeOfDay": "string",
      "CarrierCode": "string",
      "FlightNbr": "string",
      "BookingCode": "string",
      "PNRTicketed": "string",
      "VendorLocator": "string",
      "CheckInURL": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AirSegmentsWithVendorLocatorsByUserResponse

CarSegmentCountsPerAccountByVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/CarSegmentCountsPerAccountByVendor/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/CarSegmentCountsPerAccountByVendor/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/CarSegmentCountsPerAccountByVendor/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/CarSegmentCountsPerAccountByVendor/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /CarSegmentCountsPerAccountByVendor/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
VendorCode	query	string	true	Vendor code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Account": "string",
      "TotalSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	CarSegmentCountsPerAccountByVendorItemResponse

CarSegmentCountsPerBranchByVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/CarSegmentCountsPerBranchByVendor/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/CarSegmentCountsPerBranchByVendor/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/CarSegmentCountsPerBranchByVendor/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/CarSegmentCountsPerBranchByVendor/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /CarSegmentCountsPerBranchByVendor/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
VendorCode	query	string	true	Vendor code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningAgencyLocation": "string",
      "OwningAgencyLocationID": "string",
      "TotalSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	CarSegmentCountsPerBranchByVendorItemResponse

CarSegmentCountsPerConsultantByVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/CarSegmentCountsPerConsultantByVendor/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/CarSegmentCountsPerConsultantByVendor/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/CarSegmentCountsPerConsultantByVendor/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/CarSegmentCountsPerConsultantByVendor/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /CarSegmentCountsPerConsultantByVendor/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
VendorCode	query	string	true	Vendor code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningConsultant": "string",
      "OwningConsultantID": "string",
      "OwningAgencyLocation": "string",
      "TotalSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	CarSegmentCountsPerConsultantByVendorItemResponse

CarSegmentCountsPerLocationByVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/CarSegmentCountsPerLocationByVendor/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/CarSegmentCountsPerLocationByVendor/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/CarSegmentCountsPerLocationByVendor/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/CarSegmentCountsPerLocationByVendor/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /CarSegmentCountsPerLocationByVendor/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
VendorCode	query	string	true	Vendor code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "CityName": "string",
      "CityCode": "string",
      "CountryName": "string",
      "TotalSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	CarSegmentCountsPerLocationByVendorItemResponse

CarSegmentCountsPerVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/CarSegmentCountsPerVendor/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/CarSegmentCountsPerVendor/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/CarSegmentCountsPerVendor/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/CarSegmentCountsPerVendor/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /CarSegmentCountsPerVendor/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "VendorCode": "string",
      "VendorName": "string",
      "TotalSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	CarSegmentCountsPerVendorItemResponse

CarSegmentsByDate

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/CarSegmentsByDate/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/CarSegmentsByDate/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/CarSegmentsByDate/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/CarSegmentsByDate/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /CarSegmentsByDate/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": "string",
      "RecordLocator": "string",
      "OwningAgencyLocationID": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "Passengers": "string",
      "PickUpDate": "2019-03-18T11:42:49Z",
      "DropOffDate": "2019-03-18T11:42:49Z",
      "CarVendorCode": "string",
      "VendorName": "string",
      "SegmentStatus": "string",
      "AirportCode": "string",
      "ConfirmationNbr": "string",
      "CurrencyCode": "string",
      "RateAmount": "string",
      "NbrOfCars": "string",
      "CarType": "string",
      "ServiceInformation": "string",
      "BRInformation": "string",
      "CarSegmentType": "string",
      "CreatingAgencyIata": "string",
      "CityCode": "string",
      "Text": "string",
      "Vouchers": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	CarSegmentsByDateItemResponse

CarSegmentsByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/carsegments/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/carsegments/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/carsegments/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/carsegments/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /carsegments/user

Parameters

Name	In	Type	Required	Description
PickUpDateEnd	query	string	true	Date in format YYYYMMDD
PickUpDateStart	query	string	true	Date in format YYYYMMDD
UserName	query	string	true	UserName in form of an email address
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
        "OwningAgencyLocation": "string",
        "PNR": "string",
        "Consultant": "string",
        "SegmentStatus": "string",
        "PickUpDate": "string",
        "DropOffDate": "string",
        "CarVendorCode": "string",
        "VendorName": "string",
        "AirportCode": "string",
        "Passenger": "string",
        "Account": "string",
        "ConfirmationNbr": "string",
        "CurrencyCode": "string",
        "RateAmount": "string",
        "CarType": "string",
        "NbrOfCars": "string",
        "BookedInName": "string",
        "ServiceInformation": "string",
        "BRInformation": "string"
    },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	Object

CancelledHotelSegmentsByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/cancelledhotelsegments/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/cancelledhotelsegments/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/cancelledhotelsegments/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/cancelledhotelsegments/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /cancelledhotelsegments/user

Parameters

Name	In	Type	Required	Description
UserID	query	number	true	ID of the user
CancelledDateStart	query	string	true	Date in format YYYYMMDD
CancelledDateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	Object

HotelLocSegmentCountsPerChainByCity

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/HotelLocSegmentCountsPerChainByCity/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/HotelLocSegmentCountsPerChainByCity/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/HotelLocSegmentCountsPerChainByCity/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/HotelLocSegmentCountsPerChainByCity/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /HotelLocSegmentCountsPerChainByCity/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
CityCode	query	string	true	3 letter city code
VendorCode	query	string	false	Vendor code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "ChainName": "string",
      "VendorCode": "string",
      "TotalSegments": 0,
      "TotalNights": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	HotelLocSegmentCountsPerChainByCityItemResponse

HotelLocSegmentCountsPerPropertyByCity

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/HotelLocSegmentCountsPerPropertyByCity/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/HotelLocSegmentCountsPerPropertyByCity/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/HotelLocSegmentCountsPerPropertyByCity/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/HotelLocSegmentCountsPerPropertyByCity/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /HotelLocSegmentCountsPerPropertyByCity/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
CityCode	query	string	true	3 letter city code
VendorCode	query	string	true	Vendor code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "PropertyName": "string",
      "TotalSegments": 0,
      "TotalNights": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	HotelLocSegmentCountsPerPropertyByCityItemResponse

HotelSegmentsByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/hotelsegments/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/hotelsegments/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/hotelsegments/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/hotelsegments/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /hotelsegments/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
ArrivalDateStart	query	string	true	Date in format YYYYMMDD
ArrivalDateEnd	query	string	true	Date in format YYYYMMDD
Account	query	string	false	GDS account
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "HotelSegmentNbr": "string",
      "PCC": "string",
      "PNR": "string",
      "Consultant": "string",
      "StatusCode": "string",
      "ArrivalDate": "string",
      "DepartureDate": "string",
      "PropertyName": "string",
      "ChainCode": "string",
      "ChainName": "string",
      "City": "string",
      "CityCode": "string",
      "CityName": "string",
      "CountryCode": "string",
      "CountryName": "string",
      "Passenger": "string",
      "Account": "string",
      "ConfirmationNbr": "string",
      "Currency": "string",
      "Rate": "string",
      "RoomBookingCode": "string",
      "NbrNights": 0,
      "MultiLevelRateCode": "string",
      "NbrRooms": 0,
      "BookedInName": "string",
      "ServiceInformation": "string",
      "TotalAirSegs": "string",
      "CreatingAgencyIata": "string",
      "AgentivityRef": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	HotelSegmentsByUserItemResponse

HotelSegmentCountsPerAccountByVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/HotelSegmentCountsPerAccountByVendor/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/HotelSegmentCountsPerAccountByVendor/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/HotelSegmentCountsPerAccountByVendor/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/HotelSegmentCountsPerAccountByVendor/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /HotelSegmentCountsPerAccountByVendor/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
VendorCode	query	string	true	Vendor code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Account": "string",
      "TotalSegments": 0,
      "TotalNights": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	HotelSegmentCountsPerAccountByVendorItemResponse

HotelSegmentCountsPerBranchByVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/HotelSegmentCountsPerBranchByVendor/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/HotelSegmentCountsPerBranchByVendor/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/HotelSegmentCountsPerBranchByVendor/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/HotelSegmentCountsPerBranchByVendor/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /HotelSegmentCountsPerBranchByVendor/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
VendorCode	query	string	true	Vendor code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningAgencyLocation": "string",
      "OwningAgencyLocationID": "string",
      "TotalSegments": 0,
      "TotalNights": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	HotelSegmentCountsPerBranchByVendorItemResponse

HotelSegmentCountsPerConsultantByVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/HotelSegmentCountsPerConsultantByVendor/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/HotelSegmentCountsPerConsultantByVendor/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/HotelSegmentCountsPerConsultantByVendor/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/HotelSegmentCountsPerConsultantByVendor/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /HotelSegmentCountsPerConsultantByVendor/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
VendorCode	query	string	true	Vendor code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningConsultant": "string",
      "OwningConsultantID": "string",
      "OwningAgencyLocation": "string",
      "TotalSegments": 0,
      "TotalNights": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	HotelSegmentCountsPerConsultantByVendorItemResponse

HotelSegmentCountsPerLocationByVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/HotelSegmentCountsPerLocationByVendor/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/HotelSegmentCountsPerLocationByVendor/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/HotelSegmentCountsPerLocationByVendor/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/HotelSegmentCountsPerLocationByVendor/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /HotelSegmentCountsPerLocationByVendor/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
VendorCode	query	string	false	Vendor code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "CityName": "string",
      "CityCode": "string",
      "CountryName": "string",
      "TotalSegments": 0,
      "TotalNights": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	HotelSegmentCountsPerLocationByVendorItemResponse

HotelSegmentCountsPerVendor

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/HotelSegmentCountsPerVendor/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/HotelSegmentCountsPerVendor/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/HotelSegmentCountsPerVendor/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/HotelSegmentCountsPerVendor/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /HotelSegmentCountsPerVendor/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "ChainName": "string",
      "VendorCode": "string",
      "TotalSegments": 0,
      "TotalNights": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	HotelSegmentCountsPerVendorItemResponse

HotelSegmentsWithNotepadByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/hotelsegmentswithnotepad/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/hotelsegmentswithnotepad/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/hotelsegmentswithnotepad/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/hotelsegmentswithnotepad/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /hotelsegmentswithnotepad/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
ArrivalDateStart	query	string	true	Date in format YYYYMMDD
ArrivalDateEnd	query	string	true	Date in format YYYYMMDD
Account	query	string	false	GDS account
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	Object

PassiveSegmentsByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/passivesegments/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/passivesegments/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/passivesegments/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/passivesegments/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /passivesegments/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
ArrivalDateStart	query	string	true	Date in format YYYYMMDD
ArrivalDateEnd	query	string	true	Date in format YYYYMMDD
Account	query	string	false	GDS account
SegmentType	query	string	false	Type of segment
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Address": "string",
      "AgentivityRef": 0,
      "BookingReasonCode": "string",
      "BookingSource": "string",
      "CityCode": "string",
      "CommissionInformation": "string",
      "ConfirmationNumber": "string",
      "NbrNights": "string",
      "OwningConsultantID": "string",
      "PropertyName": "string",
      "PropertyNumber": "string",
      "RateAccessCode": "string",
      "RateCode": "string",
      "RateQuoted": "string",
      "SegmentType": "string",
      "ServiceInformation": "string",
      "StartDate": "string",
      "Text": "string",
      "TotalAirSegs": "string",
      "VendorCode": "string",
      "RecordLocator": "string",
      "OwningAgencyLocationID": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "Passenger": "string",
      "DepartureDate": "string",
      "SegmentStatus": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	PassiveSegmentsResponse

PNRSegmentCountsByCompanyAgentLocation2

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/pnrsegmentcounts2/company/alcc \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/pnrsegmentcounts2/company/alcc");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/pnrsegmentcounts2/company/alcc', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/pnrsegmentcounts2/company/alcc");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /pnrsegmentcounts2/company/alcc

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
AgentLocationCountryCode	query	string	true	Country code for agent's location
PNRCreationDateStart	query	string	true	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	true	Date in format YYYYMMDD
OwningAgencyLocationID	query	string	false	Owning agency location ID
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	Object

ProblematicSegmentsByUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/problematicsegments/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/problematicsegments/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/problematicsegments/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/problematicsegments/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /problematicsegments/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DepartureDateStart	query	string	true	Date in format YYYYMMDD
DepartureDateEnd	query	string	false	Date in format YYYYMMDD
CompanyID	query	string	false	ID of a Company (travel agency)
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "RecordLocator": "string",
      "OwningConsultantID": "string",
      "PrimaryPax": "string",
      "TransactionAgent": "string",
      "Account": "string",
      "SegmentStatus": "string",
      "Segment": "string",
      "AgentivityRef": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	ProblematicSegmentsByUserItemResponse

SegmentsByPNR

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/1/segments/pnr?RecordLocator=string \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/segments/pnr?RecordLocator=string");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/1/segments/pnr', params={
  'RecordLocator': 'string'
}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/1/segments/pnr?RecordLocator=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /1/segments/pnr

GET /segments/pnr

Parameters

Name	In	Type	Required	Description
RecordLocator	query	string	true	RecordLocator
PNRCreationDate	query	string	false	Start Date in format YYYYMMDD
SegmentType	query	string	false	Type of segment
PassiveSegmentType	query	string	false	Type of passive segment
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "PNRSummary": {
      "RecordLocator": "string",
      "AirlineReferences": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "Vendor": "string",
          "VendorLocator": "string"
        }
      },
      "Tickets": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "TktNumber": "string",
          "Passenger": {
            "LastName": "string",
            "FirstName": "string"
          },
          "Coupons": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "CouponSequenceNbr": "string",
              "CouponBoardPoint": "string",
              "CouponOffPoint": "string",
              "Carrier": "string",
              "FlightNbr": "string",
              "FlightDate": "string",
              "FlightTime": "string"
            }
          }
        }
      }
    },
    "Segments": {
      "AirSegments": [
        {
          "AirSegmentNbr": 0,
          "ArrivalTime": "string",
          "BoardPoint": "string",
          "BookingCode": "string",
          "CarrierCode": "string",
          "ChangeOfDay": "string",
          "ConnectionIndicator": "string",
          "DepartureDate": "string",
          "DepartureTime": "string",
          "FlightNbr": "string",
          "JourneyTime": "string",
          "NbrSeats": 0,
          "OffPoint": "string",
          "OperatingCarrierCode": "string",
          "OperatingCarrierName": "string",
          "SeatingData": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "SeatLocation": "string",
              "SeatStatusCode": "string"
            }
          },
          "SegmentStatus": "string"
        }
      ],
      "CarSegments": [
        {
          "AirportCode": "string",
          "CarAddress": "string",
          "CarLocationCategory": "string",
          "CarRateCode": "string",
          "CarRateType": "string",
          "CarSegmentNbr": 0,
          "CarType": "string",
          "CarVendorCode": "string",
          "CarYieldManagementNbr": "string",
          "ConfirmationNbr": "string",
          "CurrencyCode": "string",
          "DistanceAllowance": "string",
          "DistanceRateAmount": "string",
          "DropOffDate": "string",
          "DropOffTime": "string",
          "MilesKilometerIndicator": "string",
          "NbrOfCars": 0,
          "PickUpDate": "string",
          "PickUpTime": "string",
          "RateAmount": "string",
          "RateGuaranteeIndicator": "string",
          "SegmentStatus": "string"
        }
      ],
      "HotelSegments": [
        {
          "HotelSegmentNbr": "string",
          "StatusCode": "string",
          "ArrivalDate": "string",
          "DepartureDate": "string",
          "PropertyName": "string",
          "ChainCode": "string",
          "ChainName": "string",
          "CityCode": "string",
          "CityName": "string",
          "CountryCode": "string",
          "CountryName": "string",
          "Passenger": "string",
          "Account": "string",
          "ConfirmationNbr": "string",
          "Currency": "string",
          "Rate": "string",
          "RoomBookingCode": "string",
          "NbrNights": 0,
          "MultiLevelRateCode": "string",
          "NbrRooms": 0,
          "BookedInName": "string",
          "ServiceInformation": "string",
          "PropertyCityCode": "string",
          "SegmentStatus": "string",
          "HotelVendorCode": "string"
        }
      ],
      "PassiveSegments": [
        {
          "Address": "string",
          "BookingReasonCode": "string",
          "BookingSource": "string",
          "CityCode": "string",
          "CommissionInformation": "string",
          "ConfirmationNumber": "string",
          "DepartureDate": "string",
          "NbrNights": "string",
          "Passenger": "string",
          "PropertyName": "string",
          "PropertyNumber": "string",
          "RateAccessCode": "string",
          "RateCode": "string",
          "RateQuoted": "string",
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceInformation": "string",
          "StartDate": "string",
          "Text": "string",
          "VendorCode": "string"
        }
      ]
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	SegmentsByPNRResponse

SegmentsQC

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/SegmentsQC/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/SegmentsQC/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/SegmentsQC/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/SegmentsQC/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /SegmentsQC/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DepartureDateStart	query	string	true	Date in format YYYYMMDD
DepartureDateEnd	query	string	false	Date in format YYYYMMDD
Account	query	string	false	GDS account
VipOnly	query	string	false	Return only segments that are flagged as VIP only
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningConsultant": "string",
      "Passenger": "string",
      "Account": "string",
      "BoardPoint": "string",
      "OffPoint": "string",
      "DepartureTime": "string",
      "BookingClass": "string",
      "SegmentStatus": "string",
      "CarrierCode": "string",
      "FlightNbr": "string",
      "FlightNumberFromatted": "string",
      "SeatCheck": "string",
      "SeatFormatted": "string",
      "MealCheck": "string",
      "MealFormatted": "string",
      "ChauffeurDesc": "string",
      "TransferDesc": "string",
      "CarsFormatted": "string",
      "HoteCheck": "string",
      "Hotels": "string",
      "ShuttleDesc": "string",
      "TourDesc": "string",
      "FrequentFlyerNumbers": "string",
      "PnrTicketed": "string",
      "TicketNumber": "string",
      "Comments": "string",
      "OpsComments": "string",
      "IsVip": true
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	SegmentsQCItemResponse

Ticket

GetTicketCouponCodes

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/TicketCouponCodes/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/TicketCouponCodes/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/TicketCouponCodes/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/TicketCouponCodes/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /TicketCouponCodes/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "CouponCode": "string",
      "Name": "string",
      "IsGroup": true
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	TicketCouponCodesResponse

GetTicketCouponsByStatusCode

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/TicketCouponsByStatusCode/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/TicketCouponsByStatusCode/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/TicketCouponsByStatusCode/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/TicketCouponsByStatusCode/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /TicketCouponsByStatusCode/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
CouponCodeGroup	query	string	true	Coupon code group
DateTracker	query	string	true	One letter code for DateRange (I = Issue date, T =Travel date, E = Expiry date)
TravAgntID	query	string	false	Travel agent ID
Account	query	string	false	GDS account
Repeat	query	string	false	Repeat
NoActiveSegments	query	boolean	false	Lists only segments that are not active
IncludePartialMatches	query	boolean	false	Include partial matches
PaxSurname	query	string	false	Pax surname
CarrierCode	query	string	false	Two letter code for carrier
OwningConsultantID	query	string	false	Id of the owning counsultant
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RN": "string",
      "AirTktSegId": "string",
      "VndIssueDt": "2019-03-18T11:42:49Z",
      "RecordLocator": "string",
      "Passenger": "string",
      "TktNumber": "string",
      "TravAgntID": "string",
      "OwningConsultantID": "string",
      "FOPFare": "string",
      "BaseFare": "string",
      "FOP": "string",
      "TotalTax": "string",
      "Tax1Code": "string",
      "Tax1Amt": "string",
      "Tax2Code": "string",
      "Tax2Amt": "string",
      "Tax3Code": "string",
      "Tax3Amt": "string",
      "Tax4Amt": "string",
      "Tax4Code": "string",
      "Tax5Code": "string",
      "Tax5Amt": "string",
      "Account": "string",
      "ExchangedForTicket": "string",
      "CouponSequenceNbr": "string",
      "Carrier": "string",
      "BoardPoint": "string",
      "OffPoint": "string",
      "FlightDate": "2019-03-18T11:42:49Z",
      "FlightServiceClass": "string",
      "FareBasis": "string",
      "FlightCouponStatus": "string",
      "DateLastChecked": "2019-03-18T11:42:49Z",
      "PCC": "string",
      "AirlineCode": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	TicketCouponsByStatusCodeResponse

TicketCouponsIssued

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/user/ticketcouponsissued \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/user/ticketcouponsissued");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/user/ticketcouponsissued', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/user/ticketcouponsissued");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /user/ticketcouponsissued

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
IssueDateStart	query	string	true	Date in format YYYYMMDD
IssueDateEnd	query	string	false	Date in format YYYYMMDD
Account	query	string	false	GDS account
TravelAgentID	query	string	false	ID of a travel agent
FlightCouponStatus	query	string	false	4 letter code for flight coupon status
FormatStyle	query	string	false	Format style
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "TktNumber": "string",
      "Passenger": "string",
      "VendorIssueDate": "2019-03-18T11:42:49Z",
      "FOP": "string",
      "FOPCurrncy": "string",
      "FOPFare": "string",
      "CouponSequenceNbr": "string",
      "FlightDate": "2019-03-18T11:42:49Z",
      "Routing": "string",
      "FlightServiceClass": "string",
      "FareBasis": "string",
      "Carrier": "string",
      "Account": "string",
      "OwningAgencyLocationID": "string",
      "FlightCouponStatus": "string",
      "DateLastChecked": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	TicketCouponsIssuedByUserItemResponse

GetTicketAutomationSuccessPerPCC

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/TicketAutomationSuccessPerPCC/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/TicketAutomationSuccessPerPCC/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/TicketAutomationSuccessPerPCC/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/TicketAutomationSuccessPerPCC/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /TicketAutomationSuccessPerPCC/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "OwningAgencyPseudo": "string",
      "TotalTicketedPNRs": "string",
      "Consultant": "string",
      "Requested": "string",
      "Success": "string",
      "Failed": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	TicketAutomationSuccessPerPCCResponse

GetTicketsIssued

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/TicketsIssued/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/TicketsIssued/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/TicketsIssued/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/TicketsIssued/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /TicketsIssued/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
IATA	query	string	false	IATA code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "TktNumber": "string",
      "FOP": "string",
      "Passenger": "string",
      "Consultant": "string",
      "RemarkText": "string",
      "AirlineCode": "string",
      "TravAgntID": "string",
      "PCC": "string",
      "PrintedCurrency": "string",
      "FOPFare": "string",
      "Date": "2019-03-18T11:42:49Z",
      "DueDate": "2019-03-18T11:42:49Z"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	TicketsIssuedResponse

GetTicketsIssuedByNumber

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/TicketsIssuedByNumber/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/TicketsIssuedByNumber/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/TicketsIssuedByNumber/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/TicketsIssuedByNumber/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /TicketsIssuedByNumber/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
tktNumber	query	string	true	Ticket number
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "TktNumber": "string",
      "PlatingCarrier": "string",
      "Passenger": "string",
      "IATA": "string",
      "OwningAgencyLocationID": "string",
      "IssueDate": "2019-03-18T11:42:49Z",
      "ExpirationDate": "2019-03-18T11:42:49Z",
      "FOPFare": "string",
      "PrintedCurrency": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	CollectionResponse_TicketsIssuedByNumber_

TicketsByAccount

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/ticketsbyaccount \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/ticketsbyaccount");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/ticketsbyaccount', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/ticketsbyaccount");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /ticketsbyaccount

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
TicketIssueStartDate	query	string	true	Date in format YYYYMMDD
TicketIssueEndDate	query	string	true	Date in format YYYYMMDD
Account	query	string	false	GDS account
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "Account": "string",
      "IssueDate": "2019-03-18T11:42:49Z",
      "TicketNumber": "string",
      "PrimaryPassenger": "string",
      "PlatingCarrier": "string",
      "IATA": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	TicketsByAccountItemResponse

TicketDetails

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/TicketDetails/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/TicketDetails/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/TicketDetails/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/TicketDetails/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /TicketDetails/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
TktNumber	query	string	true	Ticket number
CacheGuid	query	string	false	Cache guid
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "TktNumber": "string",
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "TktIssueDate": "2019-03-18T11:42:49Z",
      "PlatingCarrier": "string",
      "Status": "string",
      "BAR": "string",
      "PAR": "string",
      "LastName": "string",
      "FirstName": "string",
      "TicketExpiryDate": "2019-03-18T11:42:49Z",
      "FOP": "string",
      "FopFare": "string",
      "FOPCurrency": "string",
      "PrintedCurrency": "string",
      "PrintedFare": "string",
      "CreditCardFOPAcct": "string",
      "OwningAgencyLocationID": "string",
      "IATA": "string",
      "Coupons": [
        {
          "TktNumber": "string",
          "Carrier": "string",
          "CouponSequenceNbr": 0,
          "FlightNbr": "string",
          "BoardPoint": "string",
          "OffPoint": "string",
          "FlightServiceClass": "string",
          "FlightDate": "2019-03-18T11:42:49Z",
          "FlightCouponStatus": "string",
          "DateLastChecked": "2019-03-18T11:42:49Z",
          "AirTktSegId": 0,
          "EligibleForRefund": true
        }
      ],
      "EligibleForRefund": true
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	TicketDetailsItemResponse

TicketingStatsRequest

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/ticketingstats \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/ticketingstats");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/ticketingstats', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/ticketingstats");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /ticketingstats

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
TicketingDateStart	query	string	true	Date in format YYYYMMDD
TicketingDateEnd	query	string	true	Date in format YYYYMMDD
Account	query	string	true	Comma Delimited List of GDS Accounts
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "TraditionalCount": 0,
      "OnlineCount": 0,
      "TotalCount": 0,
      "ChangesCount": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	TicketingStatsRequestItemResponse

TicketRevenueByCompany

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/ticketrevenue/company \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/ticketrevenue/company");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/ticketrevenue/company', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/ticketrevenue/company");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /ticketrevenue/company

Parameters

Name	In	Type	Required	Description
DepartureDateStart	query	string	true	Date in format YYYYMMDD
DepartureDateEnd	query	string	true	Date in format YYYYMMDD
FlightCouponStatus	query	string	true	4 letter code for flight coupon status
CompanyID	query	integer(int32)	false	ID of a Company (travel agency)
TravelAgentID	query	string	false	ID of a travel agent
PlatingCarrier	query	string	false	Code for Plating Carrier
AirlineCode	query	string	false	Two letter airline code
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	Object

TicketSegmentsByBAR

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/ticketsegments/bar \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/ticketsegments/bar");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/ticketsegments/bar', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/ticketsegments/bar");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /ticketsegments/bar

Parameters

Name	In	Type	Required	Description
OwningAgencyLocationID	query	string	true	Owning agency location ID
FlightCouponStatus	query	string	true	4 letter code for flight coupon status
BAR	query	string	true	Busness account record
PAR	query	string	false	Passegner account record
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "TktNumber": "string",
      "RecordLocator": "string",
      "VndIssueDt": "string",
      "BAR": "string",
      "PAR": "string",
      "FOPCurrency": "string",
      "FOPFare": "string",
      "Segments": [
        {
          "Carrier": "string",
          "CouponBoardPoint": "string",
          "CouponOffPoint": "string",
          "CouponSequenceNbr": 0,
          "DateLastChecked": "string",
          "FareBasis": "string",
          "FlightCouponStatus": "string",
          "FlightServiceClass": "string",
          "FlightStatus": "string"
        }
      ]
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	TicketSegmentsByBARResponse

TicketSegmentsWithTaxByIssueDate

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/ticketsegmentswithtax \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/ticketsegmentswithtax");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/ticketsegmentswithtax', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/ticketsegmentswithtax");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /ticketsegmentswithtax

Parameters

Name	In	Type	Required	Description
UserName	query	string	false	UserName in form of an email address
TicketIssueDateStart	query	string	false	Date in format YYYYMMDD
TicketIssueDateEnd	query	string	false	Date in format YYYYMMDD
Account	query	string	false	GDS account
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Recordlocator": "string",
      "PNRCreationDate": "string",
      "TicketNumber": "string",
      "Account": "string",
      "PrimaryPassenger": "string",
      "VndIssueDate": "string",
      "TravelAgentID": "string",
      "FOPFare": "string",
      "FOP": "string",
      "TotalTax": "string",
      "Tax1Code": "string",
      "Tax1Amt": "string",
      "Tax2Code": "string",
      "Tax2Amt": "string",
      "Tax3Code": "string",
      "Tax3Amt": "string",
      "Tax4Code": "string",
      "Tax4Amt": "string",
      "Tax5Code": "string",
      "Tax5Amt": "string",
      "ExchangedForTicket": "string",
      "CouponSequenceNbr": "string",
      "Carrier": "string",
      "BoardPoint": "string",
      "OffPoint": "string",
      "FlightDate": "string",
      "FlightServiceClass": "string",
      "FareBasis": "string",
      "FlightCouponStatus": "string",
      "DateLastChecked": "string",
      "OwningAgencyLocationID": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	TicketSegmentsWithTaxByIssueDateResponse

Traveller

TravelHistorySummaryByTraveller

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/travelhistorysummary/traveller?TravellerReference=string \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/travelhistorysummary/traveller?TravellerReference=string");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/travelhistorysummary/traveller', params={
  'TravellerReference': 'string'
}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/travelhistorysummary/traveller?TravellerReference=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /travelhistorysummary/traveller

GET /1/travelhistorysummary/traveller

Parameters

Name	In	Type	Required	Description
CompanyID	query	number	false	ID for your Company
PNRTicketed	query	string	false	Return only PNRs that are ticketed/all
TravellerReference	query	string	true	Traveller Reference
TravellerEmail	query	string	false	Email of the traveller
TravellerPhoneNbr	query	string	false	Phone Number of the traveller
TravelDateStart	query	string	false	Start Date in format YYYYMMDD
TravelDateEnd	query	string	false	End Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "PNRSummary": {
      "RecordLocator": "string",
      "AirlineReferences": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "Vendor": "string",
          "VendorLocator": "string"
        }
      },
      "Tickets": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "TktNumber": "string",
          "Passenger": {
            "LastName": "string",
            "FirstName": "string"
          },
          "Coupons": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "CouponSequenceNbr": "string",
              "CouponBoardPoint": "string",
              "CouponOffPoint": "string",
              "Carrier": "string",
              "FlightNbr": "string",
              "FlightDate": "string",
              "FlightTime": "string"
            }
          }
        }
      }
    },
    "Segments": {
      "AirSegments": [
        {
          "AirSegmentNbr": 0,
          "ArrivalTime": "string",
          "BoardPoint": "string",
          "BookingCode": "string",
          "CarrierCode": "string",
          "ChangeOfDay": "string",
          "ConnectionIndicator": "string",
          "DepartureDate": "string",
          "DepartureTime": "string",
          "FlightNbr": "string",
          "JourneyTime": "string",
          "NbrSeats": 0,
          "OffPoint": "string",
          "OperatingCarrierCode": "string",
          "OperatingCarrierName": "string",
          "SeatingData": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "SeatLocation": "string",
              "SeatStatusCode": "string"
            }
          },
          "SegmentStatus": "string"
        }
      ],
      "CarSegments": [
        {
          "AirportCode": "string",
          "CarAddress": "string",
          "CarLocationCategory": "string",
          "CarRateCode": "string",
          "CarRateType": "string",
          "CarSegmentNbr": 0,
          "CarType": "string",
          "CarVendorCode": "string",
          "CarYieldManagementNbr": "string",
          "ConfirmationNbr": "string",
          "CurrencyCode": "string",
          "DistanceAllowance": "string",
          "DistanceRateAmount": "string",
          "DropOffDate": "string",
          "DropOffTime": "string",
          "MilesKilometerIndicator": "string",
          "NbrOfCars": 0,
          "PickUpDate": "string",
          "PickUpTime": "string",
          "RateAmount": "string",
          "RateGuaranteeIndicator": "string",
          "SegmentStatus": "string"
        }
      ],
      "HotelSegments": [
        {
          "HotelSegmentNbr": "string",
          "StatusCode": "string",
          "ArrivalDate": "string",
          "DepartureDate": "string",
          "PropertyName": "string",
          "ChainCode": "string",
          "ChainName": "string",
          "CityCode": "string",
          "CityName": "string",
          "CountryCode": "string",
          "CountryName": "string",
          "Passenger": "string",
          "Account": "string",
          "ConfirmationNbr": "string",
          "Currency": "string",
          "Rate": "string",
          "RoomBookingCode": "string",
          "NbrNights": 0,
          "MultiLevelRateCode": "string",
          "NbrRooms": 0,
          "BookedInName": "string",
          "ServiceInformation": "string",
          "PropertyCityCode": "string",
          "SegmentStatus": "string",
          "HotelVendorCode": "string"
        }
      ],
      "PassiveSegments": [
        {
          "Address": "string",
          "BookingReasonCode": "string",
          "BookingSource": "string",
          "CityCode": "string",
          "CommissionInformation": "string",
          "ConfirmationNumber": "string",
          "DepartureDate": "string",
          "NbrNights": "string",
          "Passenger": "string",
          "PropertyName": "string",
          "PropertyNumber": "string",
          "RateAccessCode": "string",
          "RateCode": "string",
          "RateQuoted": "string",
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceInformation": "string",
          "StartDate": "string",
          "Text": "string",
          "VendorCode": "string"
        }
      ]
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	TravelHistorySummaryByTravellerResponse

TravellersByAccount

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/TravellersByAccount/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/TravellersByAccount/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/TravellersByAccount/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/TravellersByAccount/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /TravellersByAccount/user

Parameters

Name	In	Type	Required	Description
Account	query	string	true	GDS account
UserName	query	string	true	UserName in form of an email address
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Passenger": "string",
      "TravellerID": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	TravellersByAccountItemResponse

TravelHistorySummaryByBAR

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/travelhistorysummary/bar \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/travelhistorysummary/bar");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/travelhistorysummary/bar', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/travelhistorysummary/bar");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /travelhistorysummary/bar

Parameters

Name	In	Type	Required	Description
OwningAgencyLocationID	query	string	true	Owning agency location ID
BAR	query	string	true	Busness account record
MAR	query	string	true	Master account record
PAR	query	string	true	Passegner account record
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "PNRSummary": {
      "RecordLocator": "string",
      "AirlineReferences": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "Vendor": "string",
          "VendorLocator": "string"
        }
      },
      "Tickets": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "TktNumber": "string",
          "Passenger": {
            "LastName": "string",
            "FirstName": "string"
          },
          "Coupons": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "CouponSequenceNbr": "string",
              "CouponBoardPoint": "string",
              "CouponOffPoint": "string",
              "Carrier": "string",
              "FlightNbr": "string",
              "FlightDate": "string",
              "FlightTime": "string"
            }
          }
        }
      }
    },
    "Segments": {
      "AirSegments": [
        {
          "AirSegmentNbr": 0,
          "ArrivalTime": "string",
          "BoardPoint": "string",
          "BookingCode": "string",
          "CarrierCode": "string",
          "ChangeOfDay": "string",
          "ConnectionIndicator": "string",
          "DepartureDate": "string",
          "DepartureTime": "string",
          "FlightNbr": "string",
          "JourneyTime": "string",
          "NbrSeats": 0,
          "OffPoint": "string",
          "OperatingCarrierCode": "string",
          "OperatingCarrierName": "string",
          "SeatingData": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "SeatLocation": "string",
              "SeatStatusCode": "string"
            }
          },
          "SegmentStatus": "string"
        }
      ],
      "CarSegments": [
        {
          "AirportCode": "string",
          "CarAddress": "string",
          "CarLocationCategory": "string",
          "CarRateCode": "string",
          "CarRateType": "string",
          "CarSegmentNbr": 0,
          "CarType": "string",
          "CarVendorCode": "string",
          "CarYieldManagementNbr": "string",
          "ConfirmationNbr": "string",
          "CurrencyCode": "string",
          "DistanceAllowance": "string",
          "DistanceRateAmount": "string",
          "DropOffDate": "string",
          "DropOffTime": "string",
          "MilesKilometerIndicator": "string",
          "NbrOfCars": 0,
          "PickUpDate": "string",
          "PickUpTime": "string",
          "RateAmount": "string",
          "RateGuaranteeIndicator": "string",
          "SegmentStatus": "string"
        }
      ],
      "HotelSegments": [
        {
          "HotelSegmentNbr": "string",
          "StatusCode": "string",
          "ArrivalDate": "string",
          "DepartureDate": "string",
          "PropertyName": "string",
          "ChainCode": "string",
          "ChainName": "string",
          "CityCode": "string",
          "CityName": "string",
          "CountryCode": "string",
          "CountryName": "string",
          "Passenger": "string",
          "Account": "string",
          "ConfirmationNbr": "string",
          "Currency": "string",
          "Rate": "string",
          "RoomBookingCode": "string",
          "NbrNights": 0,
          "MultiLevelRateCode": "string",
          "NbrRooms": 0,
          "BookedInName": "string",
          "ServiceInformation": "string",
          "PropertyCityCode": "string",
          "SegmentStatus": "string",
          "HotelVendorCode": "string"
        }
      ],
      "PassiveSegments": [
        {
          "Address": "string",
          "BookingReasonCode": "string",
          "BookingSource": "string",
          "CityCode": "string",
          "CommissionInformation": "string",
          "ConfirmationNumber": "string",
          "DepartureDate": "string",
          "NbrNights": "string",
          "Passenger": "string",
          "PropertyName": "string",
          "PropertyNumber": "string",
          "RateAccessCode": "string",
          "RateCode": "string",
          "RateQuoted": "string",
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceInformation": "string",
          "StartDate": "string",
          "Text": "string",
          "VendorCode": "string"
        }
      ]
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	TravelHistorySummaryByBARResponse

Other

ConferencesByRemark

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/ConferencesByRemark/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/ConferencesByRemark/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/ConferencesByRemark/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/ConferencesByRemark/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /ConferencesByRemark/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	false	Date in format YYYYMMDD
Qualifier	query	string	false	Qualifier
Remark	query	string	false	Remark
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Name": "string",
      "OrganizingDate": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	ConferencesByRemarkItemResponse

DashboardStatsByOptions

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/dashboardstats/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/dashboardstats/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/dashboardstats/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/dashboardstats/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /dashboardstats/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
MostActiveUsersTop	query	number	true	Top most active users
ReportsTop	query	number	false	Top reports
ReportsDaysSpan	query	number	false	Reports in days span
MostActiveUsersDaysSpan	query	number	false	Top most active users
Options	query	string	false	Options
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "ProblematicBookings": {
        "DayPlusZeroTtl": 0,
        "DayPlusOneTtl": 0,
        "DayPlusTwoTtl": 0
      },
      "AirlineTicketing": {
        "DayPlusZeroTtl": 0,
        "DayPlusOneTtl": 0,
        "DayPlusTwoTtl": 0
      },
      "UnticketedBookingsByTau": {
        "DayPlusZeroTtl": 0,
        "DayPlusOneTtl": 0,
        "DayPlusTwoTtl": 0
      },
      "MonthlyActivity": [
        {
          "ReportDate": "string",
          "MonthlyEvents": 0,
          "C": 0,
          "C_Percentage": 0,
          "I": 0,
          "I_Percentage": 0,
          "T": 0,
          "T_Percentage": 0,
          "X": 0,
          "X_Percentage": 0
        }
      ],
      "MostActiveUsers": [
        {
          "UserName": "string",
          "FirstName": "string",
          "LastName": "string",
          "UserID": 0,
          "UserFrequency": "string",
          "ActivityMeasure": 0
        }
      ],
      "TopConsultants": [
        {
          "Name": "string",
          "Total": 0
        }
      ],
      "TopReports": [
        {
          "Name": "string",
          "UrlSlug": "string",
          "Total": 0
        }
      ],
      "ActiveBookingsAirConversion": {
        "TotalTicketed": 0,
        "TotalUnticketed": 0
      },
      "PassengerElements": [
        {
          "DateMonth": 0,
          "DateYear": 0,
          "WithMobilePercent": 0,
          "WithEmailPercent": 0,
          "TotalWithMobile": 0,
          "TotalWithEmail": 0,
          "TotalCreated": 0
        }
      ],
      "ReportUsageSummary": [
        {
          "Name": "string",
          "UrlSlug": "string",
          "Total": 0
        }
      ],
      "MonthlyActivityFormatted": "string",
      "PassengerElementsFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	DashboardStatsByOptionsItemResponse

DeparturesByClassName

Code samples

curl --request GET \
  --url 'http://api.agentivity.com/departuresbyclassname' \
  --header 'accept: application/json'

var client = new RestClient("http://api.agentivity.com/departuresbyclassname");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('http://api.agentivity.com/departuresbyclassname', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("http://api.agentivity.com/departuresbyclassname");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /departuresbyclassname

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
Accounts	query	string	false	Comma Delimited List of Accounts
ClassName	query	string	false	Name of the class
TravelDateStart	query	string	true	Date in format YYYYMMDD
TravelDateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Example responses

default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-10-04T11:01:34Z",
      "CacheExpiresAt": "2019-10-04T11:01:34Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "PNRCreationDate": "string",
      "AgentivityRef": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "PNRTicketed": "string",
      "TravelDate": "string",
      "TicketedStatus": "string",
      "PaxList": "string",
      "Routing": "string",
      "AirSegCount": "string",
      "CarSegCount": "string",
      "HtlSegCount": "string",
      "CarPSegCount": "string",
      "HtlPSegCount": "string",
      "TrainSegCount": "string",
      "OtherSegCount": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	DeparturesByClassNameResponse

GetAfterHoursServicing

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/AfterHoursServicing/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/AfterHoursServicing/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/AfterHoursServicing/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/AfterHoursServicing/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /AfterHoursServicing/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
LoggedDateStart	query	string	true	Date in format YYYYMMDD
LoggedDateEnd	query	string	false	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "AfterHoursValue": "string",
      "CreationDateTime": "2019-03-18T11:42:49Z",
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningConsultant": "string",
      "Account": "string",
      "PaxList": "string",
      "AgentivityRef": 0,
      "CreationTimeFormatted": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	AfterHoursServicingResponse

GetEventMonitoring

Code samples

curl --request GET \
  --url 'http://api.agentivity.com//EventMonitoring/user' \
  --header 'accept: application/json'

var client = new RestClient("http://api.agentivity.com//EventMonitoring/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('http://api.agentivity.com//EventMonitoring/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("http://api.agentivity.com//EventMonitoring/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /EventMonitoring/user

Parameters

Name	In	Type	Required	Description
CityCode	query	string	true	3 letter city code
DateEnd	query	string	true	Date in format YYYYMMDD
DateStart	query	string	true	Date in format YYYYMMDD
UserName	query	string	true	UserName in form of an email address
InTransitOnly	query	string	true	Include passangers that are in transit only in response
Accounts	query	string	false	Comma Delimited List of Accounts
WithHotel	query	boolean	false	Include items with hotel in response
HotelName	query	string	false	Name of the hotel
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-10-04T11:01:34Z",
      "CacheExpiresAt": "2019-10-04T11:01:34Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "AgentivityRef": 0,
      "PNR": "string",
      "Consultant": "string",
      "PaxList": "string",
      "Account": "string",
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      },
      "ItineraryFormatted": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	EventMonitoringResponse

GetPARUsagePerUser

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/PARUsagePerUser/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/PARUsagePerUser/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/PARUsagePerUser/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/PARUsagePerUser/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /PARUsagePerUser/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Consultant": "string",
      "TotalBookings": "string",
      "NumberOfPAR": "string",
      "PercentOfPAR": "string",
      "NumberOfBAR": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	PARUsagePerUserResponse

GetQcComments

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/QcComments/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/QcComments/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/QcComments/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/QcComments/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /QcComments/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
OwningAgencyLocationID	query	string	true	Owning agency location ID
Team	query	string	false	Team name
DateByComments	query	boolean	false	Sort date by comments
GroupByAgentInitials	query	string	false	Group by agent initials
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Consultant": "string",
      "AgentInitials": "string",
      "BookingsCount": 0,
      "CommentsCount": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	QcCommentsResponse

GetQcCommentsForConsultant

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/QcCommentsForConsultant/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/QcCommentsForConsultant/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/QcCommentsForConsultant/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/QcCommentsForConsultant/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /QcCommentsForConsultant/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
Consultant	query	string	false	Consultant full name
AgentInitials	query	string	false	Agent initials
OwningAgencyLocationID	query	string	false	Owning agency location ID
Team	query	string	false	Team name
DateByComments	query	boolean	false	Sort date by comments
GroupByAgentInitials	query	string	false	Group by agent initials
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "Consultant": "string",
      "AgentInitials": "string",
      "Comment": "string",
      "CommentDate": "2019-03-18T11:42:49Z"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	QcCommentsForConsultantResponse

GetRemarkQualifier

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/RemarkQualifier/user \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/RemarkQualifier/user");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/RemarkQualifier/user', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/RemarkQualifier/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /RemarkQualifier/user

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
DateStart	query	string	true	Date in format YYYYMMDD
DateEnd	query	string	true	Date in format YYYYMMDD
OwningAgencyLocationID	query	string	false	Owning agency location ID
Team	query	string	false	Team name
Qualifier	query	string	false	Qualifier
CountryCount	query	number	false	Count of countries
Consultant	query	string	false	Consultant full name
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "Account": "string",
      "Passangers": "string",
      "TravelDate": "string",
      "Remark": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	RemarkQualifierResponse

PNROriginatingCountries

Code samples

# You can also use wget
curl -X GET https://api.agentivity.com/pnroriginatingcountries/company \
  --header "X-AGENTIVTY-API-SIGNATURE: $apisig" --header "X-AGENTIVTY-API-DATE: $dateTime" --header "X-AGENTIVTY-API-USERNAME: PostmanTesting" --header "CONTENT-TYPE: application/xml"

var client = new RestClient("https://api.agentivity.com/pnroriginatingcountries/company");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

import urllib.request
h = {'ACCEPT': contenttype, 'CONTENT-TYPE': contenttype, 'X-AGENTIVTY-API-DATE': datetime, 'X-AGENTIVTY-API-USERNAME': username, 'X-AGENTIVTY-API-SIGNATURE': signature }

req = urllib.request.Request('https://api.agentivity.com/pnroriginatingcountries/company', params={

}, headers=h)

with urllib.request.urlopen req  as response: ()
	response_text = response.read 
print response_text ()

URL obj = new URL("https://api.agentivity.com/pnroriginatingcountries/company");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /pnroriginatingcountries/company

Parameters

Name	In	Type	Required	Description
UserName	query	string	true	UserName in form of an email address
Accept	header	string	true	Accept Header

Enumerated Values

Parameter	Value
Accept	application/json

Default Response

{}

Responses

Status	Meaning	Description	Schema
default	Default	Default response	Object

Schemas

Object

{}

Object

Properties

None

AccountsHotelAttachmentSuccess

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

AccountsHotelAttachmentSuccess

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

AccountsProductivity

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

AccountsProductivity

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

GetActiveUnsoldAirBookings

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "UserName": "string"
}

GetActiveUnsoldAirBookings

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
UserName	string	false	none	none

GetAfterHoursServicing

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "LoggedDateEnd": "string",
  "LoggedDateStart": "string",
  "UserName": "string"
}

GetAfterHoursServicing

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
LoggedDateEnd	string	false	none	none
LoggedDateStart	string	false	none	none
UserName	string	false	none	none

AgencyActivitiesByConsultant

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "EventDateEnd": "string",
  "EventDateStart": "string",
  "FormatStyle": 0,
  "OwningConsultantID": "string",
  "UserName": "string"
}

AgencyActivitiesByConsultant

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
EventDateEnd	string	false	none	none
EventDateStart	string	false	none	none
FormatStyle	integer(int32)	false	none	none
OwningConsultantID	string	false	none	none
UserName	string	false	none	none

AgencyLocationsHotelAttachmentSuccess

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "OwningAgencyLocationID": [
    "string"
  ],
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

AgencyLocationsHotelAttachmentSuccess

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
OwningAgencyLocationID	[string]	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

AgencyReviews

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "AirlineSupportFormatStyle": 0,
  "ExcludedCarrierCode": "string",
  "LoadOptions": 0,
  "Mode": 0,
  "OwningAgencyLocationID": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

AgencyReviews

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
AirlineSupportFormatStyle	integer(int32)	false	none	none
ExcludedCarrierCode	string	false	none	none
LoadOptions	integer(int32)	false	none	none
Mode	integer(int32)	false	none	none
OwningAgencyLocationID	string	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

AgencyTicketingActivity

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "EventDateEnd": "string",
  "EventDateStart": "string",
  "ItineraryFormatting": 0,
  "OwningAgencyLocationID": "string",
  "UserName": "string"
}

AgencyTicketingActivity

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
EventDateEnd	string	false	none	none
EventDateStart	string	false	none	none
ItineraryFormatting	integer(int32)	false	none	none
OwningAgencyLocationID	string	false	none	none
UserName	string	false	none	none

CompanyTicketRevenuePerPlatingCarrierService

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "CompanyID": 0,
  "DepartureDateEnd": "string",
  "DepartureDateStart": "string",
  "FlightCouponStatus": "string",
  "PlatingCarrier": "string",
  "TravelAgentID": "string"
}

CompanyTicketRevenuePerPlatingCarrierService

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
CompanyID	integer(int32)	false	none	none
DepartureDateEnd	string	false	none	none
DepartureDateStart	string	false	none	none
FlightCouponStatus	string	false	none	none
PlatingCarrier	string	false	none	none
TravelAgentID	string	false	none	none

AirSegmentsByDate

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string"
}

AirSegmentsByDate

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none

AirSegmentsPerAccountByVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string",
  "VendorCode": "string"
}

AirSegmentsPerAccountByVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none
VendorCode	string	false	none	none

AirSegmentsPerBranchByVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string",
  "VendorCode": "string"
}

AirSegmentsPerBranchByVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none
VendorCode	string	false	none	none

AirSegmentsPerCarrier

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string"
}

AirSegmentsPerCarrier

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none

AirSegmentsPerConsultantByVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string",
  "VendorCode": "string"
}

AirSegmentsPerConsultantByVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none
VendorCode	string	false	none	none

AirSegmentsPerDestinationByVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string",
  "VendorCode": "string"
}

AirSegmentsPerDestinationByVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none
VendorCode	string	false	none	none

GetBookingCountPerPcc

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string"
}

GetBookingCountPerPcc

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none

BookingsBasicByUserSameDayTicketed

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserID": 0
}

BookingsBasicByUserSameDayTicketed

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserID	integer(int32)	false	none	none

BookingsBasicByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "PNRCancelled": "string",
  "PNRCancelledDateEnd": "string",
  "PNRCancelledDateStart": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "PNRTicketed": "string",
  "TravelDateEnd": "string",
  "TravelDateStart": "string",
  "UserName": "string",
  "WithPax": "string"
}

BookingsBasicByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
PNRCancelled	string	false	none	none
PNRCancelledDateEnd	string	false	none	none
PNRCancelledDateStart	string	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
PNRTicketed	string	false	none	none
TravelDateEnd	string	false	none	none
TravelDateStart	string	false	none	none
UserName	string	false	none	none
WithPax	string	false	none	none

BookingsBasicWithPaxByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "PNRCancelled": "string",
  "PNRCancelledDateEnd": "string",
  "PNRCancelledDateStart": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "PNRTicketed": "string",
  "TravelDateEnd": "string",
  "TravelDateStart": "string",
  "UserName": "string"
}

BookingsBasicWithPaxByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
PNRCancelled	string	false	none	none
PNRCancelledDateEnd	string	false	none	none
PNRCancelledDateStart	string	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
PNRTicketed	string	false	none	none
TravelDateEnd	string	false	none	none
TravelDateStart	string	false	none	none
UserName	string	false	none	none

BookingsByAccount

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "IncludeItinerary": true,
  "ItineraryFormatting": 0,
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "Repeat": true,
  "UserName": "string"
}

BookingsByAccount

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
IncludeItinerary	boolean	false	none	none
ItineraryFormatting	integer(int32)	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
Repeat	boolean	false	none	none
UserName	string	false	none	none

BookingsByAirlineWithClassSupport

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "CarrierCode": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

BookingsByAirlineWithClassSupport

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
CarrierCode	string	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

BookingsByConsultantActivity

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "IncludeItinerary": true,
  "ItineraryFormatting": 0,
  "OwningConsultant": "string",
  "OwningConsultantID": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

BookingsByConsultantActivity

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
IncludeItinerary	boolean	false	none	none
ItineraryFormatting	integer(int32)	false	none	none
OwningConsultant	string	false	none	none
OwningConsultantID	string	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

BookingsByConsultant

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "IncludeItinerary": true,
  "ItineraryFormatting": 0,
  "OwningConsultant": "string",
  "OwningConsultantID": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

BookingsByConsultant

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
IncludeItinerary	boolean	false	none	none
ItineraryFormatting	integer(int32)	false	none	none
OwningConsultant	string	false	none	none
OwningConsultantID	string	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

BookingsCountsPerConsultant

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "OnlySummary": true,
  "OwningAgencyLocationID": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "Qualifier": "string",
  "Team": "string",
  "UserName": "string"
}

BookingsCountsPerConsultant

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
OnlySummary	boolean	false	none	none
OwningAgencyLocationID	string	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
Qualifier	string	false	none	none
Team	string	false	none	none
UserName	string	false	none	none

BookingsByTraveller

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "FirstName": "string",
  "LastName": "string",
  "TravelDateEnd": "string",
  "TravelDateStart": "string",
  "UserName": "string"
}

BookingsByTraveller

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
FirstName	string	false	none	none
LastName	string	false	none	none
TravelDateEnd	string	false	none	none
TravelDateStart	string	false	none	none
UserName	string	false	none	none

BookingsCancelled

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "PnrCancellationDateEnd": "string",
  "PnrCancellationDateStart": "string",
  "UserName": "string"
}

BookingsCancelled

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
PnrCancellationDateEnd	string	false	none	none
PnrCancellationDateStart	string	false	none	none
UserName	string	false	none	none

BookingsWithReviewDueDate

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DueDateEnd": "string",
  "DueDateStart": "string",
  "UserName": "string"
}

BookingsWithReviewDueDate

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DueDateEnd	string	false	none	none
DueDateStart	string	false	none	none
UserName	string	false	none	none

BookingsWithTAUDateByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "PNRTicketed": "string",
  "TauDateEnd": "string",
  "TauDateStart": "string",
  "TravelDateStart": "string",
  "UserName": "string"
}

BookingsWithTAUDateByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
PNRTicketed	string	false	none	PNRTicketed
TauDateEnd	string	false	none	TAU Date Range End in format YYYYMMDD
TauDateStart	string	false	none	TAU Date Range Start in format YYYYMMDD
TravelDateStart	string	false	none	TAU Date Range End in format YYYYMMDD
UserName	string	false	none	User's Email Address/Username

BookingsWithTicketDueDataByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AirlineTicketingDueDateEnd": "string",
  "AirlineTicketingDueDateStart": "string",
  "UserName": "string"
}

BookingsWithTicketDueDataByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AirlineTicketingDueDateEnd	string	false	none	none
AirlineTicketingDueDateStart	string	false	none	none
UserName	string	false	none	none

GetConsultantPnrActivity

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "ActivityDateEnd": "string",
  "ActivityDateStart": "string",
  "OnlySummary": true,
  "OwningAgencyLocationID": "string",
  "Qualifier": "string",
  "Team": "string",
  "UserName": "string"
}

GetConsultantPnrActivity

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
ActivityDateEnd	string	false	none	none
ActivityDateStart	string	false	none	none
OnlySummary	boolean	false	none	none
OwningAgencyLocationID	string	false	none	none
Qualifier	string	false	none	none
Team	string	false	none	none
UserName	string	false	none	none

ConsultantsProductivity

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "OwningAgencyLocationID": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

ConsultantsProductivity

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
OwningAgencyLocationID	string	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

ConsultantsGdsSegmentPerformance

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "OwningAgencyLocationID": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

ConsultantsGdsSegmentPerformance

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
OwningAgencyLocationID	string	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

CorporateLongTermArrivals

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "ArrivalDateEnd": "string",
  "ArrivalDateStart": "string",
  "UserName": "string"
}

CorporateLongTermArrivals

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
ArrivalDateEnd	string	false	none	none
ArrivalDateStart	string	false	none	none
UserName	string	false	none	none

GetGDSDestinations

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "UserName": "string"
}

GetGDSDestinations

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
UserName	string	false	none	none

HotelSegmentsByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "ArrivalDateEnd": "string",
  "ArrivalDateStart": "string",
  "UserName": "string"
}

HotelSegmentsByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
ArrivalDateEnd	string	false	none	none
ArrivalDateStart	string	false	none	none
UserName	string	false	none	none

GetItineraryChangeEventsSummary

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "AddDILine": "string",
  "ChangeDateEnd": "string",
  "ChangeDateStart": "string",
  "UserName": "string"
}

GetItineraryChangeEventsSummary

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	Comma Delimited List of Accounts
AddDILine	string	false	none	Comma Delimited List of Accounts
ChangeDateEnd	string	false	none	End Date in format YYYYMMDD
ChangeDateStart	string	false	none	Start Date in format YYYYMMDD
UserName	string	false	none	UserName

BookingsByGDSDestination

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Destination": "string",
  "PlacementDateEnd": "string",
  "PlacementDateStart": "string",
  "UserName": "string"
}

BookingsByGDSDestination

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Destination	string	false	none	none
PlacementDateEnd	string	false	none	none
PlacementDateStart	string	false	none	none
UserName	string	false	none	none

GetPARUsagePerCompany

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "UserName": "string"
}

GetPARUsagePerCompany

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
UserName	string	false	none	none

GetPARUsagePerUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string"
}

GetPARUsagePerUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none

PassengerAirSegmentsWithMaxTravellerMembersByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "DepartureDateEnd": "string",
  "DepartureDateStart": "string",
  "GroupId": [
    0
  ],
  "MaxTravellerIsExceededFlag": "string",
  "UserName": "string"
}

PassengerAirSegmentsWithMaxTravellerMembersByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
DepartureDateEnd	string	false	none	none
DepartureDateStart	string	false	none	none
GroupId	[integer]	false	none	none
MaxTravellerIsExceededFlag	string	false	none	none
UserName	string	false	none	none

PassengerDepartures

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "AddTransfers": true,
  "AddVouchers": true,
  "Carrier": [
    "string"
  ],
  "ClassName": [
    "string"
  ],
  "IncludeItinerary": true,
  "IsVip": true,
  "ItineraryFormatting": 0,
  "TravelDateEnd": "string",
  "TravelDateStart": "string",
  "UserName": "string",
  "WithSMS": true
}

PassengerDepartures

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
AddTransfers	boolean	false	none	none
AddVouchers	boolean	false	none	none
Carrier	[string]	false	none	none
ClassName	[string]	false	none	none
IncludeItinerary	boolean	false	none	none
IsVip	boolean	false	none	none
ItineraryFormatting	integer(int32)	false	none	none
TravelDateEnd	string	false	none	none
TravelDateStart	string	false	none	none
UserName	string	false	none	none
WithSMS	boolean	false	none	none

PassengerLocationHotelsByUserCity

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AccountList": [
    "string"
  ],
  "CityCode": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "InTransitOnly": true,
  "UserName": "string"
}

PassengerLocationHotelsByUserCity

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AccountList	[string]	false	none	none
CityCode	string	false	none	none
DateEnd	string	false	none	none
DateStart	string	false	none	none
InTransitOnly	boolean	false	none	none
UserName	string	false	none	none

PassengerLocationsByUserAirport

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AccountList": [
    "string"
  ],
  "AirportCode": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "InTransitOnly": true,
  "UserName": "string"
}

PassengerLocationsByUserAirport

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AccountList	[string]	false	none	none
AirportCode	string	false	none	none
DateEnd	string	false	none	none
DateStart	string	false	none	none
InTransitOnly	boolean	false	none	none
UserName	string	false	none	none

PassengerLocationsByUserAirVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AccountList": [
    "string"
  ],
  "AirVendor": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "InTransitOnly": true,
  "UserName": "string"
}

PassengerLocationsByUserAirVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AccountList	[string]	false	none	none
AirVendor	string	false	none	none
DateEnd	string	false	none	none
DateStart	string	false	none	none
InTransitOnly	boolean	false	none	none
UserName	string	false	none	none

PassengerLocationsByUserCity

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AccountList": [
    "string"
  ],
  "CityCode": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "HotelName": "string",
  "InTransitOnly": true,
  "UserName": "string",
  "WithHotel": true
}

PassengerLocationsByUserCity

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AccountList	[string]	false	none	none
CityCode	string	false	none	none
DateEnd	string	false	none	none
DateStart	string	false	none	none
HotelName	string	false	none	none
InTransitOnly	boolean	false	none	none
UserName	string	false	none	none
WithHotel	boolean	false	none	none

PassengerLocationsByUserCountry

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AccountList": [
    "string"
  ],
  "CountryCode": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "InTransitOnly": true,
  "UserName": "string"
}

PassengerLocationsByUserCountry

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AccountList	[string]	false	none	none
CountryCode	string	false	none	none
DateEnd	string	false	none	none
DateStart	string	false	none	none
InTransitOnly	boolean	false	none	none
UserName	string	false	none	none

PassiveSegmentsByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "ArrivalDateEnd": "string",
  "ArrivalDateStart": "string",
  "SegmentType": "string",
  "UserName": "string"
}

PassiveSegmentsByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
ArrivalDateEnd	string	false	none	none
ArrivalDateStart	string	false	none	none
SegmentType	string	false	none	none
UserName	string	false	none	none

PNROriginatingCountries

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "UserName": "string"
}

PNROriginatingCountries

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
UserName	string	false	none	none

PNRSegmentCountsByCompanyAgentLocation2

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AgentLocationCountryCode": "string",
  "OwningAgencyLocationID": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

PNRSegmentCountsByCompanyAgentLocation2

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AgentLocationCountryCode	string	false	none	none
OwningAgencyLocationID	string	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

ProblematicSegmentsByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DepartureDateEnd": "string",
  "DepartureDateStart": "string",
  "UserName": "string"
}

ProblematicSegmentsByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DepartureDateEnd	string	false	none	none
DepartureDateStart	string	false	none	none
UserName	string	false	none	none

GetQcCommentsForConsultant

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AgentInitials": "string",
  "Consultant": "string",
  "DateByComments": true,
  "DateEnd": "string",
  "DateStart": "string",
  "GroupByAgentInitials": true,
  "OwningAgencyLocationID": "string",
  "Team": "string",
  "UserName": "string"
}

GetQcCommentsForConsultant

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AgentInitials	string	false	none	none
Consultant	string	false	none	none
DateByComments	boolean	false	none	none
DateEnd	string	false	none	none
DateStart	string	false	none	none
GroupByAgentInitials	boolean	false	none	none
OwningAgencyLocationID	string	false	none	none
Team	string	false	none	none
UserName	string	false	none	none

GetQcComments

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateByComments": true,
  "DateEnd": "string",
  "DateStart": "string",
  "GroupByAgentInitials": true,
  "OwningAgencyLocationID": "string",
  "Team": "string",
  "UserName": "string"
}

GetQcComments

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateByComments	boolean	false	none	none
DateEnd	string	false	none	none
DateStart	string	false	none	none
GroupByAgentInitials	boolean	false	none	none
OwningAgencyLocationID	string	false	none	none
Team	string	false	none	none
UserName	string	false	none	none

QLogEm

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "CompanyID": 0,
  "LogDateEnd": "string",
  "LogDateStart": "string",
  "QueueEntryID": 0
}

QLogEm

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
CompanyID	integer(int32)	false	none	none
LogDateEnd	string	false	none	none
LogDateStart	string	false	none	none
QueueEntryID	integer(int32)	false	none	none

QLogForward

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "CompanyID": 0,
  "LogDateEnd": "string",
  "LogDateStart": "string",
  "QueueEntryID": 0
}

QLogForward

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
CompanyID	integer(int32)	false	none	none
LogDateEnd	string	false	none	none
LogDateStart	string	false	none	none
QueueEntryID	integer(int32)	false	none	none

QLogIgnored

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "LogDateEnd": "string",
  "LogDateStart": "string",
  "Queue": "string",
  "SiteID": 0
}

QLogIgnored

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
LogDateEnd	string	false	none	none
LogDateStart	string	false	none	none
Queue	string	false	none	none
SiteID	integer(int32)	false	none	none

QSorterLogErrors

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string"
}

QSorterLogErrors

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none

GetRemarkQualifier

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Consultant": "string",
  "CountryCount": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "OwningAgencyLocationID": "string",
  "Qualifier": "string",
  "Team": "string",
  "UserName": "string"
}

GetRemarkQualifier

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Consultant	string	false	none	none
CountryCount	string	false	none	none
DateEnd	string	false	none	none
DateStart	string	false	none	none
OwningAgencyLocationID	string	false	none	none
Qualifier	string	false	none	none
Team	string	false	none	none
UserName	string	false	none	none

GetRMQServicesLog

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "RMQService": "string",
  "UserName": "string"
}

GetRMQServicesLog

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
RMQService	string	false	none	none
UserName	string	false	none	none

GetPNRTotalsPerCompany

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string"
}

GetPNRTotalsPerCompany

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none

GetTicketCouponCodes

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "UserName": "string"
}

GetTicketCouponCodes

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
UserName	string	false	none	none

GetTicketCouponsByStatusCode

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "CarrierCode": "string",
  "CouponCodeGroup": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "DateTracker": "string",
  "IncludePartialMatches": true,
  "NoActiveSegments": true,
  "OwningConsultantID": "string",
  "PaxSurname": "string",
  "Repeat": true,
  "TravAgntID": "string",
  "UserName": "string"
}

GetTicketCouponsByStatusCode

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
CarrierCode	string	false	none	none
CouponCodeGroup	string	false	none	none
DateEnd	string	false	none	none
DateStart	string	false	none	none
DateTracker	string	false	none	none
IncludePartialMatches	boolean	false	none	none
NoActiveSegments	boolean	false	none	none
OwningConsultantID	string	false	none	none
PaxSurname	string	false	none	none
Repeat	boolean	false	none	none
TravAgntID	string	false	none	none
UserName	string	false	none	none

TicketCouponsIssuedByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "FlightCouponStatus": "string",
  "FormatStyle": "string",
  "IssueDateEnd": "string",
  "IssueDateStart": "string",
  "TravelAgentID": "string",
  "UserName": "string"
}

TicketCouponsIssuedByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
FlightCouponStatus	string	false	none	none
FormatStyle	string	false	none	none
IssueDateEnd	string	false	none	none
IssueDateStart	string	false	none	none
TravelAgentID	string	false	none	none
UserName	string	false	none	none

GetHotelWithNoRateCodeCreated

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "Username": "string"
}

GetHotelWithNoRateCodeCreated

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
Username	string	false	none	none

UserCorporateTrackerByDateRangeRequest

{
  "Account": "string",
  "EmailID": 0,
  "UserID": 0
}

UserCorporateTrackerByDateRangeRequest

Properties

Name	Type	Required	Restrictions	Description
Account	string	false	none	none
EmailID	integer(int32)	false	none	none
UserID	integer(int32)	false	none	none

UserItineraryChangesRequest

{
  "UserID": 0
}

UserItineraryChangesRequest

Properties

Name	Type	Required	Restrictions	Description
UserID	integer(int32)	false	none	none

UserBookingsCreatedWithoutNameRemarkByDateRangeRequest

{
  "UserID": 0
}

UserBookingsCreatedWithoutNameRemarkByDateRangeRequest

Properties

Name	Type	Required	Restrictions	Description
UserID	integer(int32)	false	none	none

UserAgencyTrackerByDateRangeRequest

{
  "UserID": 0
}

UserAgencyTrackerByDateRangeRequest

Properties

Name	Type	Required	Restrictions	Description
UserID	integer(int32)	false	none	none

UserTravellersByDateRangeRequest

{
  "UserID": 0
}

UserTravellersByDateRangeRequest

Properties

Name	Type	Required	Restrictions	Description
UserID	integer(int32)	false	none	none

UserIssuedTicketsRequest

{
  "EndDate": "string",
  "StartDate": "string",
  "UserID": 0
}

UserIssuedTicketsRequest

Properties

Name	Type	Required	Restrictions	Description
EndDate	string	false	none	none
StartDate	string	false	none	none
UserID	integer(int32)	false	none	none

UserCorporateArrivalsRequest

{
  "Account": "string",
  "EndDate": "string",
  "StartDate": "string",
  "UserID": 0
}

UserCorporateArrivalsRequest

Properties

Name	Type	Required	Restrictions	Description
Account	string	false	none	none
EndDate	string	false	none	none
StartDate	string	false	none	none
UserID	integer(int32)	false	none	none

BookingsTravelling

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "HasAccount": true,
  "HasEmail": true,
  "HasHotel": true,
  "HasMobile": true,
  "IncludeItinerary": true,
  "ItineraryFormatting": 0,
  "MinSegments": 0,
  "MissingEmailOrPhone": true,
  "TravelDateEnd": "string",
  "TravelDateStart": "string",
  "UserName": "string"
}

BookingsTravelling

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
HasAccount	boolean	false	none	none
HasEmail	boolean	false	none	none
HasHotel	boolean	false	none	none
HasMobile	boolean	false	none	none
IncludeItinerary	boolean	false	none	none
ItineraryFormatting	integer(int32)	false	none	none
MinSegments	integer(int32)	false	none	none
MissingEmailOrPhone	boolean	false	none	none
TravelDateEnd	string	false	none	none
TravelDateStart	string	false	none	none
UserName	string	false	none	none

BookingsLapsedToEvent

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "CarrierCode": "string",
  "EventDateEnd": "string",
  "EventDateStart": "string",
  "EventType": "string",
  "UserName": "string"
}

BookingsLapsedToEvent

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
CarrierCode	string	false	none	none
EventDateEnd	string	false	none	none
EventDateStart	string	false	none	none
EventType	string	false	none	none
UserName	string	false	none	none

BookingsTicketTravelDates

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "AddDILine": true,
  "AddDivisionCode": true,
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

BookingsTicketTravelDates

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
AddDILine	boolean	false	none	none
AddDivisionCode	boolean	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

BookingsWithTicketDueDataByUser2

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "TicketingDueDateStart": "string",
  "UserName": "string"
}

BookingsWithTicketDueDataByUser2

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
TicketingDueDateStart	string	false	none	none
UserName	string	false	none	none

CarSegmentCountsPerAccountByVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string",
  "VendorCode": "string"
}

CarSegmentCountsPerAccountByVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none
VendorCode	string	false	none	none

CarSegmentCountsPerBranchByVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string",
  "VendorCode": "string"
}

CarSegmentCountsPerBranchByVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none
VendorCode	string	false	none	none

CarSegmentCountsPerConsultantByVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string",
  "VendorCode": "string"
}

CarSegmentCountsPerConsultantByVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none
VendorCode	string	false	none	none

CarSegmentCountsPerLocationByVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string",
  "VendorCode": "string"
}

CarSegmentCountsPerLocationByVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none
VendorCode	string	false	none	none

CarSegmentCountsPerVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string"
}

CarSegmentCountsPerVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none

CarSegmentsByDate

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "SegmentType": "string",
  "UserName": "string"
}

CarSegmentsByDate

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
SegmentType	string	false	none	none
UserName	string	false	none	none

ConferencesByRemark

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateStart": "string",
  "Qualifier": "string",
  "Remark": "string",
  "UserName": "string"
}

ConferencesByRemark

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateStart	string	false	none	none
Qualifier	string	false	none	none
Remark	string	false	none	none
UserName	string	false	none	none

CorporateTrackerBookings

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "ItineraryFormatting": 0,
  "ItinerarySegmentsToShow": "string",
  "TravelDateEnd": "string",
  "TravelDateStart": "string",
  "UserName": "string"
}

CorporateTrackerBookings

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
ItineraryFormatting	integer(int32)	false	none	none
ItinerarySegmentsToShow	string	false	none	none
TravelDateEnd	string	false	none	none
TravelDateStart	string	false	none	none
UserName	string	false	none	none

DashboardStatsByOptions

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "MostActiveUsersDaysSpan": 0,
  "MostActiveUsersTop": 0,
  "Options": 0,
  "ReportsDaysSpan": 0,
  "ReportsTop": 0,
  "UserName": "string"
}

DashboardStatsByOptions

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
MostActiveUsersDaysSpan	integer(int32)	false	none	none
MostActiveUsersTop	integer(int32)	false	none	none
Options	integer(int32)	false	none	none
ReportsDaysSpan	integer(int32)	false	none	none
ReportsTop	integer(int32)	false	none	none
UserName	string	false	none	none

FindBookings

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AirlineLocator": "string",
  "RecordLocator": "string",
  "Surname": "string",
  "UserName": "string"
}

FindBookings

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AirlineLocator	string	false	none	none
RecordLocator	string	false	none	none
Surname	string	false	none	none
UserName	string	false	none	none

HotelLocSegmentCountsPerChainByCity

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "CityCode": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string"
}

HotelLocSegmentCountsPerChainByCity

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
CityCode	string	false	none	none
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none

HotelLocSegmentCountsPerPropertyByCity

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "CityCode": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string",
  "VendorCode": "string"
}

HotelLocSegmentCountsPerPropertyByCity

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
CityCode	string	false	none	none
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none
VendorCode	string	false	none	none

HotelSegmentCountsPerAccountByVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string",
  "VendorCode": "string"
}

HotelSegmentCountsPerAccountByVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none
VendorCode	string	false	none	none

HotelSegmentCountsPerBranchByVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string",
  "VendorCode": "string"
}

HotelSegmentCountsPerBranchByVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none
VendorCode	string	false	none	none

HotelSegmentCountsPerConsultantByVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string",
  "VendorCode": "string"
}

HotelSegmentCountsPerConsultantByVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none
VendorCode	string	false	none	none

HotelSegmentCountsPerLocationByVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string",
  "VendorCode": "string"
}

HotelSegmentCountsPerLocationByVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none
VendorCode	string	false	none	none

HotelSegmentCountsPerVendor

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string"
}

HotelSegmentCountsPerVendor

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none

ItineraryChangeDetailByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "ChangeDateEnd": "string",
  "ChangeDateStart": "string",
  "CompanyID": null,
  "UserName": "string"
}

ItineraryChangeDetailByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
ChangeDateEnd	string	false	none	End Date in format YYYYMMDD
ChangeDateStart	string	false	none	Start Date in format YYYYMMDD
CompanyID	int(int32)	false	none	ID for your Company
UserName	string	false	none	UserName

ArrivalsWithDestinationsByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "ArrivalDateEnd": "string",
  "ArrivalDateStart": "string",
  "CompanyID": 0,
  "UserName": "string"
}

ArrivalsWithDestinationsByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
ArrivalDateEnd	string	false	none	none
ArrivalDateStart	string	false	none	none
CompanyID	integer(int32)	false	none	none
UserName	string	false	none	none

BookingsCreated

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "HasAccount": true,
  "HasEmail": true,
  "HasHotel": true,
  "HasMobile": true,
  "IncludeItinerary": true,
  "IsVip": true,
  "ItineraryFormatting": 0,
  "MinSegments": 0,
  "MissingEmailOrPhone": true,
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

BookingsCreated

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	Comma Delimited List of Accounts
HasAccount	boolean	false	none	Return only PNRs with/without an Account
HasEmail	boolean	false	none	Return only PNRs with/without an email address
HasHotel	boolean	false	none	Return only PNRs with/without a Hotel segment
HasMobile	boolean	false	none	Return only PNRs with/without a mobile number
IncludeItinerary	boolean	false	none	Include Itinerary in the response
IsVip	boolean	false	none	Return only PNRs that are or are not flagged as VIP bookings
ItineraryFormatting	integer(int32)	false	none	Indicaed the required formatting: 0=None(Default), 1= Html, 2 = Chart
MinSegments	integer(int32)	false	none	Return only PNRs that equal or exceed a certain number of segments
MissingEmailOrPhone	boolean	false	none	Return only PNRs with/without an email address OR a mobile number
PNRCreationDateEnd	string	false	none	End Date in format YYYYMMDD
PNRCreationDateStart	string	false	none	Start Date in format YYYYMMDD
UserName	string	false	none	UserName

HotelBookingsByRateCode

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "Formatting": 0,
  "HasRateCode": true,
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

HotelBookingsByRateCode

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
Formatting	integer(int32)	false	none	none
HasRateCode	boolean	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

ItineraryChangeEvents

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "AddDILine": "string",
  "ChangeDateEnd": "string",
  "ChangeDateStart": "string",
  "UserName": "string"
}

ItineraryChangeEvents

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	Comma Delimited List of Accounts
AddDILine	string	false	none	AddDILine
ChangeDateEnd	string	false	none	End Date in format YYYYMMDD
ChangeDateStart	string	false	none	Start Date in format YYYYMMDD
UserName	string	false	none	UserName

AirlineTicketRevenueByCompany

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AirlineCode": "string",
  "DepartureDateEnd": "string",
  "DepartureDateStart": "string",
  "FlightCouponStatus": "string",
  "PlatingCarrier": "string",
  "TravelAgentID": "string",
  "UserName": "string"
}

AirlineTicketRevenueByCompany

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AirlineCode	string	false	none	none
DepartureDateEnd	string	false	none	none
DepartureDateStart	string	false	none	none
FlightCouponStatus	string	false	none	none
PlatingCarrier	string	false	none	none
TravelAgentID	string	false	none	none
UserName	string	false	none	none

BookingDetailsByRef

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AgentivityRef": 0,
  "LoadOptions": 0,
  "Username": "string"
}

BookingDetailsByRef

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AgentivityRef	integer(int32)	false	none	none
LoadOptions	integer(int32)	false	none	none
Username	string	false	none	none

MirGenerationLogByAccount

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string"
}

MirGenerationLogByAccount

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none

MissedHotelOpportunitiesByCity

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "CityCode": "string",
  "TravelDateEnd": "string",
  "TravelDateStart": "string",
  "UserName": "string"
}

MissedHotelOpportunitiesByCity

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
CityCode	string	false	none	none
TravelDateEnd	string	false	none	none
TravelDateStart	string	false	none	none
UserName	string	false	none	none

MissedHotelOpportunitiesPerCity

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "TravelDateEnd": "string",
  "TravelDateStart": "string",
  "UserName": "string"
}

MissedHotelOpportunitiesPerCity

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
TravelDateEnd	string	false	none	none
TravelDateStart	string	false	none	none
UserName	string	false	none	none

PassengerAirSegmentsWithMaxTravellerFlagByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "DepartureDateEnd": "string",
  "DepartureDateStart": "string",
  "MaxTravellerIsExceededFlag": "string",
  "UserName": "string"
}

PassengerAirSegmentsWithMaxTravellerFlagByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
DepartureDateEnd	string	false	none	none
DepartureDateStart	string	false	none	none
MaxTravellerIsExceededFlag	string	false	none	none
UserName	string	false	none	none

BookingsByAirSegmentsCount

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AccountList": [
    "string"
  ],
  "MinAirSegments": 0,
  "PNRCancelled": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

BookingsByAirSegmentsCount

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AccountList	[string]	false	none	none
MinAirSegments	integer(int32)	false	none	none
PNRCancelled	string	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

BookingsBasicWithoutMobileByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "TicketedDateEnd": "string",
  "TicketedDateStart": "string",
  "UserName": "string"
}

BookingsBasicWithoutMobileByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
TicketedDateEnd	string	false	none	none
TicketedDateStart	string	false	none	none
UserName	string	false	none	none

BookingsTurnAround

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

BookingsTurnAround

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

CountryPassengerCountsByCompany

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "ArrivalDate": "string",
  "CompanyID": "string",
  "DepartureDate": "string",
  "InTransitOnly": true
}

CountryPassengerCountsByCompany

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
ArrivalDate	string	false	none	none
CompanyID	string	false	none	none
DepartureDate	string	false	none	none
InTransitOnly	boolean	false	none	none

EventBookingsRequest

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "EventCode": "string",
  "FormattingStyle": 0,
  "IncludeNotes": true,
  "ItinerarySegmentsToShow": "string",
  "SplitMultiplePassengers": true,
  "UserName": "string"
}

EventBookingsRequest

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
EventCode	string	false	none	none
FormattingStyle	integer(int32)	false	none	none
IncludeNotes	boolean	false	none	none
ItinerarySegmentsToShow	string	false	none	none
SplitMultiplePassengers	boolean	false	none	none
UserName	string	false	none	none

PartnerBookingsDataCapture

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "PCCList": [
    "string"
  ],
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

PartnerBookingsDataCapture

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
PCCList	[string]	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

PassengerArrivals

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "ArrivalDateEnd": "string",
  "ArrivalDateStart": "string",
  "UserName": "string"
}

PassengerArrivals

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
ArrivalDateEnd	string	false	none	none
ArrivalDateStart	string	false	none	none
UserName	string	false	none	none

PassengerLocationsByAirline

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AccountList": [
    "string"
  ],
  "CarrierCode": "string",
  "CityCode": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string"
}

PassengerLocationsByAirline

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AccountList	[string]	false	none	none
CarrierCode	string	false	none	none
CityCode	string	false	none	none
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none

PassengerLocationsByFlightNumber

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AccountList": [
    "string"
  ],
  "AllFutureDate": true,
  "CarrierCode": "string",
  "DepartureDateEnd": "string",
  "DepartureDateStart": "string",
  "FlightNumber": "string",
  "UserName": "string"
}

PassengerLocationsByFlightNumber

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AccountList	[string]	false	none	none
AllFutureDate	boolean	false	none	none
CarrierCode	string	false	none	none
DepartureDateEnd	string	false	none	none
DepartureDateStart	string	false	none	none
FlightNumber	string	false	none	none
UserName	string	false	none	none

Rebookings

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "OwningAgencyLocationID": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

Rebookings

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
OwningAgencyLocationID	string	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

DuplicateBookings

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "OwningAgencyLocationID": "string",
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

DuplicateBookings

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
OwningAgencyLocationID	string	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

RoutingInstancesByCity

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "DestinationCity": "string",
  "UserName": "string"
}

RoutingInstancesByCity

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
DestinationCity	string	false	none	none
UserName	string	false	none	none

RoutingInstancesPerCity

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string"
}

RoutingInstancesPerCity

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none

SegmentsQC

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "DepartureDateEnd": "string",
  "DepartureDateStart": "string",
  "UserName": "string",
  "VipOnly": true
}

SegmentsQC

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
DepartureDateEnd	string	false	none	none
DepartureDateStart	string	false	none	none
UserName	string	false	none	none
VipOnly	boolean	false	none	none

GetTicketAutomationSuccessPerPCC

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "UserName": "string"
}

GetTicketAutomationSuccessPerPCC

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
UserName	string	false	none	none

TicketDetails

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "CacheGuid": "string",
  "TktNumber": "string",
  "UserName": "string"
}

TicketDetails

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
CacheGuid	string	false	none	none
TktNumber	string	false	none	none
UserName	string	false	none	none

TicketingStatsRequest

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "AccountList": [
    "string"
  ],
  "TicketingDateEnd": "string",
  "TicketingDateStart": "string",
  "UserName": "string"
}

TicketingStatsRequest

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
AccountList	[string]	false	none	none
TicketingDateEnd	string	false	none	none
TicketingDateStart	string	false	none	none
UserName	string	false	none	none

TicketRevalidations

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "OwningAgencyLocationID": "string",
  "OwningConsultantID": "string",
  "ReportType": "string",
  "RevalidatedDateEnd": "string",
  "RevalidatedDateStart": "string",
  "UserName": "string"
}

TicketRevalidations

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
OwningAgencyLocationID	string	false	none	none
OwningConsultantID	string	false	none	none
ReportType	string	false	none	none
RevalidatedDateEnd	string	false	none	none
RevalidatedDateStart	string	false	none	none
UserName	string	false	none	none

AirSegmentsWithVendorLocatorsByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "DepartureDateEnd": "string",
  "DepartureDateStart": "string",
  "UserName": "string"
}

AirSegmentsWithVendorLocatorsByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
DepartureDateEnd	string	false	none	none
DepartureDateStart	string	false	none	none
UserName	string	false	none	none

GetTicketsIssuedByNumber

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "TktNumber": "string",
  "UserName": "string"
}

GetTicketsIssuedByNumber

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
TktNumber	string	false	none	none
UserName	string	false	none	none

GetTicketsIssued

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "DateEnd": "string",
  "DateStart": "string",
  "IATA": "string",
  "UserName": "string"
}

GetTicketsIssued

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
DateEnd	string	false	none	none
DateStart	string	false	none	none
IATA	string	false	none	none
UserName	string	false	none	none

TicketSegmentsWithTaxByIssueDate

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "TicketIssueDateEnd": "string",
  "TicketIssueDateStart": "string",
  "UserName": "string"
}

TicketSegmentsWithTaxByIssueDate

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
TicketIssueDateEnd	string	false	none	none
TicketIssueDateStart	string	false	none	none
UserName	string	false	none	none

TicketsByAccount

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "TicketIssueEndDate": "string",
  "TicketIssueStartDate": "string",
  "UserName": "string"
}

TicketsByAccount

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
TicketIssueEndDate	string	false	none	none
TicketIssueStartDate	string	false	none	none
UserName	string	false	none	none

TicketTrackingFailuresByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "CompanyID": 0,
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

TicketTrackingFailuresByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
CompanyID	integer(int32)	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

PassengerBookingCountsByAccountAndGenRemark

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "CompanyID": 0,
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "Qualifier": "string",
  "Remark": "string"
}

PassengerBookingCountsByAccountAndGenRemark

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
CompanyID	integer(int32)	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
Qualifier	string	false	none	none
Remark	string	false	none	none

CorporateAccountTicketingActivityPerDayByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "ActivityDate": "string",
  "CompanyID": 0,
  "UserName": "string"
}

CorporateAccountTicketingActivityPerDayByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
ActivityDate	string	false	none	none
CompanyID	integer(int32)	false	none	none
UserName	string	false	none	none

AirlineDemandsForTicketingByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "CompanyID": 0,
  "DueDate": "string",
  "UserName": "string"
}

AirlineDemandsForTicketingByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
CompanyID	integer(int32)	false	none	none
DueDate	string	false	none	none
UserName	string	false	none	none

BookingsWithDestinationsByTraveller

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "CompanyID": "string",
  "PNRTicketed": "string",
  "TravelDateEnd": "string",
  "TravelDateStart": "string",
  "TravellerEmail": "string",
  "TravellerPhoneNbr": "string",
  "TravellerReference": "string"
}

BookingsWithDestinationsByTraveller

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
CompanyID	string(int32)	false	none	ID for your Company
PNRTicketed	string	false	none	True/False or Yes/No
TravelDateEnd	string	false	none	End Date in format YYYYMMDD
TravelDateStart	string	false	none	Start Date in format YYYYMMDD
TravellerEmail	string	false	none	Email of the traveller
TravellerPhoneNbr	string	false	none	Phone Number of the traveller
TravellerReference	string	false	none	Traveller Reference

SegmentsByPNR

{
  "PassiveSegmentType": "string",
  "PNRCreationDate": "string",
  "RecordLocator": "string",
  "SegmentType": "string"
}

SegmentsByPNR

Properties

Name	Type	Required	Restrictions	Description
PassiveSegmentType	string	false	none	Type of passive segment
PNRCreationDate	string	false	none	Start Date in format YYYYMMDD
RecordLocator	string	false	none	RecordLocator
SegmentType	string	false	none	Type of segment

TravelHistorySummaryByTraveller

{
  "CompanyID": null,
  "PNRTicketed": "string",
  "TravelDateEnd": "string",
  "TravelDateStart": "string",
  "TravellerEmail": "string",
  "TravellerPhoneNbr": "string",
  "TravellerReference": "string"
}

TravelHistorySummaryByTraveller

Properties

Name	Type	Required	Restrictions	Description
CompanyID	int(int32)	false	none	ID for your Company
PNRTicketed	string	false	none	True/False or Yes/No
TravelDateEnd	string	false	none	End Date in format YYYYMMDD
TravelDateStart	string	false	none	Start Date in format YYYYMMDD
TravellerEmail	string	false	none	Email of the traveller
TravellerPhoneNbr	string	false	none	Phone Number of the traveller
TravellerReference	string	false	none	Traveller Reference

PCCAccountSupplierPreferencesRequest

{
  "Account": "string",
  "PCC": "string"
}

PCCAccountSupplierPreferencesRequest

Properties

Name	Type	Required	Restrictions	Description
Account	string	false	none	none
PCC	string	false	none	none

PCCTravellerTicketSegmentsPerStatusRequest

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "BAR": "string",
  "FlightCouponStatus": "string",
  "PAR": "string",
  "PCC": "string"
}

PCCTravellerTicketSegmentsPerStatusRequest

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
BAR	string	false	none	none
FlightCouponStatus	string	false	none	none
PAR	string	false	none	none
PCC	string	false	none	none

PCCTravellerHistorySummaryRequest

{
  "BAR": "string",
  "MAR": "string",
  "PAR": "string",
  "PCC": "string"
}

PCCTravellerHistorySummaryRequest

Properties

Name	Type	Required	Restrictions	Description
BAR	string	false	none	none
MAR	string	false	none	none
PAR	string	false	none	none
PCC	string	false	none	none

PCCTravellerBookingHistoryRequest

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "BAR": "string",
  "CityCode": "string",
  "Count": 0,
  "EndDate": "string",
  "MAR": "string",
  "OptionalParameters": "string",
  "PAR": "string",
  "PCC": "string",
  "StartDate": "string"
}

PCCTravellerBookingHistoryRequest

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
BAR	string	false	none	none
CityCode	string	false	none	none
Count	integer(int32)	false	none	none
EndDate	string	false	none	none
MAR	string	false	none	none
OptionalParameters	string	false	none	none
PAR	string	false	none	none
PCC	string	false	none	none
StartDate	string	false	none	none

PNRSegmentsRequest

{
  "PNRCreationDate": "string",
  "RecordLocator": "string"
}

PNRSegmentsRequest

Properties

Name	Type	Required	Restrictions	Description
PNRCreationDate	string	false	none	none
RecordLocator	string	false	none	none

CarSegmentsByUser

{
  "PickUpDateEnd": "string",
  "PickUpDateStart": "string",
  "UserName": "string"
}

CarSegmentsByUser

Properties

Name	Type	Required	Restrictions	Description
PickUpDateEnd	string	false	none	none
PickUpDateStart	string	false	none	none
UserName	string	false	none	none

AccountEventAndSegmentCountsByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": [
    "string"
  ],
  "PNRCreationDateEnd": "string",
  "PNRCreationDateStart": "string",
  "UserName": "string"
}

AccountEventAndSegmentCountsByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	[string]	false	none	none
PNRCreationDateEnd	string	false	none	none
PNRCreationDateStart	string	false	none	none
UserName	string	false	none	none

TicketSegmentsByBAR

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "BAR": "string",
  "FlightCouponStatus": "string",
  "OwningAgencyLocationID": "string",
  "PAR": "string"
}

TicketSegmentsByBAR

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
BAR	string	false	none	none
FlightCouponStatus	string	false	none	none
OwningAgencyLocationID	string	false	none	none
PAR	string	false	none	none

TravelHistorySummaryByBAR

{
  "BAR": "string",
  "MAR": "string",
  "OwningAgencyLocationID": "string",
  "PAR": "string"
}

TravelHistorySummaryByBAR

Properties

Name	Type	Required	Restrictions	Description
BAR	string	false	none	none
MAR	string	false	none	none
OwningAgencyLocationID	string	false	none	none
PAR	string	false	none	none

BookingHistoryByBAR

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "BAR": "string",
  "CityCode": "string",
  "Count": 0,
  "MAR": "string",
  "OwningAgencyLocationID": "string",
  "PAR": "string",
  "TravelDateEnd": "string",
  "TravelDateStart": "string"
}

BookingHistoryByBAR

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
BAR	string	false	none	none
CityCode	string	false	none	none
Count	integer(int32)	false	none	none
MAR	string	false	none	none
OwningAgencyLocationID	string	false	none	none
PAR	string	false	none	none
TravelDateEnd	string	false	none	none
TravelDateStart	string	false	none	none

SupplierPreferencesByOwningAgencyLocationID

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "OwningAgencyLocationID": "string"
}

SupplierPreferencesByOwningAgencyLocationID

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
OwningAgencyLocationID	string	false	none	none

LocationListsRequest

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Formatted": true,
  "Options": 0
}

LocationListsRequest

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Formatted	boolean	false	none	none
Options	integer(int32)	false	none	none

CreateTravellerFlightMember

{
  "GroupID": 0,
  "TravellerID": 0,
  "CompanyID": 0
}

CreateTravellerFlightMember

Properties

Name	Type	Required	Restrictions	Description
GroupID	integer(int32)	false	none	none
TravellerID	integer(int32)	false	none	none
CompanyID	integer(int32)	false	none	none

DeleteTravellerFlightMember

{
  "GroupID": 0,
  "TravellerID": 0,
  "Rowversion": 0
}

DeleteTravellerFlightMember

Properties

Name	Type	Required	Restrictions	Description
GroupID	integer(int32)	false	none	none
TravellerID	integer(int32)	false	none	none
Rowversion	integer(int64)	false	none	none

TravellersByAccount

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "UserName": "string"
}

TravellersByAccount

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
UserName	string	false	none	none

CancelledHotelSegmentsByUser

{
  "CancelledDateEnd": "string",
  "CancelledDateStart": "string",
  "UserID": 0
}

CancelledHotelSegmentsByUser

Properties

Name	Type	Required	Restrictions	Description
CancelledDateEnd	string	false	none	none
CancelledDateStart	string	false	none	none
UserID	integer(int32)	false	none	none

HotelSegmentsWithNotepadByUser

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Account": "string",
  "ArrivalDateEnd": "string",
  "ArrivalDateStart": "string",
  "UserName": "string"
}

HotelSegmentsWithNotepadByUser

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Account	string	false	none	none
ArrivalDateEnd	string	false	none	none
ArrivalDateStart	string	false	none	none
UserName	string	false	none	none

PassengerAirSegmentsByCompanyAccount

{
  "Account": [
    "string"
  ],
  "CompanyID": 0,
  "DepartureDateEnd": "string",
  "DepartureDateStart": "string",
  "DepartureTimeEnd": "string",
  "DepartureTimeStart": "string"
}

PassengerAirSegmentsByCompanyAccount

Properties

Name	Type	Required	Restrictions	Description
Account	[string]	false	none	none
CompanyID	integer(int32)	false	none	none
DepartureDateEnd	string	false	none	none
DepartureDateStart	string	false	none	none
DepartureTimeEnd	string	false	none	none
DepartureTimeStart	string	false	none	none

TicketRevenueByCompany

{
  "AirlineCode": "string",
  "CompanyID": 0,
  "DepartureDateEnd": "string",
  "DepartureDateStart": "string",
  "FlightCouponStatus": "string",
  "PlatingCarrier": "string",
  "TravelAgentID": "string"
}

TicketRevenueByCompany

Properties

Name	Type	Required	Restrictions	Description
AirlineCode	string	false	none	none
CompanyID	integer(int32)	false	none	none
DepartureDateEnd	string	false	none	none
DepartureDateStart	string	false	none	none
FlightCouponStatus	string	false	none	none
PlatingCarrier	string	false	none	none
TravelAgentID	string	false	none	none

UsersPCCsMapping

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string",
  "Deleted": true,
  "OwningAgencyLocationID": "string",
  "UserName": "string"
}

UsersPCCsMapping

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)
Deleted	boolean	false	none	none
OwningAgencyLocationID	string	false	none	none
UserName	string	false	none	none

ResponseMetadata

Properties

Name	Type	Required	Restrictions	Description
Success	boolean	false	none	none
HasCache	boolean	false	none	none
HasPaging	boolean	false	none	none
CacheMetadata	CacheMetadata	false	none	CacheMetadata
PagingMetadata	PagingMetadata	false	none	PagingMetadata

CacheMetadata

{
  "IsFromCache": true,
  "CachedAt": "2019-03-18T11:42:49Z",
  "CacheExpiresAt": "2019-03-18T11:42:49Z"
}

CacheMetadata

Properties

Name	Type	Required	Restrictions	Description
IsFromCache	boolean	false	none	none
CachedAt	string(date-time)	false	none	none
CacheExpiresAt	string(date-time)	false	none	none

PagingMetadata

{
  "Limit": "string",
  "Offset": "string",
  "ResponseRecords": "string",
  "TotalRecords": "string"
}

PagingMetadata

Properties

Name	Type	Required	Restrictions	Description
Limit	string	false	none	Number of records to return (PageSize)
Offset	string	false	none	Starting Record
ResponseRecords	string(int32)	false	none	Total NUmber of Records in this Reponse (on this page)
TotalRecords	string(int32)	false	none	Total Number of Records in a Full Reponse (if no paging)

AccountAirlineSupport

{
  "DepartureCity": "string",
  "DestinationCity": "string",
  "Route": "string",
  "Total": 0,
  "TotalEconomySegs": 0,
  "TotalPremiumSegs": 0,
  "TotalBusinessSegs": 0,
  "TotalFirstClassSegs": 0,
  "TotalCost": "string"
}

AccountAirlineSupport

Properties

Name	Type	Required	Restrictions	Description
DepartureCity	string	false	none	none
DestinationCity	string	false	none	none
Route	string	false	none	none
Total	integer(int32)	false	none	none
TotalEconomySegs	integer(int32)	false	none	none
TotalPremiumSegs	integer(int32)	false	none	none
TotalBusinessSegs	integer(int32)	false	none	none
TotalFirstClassSegs	integer(int32)	false	none	none
TotalCost	string	false	none	none

AgentivityError

{
  "ErrorCode": "string",
  "Message": "string",
  "StatusCode": "string",
  "VerboseMessage": "string"
}

AgentivityError

Properties

Name	Type	Required	Restrictions	Description
ErrorCode	string	false	none	none
Message	string	false	none	none
StatusCode	string	false	none	none
VerboseMessage	string	false	none	none

AccountPerCompanysResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "AccountValue": "string",
      "CompanyID": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AccountPerCompanysResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[AccountPerCompany]	false	none	[AccountPerCompany]
ResponseError	AgentivityError	false	none	AgentivityError

AccountPerCompany

{
  "AccountValue": "string",
  "CompanyID": "string"
}

AccountPerCompany

Properties

Name	Type	Required	Restrictions	Description
AccountValue	string	false	none	none
CompanyID	string	false	none	none

AccountsHotelAttachmentSuccessItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Account": "string",
      "TotalAirBookings": 0,
      "TotalAirBookingsWithHotel": 0,
      "TotalEligibleAirBookingsWithoutHotel": 0,
      "HotelAttachmentRate": 0,
      "HotelAttachmentRateFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AccountsHotelAttachmentSuccessItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	AccountsHotelAttachmentSuccessResponseReport	false	none	AccountsHotelAttachmentSuccessResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

AccountsHotelAttachmentSuccessResponseReport

{
  "Item": {
    "Account": "string",
    "TotalAirBookings": 0,
    "TotalAirBookingsWithHotel": 0,
    "TotalEligibleAirBookingsWithoutHotel": 0,
    "HotelAttachmentRate": 0,
    "HotelAttachmentRateFormatted": "string"
  }
}

AccountsHotelAttachmentSuccessResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	AccountHotelAttachmentSuccess	false	none	AccountHotelAttachmentSuccess

AccountHotelAttachmentSuccess

{
  "Account": "string",
  "TotalAirBookings": 0,
  "TotalAirBookingsWithHotel": 0,
  "TotalEligibleAirBookingsWithoutHotel": 0,
  "HotelAttachmentRate": 0,
  "HotelAttachmentRateFormatted": "string"
}

AccountHotelAttachmentSuccess

Properties

Name	Type	Required	Restrictions	Description
Account	string	false	none	none
TotalAirBookings	integer(int32)	false	none	none
TotalAirBookingsWithHotel	integer(int32)	false	none	none
TotalEligibleAirBookingsWithoutHotel	integer(int32)	false	none	none
HotelAttachmentRate	number(float)	false	none	none
HotelAttachmentRateFormatted	string	false	none	none

AccountsProductivityItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Account": "string",
      "AverageItineraryChangesFormatted": "string",
      "TotalBookings": 0,
      "AverageItineraryChanges": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AccountsProductivityItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	AccountsProductivityResponseReport	false	none	AccountsProductivityResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

AccountsProductivityResponseReport

{
  "Item": {
    "Account": "string",
    "AverageItineraryChangesFormatted": "string",
    "TotalBookings": 0,
    "AverageItineraryChanges": 0
  }
}

AccountsProductivityResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	AccountProductivity	false	none	AccountProductivity

AccountProductivity

{
  "Account": "string",
  "AverageItineraryChangesFormatted": "string",
  "TotalBookings": 0,
  "AverageItineraryChanges": 0
}

AccountProductivity

Properties

Name	Type	Required	Restrictions	Description
Account	string	false	none	none
AverageItineraryChangesFormatted	string	false	none	none
TotalBookings	integer(int32)	false	none	none
AverageItineraryChanges	number(float)	false	none	none

ActiveUnsoldAirBookingsResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyLocationID": "string",
      "PrimaryPax": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "IATA": "string",
      "Routing": "string",
      "AgentivityRef": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

ActiveUnsoldAirBookingsResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[ActiveUnsoldAirBookings]	false	none	[ActiveUnsoldAirBookings]
ResponseError	AgentivityError	false	none	AgentivityError

ActiveUnsoldAirBookings

{
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "OwningAgencyLocationID": "string",
  "PrimaryPax": "string",
  "OwningConsultant": "string",
  "Account": "string",
  "IATA": "string",
  "Routing": "string",
  "AgentivityRef": 0
}

ActiveUnsoldAirBookings

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
OwningAgencyLocationID	string	false	none	none
PrimaryPax	string	false	none	none
OwningConsultant	string	false	none	none
Account	string	false	none	none
IATA	string	false	none	none
Routing	string	false	none	none
AgentivityRef	integer(int32)	false	none	none

AfterHoursServicingResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "AfterHoursValue": "string",
      "CreationDateTime": "2019-03-18T11:42:49Z",
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningConsultant": "string",
      "Account": "string",
      "PaxList": "string",
      "AgentivityRef": 0,
      "CreationTimeFormatted": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AfterHoursServicingResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[AfterHoursServicing]	false	none	[AfterHoursServicing]
ResponseError	AgentivityError	false	none	AgentivityError

AfterHoursServicing

{
  "AfterHoursValue": "string",
  "CreationDateTime": "2019-03-18T11:42:49Z",
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "OwningConsultant": "string",
  "Account": "string",
  "PaxList": "string",
  "AgentivityRef": 0,
  "CreationTimeFormatted": "string"
}

AfterHoursServicing

Properties

Name	Type	Required	Restrictions	Description
AfterHoursValue	string	false	none	none
CreationDateTime	string(date-time)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
OwningConsultant	string	false	none	none
Account	string	false	none	none
PaxList	string	false	none	none
AgentivityRef	integer(int32)	false	none	none
CreationTimeFormatted	string	false	none	none

AgencyActivitiesByConsultantItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Items": [
        {
          "EventHour": 0,
          "EventType": "string",
          "TotalBookings": 0
        }
      ],
      "Formatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AgencyActivitiesByConsultantItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	AgencyActivitiesByConsultantResponseReport	false	none	AgencyActivitiesByConsultantResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

AgencyActivitiesByConsultantResponseReport

{
  "Item": {
    "Items": [
      {
        "EventHour": 0,
        "EventType": "string",
        "TotalBookings": 0
      }
    ],
    "Formatted": "string"
  }
}

AgencyActivitiesByConsultantResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	AgencyActivityByConsultant	false	none	AgencyActivityByConsultant

AgencyActivityByConsultant

{
  "Items": [
    {
      "EventHour": 0,
      "EventType": "string",
      "TotalBookings": 0
    }
  ],
  "Formatted": "string"
}

AgencyActivityByConsultant

Properties

Name	Type	Required	Restrictions	Description
Items	[AgencyActivityItem]	false	none	[AgencyActivityItem]
Formatted	string	false	none	none

AgencyActivityItem

{
  "EventHour": 0,
  "EventType": "string",
  "TotalBookings": 0
}

AgencyActivityItem

Properties

Name	Type	Required	Restrictions	Description
EventHour	integer(int32)	false	none	none
EventType	string	false	none	none
TotalBookings	integer(int32)	false	none	none

AgencyLocationsHotelAttachmentSuccessItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningAgencyLocationID": "string",
      "TotalAirBookings": 0,
      "TotalAirBookingsWithHotel": 0,
      "TotalEligibleAirBookingsWithoutHotel": 0,
      "HotelAttachmentRate": 0,
      "HotelAttachmentRateFormatted": "string",
      "Country": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AgencyLocationsHotelAttachmentSuccessItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	AgencyLocationsHotelAttachmentSuccessResponseReport	false	none	AgencyLocationsHotelAttachmentSuccessResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

AgencyLocationsHotelAttachmentSuccessResponseReport

{
  "Item": {
    "OwningAgencyLocationID": "string",
    "TotalAirBookings": 0,
    "TotalAirBookingsWithHotel": 0,
    "TotalEligibleAirBookingsWithoutHotel": 0,
    "HotelAttachmentRate": 0,
    "HotelAttachmentRateFormatted": "string",
    "Country": "string"
  }
}

AgencyLocationsHotelAttachmentSuccessResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	AgencyLocationHotelAttachmentSuccess	false	none	AgencyLocationHotelAttachmentSuccess

AgencyLocationHotelAttachmentSuccess

{
  "OwningAgencyLocationID": "string",
  "TotalAirBookings": 0,
  "TotalAirBookingsWithHotel": 0,
  "TotalEligibleAirBookingsWithoutHotel": 0,
  "HotelAttachmentRate": 0,
  "HotelAttachmentRateFormatted": "string",
  "Country": "string"
}

AgencyLocationHotelAttachmentSuccess

Properties

Name	Type	Required	Restrictions	Description
OwningAgencyLocationID	string	false	none	none
TotalAirBookings	integer(int32)	false	none	none
TotalAirBookingsWithHotel	integer(int32)	false	none	none
TotalEligibleAirBookingsWithoutHotel	integer(int32)	false	none	none
HotelAttachmentRate	number(float)	false	none	none
HotelAttachmentRateFormatted	string	false	none	none
Country	string	false	none	none

AgencyReviewsItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Summary": {
        "TicketedBookings": 0,
        "LCCTktBookings": 0,
        "NonTicketedBookings": 0,
        "TicketedBookingsPerc": 0,
        "NonTicketedBookingsPerc": 0,
        "OnlineBookings": 0,
        "OfflineBookings": 0,
        "CxlBookings": 0,
        "OffLineHtlBookings": 0,
        "BookingsWithHotelSegments": 0,
        "BookingsWithCarSegments": 0,
        "NonAirBookings": 0,
        "TotalBookings": 0,
        "AeroTouches": 0,
        "AverageItineraryChanges": 0,
        "AverageAccountBookingToTravelTime": 0,
        "TotalItineraryChangesBeforeTicketing": 0,
        "TotalItineraryChangesAfterTicketing": 0,
        "TotalItineraryChanges": 0,
        "OwningConsultantID": "string"
      },
      "AirlineSupport": {
        "AirlinesStats": [
          {
            "CarrierCode": "string",
            "Carrier": "string",
            "TotalSegments": 0
          }
        ],
        "TotalSegments": 0,
        "FormattedAirlineSupport": "string"
      }
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AgencyReviewsItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	AgencyReviewsResponseReport	false	none	AgencyReviewsResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

AgencyReviewsResponseReport

{
  "Item": {
    "Summary": {
      "TicketedBookings": 0,
      "LCCTktBookings": 0,
      "NonTicketedBookings": 0,
      "TicketedBookingsPerc": 0,
      "NonTicketedBookingsPerc": 0,
      "OnlineBookings": 0,
      "OfflineBookings": 0,
      "CxlBookings": 0,
      "OffLineHtlBookings": 0,
      "BookingsWithHotelSegments": 0,
      "BookingsWithCarSegments": 0,
      "NonAirBookings": 0,
      "TotalBookings": 0,
      "AeroTouches": 0,
      "AverageItineraryChanges": 0,
      "AverageAccountBookingToTravelTime": 0,
      "TotalItineraryChangesBeforeTicketing": 0,
      "TotalItineraryChangesAfterTicketing": 0,
      "TotalItineraryChanges": 0,
      "OwningConsultantID": "string"
    },
    "AirlineSupport": {
      "AirlinesStats": [
        {
          "CarrierCode": "string",
          "Carrier": "string",
          "TotalSegments": 0
        }
      ],
      "TotalSegments": 0,
      "FormattedAirlineSupport": "string"
    }
  }
}

AgencyReviewsResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	AgencyReview	false	none	AgencyReview

AgencyReview

{
  "Summary": {
    "TicketedBookings": 0,
    "LCCTktBookings": 0,
    "NonTicketedBookings": 0,
    "TicketedBookingsPerc": 0,
    "NonTicketedBookingsPerc": 0,
    "OnlineBookings": 0,
    "OfflineBookings": 0,
    "CxlBookings": 0,
    "OffLineHtlBookings": 0,
    "BookingsWithHotelSegments": 0,
    "BookingsWithCarSegments": 0,
    "NonAirBookings": 0,
    "TotalBookings": 0,
    "AeroTouches": 0,
    "AverageItineraryChanges": 0,
    "AverageAccountBookingToTravelTime": 0,
    "TotalItineraryChangesBeforeTicketing": 0,
    "TotalItineraryChangesAfterTicketing": 0,
    "TotalItineraryChanges": 0,
    "OwningConsultantID": "string"
  },
  "AirlineSupport": {
    "AirlinesStats": [
      {
        "CarrierCode": "string",
        "Carrier": "string",
        "TotalSegments": 0
      }
    ],
    "TotalSegments": 0,
    "FormattedAirlineSupport": "string"
  }
}

AgencyReview

Properties

Name	Type	Required	Restrictions	Description
Summary	AgencyReviewSummary	false	none	AgencyReviewSummary
AirlineSupport	AirlineSupport	false	none	AirlineSupport

AgencyReviewSummary

{
  "TicketedBookings": 0,
  "LCCTktBookings": 0,
  "NonTicketedBookings": 0,
  "TicketedBookingsPerc": 0,
  "NonTicketedBookingsPerc": 0,
  "OnlineBookings": 0,
  "OfflineBookings": 0,
  "CxlBookings": 0,
  "OffLineHtlBookings": 0,
  "BookingsWithHotelSegments": 0,
  "BookingsWithCarSegments": 0,
  "NonAirBookings": 0,
  "TotalBookings": 0,
  "AeroTouches": 0,
  "AverageItineraryChanges": 0,
  "AverageAccountBookingToTravelTime": 0,
  "TotalItineraryChangesBeforeTicketing": 0,
  "TotalItineraryChangesAfterTicketing": 0,
  "TotalItineraryChanges": 0,
  "OwningConsultantID": "string"
}

AgencyReviewSummary

Properties

Name	Type	Required	Restrictions	Description
TicketedBookings	integer(int32)	false	none	none
LCCTktBookings	integer(int32)	false	none	none
NonTicketedBookings	integer(int32)	false	none	none
TicketedBookingsPerc	integer(int32)	false	none	none
NonTicketedBookingsPerc	integer(int32)	false	none	none
OnlineBookings	integer(int32)	false	none	none
OfflineBookings	integer(int32)	false	none	none
CxlBookings	integer(int32)	false	none	none
OffLineHtlBookings	integer(int32)	false	none	none
BookingsWithHotelSegments	integer(int32)	false	none	none
BookingsWithCarSegments	integer(int32)	false	none	none
NonAirBookings	integer(int32)	false	none	none
TotalBookings	integer(int32)	false	none	none
AeroTouches	integer(int32)	false	none	none
AverageItineraryChanges	number(double)	false	none	none
AverageAccountBookingToTravelTime	number(double)	false	none	none
TotalItineraryChangesBeforeTicketing	integer(int32)	false	none	none
TotalItineraryChangesAfterTicketing	integer(int32)	false	none	none
TotalItineraryChanges	number(double)	false	none	none
OwningConsultantID	string	false	none	none

AirlineSupport

{
  "AirlinesStats": [
    {
      "CarrierCode": "string",
      "Carrier": "string",
      "TotalSegments": 0
    }
  ],
  "TotalSegments": 0,
  "FormattedAirlineSupport": "string"
}

AirlineSupport

Properties

Name	Type	Required	Restrictions	Description
AirlinesStats	[AirlineStats]	false	none	[AirlineStats]
TotalSegments	integer(int32)	false	none	none
FormattedAirlineSupport	string	false	none	none

AirlineStats

{
  "CarrierCode": "string",
  "Carrier": "string",
  "TotalSegments": 0
}

AirlineStats

Properties

Name	Type	Required	Restrictions	Description
CarrierCode	string	false	none	none
Carrier	string	false	none	none
TotalSegments	integer(int32)	false	none	none

AgencyTicketingActivityItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyLocationID": "string",
      "Passengers": "string",
      "Account": "string",
      "Consultant": "string",
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AgencyTicketingActivityItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	AgencyTicketingActivityResponseReport	false	none	AgencyTicketingActivityResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

AgencyTicketingActivityResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "OwningAgencyLocationID": "string",
    "Passengers": "string",
    "Account": "string",
    "Consultant": "string",
    "ItineraryFormatted": "string"
  }
}

AgencyTicketingActivityResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	AgencyTicketing	false	none	AgencyTicketing

AgencyTicketing

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "OwningAgencyLocationID": "string",
  "Passengers": "string",
  "Account": "string",
  "Consultant": "string",
  "ItineraryFormatted": "string"
}

AgencyTicketing

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
OwningAgencyLocationID	string	false	none	none
Passengers	string	false	none	none
Account	string	false	none	none
Consultant	string	false	none	none
ItineraryFormatted	string	false	none	none

AgencyTrackerBooking

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "OwningConsultant": "string",
  "PaxList": "string",
  "PNRTicketed": "string",
  "ItineraryFormatted": "string"
}

AgencyTrackerBooking

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
OwningConsultant	string	false	none	none
PaxList	string	false	none	none
PNRTicketed	string	false	none	none
ItineraryFormatted	string	false	none	none

AirportCountryResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "AirportCode": "string",
      "AirportName": "string",
      "CityCode": "string",
      "CityName": "string",
      "CountryCode": "string",
      "CountryName": "string",
      "StateCode": "string",
      "StateName": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AirportCountryResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[AirportCountry]	false	none	[AirportCountry]
ResponseError	AgentivityError	false	none	AgentivityError

AirportCountry

{
  "AirportCode": "string",
  "AirportName": "string",
  "CityCode": "string",
  "CityName": "string",
  "CountryCode": "string",
  "CountryName": "string",
  "StateCode": "string",
  "StateName": "string"
}

AirportCountry

Properties

Name	Type	Required	Restrictions	Description
AirportCode	string	false	none	none
AirportName	string	false	none	none
CityCode	string	false	none	none
CityName	string	false	none	none
CountryCode	string	false	none	none
CountryName	string	false	none	none
StateCode	string	false	none	none
StateName	string	false	none	none

AirSegmentsByDateItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": "string",
      "RecordLocator": "string",
      "OwningAgencyLocationID": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "Passengers": "string",
      "DepartureDate": "2019-03-18T11:42:49Z",
      "DepartureTime": "string",
      "ArrivalDate": "2019-03-18T11:42:49Z",
      "ArrivalTime": "string",
      "CarrierCode": "string",
      "BoardPoint": "string",
      "OffPoint": "string",
      "FlightNbr": "string",
      "BookingCode": "string",
      "CreatingAgencyIata": "string",
      "SegmentStatus": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AirSegmentsByDateItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	AirSegmentsByDateResponseReport	false	none	AirSegmentsByDateResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

AirSegmentsByDateResponseReport

{
  "Item": {
    "AgentivityRef": "string",
    "RecordLocator": "string",
    "OwningAgencyLocationID": "string",
    "OwningConsultant": "string",
    "Account": "string",
    "Passengers": "string",
    "DepartureDate": "2019-03-18T11:42:49Z",
    "DepartureTime": "string",
    "ArrivalDate": "2019-03-18T11:42:49Z",
    "ArrivalTime": "string",
    "CarrierCode": "string",
    "BoardPoint": "string",
    "OffPoint": "string",
    "FlightNbr": "string",
    "BookingCode": "string",
    "CreatingAgencyIata": "string",
    "SegmentStatus": "string"
  }
}

AirSegmentsByDateResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	AirSegmentByDate	false	none	AirSegmentByDate

AirSegmentByDate

{
  "AgentivityRef": "string",
  "RecordLocator": "string",
  "OwningAgencyLocationID": "string",
  "OwningConsultant": "string",
  "Account": "string",
  "Passengers": "string",
  "DepartureDate": "2019-03-18T11:42:49Z",
  "DepartureTime": "string",
  "ArrivalDate": "2019-03-18T11:42:49Z",
  "ArrivalTime": "string",
  "CarrierCode": "string",
  "BoardPoint": "string",
  "OffPoint": "string",
  "FlightNbr": "string",
  "BookingCode": "string",
  "CreatingAgencyIata": "string",
  "SegmentStatus": "string"
}

AirSegmentByDate

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	string	false	none	none
RecordLocator	string	false	none	none
OwningAgencyLocationID	string	false	none	none
OwningConsultant	string	false	none	none
Account	string	false	none	none
Passengers	string	false	none	none
DepartureDate	string(date-time)	false	none	none
DepartureTime	string	false	none	none
ArrivalDate	string(date-time)	false	none	none
ArrivalTime	string	false	none	none
CarrierCode	string	false	none	none
BoardPoint	string	false	none	none
OffPoint	string	false	none	none
FlightNbr	string	false	none	none
BookingCode	string	false	none	none
CreatingAgencyIata	string	false	none	none
SegmentStatus	string	false	none	none

AirSegmentsPerAccountByVendorItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Account": "string",
      "TotalAirSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AirSegmentsPerAccountByVendorItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	AirSegmentsPerAccountByVendorResponseReport	false	none	AirSegmentsPerAccountByVendorResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

AirSegmentsPerAccountByVendorResponseReport

{
  "Item": {
    "Account": "string",
    "TotalAirSegments": 0
  }
}

AirSegmentsPerAccountByVendorResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	AirSegmentPerAccountByVendor	false	none	AirSegmentPerAccountByVendor

AirSegmentPerAccountByVendor

{
  "Account": "string",
  "TotalAirSegments": 0
}

AirSegmentPerAccountByVendor

Properties

Name	Type	Required	Restrictions	Description
Account	string	false	none	none
TotalAirSegments	integer(int32)	false	none	none

AirSegmentsPerBranchByVendorItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningAgencyLocation": "string",
      "OwningAgencyLocationID": "string",
      "TotalAirSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AirSegmentsPerBranchByVendorItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	AirSegmentsPerBranchByVendorResponseReport	false	none	AirSegmentsPerBranchByVendorResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

AirSegmentsPerBranchByVendorResponseReport

{
  "Item": {
    "OwningAgencyLocation": "string",
    "OwningAgencyLocationID": "string",
    "TotalAirSegments": 0
  }
}

AirSegmentsPerBranchByVendorResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	AirSegmentPerBranchByVendor	false	none	AirSegmentPerBranchByVendor

AirSegmentPerBranchByVendor

{
  "OwningAgencyLocation": "string",
  "OwningAgencyLocationID": "string",
  "TotalAirSegments": 0
}

AirSegmentPerBranchByVendor

Properties

Name	Type	Required	Restrictions	Description
OwningAgencyLocation	string	false	none	none
OwningAgencyLocationID	string	false	none	none
TotalAirSegments	integer(int32)	false	none	none

AirSegmentsPerCarrierItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "CarrierCode": "string",
      "CarrierName": "string",
      "TotalAirSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AirSegmentsPerCarrierItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	AirSegmentsPerCarrierResponseReport	false	none	AirSegmentsPerCarrierResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

AirSegmentsPerCarrierResponseReport

{
  "Item": {
    "CarrierCode": "string",
    "CarrierName": "string",
    "TotalAirSegments": 0
  }
}

AirSegmentsPerCarrierResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	AirSegmentPerCarrier	false	none	AirSegmentPerCarrier

AirSegmentPerCarrier

{
  "CarrierCode": "string",
  "CarrierName": "string",
  "TotalAirSegments": 0
}

AirSegmentPerCarrier

Properties

Name	Type	Required	Restrictions	Description
CarrierCode	string	false	none	none
CarrierName	string	false	none	none
TotalAirSegments	integer(int32)	false	none	none

AirSegmentsPerConsultantByVendorItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningConsultant": "string",
      "OwningConsultantID": "string",
      "OwningAgencyLocation": "string",
      "TotalAirSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AirSegmentsPerConsultantByVendorItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	AirSegmentsPerConsultantByVendorResponseReport	false	none	AirSegmentsPerConsultantByVendorResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

AirSegmentsPerConsultantByVendorResponseReport

{
  "Item": {
    "OwningConsultant": "string",
    "OwningConsultantID": "string",
    "OwningAgencyLocation": "string",
    "TotalAirSegments": 0
  }
}

AirSegmentsPerConsultantByVendorResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	AirSegmentPerConsultantByVendor	false	none	AirSegmentPerConsultantByVendor

AirSegmentPerConsultantByVendor

{
  "OwningConsultant": "string",
  "OwningConsultantID": "string",
  "OwningAgencyLocation": "string",
  "TotalAirSegments": 0
}

AirSegmentPerConsultantByVendor

Properties

Name	Type	Required	Restrictions	Description
OwningConsultant	string	false	none	none
OwningConsultantID	string	false	none	none
OwningAgencyLocation	string	false	none	none
TotalAirSegments	integer(int32)	false	none	none

AirSegmentsPerDestinationByVendorItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "CityName": "string",
      "CityCode": "string",
      "CountryName": "string",
      "TotalInstances": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AirSegmentsPerDestinationByVendorItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	AirSegmentsPerDestinationByVendorResponseReport	false	none	AirSegmentsPerDestinationByVendorResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

AirSegmentsPerDestinationByVendorResponseReport

{
  "Item": {
    "CityName": "string",
    "CityCode": "string",
    "CountryName": "string",
    "TotalInstances": 0
  }
}

AirSegmentsPerDestinationByVendorResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	AirSegmentPerDestinationByVendor	false	none	AirSegmentPerDestinationByVendor

AirSegmentPerDestinationByVendor

{
  "CityName": "string",
  "CityCode": "string",
  "CountryName": "string",
  "TotalInstances": 0
}

AirSegmentPerDestinationByVendor

Properties

Name	Type	Required	Restrictions	Description
CityName	string	false	none	none
CityCode	string	false	none	none
CountryName	string	false	none	none
TotalInstances	integer(int32)	false	none	none

BookingCountPerPccResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "OwningAgencyLocationID": "string",
      "BookingsCount": 0,
      "TicketedCount": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingCountPerPccResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[BookingCountPerPcc]	false	none	[BookingCountPerPcc]
ResponseError	AgentivityError	false	none	AgentivityError

BookingCountPerPcc

{
  "OwningAgencyLocationID": "string",
  "BookingsCount": 0,
  "TicketedCount": 0
}

BookingCountPerPcc

Properties

Name	Type	Required	Restrictions	Description
OwningAgencyLocationID	string	false	none	none
BookingsCount	integer(int32)	false	none	none
TicketedCount	integer(int32)	false	none	none

BookingsBasicByUserSameDayTicketedItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "RecordLocator": "string",
      "TravelDate": "string",
      "OwningConsultant": "string",
      "Account": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsBasicByUserSameDayTicketedItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsBasicByUserSameDayTicketedResponseReport	false	none	BookingsBasicByUserSameDayTicketedResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsBasicByUserSameDayTicketedResponseReport

{
  "Item": {
    "RecordLocator": "string",
    "TravelDate": "string",
    "OwningConsultant": "string",
    "Account": "string"
  }
}

BookingsBasicByUserSameDayTicketedResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BasicBooking	false	none	BasicBooking

BasicBooking

{
  "RecordLocator": "string",
  "TravelDate": "string",
  "OwningConsultant": "string",
  "Account": "string"
}

BasicBooking

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
TravelDate	string	false	none	none
OwningConsultant	string	false	none	none
Account	string	false	none	none

BookingsBasicByUserResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "TravelDate": "string",
      "OwningConsultant": "string",
      "Account": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsBasicByUserResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[BasicBooking]	false	none	[BasicBooking]
ResponseError	AgentivityError	false	none	AgentivityError

BookingsByAccountItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyLocationID": "string",
      "Passengers": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "PNRTicketed": "string",
      "PNRCancelled": "string",
      "OrderNumber": "string",
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsByAccountItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsByAccountResponseReport	false	none	BookingsByAccountResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsByAccountResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "OwningAgencyLocationID": "string",
    "Passengers": "string",
    "OwningConsultant": "string",
    "Account": "string",
    "TravelDate": "2019-03-18T11:42:49Z",
    "PNRTicketed": "string",
    "PNRCancelled": "string",
    "OrderNumber": "string",
    "ItineraryFormatted": "string"
  }
}

BookingsByAccountResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingByAccount	false	none	BookingByAccount

BookingByAccount

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "OwningAgencyLocationID": "string",
  "Passengers": "string",
  "OwningConsultant": "string",
  "Account": "string",
  "TravelDate": "2019-03-18T11:42:49Z",
  "PNRTicketed": "string",
  "PNRCancelled": "string",
  "OrderNumber": "string",
  "ItineraryFormatted": "string"
}

BookingByAccount

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
OwningAgencyLocationID	string	false	none	none
Passengers	string	false	none	none
OwningConsultant	string	false	none	none
Account	string	false	none	none
TravelDate	string(date-time)	false	none	none
PNRTicketed	string	false	none	none
PNRCancelled	string	false	none	none
OrderNumber	string	false	none	none
ItineraryFormatted	string	false	none	none

BookingsByAirlineWithClassSupportItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "Account": "string",
      "OwningConsultant": "string",
      "TicketedStatusCode": "string",
      "TicketedStatus": "string",
      "BookingCodesBooked": "string",
      "FlightNumbers": "string",
      "Routing": "string",
      "TrackingCode": "string",
      "TktTourCode": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsByAirlineWithClassSupportItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsByAirlineWithClassSupportResponseReport	false	none	BookingsByAirlineWithClassSupportResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsByAirlineWithClassSupportResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "Account": "string",
    "OwningConsultant": "string",
    "TicketedStatusCode": "string",
    "TicketedStatus": "string",
    "BookingCodesBooked": "string",
    "FlightNumbers": "string",
    "Routing": "string",
    "TrackingCode": "string",
    "TktTourCode": "string"
  }
}

BookingsByAirlineWithClassSupportResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingByAirlineWithClassSupport	false	none	BookingByAirlineWithClassSupport

BookingByAirlineWithClassSupport

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "Account": "string",
  "OwningConsultant": "string",
  "TicketedStatusCode": "string",
  "TicketedStatus": "string",
  "BookingCodesBooked": "string",
  "FlightNumbers": "string",
  "Routing": "string",
  "TrackingCode": "string",
  "TktTourCode": "string"
}

BookingByAirlineWithClassSupport

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
Account	string	false	none	none
OwningConsultant	string	false	none	none
TicketedStatusCode	string	false	none	none
TicketedStatus	string	false	none	none
BookingCodesBooked	string	false	none	none
FlightNumbers	string	false	none	none
Routing	string	false	none	none
TrackingCode	string	false	none	none
TktTourCode	string	false	none	none

BookingsByConsultantActivityItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "CountryCountGroup": "string",
      "Passenger": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "PnrTicketed": "string",
      "PnrCancelled": "string",
      "AgentInitials": "string",
      "IsChurned": "string",
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      },
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsByConsultantActivityItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsByConsultantActivityResponseReport	false	none	BookingsByConsultantActivityResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsByConsultantActivityResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "CountryCountGroup": "string",
    "Passenger": "string",
    "Account": "string",
    "TravelDate": "2019-03-18T11:42:49Z",
    "PnrTicketed": "string",
    "PnrCancelled": "string",
    "AgentInitials": "string",
    "IsChurned": "string",
    "Itinerary": {
      "SegmentTypesFilter": [
        "string"
      ],
      "FilteredSegments": null,
      "Capacity": 0,
      "Count": 0,
      "Item": {
        "ArrivalTimeFormatted": "string",
        "BoardPoint": "string",
        "ChangeOfDayFormatted": "string",
        "DepartureTimeFormatted": "string",
        "EndDate": "string",
        "OffPoint": "string",
        "OperatorCode": "string",
        "OperatorService": "string",
        "SegmentNbr": 0,
        "SegmentStatus": "string",
        "SegmentType": "string",
        "ServiceCode": "string",
        "StartDate": "string",
        "TicketNumber": "string"
      }
    },
    "ItineraryFormatted": "string"
  }
}

BookingsByConsultantActivityResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingByConsultantActivity	false	none	BookingByConsultantActivity

BookingByConsultantActivity

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "CountryCountGroup": "string",
  "Passenger": "string",
  "Account": "string",
  "TravelDate": "2019-03-18T11:42:49Z",
  "PnrTicketed": "string",
  "PnrCancelled": "string",
  "AgentInitials": "string",
  "IsChurned": "string",
  "Itinerary": {
    "SegmentTypesFilter": [
      "string"
    ],
    "FilteredSegments": null,
    "Capacity": 0,
    "Count": 0,
    "Item": {
      "ArrivalTimeFormatted": "string",
      "BoardPoint": "string",
      "ChangeOfDayFormatted": "string",
      "DepartureTimeFormatted": "string",
      "EndDate": "string",
      "OffPoint": "string",
      "OperatorCode": "string",
      "OperatorService": "string",
      "SegmentNbr": 0,
      "SegmentStatus": "string",
      "SegmentType": "string",
      "ServiceCode": "string",
      "StartDate": "string",
      "TicketNumber": "string"
    }
  },
  "ItineraryFormatted": "string"
}

BookingByConsultantActivity

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
CountryCountGroup	string	false	none	none
Passenger	string	false	none	none
Account	string	false	none	none
TravelDate	string(date-time)	false	none	none
PnrTicketed	string	false	none	none
PnrCancelled	string	false	none	none
AgentInitials	string	false	none	none
IsChurned	string	false	none	none
Itinerary	ItinerarySegmentsCollection	false	none	ItinerarySegmentsCollection
ItineraryFormatted	string	false	none	none

ItinerarySegmentsCollection

{
  "SegmentTypesFilter": [
    "string"
  ],
  "FilteredSegments": null,
  "Capacity": 0,
  "Count": 0,
  "Item": {
    "ArrivalTimeFormatted": "string",
    "BoardPoint": "string",
    "ChangeOfDayFormatted": "string",
    "DepartureTimeFormatted": "string",
    "EndDate": "string",
    "OffPoint": "string",
    "OperatorCode": "string",
    "OperatorService": "string",
    "SegmentNbr": 0,
    "SegmentStatus": "string",
    "SegmentType": "string",
    "ServiceCode": "string",
    "StartDate": "string",
    "TicketNumber": "string"
  }
}

ItinerarySegmentsCollection

Properties

Name	Type	Required	Restrictions	Description
SegmentTypesFilter	[string]	false	none	none
FilteredSegments	ItinerarySegmentsCollection	false	none	ItinerarySegmentsCollection
Capacity	integer(int32)	false	none	none
Count	integer(int32)	false	none	none
Item	ItinerarySegment	false	none	ItinerarySegment

ItinerarySegment

{
  "ArrivalTimeFormatted": "string",
  "BoardPoint": "string",
  "ChangeOfDayFormatted": "string",
  "DepartureTimeFormatted": "string",
  "EndDate": "string",
  "OffPoint": "string",
  "OperatorCode": "string",
  "OperatorService": "string",
  "SegmentNbr": 0,
  "SegmentStatus": "string",
  "SegmentType": "string",
  "ServiceCode": "string",
  "StartDate": "string",
  "TicketNumber": "string"
}

ItinerarySegment

Properties

Name	Type	Required	Restrictions	Description
ArrivalTimeFormatted	string	false	none	none
BoardPoint	string	false	none	none
ChangeOfDayFormatted	string	false	none	none
DepartureTimeFormatted	string	false	none	none
EndDate	string	false	none	none
OffPoint	string	false	none	none
OperatorCode	string	false	none	none
OperatorService	string	false	none	none
SegmentNbr	integer(int32)	false	none	none
SegmentStatus	string	false	none	none
SegmentType	string	false	none	none
ServiceCode	string	false	none	none
StartDate	string	false	none	none
TicketNumber	string	false	none	none

BookingsByConsultantItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "CountryCountGroup": "string",
      "Passenger": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "PnrTicketed": "string",
      "PnrCancelled": "string",
      "AgentInitials": "string",
      "IsChurned": "string",
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      },
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsByConsultantItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsByConsultantResponseReport	false	none	BookingsByConsultantResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsByConsultantResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "CountryCountGroup": "string",
    "Passenger": "string",
    "Account": "string",
    "TravelDate": "2019-03-18T11:42:49Z",
    "PnrTicketed": "string",
    "PnrCancelled": "string",
    "AgentInitials": "string",
    "IsChurned": "string",
    "Itinerary": {
      "SegmentTypesFilter": [
        "string"
      ],
      "FilteredSegments": null,
      "Capacity": 0,
      "Count": 0,
      "Item": {
        "ArrivalTimeFormatted": "string",
        "BoardPoint": "string",
        "ChangeOfDayFormatted": "string",
        "DepartureTimeFormatted": "string",
        "EndDate": "string",
        "OffPoint": "string",
        "OperatorCode": "string",
        "OperatorService": "string",
        "SegmentNbr": 0,
        "SegmentStatus": "string",
        "SegmentType": "string",
        "ServiceCode": "string",
        "StartDate": "string",
        "TicketNumber": "string"
      }
    },
    "ItineraryFormatted": "string"
  }
}

BookingsByConsultantResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingByConsultant	false	none	BookingByConsultant

BookingByConsultant

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "CountryCountGroup": "string",
  "Passenger": "string",
  "Account": "string",
  "TravelDate": "2019-03-18T11:42:49Z",
  "PnrTicketed": "string",
  "PnrCancelled": "string",
  "AgentInitials": "string",
  "IsChurned": "string",
  "Itinerary": {
    "SegmentTypesFilter": [
      "string"
    ],
    "FilteredSegments": null,
    "Capacity": 0,
    "Count": 0,
    "Item": {
      "ArrivalTimeFormatted": "string",
      "BoardPoint": "string",
      "ChangeOfDayFormatted": "string",
      "DepartureTimeFormatted": "string",
      "EndDate": "string",
      "OffPoint": "string",
      "OperatorCode": "string",
      "OperatorService": "string",
      "SegmentNbr": 0,
      "SegmentStatus": "string",
      "SegmentType": "string",
      "ServiceCode": "string",
      "StartDate": "string",
      "TicketNumber": "string"
    }
  },
  "ItineraryFormatted": "string"
}

BookingByConsultant

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
CountryCountGroup	string	false	none	none
Passenger	string	false	none	none
Account	string	false	none	none
TravelDate	string(date-time)	false	none	none
PnrTicketed	string	false	none	none
PnrCancelled	string	false	none	none
AgentInitials	string	false	none	none
IsChurned	string	false	none	none
Itinerary	ItinerarySegmentsCollection	false	none	ItinerarySegmentsCollection
ItineraryFormatted	string	false	none	none

BookingsCountsPerConsultantItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningConsultant": "string",
      "OwningConsultantID": "string",
      "TotalBookings": 0,
      "CancelledCount": 0,
      "ContainingAirCount": 0,
      "GDSTicketedCount": 0,
      "LowCostCarrierCount": 0,
      "ChurnCount": 0,
      "QualifierCount": 0,
      "CountryCount": "string",
      "RemarkDetailsList": [
        {
          "RecordLocator": "string",
          "Account": "string",
          "Passangers": "string",
          "TravelDate": "string",
          "Remark": "string"
        }
      ]
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsCountsPerConsultantItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsCountsPerConsultantResponseReport	false	none	BookingsCountsPerConsultantResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsCountsPerConsultantResponseReport

{
  "Item": {
    "OwningConsultant": "string",
    "OwningConsultantID": "string",
    "TotalBookings": 0,
    "CancelledCount": 0,
    "ContainingAirCount": 0,
    "GDSTicketedCount": 0,
    "LowCostCarrierCount": 0,
    "ChurnCount": 0,
    "QualifierCount": 0,
    "CountryCount": "string",
    "RemarkDetailsList": [
      {
        "RecordLocator": "string",
        "Account": "string",
        "Passangers": "string",
        "TravelDate": "string",
        "Remark": "string"
      }
    ]
  }
}

BookingsCountsPerConsultantResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingCountsPerConsultant	false	none	BookingCountsPerConsultant

BookingCountsPerConsultant

{
  "OwningConsultant": "string",
  "OwningConsultantID": "string",
  "TotalBookings": 0,
  "CancelledCount": 0,
  "ContainingAirCount": 0,
  "GDSTicketedCount": 0,
  "LowCostCarrierCount": 0,
  "ChurnCount": 0,
  "QualifierCount": 0,
  "CountryCount": "string",
  "RemarkDetailsList": [
    {
      "RecordLocator": "string",
      "Account": "string",
      "Passangers": "string",
      "TravelDate": "string",
      "Remark": "string"
    }
  ]
}

BookingCountsPerConsultant

Properties

Name	Type	Required	Restrictions	Description
OwningConsultant	string	false	none	none
OwningConsultantID	string	false	none	none
TotalBookings	integer(int32)	false	none	none
CancelledCount	integer(int32)	false	none	none
ContainingAirCount	integer(int32)	false	none	none
GDSTicketedCount	integer(int32)	false	none	none
LowCostCarrierCount	integer(int32)	false	none	none
ChurnCount	integer(int32)	false	none	none
QualifierCount	integer(int32)	false	none	none
CountryCount	string	false	none	none
RemarkDetailsList	[RemarkDetails]	false	none	[RemarkDetails]

RemarkDetails

{
  "RecordLocator": "string",
  "Account": "string",
  "Passangers": "string",
  "TravelDate": "string",
  "Remark": "string"
}

RemarkDetails

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
Account	string	false	none	none
Passangers	string	false	none	none
TravelDate	string	false	none	none
Remark	string	false	none	none

BookingsByTravellerItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "LastName": "string",
      "FirstName": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "PNRCancelled": "string",
      "PNRTicketed": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsByTravellerItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsByTravellerResponseReport	false	none	BookingsByTravellerResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsByTravellerResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "LastName": "string",
    "FirstName": "string",
    "Account": "string",
    "OwningConsultant": "string",
    "TravelDate": "2019-03-18T11:42:49Z",
    "PNRCancelled": "string",
    "PNRTicketed": "string"
  }
}

BookingsByTravellerResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingByTraveller	false	none	BookingByTraveller

BookingByTraveller

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "LastName": "string",
  "FirstName": "string",
  "Account": "string",
  "OwningConsultant": "string",
  "TravelDate": "2019-03-18T11:42:49Z",
  "PNRCancelled": "string",
  "PNRTicketed": "string"
}

BookingByTraveller

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
LastName	string	false	none	none
FirstName	string	false	none	none
Account	string	false	none	none
OwningConsultant	string	false	none	none
TravelDate	string(date-time)	false	none	none
PNRCancelled	string	false	none	none
PNRTicketed	string	false	none	none

BookingsCancelledItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyLocationID": "string",
      "Passengers": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "PNRTicketed": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsCancelledItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsCancelledResponseReport	false	none	BookingsCancelledResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsCancelledResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "OwningAgencyLocationID": "string",
    "Passengers": "string",
    "Account": "string",
    "OwningConsultant": "string",
    "PNRTicketed": "string"
  }
}

BookingsCancelledResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingCancelled	false	none	BookingCancelled

BookingCancelled

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "OwningAgencyLocationID": "string",
  "Passengers": "string",
  "Account": "string",
  "OwningConsultant": "string",
  "PNRTicketed": "string"
}

BookingCancelled

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
OwningAgencyLocationID	string	false	none	none
Passengers	string	false	none	none
Account	string	false	none	none
OwningConsultant	string	false	none	none
PNRTicketed	string	false	none	none

BookingsWithReviewDueDateItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "Passenger": "string",
      "OwningAgencyLocationID": "string",
      "Queue": "string",
      "Text": "string",
      "DueDate": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsWithReviewDueDateItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsWithReviewDueDateResponseReport	false	none	BookingsWithReviewDueDateResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsWithReviewDueDateResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "OwningConsultant": "string",
    "Account": "string",
    "Passenger": "string",
    "OwningAgencyLocationID": "string",
    "Queue": "string",
    "Text": "string",
    "DueDate": "2019-03-18T11:42:49Z"
  }
}

BookingsWithReviewDueDateResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingWithReviewDueDate	false	none	BookingWithReviewDueDate

BookingWithReviewDueDate

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "OwningConsultant": "string",
  "Account": "string",
  "Passenger": "string",
  "OwningAgencyLocationID": "string",
  "Queue": "string",
  "Text": "string",
  "DueDate": "2019-03-18T11:42:49Z"
}

BookingWithReviewDueDate

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
OwningConsultant	string	false	none	none
Account	string	false	none	none
Passenger	string	false	none	none
OwningAgencyLocationID	string	false	none	none
Queue	string	false	none	none
Text	string	false	none	none
DueDate	string(date-time)	false	none	none

ConsultantPnrActivityResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Consultant": "string",
      "TransactionAgent": "string",
      "Location": "string",
      "Team": "string",
      "TotalBookings": 0,
      "Domestic": 0,
      "International": 0,
      "Land": 0,
      "Cancelled": 0,
      "Complex": 0,
      "ChangedOwnDomestic": 0,
      "ChangedOwnInternational": 0,
      "ChangedOtherDomestic": 0,
      "ChangedOtherInternational": 0,
      "WithAir": 0,
      "WithHotel": 0,
      "WithPassiveHotel": 0,
      "WithCar": 0,
      "TotalChangedBookings": 0,
      "TotalServicedBookings": 0,
      "TotalTicketedBookings": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

ConsultantPnrActivityResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[ConsultantPnrActivity]	false	none	[ConsultantPnrActivity]
ResponseError	AgentivityError	false	none	AgentivityError

ConsultantPnrActivity

{
  "Consultant": "string",
  "TransactionAgent": "string",
  "Location": "string",
  "Team": "string",
  "TotalBookings": 0,
  "Domestic": 0,
  "International": 0,
  "Land": 0,
  "Cancelled": 0,
  "Complex": 0,
  "ChangedOwnDomestic": 0,
  "ChangedOwnInternational": 0,
  "ChangedOtherDomestic": 0,
  "ChangedOtherInternational": 0,
  "WithAir": 0,
  "WithHotel": 0,
  "WithPassiveHotel": 0,
  "WithCar": 0,
  "TotalChangedBookings": 0,
  "TotalServicedBookings": 0,
  "TotalTicketedBookings": 0
}

ConsultantPnrActivity

Properties

Name	Type	Required	Restrictions	Description
Consultant	string	false	none	none
TransactionAgent	string	false	none	none
Location	string	false	none	none
Team	string	false	none	none
TotalBookings	integer(int32)	false	none	none
Domestic	integer(int32)	false	none	none
International	integer(int32)	false	none	none
Land	integer(int32)	false	none	none
Cancelled	integer(int32)	false	none	none
Complex	integer(int32)	false	none	none
ChangedOwnDomestic	integer(int32)	false	none	none
ChangedOwnInternational	integer(int32)	false	none	none
ChangedOtherDomestic	integer(int32)	false	none	none
ChangedOtherInternational	integer(int32)	false	none	none
WithAir	integer(int32)	false	none	none
WithHotel	integer(int32)	false	none	none
WithPassiveHotel	integer(int32)	false	none	none
WithCar	integer(int32)	false	none	none
TotalChangedBookings	integer(int32)	false	none	none
TotalServicedBookings	integer(int32)	false	none	none
TotalTicketedBookings	integer(int32)	false	none	none

ConsultantProductivityItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningConsultant": "string",
      "OwningConsultantID": "string",
      "OwningAgencyLocationID": "string",
      "Location": "string",
      "Team": "string",
      "TotalCreated": 0,
      "TotalCancelled": 0,
      "TotalItinChanges": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

ConsultantProductivityItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	ConsultantProductivityResponseReport	false	none	ConsultantProductivityResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

ConsultantProductivityResponseReport

{
  "Item": {
    "OwningConsultant": "string",
    "OwningConsultantID": "string",
    "OwningAgencyLocationID": "string",
    "Location": "string",
    "Team": "string",
    "TotalCreated": 0,
    "TotalCancelled": 0,
    "TotalItinChanges": 0
  }
}

ConsultantProductivityResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	ConsultantProductivity	false	none	ConsultantProductivity

ConsultantProductivity

{
  "OwningConsultant": "string",
  "OwningConsultantID": "string",
  "OwningAgencyLocationID": "string",
  "Location": "string",
  "Team": "string",
  "TotalCreated": 0,
  "TotalCancelled": 0,
  "TotalItinChanges": 0
}

ConsultantProductivity

Properties

Name	Type	Required	Restrictions	Description
OwningConsultant	string	false	none	none
OwningConsultantID	string	false	none	none
OwningAgencyLocationID	string	false	none	none
Location	string	false	none	none
Team	string	false	none	none
TotalCreated	integer(int32)	false	none	none
TotalCancelled	integer(int32)	false	none	none
TotalItinChanges	integer(int32)	false	none	none

ConsultantsGdsSegmentPerformanceItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningConsultantID": "string",
      "OwningConsultant": "string",
      "OwningAgencyLocationID": "string",
      "AirCount": 0,
      "HotelCount": 0,
      "CarCount": 0,
      "PassiveHotelCount": 0,
      "PassiveCarCount": 0,
      "TURCount": 0,
      "OtherCount": 0,
      "TotalBookings": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

ConsultantsGdsSegmentPerformanceItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	ConsultantsGdsSegmentPerformanceResponseReport	false	none	ConsultantsGdsSegmentPerformanceResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

ConsultantsGdsSegmentPerformanceResponseReport

{
  "Item": {
    "OwningConsultantID": "string",
    "OwningConsultant": "string",
    "OwningAgencyLocationID": "string",
    "AirCount": 0,
    "HotelCount": 0,
    "CarCount": 0,
    "PassiveHotelCount": 0,
    "PassiveCarCount": 0,
    "TURCount": 0,
    "OtherCount": 0,
    "TotalBookings": 0
  }
}

ConsultantsGdsSegmentPerformanceResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	ConsultantGdsSegmentPerformance	false	none	ConsultantGdsSegmentPerformance

ConsultantGdsSegmentPerformance

{
  "OwningConsultantID": "string",
  "OwningConsultant": "string",
  "OwningAgencyLocationID": "string",
  "AirCount": 0,
  "HotelCount": 0,
  "CarCount": 0,
  "PassiveHotelCount": 0,
  "PassiveCarCount": 0,
  "TURCount": 0,
  "OtherCount": 0,
  "TotalBookings": 0
}

ConsultantGdsSegmentPerformance

Properties

Name	Type	Required	Restrictions	Description
OwningConsultantID	string	false	none	none
OwningConsultant	string	false	none	none
OwningAgencyLocationID	string	false	none	none
AirCount	integer(int32)	false	none	none
HotelCount	integer(int32)	false	none	none
CarCount	integer(int32)	false	none	none
PassiveHotelCount	integer(int32)	false	none	none
PassiveCarCount	integer(int32)	false	none	none
TURCount	integer(int32)	false	none	none
OtherCount	integer(int32)	false	none	none
TotalBookings	integer(int32)	false	none	none

CorporateLongTermArrivalsItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "ArrivalDate": "2019-03-18T11:42:49Z",
      "Days": 0,
      "LastName": "string",
      "FirstName": "string",
      "DestinationCountries": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

CorporateLongTermArrivalsItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	CorporateLongTermArrivalsResponseReport	false	none	CorporateLongTermArrivalsResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

CorporateLongTermArrivalsResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "TravelDate": "2019-03-18T11:42:49Z",
    "ArrivalDate": "2019-03-18T11:42:49Z",
    "Days": 0,
    "LastName": "string",
    "FirstName": "string",
    "DestinationCountries": "string"
  }
}

CorporateLongTermArrivalsResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	CorporateLongTermArrival	false	none	CorporateLongTermArrival

CorporateLongTermArrival

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "TravelDate": "2019-03-18T11:42:49Z",
  "ArrivalDate": "2019-03-18T11:42:49Z",
  "Days": 0,
  "LastName": "string",
  "FirstName": "string",
  "DestinationCountries": "string"
}

CorporateLongTermArrival

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
TravelDate	string(date-time)	false	none	none
ArrivalDate	string(date-time)	false	none	none
Days	integer(int32)	false	none	none
LastName	string	false	none	none
FirstName	string	false	none	none
DestinationCountries	string	false	none	none

DistributorCustomerContactValuesResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "CompanyName": "string",
      "RecordLocator": "string",
      "PNRCreationDate": "string",
      "OwningAgencyPseudo": "string",
      "Consultant": "string",
      "Email": "string",
      "Mobile": "string",
      "Passengers": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

DistributorCustomerContactValuesResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[DistributorCustomerContactValues]	false	none	[DistributorCustomerContactValues]
ResponseError	AgentivityError	false	none	AgentivityError

DistributorCustomerContactValues

{
  "CompanyName": "string",
  "RecordLocator": "string",
  "PNRCreationDate": "string",
  "OwningAgencyPseudo": "string",
  "Consultant": "string",
  "Email": "string",
  "Mobile": "string",
  "Passengers": "string"
}

DistributorCustomerContactValues

Properties

Name	Type	Required	Restrictions	Description
CompanyName	string	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string	false	none	none
OwningAgencyPseudo	string	false	none	none
Consultant	string	false	none	none
Email	string	false	none	none
Mobile	string	false	none	none
Passengers	string	false	none	none

DistributorEmailRatesLastMonthResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "CompanyName": "string",
      "Total": "string",
      "WithEmail": "string",
      "PercentOfEmail": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

DistributorEmailRatesLastMonthResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[DistributorEmailRatesLastMonth]	false	none	[DistributorEmailRatesLastMonth]
ResponseError	AgentivityError	false	none	AgentivityError

DistributorEmailRatesLastMonth

{
  "CompanyName": "string",
  "Total": "string",
  "WithEmail": "string",
  "PercentOfEmail": "string"
}

DistributorEmailRatesLastMonth

Properties

Name	Type	Required	Restrictions	Description
CompanyName	string	false	none	none
Total	string	false	none	none
WithEmail	string	false	none	none
PercentOfEmail	string	false	none	none

DistributorTicketedValuesResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "PlatingCarrier": "string",
      "ShortName": "string",
      "NumberOfTickets": "string",
      "Currency": "string",
      "TotalValue": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

DistributorTicketedValuesResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[DistributorTicketedValues]	false	none	[DistributorTicketedValues]
ResponseError	AgentivityError	false	none	AgentivityError

DistributorTicketedValues

{
  "PlatingCarrier": "string",
  "ShortName": "string",
  "NumberOfTickets": "string",
  "Currency": "string",
  "TotalValue": "string"
}

DistributorTicketedValues

Properties

Name	Type	Required	Restrictions	Description
PlatingCarrier	string	false	none	none
ShortName	string	false	none	none
NumberOfTickets	string	false	none	none
Currency	string	false	none	none
TotalValue	string	false	none	none

EventMonitoringResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "AgentivityRef": 0,
      "PNR": "string",
      "Consultant": "string",
      "PaxList": "string",
      "Account": "string",
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      },
      "ItineraryFormatted": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

EventMonitoringResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[EventMonitoring]	false	none	[EventMonitoring]
ResponseError	AgentivityError	false	none	AgentivityError

EventMonitoring

{
  "AgentivityRef": 0,
  "PNR": "string",
  "Consultant": "string",
  "PaxList": "string",
  "Account": "string",
  "Itinerary": {
    "SegmentTypesFilter": [
      "string"
    ],
    "FilteredSegments": null,
    "Capacity": 0,
    "Count": 0,
    "Item": {
      "ArrivalTimeFormatted": "string",
      "BoardPoint": "string",
      "ChangeOfDayFormatted": "string",
      "DepartureTimeFormatted": "string",
      "EndDate": "string",
      "OffPoint": "string",
      "OperatorCode": "string",
      "OperatorService": "string",
      "SegmentNbr": 0,
      "SegmentStatus": "string",
      "SegmentType": "string",
      "ServiceCode": "string",
      "StartDate": "string",
      "TicketNumber": "string"
    }
  },
  "ItineraryFormatted": "string"
}

EventMonitoring

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
PNR	string	false	none	none
Consultant	string	false	none	none
PaxList	string	false	none	none
Account	string	false	none	none
Itinerary	ItinerarySegmentsCollection	false	none	ItinerarySegmentsCollection
ItineraryFormatted	string	false	none	none

CompanyStatsForYear

{
  "Data": {}
}

CompanyStatsForYear

Properties

Name	Type	Required	Restrictions	Description
Data	DataSet	false	none	Represents an in-memory cache of data.

DataSet

{}

DataSet

Properties

None

GDSDestinationsItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Destination": "string",
      "DestinationPCC": "string",
      "DestinationPCCQ": "string",
      "DestinationPCCQCategory": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

GDSDestinationsItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	GDSDestinationsResponseReport	false	none	GDSDestinationsResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

GDSDestinationsResponseReport

{
  "Item": {
    "Destination": "string",
    "DestinationPCC": "string",
    "DestinationPCCQ": "string",
    "DestinationPCCQCategory": "string"
  }
}

GDSDestinationsResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	GDSDestination	false	none	GDSDestination

GDSDestination

{
  "Destination": "string",
  "DestinationPCC": "string",
  "DestinationPCCQ": "string",
  "DestinationPCCQCategory": "string"
}

GDSDestination

Properties

Name	Type	Required	Restrictions	Description
Destination	string	false	none	none
DestinationPCC	string	false	none	none
DestinationPCCQ	string	false	none	none
DestinationPCCQCategory	string	false	none	none

HotelSegmentsByUserItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "HotelSegmentNbr": "string",
      "PCC": "string",
      "PNR": "string",
      "Consultant": "string",
      "StatusCode": "string",
      "ArrivalDate": "string",
      "DepartureDate": "string",
      "PropertyName": "string",
      "ChainCode": "string",
      "ChainName": "string",
      "City": "string",
      "CityCode": "string",
      "CityName": "string",
      "CountryCode": "string",
      "CountryName": "string",
      "Passenger": "string",
      "Account": "string",
      "ConfirmationNbr": "string",
      "Currency": "string",
      "Rate": "string",
      "RoomBookingCode": "string",
      "NbrNights": 0,
      "MultiLevelRateCode": "string",
      "NbrRooms": 0,
      "BookedInName": "string",
      "ServiceInformation": "string",
      "TotalAirSegs": "string",
      "CreatingAgencyIata": "string",
      "AgentivityRef": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

HotelSegmentsByUserItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	HotelSegmentsByUserResponseReport	false	none	HotelSegmentsByUserResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

HotelSegmentsByUserResponseReport

{
  "Item": {
    "HotelSegmentNbr": "string",
    "PCC": "string",
    "PNR": "string",
    "Consultant": "string",
    "StatusCode": "string",
    "ArrivalDate": "string",
    "DepartureDate": "string",
    "PropertyName": "string",
    "ChainCode": "string",
    "ChainName": "string",
    "City": "string",
    "CityCode": "string",
    "CityName": "string",
    "CountryCode": "string",
    "CountryName": "string",
    "Passenger": "string",
    "Account": "string",
    "ConfirmationNbr": "string",
    "Currency": "string",
    "Rate": "string",
    "RoomBookingCode": "string",
    "NbrNights": 0,
    "MultiLevelRateCode": "string",
    "NbrRooms": 0,
    "BookedInName": "string",
    "ServiceInformation": "string",
    "TotalAirSegs": "string",
    "CreatingAgencyIata": "string",
    "AgentivityRef": 0
  }
}

HotelSegmentsByUserResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	HotelSegmentWithOwner	false	none	HotelSegmentWithOwner

HotelSegmentWithOwner

{
  "HotelSegmentNbr": "string",
  "PCC": "string",
  "PNR": "string",
  "Consultant": "string",
  "StatusCode": "string",
  "ArrivalDate": "string",
  "DepartureDate": "string",
  "PropertyName": "string",
  "ChainCode": "string",
  "ChainName": "string",
  "City": "string",
  "CityCode": "string",
  "CityName": "string",
  "CountryCode": "string",
  "CountryName": "string",
  "Passenger": "string",
  "Account": "string",
  "ConfirmationNbr": "string",
  "Currency": "string",
  "Rate": "string",
  "RoomBookingCode": "string",
  "NbrNights": 0,
  "MultiLevelRateCode": "string",
  "NbrRooms": 0,
  "BookedInName": "string",
  "ServiceInformation": "string",
  "TotalAirSegs": "string",
  "CreatingAgencyIata": "string",
  "AgentivityRef": 0
}

HotelSegmentWithOwner

Properties

Name	Type	Required	Restrictions	Description
HotelSegmentNbr	string	false	none	none
PCC	string	false	none	none
PNR	string	false	none	none
Consultant	string	false	none	none
StatusCode	string	false	none	none
ArrivalDate	string	false	none	none
DepartureDate	string	false	none	none
PropertyName	string	false	none	none
ChainCode	string	false	none	none
ChainName	string	false	none	none
City	string	false	none	none
CityCode	string	false	none	none
CityName	string	false	none	none
CountryCode	string	false	none	none
CountryName	string	false	none	none
Passenger	string	false	none	none
Account	string	false	none	none
ConfirmationNbr	string	false	none	none
Currency	string	false	none	none
Rate	string	false	none	none
RoomBookingCode	string	false	none	none
NbrNights	integer(int32)	false	none	none
MultiLevelRateCode	string	false	none	none
NbrRooms	integer(int32)	false	none	none
BookedInName	string	false	none	none
ServiceInformation	string	false	none	none
TotalAirSegs	string	false	none	none
CreatingAgencyIata	string	false	none	none
AgentivityRef	integer(int32)	false	none	none

ItineraryChangeEventsSummaryItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "EventType": "string",
      "Count": 0,
      "Ticketed": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

ItineraryChangeEventsSummaryItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	ItineraryChangeEventsSummaryResponseReport	false	none	ItineraryChangeEventsSummaryResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

ItineraryChangeEventsSummaryResponseReport

{
  "Item": {
    "EventType": "string",
    "Count": 0,
    "Ticketed": "string"
  }
}

ItineraryChangeEventsSummaryResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	ItineraryChangeEventsSummary	false	none	ItineraryChangeEventsSummary

ItineraryChangeEventsSummary

{
  "EventType": "string",
  "Count": 0,
  "Ticketed": "string"
}

ItineraryChangeEventsSummary

Properties

Name	Type	Required	Restrictions	Description
EventType	string	false	none	none
Count	integer(int32)	false	none	none
Ticketed	string	false	none	none

BookingsByGDSDestinationItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyLocationID": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "OwningConsultantID": "string",
      "Source": "string",
      "Destination": "string",
      "RuleName": "string",
      "Success": "string",
      "LoggedDateTime": "2019-03-18T11:42:49Z",
      "FailureReason": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsByGDSDestinationItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsByGDSDestinationResponseReport	false	none	BookingsByGDSDestinationResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsByGDSDestinationResponseReport

{
  "Item": {
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "OwningAgencyLocationID": "string",
    "Account": "string",
    "OwningConsultant": "string",
    "OwningConsultantID": "string",
    "Source": "string",
    "Destination": "string",
    "RuleName": "string",
    "Success": "string",
    "LoggedDateTime": "2019-03-18T11:42:49Z",
    "FailureReason": "string"
  }
}

BookingsByGDSDestinationResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingWithGDSDestination	false	none	BookingWithGDSDestination

BookingWithGDSDestination

{
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "OwningAgencyLocationID": "string",
  "Account": "string",
  "OwningConsultant": "string",
  "OwningConsultantID": "string",
  "Source": "string",
  "Destination": "string",
  "RuleName": "string",
  "Success": "string",
  "LoggedDateTime": "2019-03-18T11:42:49Z",
  "FailureReason": "string"
}

BookingWithGDSDestination

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
OwningAgencyLocationID	string	false	none	none
Account	string	false	none	none
OwningConsultant	string	false	none	none
OwningConsultantID	string	false	none	none
Source	string	false	none	none
Destination	string	false	none	none
RuleName	string	false	none	none
Success	string	false	none	none
LoggedDateTime	string(date-time)	false	none	none
FailureReason	string	false	none	none

MrrTrackingResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Month": "string",
      "Year": 0,
      "Mrr": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

MrrTrackingResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[MrrTracking]	false	none	[MrrTracking]
ResponseError	AgentivityError	false	none	AgentivityError

MrrTracking

{
  "Month": "string",
  "Year": 0,
  "Mrr": 0
}

MrrTracking

Properties

Name	Type	Required	Restrictions	Description
Month	string	false	none	none
Year	integer(int32)	false	none	none
Mrr	integer(int32)	false	none	none

PARUsagePerCompanyResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "OwningAgencyPseudo": "string",
      "TotalBookings": "string",
      "NumberOfPAR": "string",
      "PercentOfPAR": "string",
      "NumberOfBAR": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

PARUsagePerCompanyResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[PARUsagePerCompany]	false	none	[PARUsagePerCompany]
ResponseError	AgentivityError	false	none	AgentivityError

PARUsagePerCompany

{
  "OwningAgencyPseudo": "string",
  "TotalBookings": "string",
  "NumberOfPAR": "string",
  "PercentOfPAR": "string",
  "NumberOfBAR": "string"
}

PARUsagePerCompany

Properties

Name	Type	Required	Restrictions	Description
OwningAgencyPseudo	string	false	none	none
TotalBookings	string	false	none	none
NumberOfPAR	string	false	none	none
PercentOfPAR	string	false	none	none
NumberOfBAR	string	false	none	none

PARUsagePerUserResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Consultant": "string",
      "TotalBookings": "string",
      "NumberOfPAR": "string",
      "PercentOfPAR": "string",
      "NumberOfBAR": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

PARUsagePerUserResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[PARUsagePerUser]	false	none	[PARUsagePerUser]
ResponseError	AgentivityError	false	none	AgentivityError

PARUsagePerUser

{
  "Consultant": "string",
  "TotalBookings": "string",
  "NumberOfPAR": "string",
  "PercentOfPAR": "string",
  "NumberOfBAR": "string"
}

PARUsagePerUser

Properties

Name	Type	Required	Restrictions	Description
Consultant	string	false	none	none
TotalBookings	string	false	none	none
NumberOfPAR	string	false	none	none
PercentOfPAR	string	false	none	none
NumberOfBAR	string	false	none	none

PassengerAirSegmentsWithMaxTravellerMembersByUserResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Account": "string",
      "ArrivalCity": "string",
      "ArrivalDate": "string",
      "ArrivalTime": "string",
      "CostCentre": "string",
      "DepartureCity": "string",
      "DepartureDate": "string",
      "DepartureTime": "string",
      "FlightNbr": "string",
      "GroupName": "string",
      "MaxTravellerCount": 0,
      "MaxTravellerCountExceededFlag": true,
      "OperatingCarrierCode": "string",
      "Passenger": "string",
      "PNRTicketed": "string",
      "RecordLocator": "string",
      "TravellerCount": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

PassengerAirSegmentsWithMaxTravellerMembersByUserResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[PassengerAirSegmentsWithMaxTravellerMembers]	false	none	[PassengerAirSegmentsWithMaxTravellerMembers]
ResponseError	AgentivityError	false	none	AgentivityError

PassengerAirSegmentsWithMaxTravellerMembers

{
  "Account": "string",
  "ArrivalCity": "string",
  "ArrivalDate": "string",
  "ArrivalTime": "string",
  "CostCentre": "string",
  "DepartureCity": "string",
  "DepartureDate": "string",
  "DepartureTime": "string",
  "FlightNbr": "string",
  "GroupName": "string",
  "MaxTravellerCount": 0,
  "MaxTravellerCountExceededFlag": true,
  "OperatingCarrierCode": "string",
  "Passenger": "string",
  "PNRTicketed": "string",
  "RecordLocator": "string",
  "TravellerCount": 0
}

PassengerAirSegmentsWithMaxTravellerMembers

Properties

Name	Type	Required	Restrictions	Description
Account	string	false	none	none
ArrivalCity	string	false	none	none
ArrivalDate	string	false	none	none
ArrivalTime	string	false	none	none
CostCentre	string	false	none	none
DepartureCity	string	false	none	none
DepartureDate	string	false	none	none
DepartureTime	string	false	none	none
FlightNbr	string	false	none	none
GroupName	string	false	none	none
MaxTravellerCount	integer(int32)	false	none	none
MaxTravellerCountExceededFlag	boolean	false	none	none
OperatingCarrierCode	string	false	none	none
Passenger	string	false	none	none
PNRTicketed	string	false	none	none
RecordLocator	string	false	none	none
TravellerCount	integer(int32)	false	none	none

PassengerDeparturesItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningConsultant": "string",
      "Passenger": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "TicketedStatusCode": "string",
      "TicketedStatus": "string",
      "SupplierReference": "string",
      "SMS": "string",
      "Vouchers": "string",
      "Transfers": "string",
      "IsVip": true,
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      },
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

PassengerDeparturesItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	PassengerDeparturesResponseReport	false	none	PassengerDeparturesResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

PassengerDeparturesResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "OwningConsultant": "string",
    "Passenger": "string",
    "Account": "string",
    "TravelDate": "2019-03-18T11:42:49Z",
    "TicketedStatusCode": "string",
    "TicketedStatus": "string",
    "SupplierReference": "string",
    "SMS": "string",
    "Vouchers": "string",
    "Transfers": "string",
    "IsVip": true,
    "Itinerary": {
      "SegmentTypesFilter": [
        "string"
      ],
      "FilteredSegments": null,
      "Capacity": 0,
      "Count": 0,
      "Item": {
        "ArrivalTimeFormatted": "string",
        "BoardPoint": "string",
        "ChangeOfDayFormatted": "string",
        "DepartureTimeFormatted": "string",
        "EndDate": "string",
        "OffPoint": "string",
        "OperatorCode": "string",
        "OperatorService": "string",
        "SegmentNbr": 0,
        "SegmentStatus": "string",
        "SegmentType": "string",
        "ServiceCode": "string",
        "StartDate": "string",
        "TicketNumber": "string"
      }
    },
    "ItineraryFormatted": "string"
  }
}

PassengerDeparturesResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	PassengerDeparture	false	none	PassengerDeparture

PassengerDeparture

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "OwningConsultant": "string",
  "Passenger": "string",
  "Account": "string",
  "TravelDate": "2019-03-18T11:42:49Z",
  "TicketedStatusCode": "string",
  "TicketedStatus": "string",
  "SupplierReference": "string",
  "SMS": "string",
  "Vouchers": "string",
  "Transfers": "string",
  "IsVip": true,
  "Itinerary": {
    "SegmentTypesFilter": [
      "string"
    ],
    "FilteredSegments": null,
    "Capacity": 0,
    "Count": 0,
    "Item": {
      "ArrivalTimeFormatted": "string",
      "BoardPoint": "string",
      "ChangeOfDayFormatted": "string",
      "DepartureTimeFormatted": "string",
      "EndDate": "string",
      "OffPoint": "string",
      "OperatorCode": "string",
      "OperatorService": "string",
      "SegmentNbr": 0,
      "SegmentStatus": "string",
      "SegmentType": "string",
      "ServiceCode": "string",
      "StartDate": "string",
      "TicketNumber": "string"
    }
  },
  "ItineraryFormatted": "string"
}

PassengerDeparture

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
OwningConsultant	string	false	none	none
Passenger	string	false	none	none
Account	string	false	none	none
TravelDate	string(date-time)	false	none	none
TicketedStatusCode	string	false	none	none
TicketedStatus	string	false	none	none
SupplierReference	string	false	none	none
SMS	string	false	none	none
Vouchers	string	false	none	none
Transfers	string	false	none	none
IsVip	boolean	false	none	none
Itinerary	ItinerarySegmentsCollection	false	none	ItinerarySegmentsCollection
ItineraryFormatted	string	false	none	none

PassengerLocationsByUserAirportItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "PNR": "string",
      "TravelDate": "string",
      "DepartureDate": "string",
      "BoardPoint": "string",
      "OffPoint": "string",
      "PnrTicketed": "string",
      "Account": "string",
      "Consultant": "string",
      "PaxList": "string",
      "PhoneNbr": "string",
      "EmailAddress": "string",
      "DestinationCities": "string",
      "Connections": "string",
      "CarrierCodes": "string",
      "AgentivityRef": "string",
      "HotelsNames": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

PassengerLocationsByUserAirportItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	PassengerLocationsByUserAirportResponseReport	false	none	PassengerLocationsByUserAirportResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

PassengerLocationsByUserAirportResponseReport

{
  "Item": {
    "PNR": "string",
    "TravelDate": "string",
    "DepartureDate": "string",
    "BoardPoint": "string",
    "OffPoint": "string",
    "PnrTicketed": "string",
    "Account": "string",
    "Consultant": "string",
    "PaxList": "string",
    "PhoneNbr": "string",
    "EmailAddress": "string",
    "DestinationCities": "string",
    "Connections": "string",
    "CarrierCodes": "string",
    "AgentivityRef": "string",
    "HotelsNames": "string"
  }
}

PassengerLocationsByUserAirportResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	PassengerLocation	false	none	PassengerLocation

PassengerLocation

{
  "PNR": "string",
  "TravelDate": "string",
  "DepartureDate": "string",
  "BoardPoint": "string",
  "OffPoint": "string",
  "PnrTicketed": "string",
  "Account": "string",
  "Consultant": "string",
  "PaxList": "string",
  "PhoneNbr": "string",
  "EmailAddress": "string",
  "DestinationCities": "string",
  "Connections": "string",
  "CarrierCodes": "string",
  "AgentivityRef": "string",
  "HotelsNames": "string"
}

PassengerLocation

Properties

Name	Type	Required	Restrictions	Description
PNR	string	false	none	none
TravelDate	string	false	none	none
DepartureDate	string	false	none	none
BoardPoint	string	false	none	none
OffPoint	string	false	none	none
PnrTicketed	string	false	none	none
Account	string	false	none	none
Consultant	string	false	none	none
PaxList	string	false	none	none
PhoneNbr	string	false	none	none
EmailAddress	string	false	none	none
DestinationCities	string	false	none	none
Connections	string	false	none	none
CarrierCodes	string	false	none	none
AgentivityRef	string	false	none	none
HotelsNames	string	false	none	none

PassengerLocationsByUserCityItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "PNR": "string",
      "TravelDate": "string",
      "DepartureDate": "string",
      "BoardPoint": "string",
      "OffPoint": "string",
      "PnrTicketed": "string",
      "Account": "string",
      "Consultant": "string",
      "PaxList": "string",
      "PhoneNbr": "string",
      "EmailAddress": "string",
      "DestinationCities": "string",
      "Connections": "string",
      "CarrierCodes": "string",
      "AgentivityRef": "string",
      "HotelsNames": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

PassengerLocationsByUserCityItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	PassengerLocationsByUserCityResponseReport	false	none	PassengerLocationsByUserCityResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

PassengerLocationsByUserCityResponseReport

{
  "Item": {
    "PNR": "string",
    "TravelDate": "string",
    "DepartureDate": "string",
    "BoardPoint": "string",
    "OffPoint": "string",
    "PnrTicketed": "string",
    "Account": "string",
    "Consultant": "string",
    "PaxList": "string",
    "PhoneNbr": "string",
    "EmailAddress": "string",
    "DestinationCities": "string",
    "Connections": "string",
    "CarrierCodes": "string",
    "AgentivityRef": "string",
    "HotelsNames": "string"
  }
}

PassengerLocationsByUserCityResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	PassengerLocation	false	none	PassengerLocation

PassiveSegmentsResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Address": "string",
      "AgentivityRef": 0,
      "BookingReasonCode": "string",
      "BookingSource": "string",
      "CityCode": "string",
      "CommissionInformation": "string",
      "ConfirmationNumber": "string",
      "NbrNights": "string",
      "OwningConsultantID": "string",
      "PropertyName": "string",
      "PropertyNumber": "string",
      "RateAccessCode": "string",
      "RateCode": "string",
      "RateQuoted": "string",
      "SegmentType": "string",
      "ServiceInformation": "string",
      "StartDate": "string",
      "Text": "string",
      "TotalAirSegs": "string",
      "VendorCode": "string",
      "RecordLocator": "string",
      "OwningAgencyLocationID": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "Passenger": "string",
      "DepartureDate": "string",
      "SegmentStatus": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

PassiveSegmentsResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	PassiveSegmentsByUserResponseReport	false	none	PassiveSegmentsByUserResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

PassiveSegmentsByUserResponseReport

{
  "Item": {
    "Address": "string",
    "AgentivityRef": 0,
    "BookingReasonCode": "string",
    "BookingSource": "string",
    "CityCode": "string",
    "CommissionInformation": "string",
    "ConfirmationNumber": "string",
    "NbrNights": "string",
    "OwningConsultantID": "string",
    "PropertyName": "string",
    "PropertyNumber": "string",
    "RateAccessCode": "string",
    "RateCode": "string",
    "RateQuoted": "string",
    "SegmentType": "string",
    "ServiceInformation": "string",
    "StartDate": "string",
    "Text": "string",
    "TotalAirSegs": "string",
    "VendorCode": "string",
    "RecordLocator": "string",
    "OwningAgencyLocationID": "string",
    "OwningConsultant": "string",
    "Account": "string",
    "Passenger": "string",
    "DepartureDate": "string",
    "SegmentStatus": "string"
  }
}

PassiveSegmentsByUserResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	PassiveSegmentWithOwningInformation	false	none	PassiveSegmentWithOwningInformation

PassiveSegmentWithOwningInformation

{
  "Address": "string",
  "AgentivityRef": 0,
  "BookingReasonCode": "string",
  "BookingSource": "string",
  "CityCode": "string",
  "CommissionInformation": "string",
  "ConfirmationNumber": "string",
  "NbrNights": "string",
  "OwningConsultantID": "string",
  "PropertyName": "string",
  "PropertyNumber": "string",
  "RateAccessCode": "string",
  "RateCode": "string",
  "RateQuoted": "string",
  "SegmentType": "string",
  "ServiceInformation": "string",
  "StartDate": "string",
  "Text": "string",
  "TotalAirSegs": "string",
  "VendorCode": "string",
  "RecordLocator": "string",
  "OwningAgencyLocationID": "string",
  "OwningConsultant": "string",
  "Account": "string",
  "Passenger": "string",
  "DepartureDate": "string",
  "SegmentStatus": "string"
}

PassiveSegmentWithOwningInformation

Properties

Name	Type	Required	Restrictions	Description
Address	string	false	none	none
AgentivityRef	integer(int32)	false	none	none
BookingReasonCode	string	false	none	none
BookingSource	string	false	none	none
CityCode	string	false	none	none
CommissionInformation	string	false	none	none
ConfirmationNumber	string	false	none	none
NbrNights	string	false	none	none
OwningConsultantID	string	false	none	none
PropertyName	string	false	none	none
PropertyNumber	string	false	none	none
RateAccessCode	string	false	none	none
RateCode	string	false	none	none
RateQuoted	string	false	none	none
SegmentType	string	false	none	none
ServiceInformation	string	false	none	none
StartDate	string	false	none	none
Text	string	false	none	none
TotalAirSegs	string	false	none	none
VendorCode	string	false	none	none
RecordLocator	string	false	none	none
OwningAgencyLocationID	string	false	none	none
OwningConsultant	string	false	none	none
Account	string	false	none	none
Passenger	string	false	none	none
DepartureDate	string	false	none	none
SegmentStatus	string	false	none	none

ProblematicSegmentsByUserItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "RecordLocator": "string",
      "OwningConsultantID": "string",
      "PrimaryPax": "string",
      "TransactionAgent": "string",
      "Account": "string",
      "SegmentStatus": "string",
      "Segment": "string",
      "AgentivityRef": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

ProblematicSegmentsByUserItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	ProblematicSegmentsByUserResponseReport	false	none	ProblematicSegmentsByUserResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

ProblematicSegmentsByUserResponseReport

{
  "Item": {
    "RecordLocator": "string",
    "OwningConsultantID": "string",
    "PrimaryPax": "string",
    "TransactionAgent": "string",
    "Account": "string",
    "SegmentStatus": "string",
    "Segment": "string",
    "AgentivityRef": "string"
  }
}

ProblematicSegmentsByUserResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	ProblematicSegment	false	none	ProblematicSegment

ProblematicSegment

{
  "RecordLocator": "string",
  "OwningConsultantID": "string",
  "PrimaryPax": "string",
  "TransactionAgent": "string",
  "Account": "string",
  "SegmentStatus": "string",
  "Segment": "string",
  "AgentivityRef": "string"
}

ProblematicSegment

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
OwningConsultantID	string	false	none	none
PrimaryPax	string	false	none	none
TransactionAgent	string	false	none	none
Account	string	false	none	none
SegmentStatus	string	false	none	none
Segment	string	false	none	none
AgentivityRef	string	false	none	none

ProductSalesPerMonthResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "ProductName": "string",
      "Revenue": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

ProductSalesPerMonthResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[ProductSalesPerMonth]	false	none	[ProductSalesPerMonth]
ResponseError	AgentivityError	false	none	AgentivityError

ProductSalesPerMonth

{
  "ProductName": "string",
  "Revenue": 0
}

ProductSalesPerMonth

Properties

Name	Type	Required	Restrictions	Description
ProductName	string	false	none	none
Revenue	number(float)	false	none	none

ProductResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "ProductName": "string",
      "ProductId": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

ProductResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[Product]	false	none	[Product]
ResponseError	AgentivityError	false	none	AgentivityError

Product

{
  "ProductName": "string",
  "ProductId": "string"
}

Product

Properties

Name	Type	Required	Restrictions	Description
ProductName	string	false	none	none
ProductId	string	false	none	none

QcAgentInitialsAndCommentsResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "PNRCreationDate": "string",
      "AgentInitials": "string",
      "Comment": "string",
      "Consultant": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

QcAgentInitialsAndCommentsResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[QcAgentInitialsAndComments]	false	none	[QcAgentInitialsAndComments]
ResponseError	AgentivityError	false	none	AgentivityError

QcAgentInitialsAndComments

{
  "RecordLocator": "string",
  "PNRCreationDate": "string",
  "AgentInitials": "string",
  "Comment": "string",
  "Consultant": "string"
}

QcAgentInitialsAndComments

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
PNRCreationDate	string	false	none	none
AgentInitials	string	false	none	none
Comment	string	false	none	none
Consultant	string	false	none	none

QcCommentsForConsultantResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "Consultant": "string",
      "AgentInitials": "string",
      "Comment": "string",
      "CommentDate": "2019-03-18T11:42:49Z"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

QcCommentsForConsultantResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[QcCommentsForConsultant]	false	none	[QcCommentsForConsultant]
ResponseError	AgentivityError	false	none	AgentivityError

QcCommentsForConsultant

{
  "RecordLocator": "string",
  "Consultant": "string",
  "AgentInitials": "string",
  "Comment": "string",
  "CommentDate": "2019-03-18T11:42:49Z"
}

QcCommentsForConsultant

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
Consultant	string	false	none	none
AgentInitials	string	false	none	none
Comment	string	false	none	none
CommentDate	string(date-time)	false	none	none

QcCommentsResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Consultant": "string",
      "AgentInitials": "string",
      "BookingsCount": 0,
      "CommentsCount": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

QcCommentsResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[QcComments]	false	none	[QcComments]
ResponseError	AgentivityError	false	none	AgentivityError

QcComments

{
  "Consultant": "string",
  "AgentInitials": "string",
  "BookingsCount": 0,
  "CommentsCount": 0
}

QcComments

Properties

Name	Type	Required	Restrictions	Description
Consultant	string	false	none	none
AgentInitials	string	false	none	none
BookingsCount	integer(int32)	false	none	none
CommentsCount	integer(int32)	false	none	none

QLogEmItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "EntryID": 0,
      "MatchedOn": "string",
      "RecordLocator": "string",
      "LogDate": "2019-03-18T11:42:49Z",
      "EventType": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

QLogEmItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	QLogEmResponseReport	false	none	QLogEmResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

QLogEmResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "EntryID": 0,
    "MatchedOn": "string",
    "RecordLocator": "string",
    "LogDate": "2019-03-18T11:42:49Z",
    "EventType": "string"
  }
}

QLogEmResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	QLogEmItem	false	none	QLogEmItem

QLogEmItem

{
  "AgentivityRef": 0,
  "EntryID": 0,
  "MatchedOn": "string",
  "RecordLocator": "string",
  "LogDate": "2019-03-18T11:42:49Z",
  "EventType": "string"
}

QLogEmItem

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
EntryID	integer(int32)	false	none	none
MatchedOn	string	false	none	none
RecordLocator	string	false	none	none
LogDate	string(date-time)	false	none	none
EventType	string	false	none	none

QLogForwardItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "LogID": 0,
      "MatchedOn": "string",
      "RecordLocator": "string",
      "Destination": "string",
      "LogDate": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

QLogForwardItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	QLogForwardResponseReport	false	none	QLogForwardResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

QLogForwardResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "LogID": 0,
    "MatchedOn": "string",
    "RecordLocator": "string",
    "Destination": "string",
    "LogDate": "2019-03-18T11:42:49Z"
  }
}

QLogForwardResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	QLogForwardItem	false	none	QLogForwardItem

QLogForwardItem

{
  "AgentivityRef": 0,
  "LogID": 0,
  "MatchedOn": "string",
  "RecordLocator": "string",
  "Destination": "string",
  "LogDate": "2019-03-18T11:42:49Z"
}

QLogForwardItem

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
LogID	integer(int32)	false	none	none
MatchedOn	string	false	none	none
RecordLocator	string	false	none	none
Destination	string	false	none	none
LogDate	string(date-time)	false	none	none

QLogIgnoredItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "LogID": 0,
      "LogTime": "2019-03-18T11:42:49Z",
      "SiteID": 0,
      "Queue": "string",
      "RecordLocator": "string",
      "RejectReason": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

QLogIgnoredItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	QLogIgnoredResponseReport	false	none	QLogIgnoredResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

QLogIgnoredResponseReport

{
  "Item": {
    "LogID": 0,
    "LogTime": "2019-03-18T11:42:49Z",
    "SiteID": 0,
    "Queue": "string",
    "RecordLocator": "string",
    "RejectReason": "string"
  }
}

QLogIgnoredResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	QLogIgnoredItem	false	none	QLogIgnoredItem

QLogIgnoredItem

{
  "LogID": 0,
  "LogTime": "2019-03-18T11:42:49Z",
  "SiteID": 0,
  "Queue": "string",
  "RecordLocator": "string",
  "RejectReason": "string"
}

QLogIgnoredItem

Properties

Name	Type	Required	Restrictions	Description
LogID	integer(int32)	false	none	none
LogTime	string(date-time)	false	none	none
SiteID	integer(int32)	false	none	none
Queue	string	false	none	none
RecordLocator	string	false	none	none
RejectReason	string	false	none	none

QSorterLogErrorsItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "SiteID": 0,
      "SitePCC": "string",
      "Queue": "string",
      "RuleName": "string",
      "FailureReason": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

QSorterLogErrorsItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	QSorterLogErrorsResponseReport	false	none	QSorterLogErrorsResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

QSorterLogErrorsResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "SiteID": 0,
    "SitePCC": "string",
    "Queue": "string",
    "RuleName": "string",
    "FailureReason": "string"
  }
}

QSorterLogErrorsResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	QSorterLogError	false	none	QSorterLogError

QSorterLogError

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "SiteID": 0,
  "SitePCC": "string",
  "Queue": "string",
  "RuleName": "string",
  "FailureReason": "string"
}

QSorterLogError

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
SiteID	integer(int32)	false	none	none
SitePCC	string	false	none	none
Queue	string	false	none	none
RuleName	string	false	none	none
FailureReason	string	false	none	none

RemarkQualifierResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "Account": "string",
      "Passangers": "string",
      "TravelDate": "string",
      "Remark": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

RemarkQualifierResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[RemarkQualifier]	false	none	[RemarkQualifier]
ResponseError	AgentivityError	false	none	AgentivityError

RemarkQualifier

{
  "RecordLocator": "string",
  "Account": "string",
  "Passangers": "string",
  "TravelDate": "string",
  "Remark": "string"
}

RemarkQualifier

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
Account	string	false	none	none
Passangers	string	false	none	none
TravelDate	string	false	none	none
Remark	string	false	none	none

RMQServicesLogResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "LogDateTime": "2019-03-18T11:42:49Z",
      "LogDateTimeFormated": "string",
      "Message": "string",
      "RecordLocator": "string",
      "Gds": "string",
      "PCC": "string",
      "TransactionAgent": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

RMQServicesLogResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[RMQServicesLog]	false	none	[RMQServicesLog]
ResponseError	AgentivityError	false	none	AgentivityError

RMQServicesLog

{
  "LogDateTime": "2019-03-18T11:42:49Z",
  "LogDateTimeFormated": "string",
  "Message": "string",
  "RecordLocator": "string",
  "Gds": "string",
  "PCC": "string",
  "TransactionAgent": "string"
}

RMQServicesLog

Properties

Name	Type	Required	Restrictions	Description
LogDateTime	string(date-time)	false	none	none
LogDateTimeFormated	string	false	none	none
Message	string	false	none	none
RecordLocator	string	false	none	none
Gds	string	false	none	none
PCC	string	false	none	none
TransactionAgent	string	false	none	none

PNRTotalsPerCompanyResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "CompanyName": "string",
      "CompanyID": 0,
      "CompanyType": "string",
      "ProductLevel": "string",
      "TotalPNRsProcessed": 0,
      "DCPNRTotal": 0,
      "DCPNRTotalAmadeus": 0,
      "DCPNRTotalSabre": 0,
      "DCPNRTotalGalileo": 0,
      "DCPNRTotalApollo": 0,
      "DCPNRTotalGTA": 0,
      "DCPNRTotalTrnline": 0,
      "Tier": "string",
      "TotalPNRsProcessedAmadeus": 0,
      "TotalPNRsProcessedSabre": 0,
      "TotalPNRsProcessedGalileo": 0,
      "TotalPNRsProcessedApollo": 0,
      "TotalPNRsProcessedGTA": 0,
      "TotalPNRsProcessedTrnline": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

PNRTotalsPerCompanyResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[CompanyTotalPNRs]	false	none	[CompanyTotalPNRs]
ResponseError	AgentivityError	false	none	AgentivityError

CompanyTotalPNRs

{
  "CompanyName": "string",
  "CompanyID": 0,
  "CompanyType": "string",
  "ProductLevel": "string",
  "TotalPNRsProcessed": 0,
  "DCPNRTotal": 0,
  "DCPNRTotalAmadeus": 0,
  "DCPNRTotalSabre": 0,
  "DCPNRTotalGalileo": 0,
  "DCPNRTotalApollo": 0,
  "DCPNRTotalGTA": 0,
  "DCPNRTotalTrnline": 0,
  "Tier": "string",
  "TotalPNRsProcessedAmadeus": 0,
  "TotalPNRsProcessedSabre": 0,
  "TotalPNRsProcessedGalileo": 0,
  "TotalPNRsProcessedApollo": 0,
  "TotalPNRsProcessedGTA": 0,
  "TotalPNRsProcessedTrnline": 0
}

CompanyTotalPNRs

Properties

Name	Type	Required	Restrictions	Description
CompanyName	string	false	none	none
CompanyID	integer(int32)	false	none	none
CompanyType	string	false	none	none
ProductLevel	string	false	none	none
TotalPNRsProcessed	integer(int32)	false	none	none
DCPNRTotal	integer(int32)	false	none	none
DCPNRTotalAmadeus	integer(int32)	false	none	none
DCPNRTotalSabre	integer(int32)	false	none	none
DCPNRTotalGalileo	integer(int32)	false	none	none
DCPNRTotalApollo	integer(int32)	false	none	none
DCPNRTotalGTA	integer(int32)	false	none	none
DCPNRTotalTrnline	integer(int32)	false	none	none
Tier	string	false	none	none
TotalPNRsProcessedAmadeus	integer(int32)	false	none	none
TotalPNRsProcessedSabre	integer(int32)	false	none	none
TotalPNRsProcessedGalileo	integer(int32)	false	none	none
TotalPNRsProcessedApollo	integer(int32)	false	none	none
TotalPNRsProcessedGTA	integer(int32)	false	none	none
TotalPNRsProcessedTrnline	integer(int32)	false	none	none

SalesPerCountryCurrentMonthResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Country": "string",
      "Revenue": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

SalesPerCountryCurrentMonthResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[SalesPerCountryCurrentMonth]	false	none	[SalesPerCountryCurrentMonth]
ResponseError	AgentivityError	false	none	AgentivityError

SalesPerCountryCurrentMonth

{
  "Country": "string",
  "Revenue": 0
}

SalesPerCountryCurrentMonth

Properties

Name	Type	Required	Restrictions	Description
Country	string	false	none	none
Revenue	number(float)	false	none	none

TicketCouponCodesResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "CouponCode": "string",
      "Name": "string",
      "IsGroup": true
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TicketCouponCodesResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[TicketCouponCodes]	false	none	[TicketCouponCodes]
ResponseError	AgentivityError	false	none	AgentivityError

TicketCouponCodes

{
  "CouponCode": "string",
  "Name": "string",
  "IsGroup": true
}

TicketCouponCodes

Properties

Name	Type	Required	Restrictions	Description
CouponCode	string	false	none	none
Name	string	false	none	none
IsGroup	boolean	false	none	none

TicketCouponsByStatusCodeResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RN": "string",
      "AirTktSegId": "string",
      "VndIssueDt": "2019-03-18T11:42:49Z",
      "RecordLocator": "string",
      "Passenger": "string",
      "TktNumber": "string",
      "TravAgntID": "string",
      "OwningConsultantID": "string",
      "FOPFare": "string",
      "BaseFare": "string",
      "FOP": "string",
      "TotalTax": "string",
      "Tax1Code": "string",
      "Tax1Amt": "string",
      "Tax2Code": "string",
      "Tax2Amt": "string",
      "Tax3Code": "string",
      "Tax3Amt": "string",
      "Tax4Amt": "string",
      "Tax4Code": "string",
      "Tax5Code": "string",
      "Tax5Amt": "string",
      "Account": "string",
      "ExchangedForTicket": "string",
      "CouponSequenceNbr": "string",
      "Carrier": "string",
      "BoardPoint": "string",
      "OffPoint": "string",
      "FlightDate": "2019-03-18T11:42:49Z",
      "FlightServiceClass": "string",
      "FareBasis": "string",
      "FlightCouponStatus": "string",
      "DateLastChecked": "2019-03-18T11:42:49Z",
      "PCC": "string",
      "AirlineCode": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TicketCouponsByStatusCodeResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[TicketCouponsByStatusCode]	false	none	[TicketCouponsByStatusCode]
ResponseError	AgentivityError	false	none	AgentivityError

TicketCouponsByStatusCode

{
  "RN": "string",
  "AirTktSegId": "string",
  "VndIssueDt": "2019-03-18T11:42:49Z",
  "RecordLocator": "string",
  "Passenger": "string",
  "TktNumber": "string",
  "TravAgntID": "string",
  "OwningConsultantID": "string",
  "FOPFare": "string",
  "BaseFare": "string",
  "FOP": "string",
  "TotalTax": "string",
  "Tax1Code": "string",
  "Tax1Amt": "string",
  "Tax2Code": "string",
  "Tax2Amt": "string",
  "Tax3Code": "string",
  "Tax3Amt": "string",
  "Tax4Amt": "string",
  "Tax4Code": "string",
  "Tax5Code": "string",
  "Tax5Amt": "string",
  "Account": "string",
  "ExchangedForTicket": "string",
  "CouponSequenceNbr": "string",
  "Carrier": "string",
  "BoardPoint": "string",
  "OffPoint": "string",
  "FlightDate": "2019-03-18T11:42:49Z",
  "FlightServiceClass": "string",
  "FareBasis": "string",
  "FlightCouponStatus": "string",
  "DateLastChecked": "2019-03-18T11:42:49Z",
  "PCC": "string",
  "AirlineCode": "string"
}

TicketCouponsByStatusCode

Properties

Name	Type	Required	Restrictions	Description
RN	string	false	none	none
AirTktSegId	string	false	none	none
VndIssueDt	string(date-time)	false	none	none
RecordLocator	string	false	none	none
Passenger	string	false	none	none
TktNumber	string	false	none	none
TravAgntID	string	false	none	none
OwningConsultantID	string	false	none	none
FOPFare	string	false	none	none
BaseFare	string	false	none	none
FOP	string	false	none	none
TotalTax	string	false	none	none
Tax1Code	string	false	none	none
Tax1Amt	string	false	none	none
Tax2Code	string	false	none	none
Tax2Amt	string	false	none	none
Tax3Code	string	false	none	none
Tax3Amt	string	false	none	none
Tax4Amt	string	false	none	none
Tax4Code	string	false	none	none
Tax5Code	string	false	none	none
Tax5Amt	string	false	none	none
Account	string	false	none	none
ExchangedForTicket	string	false	none	none
CouponSequenceNbr	string	false	none	none
Carrier	string	false	none	none
BoardPoint	string	false	none	none
OffPoint	string	false	none	none
FlightDate	string(date-time)	false	none	none
FlightServiceClass	string	false	none	none
FareBasis	string	false	none	none
FlightCouponStatus	string	false	none	none
DateLastChecked	string(date-time)	false	none	none
PCC	string	false	none	none
AirlineCode	string	false	none	none

TicketCouponsIssuedByUserItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "TktNumber": "string",
      "Passenger": "string",
      "VendorIssueDate": "2019-03-18T11:42:49Z",
      "FOP": "string",
      "FOPCurrncy": "string",
      "FOPFare": "string",
      "CouponSequenceNbr": "string",
      "FlightDate": "2019-03-18T11:42:49Z",
      "Routing": "string",
      "FlightServiceClass": "string",
      "FareBasis": "string",
      "Carrier": "string",
      "Account": "string",
      "OwningAgencyLocationID": "string",
      "FlightCouponStatus": "string",
      "DateLastChecked": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TicketCouponsIssuedByUserItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	TicketCouponsIssuedByUserResponseReport	false	none	TicketCouponsIssuedByUserResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

TicketCouponsIssuedByUserResponseReport

{
  "Item": {
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "TktNumber": "string",
    "Passenger": "string",
    "VendorIssueDate": "2019-03-18T11:42:49Z",
    "FOP": "string",
    "FOPCurrncy": "string",
    "FOPFare": "string",
    "CouponSequenceNbr": "string",
    "FlightDate": "2019-03-18T11:42:49Z",
    "Routing": "string",
    "FlightServiceClass": "string",
    "FareBasis": "string",
    "Carrier": "string",
    "Account": "string",
    "OwningAgencyLocationID": "string",
    "FlightCouponStatus": "string",
    "DateLastChecked": "2019-03-18T11:42:49Z"
  }
}

TicketCouponsIssuedByUserResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	TicketCouponIssued	false	none	TicketCouponIssued

TicketCouponIssued

{
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "TktNumber": "string",
  "Passenger": "string",
  "VendorIssueDate": "2019-03-18T11:42:49Z",
  "FOP": "string",
  "FOPCurrncy": "string",
  "FOPFare": "string",
  "CouponSequenceNbr": "string",
  "FlightDate": "2019-03-18T11:42:49Z",
  "Routing": "string",
  "FlightServiceClass": "string",
  "FareBasis": "string",
  "Carrier": "string",
  "Account": "string",
  "OwningAgencyLocationID": "string",
  "FlightCouponStatus": "string",
  "DateLastChecked": "2019-03-18T11:42:49Z"
}

TicketCouponIssued

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
TktNumber	string	false	none	none
Passenger	string	false	none	none
VendorIssueDate	string(date-time)	false	none	none
FOP	string	false	none	none
FOPCurrncy	string	false	none	none
FOPFare	string	false	none	none
CouponSequenceNbr	string	false	none	none
FlightDate	string(date-time)	false	none	none
Routing	string	false	none	none
FlightServiceClass	string	false	none	none
FareBasis	string	false	none	none
Carrier	string	false	none	none
Account	string	false	none	none
OwningAgencyLocationID	string	false	none	none
FlightCouponStatus	string	false	none	none
DateLastChecked	string(date-time)	false	none	none

HotelWithNoRateCodeCreatedResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Account": "string",
      "CheckInDate": "string",
      "CheckOutDate": "string",
      "City": "string",
      "ConfirmationNbr": "string",
      "CurrencyCode": "string",
      "HotelChainCode": "string",
      "HotelGalileoPropertyID": "string",
      "HotelName": "string",
      "Passengers": "string",
      "RateAmount": "string",
      "RecordLocator": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

HotelWithNoRateCodeCreatedResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[HotelWithNoRateCodeCreated]	false	none	[HotelWithNoRateCodeCreated]
ResponseError	AgentivityError	false	none	AgentivityError

HotelWithNoRateCodeCreated

{
  "Account": "string",
  "CheckInDate": "string",
  "CheckOutDate": "string",
  "City": "string",
  "ConfirmationNbr": "string",
  "CurrencyCode": "string",
  "HotelChainCode": "string",
  "HotelGalileoPropertyID": "string",
  "HotelName": "string",
  "Passengers": "string",
  "RateAmount": "string",
  "RecordLocator": "string"
}

HotelWithNoRateCodeCreated

Properties

Name	Type	Required	Restrictions	Description
Account	string	false	none	none
CheckInDate	string	false	none	none
CheckOutDate	string	false	none	none
City	string	false	none	none
ConfirmationNbr	string	false	none	none
CurrencyCode	string	false	none	none
HotelChainCode	string	false	none	none
HotelGalileoPropertyID	string	false	none	none
HotelName	string	false	none	none
Passengers	string	false	none	none
RateAmount	string	false	none	none
RecordLocator	string	false	none	none

BookingsTravellingResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningAgencyLocationID": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "Passengers": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "Mobile": "string",
      "Emails": "string",
      "PNRTicketed": "string",
      "DestinationCount": 0,
      "ItineraryFormatted": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsTravellingResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[BookingTravelling]	false	none	[BookingTravelling]
ResponseError	AgentivityError	false	none	AgentivityError

BookingTravelling

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "OwningAgencyLocationID": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "Passengers": "string",
  "OwningConsultant": "string",
  "Account": "string",
  "TravelDate": "2019-03-18T11:42:49Z",
  "Mobile": "string",
  "Emails": "string",
  "PNRTicketed": "string",
  "DestinationCount": 0,
  "ItineraryFormatted": "string"
}

BookingTravelling

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
OwningAgencyLocationID	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
Passengers	string	false	none	none
OwningConsultant	string	false	none	none
Account	string	false	none	none
TravelDate	string(date-time)	false	none	none
Mobile	string	false	none	none
Emails	string	false	none	none
PNRTicketed	string	false	none	none
DestinationCount	integer(int32)	false	none	none
ItineraryFormatted	string	false	none	none

BookingsLapsedToEventItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyLocationID": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "Airlines": "string",
      "LapsedDateTime": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsLapsedToEventItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsLapsedToEventResponseReport	false	none	BookingsLapsedToEventResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsLapsedToEventResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "OwningAgencyLocationID": "string",
    "Account": "string",
    "OwningConsultant": "string",
    "Airlines": "string",
    "LapsedDateTime": "2019-03-18T11:42:49Z"
  }
}

BookingsLapsedToEventResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingLapsedToEvent	false	none	BookingLapsedToEvent

BookingLapsedToEvent

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "OwningAgencyLocationID": "string",
  "Account": "string",
  "OwningConsultant": "string",
  "Airlines": "string",
  "LapsedDateTime": "2019-03-18T11:42:49Z"
}

BookingLapsedToEvent

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
OwningAgencyLocationID	string	false	none	none
Account	string	false	none	none
OwningConsultant	string	false	none	none
Airlines	string	false	none	none
LapsedDateTime	string(date-time)	false	none	none

BookingsTicketTravelDatesItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningConsultant": "string",
      "Passengers": "string",
      "PNRCancelled": "string",
      "PNRTicketed": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "TicketingDate": "2019-03-18T11:42:49Z",
      "TravelDate": "2019-03-18T11:42:49Z",
      "BookingTravelDateGap": 0,
      "FirstDILine": "string",
      "Account": "string",
      "DivisionCode": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsTicketTravelDatesItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsTicketTravelDatesResponseReport	false	none	BookingsTicketTravelDatesResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsTicketTravelDatesResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "OwningConsultant": "string",
    "Passengers": "string",
    "PNRCancelled": "string",
    "PNRTicketed": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "TicketingDate": "2019-03-18T11:42:49Z",
    "TravelDate": "2019-03-18T11:42:49Z",
    "BookingTravelDateGap": 0,
    "FirstDILine": "string",
    "Account": "string",
    "DivisionCode": "string"
  }
}

BookingsTicketTravelDatesResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingTicketTravelDates	false	none	BookingTicketTravelDates

BookingTicketTravelDates

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "OwningConsultant": "string",
  "Passengers": "string",
  "PNRCancelled": "string",
  "PNRTicketed": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "TicketingDate": "2019-03-18T11:42:49Z",
  "TravelDate": "2019-03-18T11:42:49Z",
  "BookingTravelDateGap": 0,
  "FirstDILine": "string",
  "Account": "string",
  "DivisionCode": "string"
}

BookingTicketTravelDates

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
OwningConsultant	string	false	none	none
Passengers	string	false	none	none
PNRCancelled	string	false	none	none
PNRTicketed	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
TicketingDate	string(date-time)	false	none	none
TravelDate	string(date-time)	false	none	none
BookingTravelDateGap	integer(int32)	false	none	none
FirstDILine	string	false	none	none
Account	string	false	none	none
DivisionCode	string	false	none	none

BookingsWithTicketDueDataByUser2ItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PnrCreationDate": "string",
      "Passengers": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "OwningConsultant": "string",
      "OwningAgencyLocationID": "string",
      "CarrierCode": "string",
      "DueDate": "2019-03-18T11:42:49Z",
      "DueTime": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsWithTicketDueDataByUser2ItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsWithTicketDueDataByUser2ResponseReport	false	none	BookingsWithTicketDueDataByUser2ResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsWithTicketDueDataByUser2ResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PnrCreationDate": "string",
    "Passengers": "string",
    "Account": "string",
    "TravelDate": "2019-03-18T11:42:49Z",
    "OwningConsultant": "string",
    "OwningAgencyLocationID": "string",
    "CarrierCode": "string",
    "DueDate": "2019-03-18T11:42:49Z",
    "DueTime": "string"
  }
}

BookingsWithTicketDueDataByUser2ResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingWithTicketDueData2	false	none	BookingWithTicketDueData2

BookingWithTicketDueData2

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PnrCreationDate": "string",
  "Passengers": "string",
  "Account": "string",
  "TravelDate": "2019-03-18T11:42:49Z",
  "OwningConsultant": "string",
  "OwningAgencyLocationID": "string",
  "CarrierCode": "string",
  "DueDate": "2019-03-18T11:42:49Z",
  "DueTime": "string"
}

BookingWithTicketDueData2

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PnrCreationDate	string	false	none	none
Passengers	string	false	none	none
Account	string	false	none	none
TravelDate	string(date-time)	false	none	none
OwningConsultant	string	false	none	none
OwningAgencyLocationID	string	false	none	none
CarrierCode	string	false	none	none
DueDate	string(date-time)	false	none	none
DueTime	string	false	none	none

CarSegmentCountsPerAccountByVendorItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Account": "string",
      "TotalSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

CarSegmentCountsPerAccountByVendorItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	CarSegmentCountsPerAccountByVendorResponseReport	false	none	CarSegmentCountsPerAccountByVendorResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

CarSegmentCountsPerAccountByVendorResponseReport

{
  "Item": {
    "Account": "string",
    "TotalSegments": 0
  }
}

CarSegmentCountsPerAccountByVendorResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	CarSegmentCountPerAccountByVendor	false	none	CarSegmentCountPerAccountByVendor

CarSegmentCountPerAccountByVendor

{
  "Account": "string",
  "TotalSegments": 0
}

CarSegmentCountPerAccountByVendor

Properties

Name	Type	Required	Restrictions	Description
Account	string	false	none	none
TotalSegments	integer(int32)	false	none	none

CarSegmentCountsPerBranchByVendorItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningAgencyLocation": "string",
      "OwningAgencyLocationID": "string",
      "TotalSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

CarSegmentCountsPerBranchByVendorItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	CarSegmentCountsPerBranchByVendorResponseReport	false	none	CarSegmentCountsPerBranchByVendorResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

CarSegmentCountsPerBranchByVendorResponseReport

{
  "Item": {
    "OwningAgencyLocation": "string",
    "OwningAgencyLocationID": "string",
    "TotalSegments": 0
  }
}

CarSegmentCountsPerBranchByVendorResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	CarSegmentCountPerBranchByVendor	false	none	CarSegmentCountPerBranchByVendor

CarSegmentCountPerBranchByVendor

{
  "OwningAgencyLocation": "string",
  "OwningAgencyLocationID": "string",
  "TotalSegments": 0
}

CarSegmentCountPerBranchByVendor

Properties

Name	Type	Required	Restrictions	Description
OwningAgencyLocation	string	false	none	none
OwningAgencyLocationID	string	false	none	none
TotalSegments	integer(int32)	false	none	none

CarSegmentCountsPerConsultantByVendorItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningConsultant": "string",
      "OwningConsultantID": "string",
      "OwningAgencyLocation": "string",
      "TotalSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

CarSegmentCountsPerConsultantByVendorItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	CarSegmentCountsPerConsultantByVendorResponseReport	false	none	CarSegmentCountsPerConsultantByVendorResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

CarSegmentCountsPerConsultantByVendorResponseReport

{
  "Item": {
    "OwningConsultant": "string",
    "OwningConsultantID": "string",
    "OwningAgencyLocation": "string",
    "TotalSegments": 0
  }
}

CarSegmentCountsPerConsultantByVendorResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	CarSegmentCountPerConsultantByVendor	false	none	CarSegmentCountPerConsultantByVendor

CarSegmentCountPerConsultantByVendor

{
  "OwningConsultant": "string",
  "OwningConsultantID": "string",
  "OwningAgencyLocation": "string",
  "TotalSegments": 0
}

CarSegmentCountPerConsultantByVendor

Properties

Name	Type	Required	Restrictions	Description
OwningConsultant	string	false	none	none
OwningConsultantID	string	false	none	none
OwningAgencyLocation	string	false	none	none
TotalSegments	integer(int32)	false	none	none

CarSegmentCountsPerLocationByVendorItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "CityName": "string",
      "CityCode": "string",
      "CountryName": "string",
      "TotalSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

CarSegmentCountsPerLocationByVendorItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	CarSegmentCountsPerLocationByVendorResponseReport	false	none	CarSegmentCountsPerLocationByVendorResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

CarSegmentCountsPerLocationByVendorResponseReport

{
  "Item": {
    "CityName": "string",
    "CityCode": "string",
    "CountryName": "string",
    "TotalSegments": 0
  }
}

CarSegmentCountsPerLocationByVendorResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	CarSegmentCountPerLocationByVendor	false	none	CarSegmentCountPerLocationByVendor

CarSegmentCountPerLocationByVendor

{
  "CityName": "string",
  "CityCode": "string",
  "CountryName": "string",
  "TotalSegments": 0
}

CarSegmentCountPerLocationByVendor

Properties

Name	Type	Required	Restrictions	Description
CityName	string	false	none	none
CityCode	string	false	none	none
CountryName	string	false	none	none
TotalSegments	integer(int32)	false	none	none

CarSegmentCountsPerVendorItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "VendorCode": "string",
      "VendorName": "string",
      "TotalSegments": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

CarSegmentCountsPerVendorItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	CarSegmentCountsPerVendorResponseReport	false	none	CarSegmentCountsPerVendorResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

CarSegmentCountsPerVendorResponseReport

{
  "Item": {
    "VendorCode": "string",
    "VendorName": "string",
    "TotalSegments": 0
  }
}

CarSegmentCountsPerVendorResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	CarSegmentCountPerVendor	false	none	CarSegmentCountPerVendor

CarSegmentCountPerVendor

{
  "VendorCode": "string",
  "VendorName": "string",
  "TotalSegments": 0
}

CarSegmentCountPerVendor

Properties

Name	Type	Required	Restrictions	Description
VendorCode	string	false	none	none
VendorName	string	false	none	none
TotalSegments	integer(int32)	false	none	none

CarSegmentsByDateItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": "string",
      "RecordLocator": "string",
      "OwningAgencyLocationID": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "Passengers": "string",
      "PickUpDate": "2019-03-18T11:42:49Z",
      "DropOffDate": "2019-03-18T11:42:49Z",
      "CarVendorCode": "string",
      "VendorName": "string",
      "SegmentStatus": "string",
      "AirportCode": "string",
      "ConfirmationNbr": "string",
      "CurrencyCode": "string",
      "RateAmount": "string",
      "NbrOfCars": "string",
      "CarType": "string",
      "ServiceInformation": "string",
      "BRInformation": "string",
      "CarSegmentType": "string",
      "CreatingAgencyIata": "string",
      "CityCode": "string",
      "Text": "string",
      "Vouchers": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

CarSegmentsByDateItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	CarSegmentsByDateResponseReport	false	none	CarSegmentsByDateResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

CarSegmentsByDateResponseReport

{
  "Item": {
    "AgentivityRef": "string",
    "RecordLocator": "string",
    "OwningAgencyLocationID": "string",
    "OwningConsultant": "string",
    "Account": "string",
    "Passengers": "string",
    "PickUpDate": "2019-03-18T11:42:49Z",
    "DropOffDate": "2019-03-18T11:42:49Z",
    "CarVendorCode": "string",
    "VendorName": "string",
    "SegmentStatus": "string",
    "AirportCode": "string",
    "ConfirmationNbr": "string",
    "CurrencyCode": "string",
    "RateAmount": "string",
    "NbrOfCars": "string",
    "CarType": "string",
    "ServiceInformation": "string",
    "BRInformation": "string",
    "CarSegmentType": "string",
    "CreatingAgencyIata": "string",
    "CityCode": "string",
    "Text": "string",
    "Vouchers": "string"
  }
}

CarSegmentsByDateResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	CarSegmentByDate	false	none	CarSegmentByDate

CarSegmentByDate

{
  "AgentivityRef": "string",
  "RecordLocator": "string",
  "OwningAgencyLocationID": "string",
  "OwningConsultant": "string",
  "Account": "string",
  "Passengers": "string",
  "PickUpDate": "2019-03-18T11:42:49Z",
  "DropOffDate": "2019-03-18T11:42:49Z",
  "CarVendorCode": "string",
  "VendorName": "string",
  "SegmentStatus": "string",
  "AirportCode": "string",
  "ConfirmationNbr": "string",
  "CurrencyCode": "string",
  "RateAmount": "string",
  "NbrOfCars": "string",
  "CarType": "string",
  "ServiceInformation": "string",
  "BRInformation": "string",
  "CarSegmentType": "string",
  "CreatingAgencyIata": "string",
  "CityCode": "string",
  "Text": "string",
  "Vouchers": "string"
}

CarSegmentByDate

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	string	false	none	none
RecordLocator	string	false	none	none
OwningAgencyLocationID	string	false	none	none
OwningConsultant	string	false	none	none
Account	string	false	none	none
Passengers	string	false	none	none
PickUpDate	string(date-time)	false	none	none
DropOffDate	string(date-time)	false	none	none
CarVendorCode	string	false	none	none
VendorName	string	false	none	none
SegmentStatus	string	false	none	none
AirportCode	string	false	none	none
ConfirmationNbr	string	false	none	none
CurrencyCode	string	false	none	none
RateAmount	string	false	none	none
NbrOfCars	string	false	none	none
CarType	string	false	none	none
ServiceInformation	string	false	none	none
BRInformation	string	false	none	none
CarSegmentType	string	false	none	none
CreatingAgencyIata	string	false	none	none
CityCode	string	false	none	none
Text	string	false	none	none
Vouchers	string	false	none	none

ConferencesByRemarkItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Name": "string",
      "OrganizingDate": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

ConferencesByRemarkItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	ConferencesByRemarkResponseReport	false	none	ConferencesByRemarkResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

ConferencesByRemarkResponseReport

{
  "Item": {
    "Name": "string",
    "OrganizingDate": "2019-03-18T11:42:49Z"
  }
}

ConferencesByRemarkResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	ConferenceByRemark	false	none	ConferenceByRemark

ConferenceByRemark

{
  "Name": "string",
  "OrganizingDate": "2019-03-18T11:42:49Z"
}

ConferenceByRemark

Properties

Name	Type	Required	Restrictions	Description
Name	string	false	none	none
OrganizingDate	string(date-time)	false	none	none

ConsultantsResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "companyID": "string",
      "eMail": "string",
      "firstName": "string",
      "GDS": "string",
      "lastName": "string",
      "TransactionAgent": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

ConsultantsResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[Consultant]	false	none	[Consultant]
ResponseError	AgentivityError	false	none	AgentivityError

Consultant

{
  "companyID": "string",
  "eMail": "string",
  "firstName": "string",
  "GDS": "string",
  "lastName": "string",
  "TransactionAgent": "string"
}

Consultant

Properties

Name	Type	Required	Restrictions	Description
companyID	string	false	none	none
eMail	string	false	none	none
firstName	string	false	none	none
GDS	string	false	none	none
lastName	string	false	none	none
TransactionAgent	string	false	none	none

CorporateTrackerBookingsItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "Passenger": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      },
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

CorporateTrackerBookingsItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	CorporateTrackerBookingsResponseReport	false	none	CorporateTrackerBookingsResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

CorporateTrackerBookingsResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "Passenger": "string",
    "Account": "string",
    "OwningConsultant": "string",
    "Itinerary": {
      "SegmentTypesFilter": [
        "string"
      ],
      "FilteredSegments": null,
      "Capacity": 0,
      "Count": 0,
      "Item": {
        "ArrivalTimeFormatted": "string",
        "BoardPoint": "string",
        "ChangeOfDayFormatted": "string",
        "DepartureTimeFormatted": "string",
        "EndDate": "string",
        "OffPoint": "string",
        "OperatorCode": "string",
        "OperatorService": "string",
        "SegmentNbr": 0,
        "SegmentStatus": "string",
        "SegmentType": "string",
        "ServiceCode": "string",
        "StartDate": "string",
        "TicketNumber": "string"
      }
    },
    "ItineraryFormatted": "string"
  }
}

CorporateTrackerBookingsResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	CorporateTrackerBooking	false	none	CorporateTrackerBooking

CorporateTrackerBooking

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "Passenger": "string",
  "Account": "string",
  "OwningConsultant": "string",
  "Itinerary": {
    "SegmentTypesFilter": [
      "string"
    ],
    "FilteredSegments": null,
    "Capacity": 0,
    "Count": 0,
    "Item": {
      "ArrivalTimeFormatted": "string",
      "BoardPoint": "string",
      "ChangeOfDayFormatted": "string",
      "DepartureTimeFormatted": "string",
      "EndDate": "string",
      "OffPoint": "string",
      "OperatorCode": "string",
      "OperatorService": "string",
      "SegmentNbr": 0,
      "SegmentStatus": "string",
      "SegmentType": "string",
      "ServiceCode": "string",
      "StartDate": "string",
      "TicketNumber": "string"
    }
  },
  "ItineraryFormatted": "string"
}

CorporateTrackerBooking

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
Passenger	string	false	none	none
Account	string	false	none	none
OwningConsultant	string	false	none	none
Itinerary	ItinerarySegmentsCollection	false	none	ItinerarySegmentsCollection
ItineraryFormatted	string	false	none	none

DashboardStatsByOptionsItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "ProblematicBookings": {
        "DayPlusZeroTtl": 0,
        "DayPlusOneTtl": 0,
        "DayPlusTwoTtl": 0
      },
      "AirlineTicketing": {
        "DayPlusZeroTtl": 0,
        "DayPlusOneTtl": 0,
        "DayPlusTwoTtl": 0
      },
      "UnticketedBookingsByTau": {
        "DayPlusZeroTtl": 0,
        "DayPlusOneTtl": 0,
        "DayPlusTwoTtl": 0
      },
      "MonthlyActivity": [
        {
          "ReportDate": "string",
          "MonthlyEvents": 0,
          "C": 0,
          "C_Percentage": 0,
          "I": 0,
          "I_Percentage": 0,
          "T": 0,
          "T_Percentage": 0,
          "X": 0,
          "X_Percentage": 0
        }
      ],
      "MostActiveUsers": [
        {
          "UserName": "string",
          "FirstName": "string",
          "LastName": "string",
          "UserID": 0,
          "UserFrequency": "string",
          "ActivityMeasure": 0
        }
      ],
      "TopConsultants": [
        {
          "Name": "string",
          "Total": 0
        }
      ],
      "TopReports": [
        {
          "Name": "string",
          "UrlSlug": "string",
          "Total": 0
        }
      ],
      "ActiveBookingsAirConversion": {
        "TotalTicketed": 0,
        "TotalUnticketed": 0
      },
      "PassengerElements": [
        {
          "DateMonth": 0,
          "DateYear": 0,
          "WithMobilePercent": 0,
          "WithEmailPercent": 0,
          "TotalWithMobile": 0,
          "TotalWithEmail": 0,
          "TotalCreated": 0
        }
      ],
      "ReportUsageSummary": [
        {
          "Name": "string",
          "UrlSlug": "string",
          "Total": 0
        }
      ],
      "MonthlyActivityFormatted": "string",
      "PassengerElementsFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

DashboardStatsByOptionsItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	DashboardStatsByOptionsResponseReport	false	none	DashboardStatsByOptionsResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

DashboardStatsByOptionsResponseReport

{
  "Item": {
    "ProblematicBookings": {
      "DayPlusZeroTtl": 0,
      "DayPlusOneTtl": 0,
      "DayPlusTwoTtl": 0
    },
    "AirlineTicketing": {
      "DayPlusZeroTtl": 0,
      "DayPlusOneTtl": 0,
      "DayPlusTwoTtl": 0
    },
    "UnticketedBookingsByTau": {
      "DayPlusZeroTtl": 0,
      "DayPlusOneTtl": 0,
      "DayPlusTwoTtl": 0
    },
    "MonthlyActivity": [
      {
        "ReportDate": "string",
        "MonthlyEvents": 0,
        "C": 0,
        "C_Percentage": 0,
        "I": 0,
        "I_Percentage": 0,
        "T": 0,
        "T_Percentage": 0,
        "X": 0,
        "X_Percentage": 0
      }
    ],
    "MostActiveUsers": [
      {
        "UserName": "string",
        "FirstName": "string",
        "LastName": "string",
        "UserID": 0,
        "UserFrequency": "string",
        "ActivityMeasure": 0
      }
    ],
    "TopConsultants": [
      {
        "Name": "string",
        "Total": 0
      }
    ],
    "TopReports": [
      {
        "Name": "string",
        "UrlSlug": "string",
        "Total": 0
      }
    ],
    "ActiveBookingsAirConversion": {
      "TotalTicketed": 0,
      "TotalUnticketed": 0
    },
    "PassengerElements": [
      {
        "DateMonth": 0,
        "DateYear": 0,
        "WithMobilePercent": 0,
        "WithEmailPercent": 0,
        "TotalWithMobile": 0,
        "TotalWithEmail": 0,
        "TotalCreated": 0
      }
    ],
    "ReportUsageSummary": [
      {
        "Name": "string",
        "UrlSlug": "string",
        "Total": 0
      }
    ],
    "MonthlyActivityFormatted": "string",
    "PassengerElementsFormatted": "string"
  }
}

DashboardStatsByOptionsResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	DashboardStats	false	none	DashboardStats

DashboardStats

{
  "ProblematicBookings": {
    "DayPlusZeroTtl": 0,
    "DayPlusOneTtl": 0,
    "DayPlusTwoTtl": 0
  },
  "AirlineTicketing": {
    "DayPlusZeroTtl": 0,
    "DayPlusOneTtl": 0,
    "DayPlusTwoTtl": 0
  },
  "UnticketedBookingsByTau": {
    "DayPlusZeroTtl": 0,
    "DayPlusOneTtl": 0,
    "DayPlusTwoTtl": 0
  },
  "MonthlyActivity": [
    {
      "ReportDate": "string",
      "MonthlyEvents": 0,
      "C": 0,
      "C_Percentage": 0,
      "I": 0,
      "I_Percentage": 0,
      "T": 0,
      "T_Percentage": 0,
      "X": 0,
      "X_Percentage": 0
    }
  ],
  "MostActiveUsers": [
    {
      "UserName": "string",
      "FirstName": "string",
      "LastName": "string",
      "UserID": 0,
      "UserFrequency": "string",
      "ActivityMeasure": 0
    }
  ],
  "TopConsultants": [
    {
      "Name": "string",
      "Total": 0
    }
  ],
  "TopReports": [
    {
      "Name": "string",
      "UrlSlug": "string",
      "Total": 0
    }
  ],
  "ActiveBookingsAirConversion": {
    "TotalTicketed": 0,
    "TotalUnticketed": 0
  },
  "PassengerElements": [
    {
      "DateMonth": 0,
      "DateYear": 0,
      "WithMobilePercent": 0,
      "WithEmailPercent": 0,
      "TotalWithMobile": 0,
      "TotalWithEmail": 0,
      "TotalCreated": 0
    }
  ],
  "ReportUsageSummary": [
    {
      "Name": "string",
      "UrlSlug": "string",
      "Total": 0
    }
  ],
  "MonthlyActivityFormatted": "string",
  "PassengerElementsFormatted": "string"
}

DashboardStats

Properties

Name	Type	Required	Restrictions	Description
ProblematicBookings	ThreeDayCounts	false	none	ThreeDayCounts
AirlineTicketing	ThreeDayCounts	false	none	ThreeDayCounts
UnticketedBookingsByTau	ThreeDayCounts	false	none	ThreeDayCounts
MonthlyActivity	[MonthlyActivityBreakdown]	false	none	[MonthlyActivityBreakdown]
MostActiveUsers	[UserActivity]	false	none	[UserActivity]
TopConsultants	[ConsultantPerformance]	false	none	[ConsultantPerformance]
TopReports	[ReportPerformance]	false	none	[ReportPerformance]
ActiveBookingsAirConversion	BookingsAirConversion	false	none	BookingsAirConversion
PassengerElements	[PassengerContactElements]	false	none	[PassengerContactElements]
ReportUsageSummary	[ReportPerformance]	false	none	[ReportPerformance]
MonthlyActivityFormatted	string	false	none	none
PassengerElementsFormatted	string	false	none	none

ThreeDayCounts

{
  "DayPlusZeroTtl": 0,
  "DayPlusOneTtl": 0,
  "DayPlusTwoTtl": 0
}

ThreeDayCounts

Properties

Name	Type	Required	Restrictions	Description
DayPlusZeroTtl	integer(int32)	false	none	none
DayPlusOneTtl	integer(int32)	false	none	none
DayPlusTwoTtl	integer(int32)	false	none	none

MonthlyActivityBreakdown

{
  "ReportDate": "string",
  "MonthlyEvents": 0,
  "C": 0,
  "C_Percentage": 0,
  "I": 0,
  "I_Percentage": 0,
  "T": 0,
  "T_Percentage": 0,
  "X": 0,
  "X_Percentage": 0
}

MonthlyActivityBreakdown

Properties

Name	Type	Required	Restrictions	Description
ReportDate	string	false	none	none
MonthlyEvents	integer(int32)	false	none	none
C	integer(int32)	false	none	none
C_Percentage	number(float)	false	none	none
I	integer(int32)	false	none	none
I_Percentage	number(float)	false	none	none
T	integer(int32)	false	none	none
T_Percentage	number(float)	false	none	none
X	integer(int32)	false	none	none
X_Percentage	number(float)	false	none	none

UserActivity

{
  "UserName": "string",
  "FirstName": "string",
  "LastName": "string",
  "UserID": 0,
  "UserFrequency": "string",
  "ActivityMeasure": 0
}

UserActivity

Properties

Name	Type	Required	Restrictions	Description
UserName	string	false	none	none
FirstName	string	false	none	none
LastName	string	false	none	none
UserID	integer(int32)	false	none	none
UserFrequency	string	false	none	none
ActivityMeasure	number(float)	false	none	none

ConsultantPerformance

{
  "Name": "string",
  "Total": 0
}

ConsultantPerformance

Properties

Name	Type	Required	Restrictions	Description
Name	string	false	none	none
Total	integer(int32)	false	none	none

ReportPerformance

{
  "Name": "string",
  "UrlSlug": "string",
  "Total": 0
}

ReportPerformance

Properties

Name	Type	Required	Restrictions	Description
Name	string	false	none	none
UrlSlug	string	false	none	none
Total	integer(int32)	false	none	none

BookingsAirConversion

{
  "TotalTicketed": 0,
  "TotalUnticketed": 0
}

BookingsAirConversion

Properties

Name	Type	Required	Restrictions	Description
TotalTicketed	integer(int32)	false	none	none
TotalUnticketed	integer(int32)	false	none	none

PassengerContactElements

{
  "DateMonth": 0,
  "DateYear": 0,
  "WithMobilePercent": 0,
  "WithEmailPercent": 0,
  "TotalWithMobile": 0,
  "TotalWithEmail": 0,
  "TotalCreated": 0
}

PassengerContactElements

Properties

Name	Type	Required	Restrictions	Description
DateMonth	integer(int32)	false	none	none
DateYear	integer(int32)	false	none	none
WithMobilePercent	number(float)	false	none	none
WithEmailPercent	number(float)	false	none	none
TotalWithMobile	integer(int32)	false	none	none
TotalWithEmail	integer(int32)	false	none	none
TotalCreated	integer(int32)	false	none	none

FindBookingsItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "Passengers": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "PnrTicketed": "string",
      "PnrCancelled": "string",
      "IsFrequentFlyer": true,
      "ItineraryChanges": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

FindBookingsItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	FindBookingsResponseReport	false	none	FindBookingsResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

FindBookingsResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "Passengers": "string",
    "Account": "string",
    "OwningConsultant": "string",
    "TravelDate": "2019-03-18T11:42:49Z",
    "PnrTicketed": "string",
    "PnrCancelled": "string",
    "IsFrequentFlyer": true,
    "ItineraryChanges": 0
  }
}

FindBookingsResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingSearchResult	false	none	BookingSearchResult

BookingSearchResult

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "Passengers": "string",
  "Account": "string",
  "OwningConsultant": "string",
  "TravelDate": "2019-03-18T11:42:49Z",
  "PnrTicketed": "string",
  "PnrCancelled": "string",
  "IsFrequentFlyer": true,
  "ItineraryChanges": 0
}

BookingSearchResult

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
Passengers	string	false	none	none
Account	string	false	none	none
OwningConsultant	string	false	none	none
TravelDate	string(date-time)	false	none	none
PnrTicketed	string	false	none	none
PnrCancelled	string	false	none	none
IsFrequentFlyer	boolean	false	none	none
ItineraryChanges	integer(int32)	false	none	none

HotelLocSegmentCountsPerChainByCityItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "ChainName": "string",
      "VendorCode": "string",
      "TotalSegments": 0,
      "TotalNights": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

HotelLocSegmentCountsPerChainByCityItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	HotelLocSegmentCountsPerChainByCityResponseReport	false	none	HotelLocSegmentCountsPerChainByCityResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

HotelLocSegmentCountsPerChainByCityResponseReport

{
  "Item": {
    "ChainName": "string",
    "VendorCode": "string",
    "TotalSegments": 0,
    "TotalNights": 0
  }
}

HotelLocSegmentCountsPerChainByCityResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	HotelLocSegmentCountPerChainByCity	false	none	HotelLocSegmentCountPerChainByCity

HotelLocSegmentCountPerChainByCity

{
  "ChainName": "string",
  "VendorCode": "string",
  "TotalSegments": 0,
  "TotalNights": 0
}

HotelLocSegmentCountPerChainByCity

Properties

Name	Type	Required	Restrictions	Description
ChainName	string	false	none	none
VendorCode	string	false	none	none
TotalSegments	integer(int32)	false	none	none
TotalNights	integer(int32)	false	none	none

HotelLocSegmentCountsPerPropertyByCityItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "PropertyName": "string",
      "TotalSegments": 0,
      "TotalNights": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

HotelLocSegmentCountsPerPropertyByCityItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	HotelLocSegmentCountsPerPropertyByCityResponseReport	false	none	HotelLocSegmentCountsPerPropertyByCityResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

HotelLocSegmentCountsPerPropertyByCityResponseReport

{
  "Item": {
    "PropertyName": "string",
    "TotalSegments": 0,
    "TotalNights": 0
  }
}

HotelLocSegmentCountsPerPropertyByCityResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	HotelLocSegmentCountPerPropertyByCity	false	none	HotelLocSegmentCountPerPropertyByCity

HotelLocSegmentCountPerPropertyByCity

{
  "PropertyName": "string",
  "TotalSegments": 0,
  "TotalNights": 0
}

HotelLocSegmentCountPerPropertyByCity

Properties

Name	Type	Required	Restrictions	Description
PropertyName	string	false	none	none
TotalSegments	integer(int32)	false	none	none
TotalNights	integer(int32)	false	none	none

HotelSegmentCountsPerAccountByVendorItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Account": "string",
      "TotalSegments": 0,
      "TotalNights": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

HotelSegmentCountsPerAccountByVendorItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	HotelSegmentCountsPerAccountByVendorResponseReport	false	none	HotelSegmentCountsPerAccountByVendorResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

HotelSegmentCountsPerAccountByVendorResponseReport

{
  "Item": {
    "Account": "string",
    "TotalSegments": 0,
    "TotalNights": 0
  }
}

HotelSegmentCountsPerAccountByVendorResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	HotelSegmentCountPerAccountByVendor	false	none	HotelSegmentCountPerAccountByVendor

HotelSegmentCountPerAccountByVendor

{
  "Account": "string",
  "TotalSegments": 0,
  "TotalNights": 0
}

HotelSegmentCountPerAccountByVendor

Properties

Name	Type	Required	Restrictions	Description
Account	string	false	none	none
TotalSegments	integer(int32)	false	none	none
TotalNights	integer(int32)	false	none	none

HotelSegmentCountsPerBranchByVendorItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningAgencyLocation": "string",
      "OwningAgencyLocationID": "string",
      "TotalSegments": 0,
      "TotalNights": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

HotelSegmentCountsPerBranchByVendorItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	HotelSegmentCountsPerBranchByVendorResponseReport	false	none	HotelSegmentCountsPerBranchByVendorResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

HotelSegmentCountsPerBranchByVendorResponseReport

{
  "Item": {
    "OwningAgencyLocation": "string",
    "OwningAgencyLocationID": "string",
    "TotalSegments": 0,
    "TotalNights": 0
  }
}

HotelSegmentCountsPerBranchByVendorResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	HotelSegmentCountPerBranchByVendor	false	none	HotelSegmentCountPerBranchByVendor

HotelSegmentCountPerBranchByVendor

{
  "OwningAgencyLocation": "string",
  "OwningAgencyLocationID": "string",
  "TotalSegments": 0,
  "TotalNights": 0
}

HotelSegmentCountPerBranchByVendor

Properties

Name	Type	Required	Restrictions	Description
OwningAgencyLocation	string	false	none	none
OwningAgencyLocationID	string	false	none	none
TotalSegments	integer(int32)	false	none	none
TotalNights	integer(int32)	false	none	none

HotelSegmentCountsPerConsultantByVendorItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "OwningConsultant": "string",
      "OwningConsultantID": "string",
      "OwningAgencyLocation": "string",
      "TotalSegments": 0,
      "TotalNights": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

HotelSegmentCountsPerConsultantByVendorItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	HotelSegmentCountsPerConsultantByVendorResponseReport	false	none	HotelSegmentCountsPerConsultantByVendorResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

HotelSegmentCountsPerConsultantByVendorResponseReport

{
  "Item": {
    "OwningConsultant": "string",
    "OwningConsultantID": "string",
    "OwningAgencyLocation": "string",
    "TotalSegments": 0,
    "TotalNights": 0
  }
}

HotelSegmentCountsPerConsultantByVendorResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	HotelSegmentCountPerConsultantByVendor	false	none	HotelSegmentCountPerConsultantByVendor

HotelSegmentCountPerConsultantByVendor

{
  "OwningConsultant": "string",
  "OwningConsultantID": "string",
  "OwningAgencyLocation": "string",
  "TotalSegments": 0,
  "TotalNights": 0
}

HotelSegmentCountPerConsultantByVendor

Properties

Name	Type	Required	Restrictions	Description
OwningConsultant	string	false	none	none
OwningConsultantID	string	false	none	none
OwningAgencyLocation	string	false	none	none
TotalSegments	integer(int32)	false	none	none
TotalNights	integer(int32)	false	none	none

HotelSegmentCountsPerLocationByVendorItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "CityName": "string",
      "CityCode": "string",
      "CountryName": "string",
      "TotalSegments": 0,
      "TotalNights": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

HotelSegmentCountsPerLocationByVendorItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	HotelSegmentCountsPerLocationByVendorResponseReport	false	none	HotelSegmentCountsPerLocationByVendorResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

HotelSegmentCountsPerLocationByVendorResponseReport

{
  "Item": {
    "CityName": "string",
    "CityCode": "string",
    "CountryName": "string",
    "TotalSegments": 0,
    "TotalNights": 0
  }
}

HotelSegmentCountsPerLocationByVendorResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	HotelSegmentCountPerLocationByVendor	false	none	HotelSegmentCountPerLocationByVendor

HotelSegmentCountPerLocationByVendor

{
  "CityName": "string",
  "CityCode": "string",
  "CountryName": "string",
  "TotalSegments": 0,
  "TotalNights": 0
}

HotelSegmentCountPerLocationByVendor

Properties

Name	Type	Required	Restrictions	Description
CityName	string	false	none	none
CityCode	string	false	none	none
CountryName	string	false	none	none
TotalSegments	integer(int32)	false	none	none
TotalNights	integer(int32)	false	none	none

HotelSegmentCountsPerVendorItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "ChainName": "string",
      "VendorCode": "string",
      "TotalSegments": 0,
      "TotalNights": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

HotelSegmentCountsPerVendorItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	HotelSegmentCountsPerVendorResponseReport	false	none	HotelSegmentCountsPerVendorResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

HotelSegmentCountsPerVendorResponseReport

{
  "Item": {
    "ChainName": "string",
    "VendorCode": "string",
    "TotalSegments": 0,
    "TotalNights": 0
  }
}

HotelSegmentCountsPerVendorResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	HotelSegmentCountPerVendor	false	none	HotelSegmentCountPerVendor

HotelSegmentCountPerVendor

{
  "ChainName": "string",
  "VendorCode": "string",
  "TotalSegments": 0,
  "TotalNights": 0
}

HotelSegmentCountPerVendor

Properties

Name	Type	Required	Restrictions	Description
ChainName	string	false	none	none
VendorCode	string	false	none	none
TotalSegments	integer(int32)	false	none	none
TotalNights	integer(int32)	false	none	none

ItineraryChangeDetailByUserResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "AgentivityRef": "string",
      "RecordLocator": "string",
      "OwningConsultant": "string",
      "Passenger": "string",
      "Account": "string",
      "EventTypeDetail": "string",
      "OldData": "string",
      "NewData": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

ItineraryChangeDetailByUserResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[ItineraryChangeDetail]	false	none	[ItineraryChangeDetail]
ResponseError	AgentivityError	false	none	AgentivityError

ItineraryChangeDetail

{
  "AgentivityRef": "string",
  "RecordLocator": "string",
  "OwningConsultant": "string",
  "Passenger": "string",
  "Account": "string",
  "EventTypeDetail": "string",
  "OldData": "string",
  "NewData": "string"
}

ItineraryChangeDetail

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	string	false	none	none
RecordLocator	string	false	none	none
OwningConsultant	string	false	none	none
Passenger	string	false	none	none
Account	string	false	none	none
EventTypeDetail	string	false	none	none
OldData	string	false	none	none
NewData	string	false	none	none

ArrivalsWithDestinationsByUserResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "TravelOrderIdentifier": "string",
      "RecordLocator": "string",
      "LastName": "string",
      "FirstName": "string",
      "Account": "string",
      "TravelDate": "string",
      "ArrivalDate": "string",
      "DaysAway": 0,
      "DestinationCountries": "string",
      "TransactionAgent": "string",
      "MobileList": "string",
      "EmailList": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

ArrivalsWithDestinationsByUserResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[ArrivalsWithDestinations]	false	none	[ArrivalsWithDestinations]
ResponseError	AgentivityError	false	none	AgentivityError

ArrivalsWithDestinations

{
  "TravelOrderIdentifier": "string",
  "RecordLocator": "string",
  "LastName": "string",
  "FirstName": "string",
  "Account": "string",
  "TravelDate": "string",
  "ArrivalDate": "string",
  "DaysAway": 0,
  "DestinationCountries": "string",
  "TransactionAgent": "string",
  "MobileList": "string",
  "EmailList": "string"
}

ArrivalsWithDestinations

Properties

Name	Type	Required	Restrictions	Description
TravelOrderIdentifier	string	false	none	none
RecordLocator	string	false	none	none
LastName	string	false	none	none
FirstName	string	false	none	none
Account	string	false	none	none
TravelDate	string	false	none	none
ArrivalDate	string	false	none	none
DaysAway	integer(int32)	false	none	none
DestinationCountries	string	false	none	none
TransactionAgent	string	false	none	none
MobileList	string	false	none	none
EmailList	string	false	none	none

AirlinesClassesTotals

{
  "City": "string",
  "Airline": "string",
  "CabinEconomy": 0,
  "CabinBusiness": 0,
  "CabinEconomyPremium": 0,
  "CabinFirst": 0,
  "CabinOther": 0,
  "CabinNA": 0,
  "CityCode": "string",
  "CarrierCode": "string"
}

AirlinesClassesTotals

Properties

Name	Type	Required	Restrictions	Description
City	string	false	none	none
Airline	string	false	none	none
CabinEconomy	integer(int32)	false	none	none
CabinBusiness	integer(int32)	false	none	none
CabinEconomyPremium	integer(int32)	false	none	none
CabinFirst	integer(int32)	false	none	none
CabinOther	integer(int32)	false	none	none
CabinNA	integer(int32)	false	none	none
CityCode	string	false	none	none
CarrierCode	string	false	none	none

BookingsCreatedItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningAgencyLocationID": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "Passengers": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "Mobile": "string",
      "Emails": "string",
      "PNRTicketed": "string",
      "DestinationCount": 0,
      "IsVip": true,
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      },
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsCreatedItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsCreatedResponseReport	false	none	BookingsCreatedResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsCreatedResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "OwningAgencyLocationID": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "Passengers": "string",
    "OwningConsultant": "string",
    "Account": "string",
    "TravelDate": "2019-03-18T11:42:49Z",
    "Mobile": "string",
    "Emails": "string",
    "PNRTicketed": "string",
    "DestinationCount": 0,
    "IsVip": true,
    "Itinerary": {
      "SegmentTypesFilter": [
        "string"
      ],
      "FilteredSegments": null,
      "Capacity": 0,
      "Count": 0,
      "Item": {
        "ArrivalTimeFormatted": "string",
        "BoardPoint": "string",
        "ChangeOfDayFormatted": "string",
        "DepartureTimeFormatted": "string",
        "EndDate": "string",
        "OffPoint": "string",
        "OperatorCode": "string",
        "OperatorService": "string",
        "SegmentNbr": 0,
        "SegmentStatus": "string",
        "SegmentType": "string",
        "ServiceCode": "string",
        "StartDate": "string",
        "TicketNumber": "string"
      }
    },
    "ItineraryFormatted": "string"
  }
}

BookingsCreatedResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingCreated	false	none	BookingCreated

BookingCreated

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "OwningAgencyLocationID": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "Passengers": "string",
  "OwningConsultant": "string",
  "Account": "string",
  "TravelDate": "2019-03-18T11:42:49Z",
  "Mobile": "string",
  "Emails": "string",
  "PNRTicketed": "string",
  "DestinationCount": 0,
  "IsVip": true,
  "Itinerary": {
    "SegmentTypesFilter": [
      "string"
    ],
    "FilteredSegments": null,
    "Capacity": 0,
    "Count": 0,
    "Item": {
      "ArrivalTimeFormatted": "string",
      "BoardPoint": "string",
      "ChangeOfDayFormatted": "string",
      "DepartureTimeFormatted": "string",
      "EndDate": "string",
      "OffPoint": "string",
      "OperatorCode": "string",
      "OperatorService": "string",
      "SegmentNbr": 0,
      "SegmentStatus": "string",
      "SegmentType": "string",
      "ServiceCode": "string",
      "StartDate": "string",
      "TicketNumber": "string"
    }
  },
  "ItineraryFormatted": "string"
}

BookingCreated

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
OwningAgencyLocationID	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
Passengers	string	false	none	none
OwningConsultant	string	false	none	none
Account	string	false	none	none
TravelDate	string(date-time)	false	none	none
Mobile	string	false	none	none
Emails	string	false	none	none
PNRTicketed	string	false	none	none
DestinationCount	integer(int32)	false	none	none
IsVip	boolean	false	none	none
Itinerary	ItinerarySegmentsCollection	false	none	ItinerarySegmentsCollection
ItineraryFormatted	string	false	none	none

HotelBookingsByRateCodeItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "string",
      "Passengers": "string",
      "Account": "string",
      "OwningConsultant": "string",
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

HotelBookingsByRateCodeItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	HotelBookingsByRateCodeResponseReport	false	none	HotelBookingsByRateCodeResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

HotelBookingsByRateCodeResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "string",
    "Passengers": "string",
    "Account": "string",
    "OwningConsultant": "string",
    "ItineraryFormatted": "string"
  }
}

HotelBookingsByRateCodeResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	HotelBooking	false	none	HotelBooking

HotelBooking

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "string",
  "Passengers": "string",
  "Account": "string",
  "OwningConsultant": "string",
  "ItineraryFormatted": "string"
}

HotelBooking

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string	false	none	none
Passengers	string	false	none	none
Account	string	false	none	none
OwningConsultant	string	false	none	none
ItineraryFormatted	string	false	none	none

ItineraryChangeEventsItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": "string",
      "RecordLocator": "string",
      "LastActionConsultant": "string",
      "Passengers": "string",
      "EventDateTime": "2019-03-18T11:42:49Z",
      "EventDateTimeFormatted": "string",
      "EventTypeDetail": "string",
      "EventTypeGroup": "string",
      "OldData": "string",
      "NewData": "string",
      "PNRTicketed": "string",
      "FirstDILine": "string",
      "Account": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

ItineraryChangeEventsItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	ItineraryChangeEventsResponseReport	false	none	ItineraryChangeEventsResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

ItineraryChangeEventsResponseReport

{
  "Item": {
    "AgentivityRef": "string",
    "RecordLocator": "string",
    "LastActionConsultant": "string",
    "Passengers": "string",
    "EventDateTime": "2019-03-18T11:42:49Z",
    "EventDateTimeFormatted": "string",
    "EventTypeDetail": "string",
    "EventTypeGroup": "string",
    "OldData": "string",
    "NewData": "string",
    "PNRTicketed": "string",
    "FirstDILine": "string",
    "Account": "string"
  }
}

ItineraryChangeEventsResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	ItineraryChangeEvent	false	none	ItineraryChangeEvent

ItineraryChangeEvent

{
  "AgentivityRef": "string",
  "RecordLocator": "string",
  "LastActionConsultant": "string",
  "Passengers": "string",
  "EventDateTime": "2019-03-18T11:42:49Z",
  "EventDateTimeFormatted": "string",
  "EventTypeDetail": "string",
  "EventTypeGroup": "string",
  "OldData": "string",
  "NewData": "string",
  "PNRTicketed": "string",
  "FirstDILine": "string",
  "Account": "string"
}

ItineraryChangeEvent

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	string	false	none	none
RecordLocator	string	false	none	none
LastActionConsultant	string	false	none	none
Passengers	string	false	none	none
EventDateTime	string(date-time)	false	none	none
EventDateTimeFormatted	string	false	none	none
EventTypeDetail	string	false	none	none
EventTypeGroup	string	false	none	none
OldData	string	false	none	none
NewData	string	false	none	none
PNRTicketed	string	false	none	none
FirstDILine	string	false	none	none
Account	string	false	none	none

AirlineTicketRevenueByCompanyItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "PlatingCarrier": "string",
      "AirlineShortName": "string",
      "TotalFares": 0,
      "TotalTax": 0,
      "TotalBaseRevenue": 0,
      "FormattedCarrierPlatingName": "string",
      "PrintedCurrency": "string",
      "FormattedTotalFares": "string",
      "FormattedTotalTax": "string",
      "FormattedTotalBaseRevenue": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AirlineTicketRevenueByCompanyItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	AirlineTicketRevenueByCompanyResponseReport	false	none	AirlineTicketRevenueByCompanyResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

AirlineTicketRevenueByCompanyResponseReport

{
  "Item": {
    "PlatingCarrier": "string",
    "AirlineShortName": "string",
    "TotalFares": 0,
    "TotalTax": 0,
    "TotalBaseRevenue": 0,
    "FormattedCarrierPlatingName": "string",
    "PrintedCurrency": "string",
    "FormattedTotalFares": "string",
    "FormattedTotalTax": "string",
    "FormattedTotalBaseRevenue": "string"
  }
}

AirlineTicketRevenueByCompanyResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	AirlineTicketRevenue	false	none	AirlineTicketRevenue

AirlineTicketRevenue

{
  "PlatingCarrier": "string",
  "AirlineShortName": "string",
  "TotalFares": 0,
  "TotalTax": 0,
  "TotalBaseRevenue": 0,
  "FormattedCarrierPlatingName": "string",
  "PrintedCurrency": "string",
  "FormattedTotalFares": "string",
  "FormattedTotalTax": "string",
  "FormattedTotalBaseRevenue": "string"
}

AirlineTicketRevenue

Properties

Name	Type	Required	Restrictions	Description
PlatingCarrier	string	false	none	none
AirlineShortName	string	false	none	none
TotalFares	number(double)	false	none	none
TotalTax	number(double)	false	none	none
TotalBaseRevenue	number(double)	false	none	none
FormattedCarrierPlatingName	string	false	none	none
PrintedCurrency	string	false	none	none
FormattedTotalFares	string	false	none	none
FormattedTotalTax	string	false	none	none
FormattedTotalBaseRevenue	string	false	none	none

BookingDetailsByRefItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "string",
      "Account": "string",
      "OwningConsultantID": "string",
      "OwningConsultant": "string",
      "CrsDescription": "string",
      "LastActionConsultantID": "string",
      "LastActionAgencyLocationID": "string",
      "OwningAgencyLocationID": "string",
      "CreatingAgencyIata": "string",
      "Passengers": [
        {
          "Id": 0,
          "FirstName": "string",
          "LastName": "string",
          "FrequentFlyers": [
            {
              "Vendor": "string",
              "Number": "string",
              "FullNumber": "string"
            }
          ],
          "SequenceNbr": 0,
          "LastNameElement": 0,
          "IsVip": true
        }
      ],
      "Phones": [
        {
          "PhoneType": "string",
          "City": "string",
          "Number": "string",
          "SequenceNbr": 0
        }
      ],
      "Notepads": [
        {
          "Remark": "string",
          "CreatedDate": "2019-03-18T11:42:49Z",
          "CreatedTime": "string",
          "Qualifier": "string",
          "SequenceNbr": 0
        }
      ],
      "VendorRemarks": [
        {
          "DateStamp": "2019-03-18T11:42:49Z",
          "Remark": "string",
          "RemarkType": "string",
          "RmkNum": 0,
          "TimeStamp": "string",
          "TravelOrderIdentifier": 0,
          "Vendor": "string",
          "VendorType": "string",
          "VendorRemarkID": 0
        }
      ],
      "DiEntries": [
        {
          "SequenceNbr": 0,
          "Keyword": "string",
          "Remark": "string"
        }
      ],
      "Tickets": [
        {
          "SegmentNbr": 0,
          "TicketNumber": "string"
        }
      ],
      "Versions": [
        {
          "AgentivityRef": 0,
          "DataBaseTimeStamp": "2019-03-18T11:42:49Z",
          "EventType": "string",
          "PnrTicketed": "string",
          "LastActionAgentId": "string",
          "AirSegs": 0,
          "AirPSegs": 0,
          "HtlSegs": 0,
          "HtlPSegs": 0,
          "CarSegs": 0,
          "CarPSegs": 0
        }
      ],
      "VendorLocators": [
        {
          "AirSegmentNbr": 0,
          "CarrierCode": "string",
          "VendorLocator": "string"
        }
      ],
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      },
      "ItineraryFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingDetailsByRefItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingDetailsByRefResponseReport	false	none	BookingDetailsByRefResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingDetailsByRefResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "string",
    "Account": "string",
    "OwningConsultantID": "string",
    "OwningConsultant": "string",
    "CrsDescription": "string",
    "LastActionConsultantID": "string",
    "LastActionAgencyLocationID": "string",
    "OwningAgencyLocationID": "string",
    "CreatingAgencyIata": "string",
    "Passengers": [
      {
        "Id": 0,
        "FirstName": "string",
        "LastName": "string",
        "FrequentFlyers": [
          {
            "Vendor": "string",
            "Number": "string",
            "FullNumber": "string"
          }
        ],
        "SequenceNbr": 0,
        "LastNameElement": 0,
        "IsVip": true
      }
    ],
    "Phones": [
      {
        "PhoneType": "string",
        "City": "string",
        "Number": "string",
        "SequenceNbr": 0
      }
    ],
    "Notepads": [
      {
        "Remark": "string",
        "CreatedDate": "2019-03-18T11:42:49Z",
        "CreatedTime": "string",
        "Qualifier": "string",
        "SequenceNbr": 0
      }
    ],
    "VendorRemarks": [
      {
        "DateStamp": "2019-03-18T11:42:49Z",
        "Remark": "string",
        "RemarkType": "string",
        "RmkNum": 0,
        "TimeStamp": "string",
        "TravelOrderIdentifier": 0,
        "Vendor": "string",
        "VendorType": "string",
        "VendorRemarkID": 0
      }
    ],
    "DiEntries": [
      {
        "SequenceNbr": 0,
        "Keyword": "string",
        "Remark": "string"
      }
    ],
    "Tickets": [
      {
        "SegmentNbr": 0,
        "TicketNumber": "string"
      }
    ],
    "Versions": [
      {
        "AgentivityRef": 0,
        "DataBaseTimeStamp": "2019-03-18T11:42:49Z",
        "EventType": "string",
        "PnrTicketed": "string",
        "LastActionAgentId": "string",
        "AirSegs": 0,
        "AirPSegs": 0,
        "HtlSegs": 0,
        "HtlPSegs": 0,
        "CarSegs": 0,
        "CarPSegs": 0
      }
    ],
    "VendorLocators": [
      {
        "AirSegmentNbr": 0,
        "CarrierCode": "string",
        "VendorLocator": "string"
      }
    ],
    "Itinerary": {
      "SegmentTypesFilter": [
        "string"
      ],
      "FilteredSegments": null,
      "Capacity": 0,
      "Count": 0,
      "Item": {
        "ArrivalTimeFormatted": "string",
        "BoardPoint": "string",
        "ChangeOfDayFormatted": "string",
        "DepartureTimeFormatted": "string",
        "EndDate": "string",
        "OffPoint": "string",
        "OperatorCode": "string",
        "OperatorService": "string",
        "SegmentNbr": 0,
        "SegmentStatus": "string",
        "SegmentType": "string",
        "ServiceCode": "string",
        "StartDate": "string",
        "TicketNumber": "string"
      }
    },
    "ItineraryFormatted": "string"
  }
}

BookingDetailsByRefResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingDetails	false	none	BookingDetails

BookingDetails

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "string",
  "Account": "string",
  "OwningConsultantID": "string",
  "OwningConsultant": "string",
  "CrsDescription": "string",
  "LastActionConsultantID": "string",
  "LastActionAgencyLocationID": "string",
  "OwningAgencyLocationID": "string",
  "CreatingAgencyIata": "string",
  "Passengers": [
    {
      "Id": 0,
      "FirstName": "string",
      "LastName": "string",
      "FrequentFlyers": [
        {
          "Vendor": "string",
          "Number": "string",
          "FullNumber": "string"
        }
      ],
      "SequenceNbr": 0,
      "LastNameElement": 0,
      "IsVip": true
    }
  ],
  "Phones": [
    {
      "PhoneType": "string",
      "City": "string",
      "Number": "string",
      "SequenceNbr": 0
    }
  ],
  "Notepads": [
    {
      "Remark": "string",
      "CreatedDate": "2019-03-18T11:42:49Z",
      "CreatedTime": "string",
      "Qualifier": "string",
      "SequenceNbr": 0
    }
  ],
  "VendorRemarks": [
    {
      "DateStamp": "2019-03-18T11:42:49Z",
      "Remark": "string",
      "RemarkType": "string",
      "RmkNum": 0,
      "TimeStamp": "string",
      "TravelOrderIdentifier": 0,
      "Vendor": "string",
      "VendorType": "string",
      "VendorRemarkID": 0
    }
  ],
  "DiEntries": [
    {
      "SequenceNbr": 0,
      "Keyword": "string",
      "Remark": "string"
    }
  ],
  "Tickets": [
    {
      "SegmentNbr": 0,
      "TicketNumber": "string"
    }
  ],
  "Versions": [
    {
      "AgentivityRef": 0,
      "DataBaseTimeStamp": "2019-03-18T11:42:49Z",
      "EventType": "string",
      "PnrTicketed": "string",
      "LastActionAgentId": "string",
      "AirSegs": 0,
      "AirPSegs": 0,
      "HtlSegs": 0,
      "HtlPSegs": 0,
      "CarSegs": 0,
      "CarPSegs": 0
    }
  ],
  "VendorLocators": [
    {
      "AirSegmentNbr": 0,
      "CarrierCode": "string",
      "VendorLocator": "string"
    }
  ],
  "Itinerary": {
    "SegmentTypesFilter": [
      "string"
    ],
    "FilteredSegments": null,
    "Capacity": 0,
    "Count": 0,
    "Item": {
      "ArrivalTimeFormatted": "string",
      "BoardPoint": "string",
      "ChangeOfDayFormatted": "string",
      "DepartureTimeFormatted": "string",
      "EndDate": "string",
      "OffPoint": "string",
      "OperatorCode": "string",
      "OperatorService": "string",
      "SegmentNbr": 0,
      "SegmentStatus": "string",
      "SegmentType": "string",
      "ServiceCode": "string",
      "StartDate": "string",
      "TicketNumber": "string"
    }
  },
  "ItineraryFormatted": "string"
}

BookingDetails

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string	false	none	none
Account	string	false	none	none
OwningConsultantID	string	false	none	none
OwningConsultant	string	false	none	none
CrsDescription	string	false	none	none
LastActionConsultantID	string	false	none	none
LastActionAgencyLocationID	string	false	none	none
OwningAgencyLocationID	string	false	none	none
CreatingAgencyIata	string	false	none	none
Passengers	[PassengerDetails]	false	none	[PassengerDetails]
Phones	[BookingPhone]	false	none	[BookingPhone]
Notepads	[BookingNotepad]	false	none	[BookingNotepad]
VendorRemarks	[VendorRemark]	false	none	[VendorRemark]
DiEntries	[DiEntry]	false	none	[DiEntry]
Tickets	[BookingTicket]	false	none	[BookingTicket]
Versions	[BookingVersion]	false	none	[BookingVersion]
VendorLocators	[BookingVendorLocator]	false	none	[BookingVendorLocator]
Itinerary	ItinerarySegmentsCollection	false	none	ItinerarySegmentsCollection
ItineraryFormatted	string	false	none	none

PassengerDetails

{
  "Id": 0,
  "FirstName": "string",
  "LastName": "string",
  "FrequentFlyers": [
    {
      "Vendor": "string",
      "Number": "string",
      "FullNumber": "string"
    }
  ],
  "SequenceNbr": 0,
  "LastNameElement": 0,
  "IsVip": true
}

PassengerDetails

Properties

Name	Type	Required	Restrictions	Description
Id	integer(int32)	false	none	none
FirstName	string	false	none	none
LastName	string	false	none	none
FrequentFlyers	[FrequentFlyerDetails]	false	none	[FrequentFlyerDetails]
SequenceNbr	integer(int32)	false	none	none
LastNameElement	integer(int32)	false	none	none
IsVip	boolean	false	none	none

FrequentFlyerDetails

{
  "Vendor": "string",
  "Number": "string",
  "FullNumber": "string"
}

FrequentFlyerDetails

Properties

Name	Type	Required	Restrictions	Description
Vendor	string	false	none	none
Number	string	false	none	none
FullNumber	string	false	none	none

BookingPhone

{
  "PhoneType": "string",
  "City": "string",
  "Number": "string",
  "SequenceNbr": 0
}

BookingPhone

Properties

Name	Type	Required	Restrictions	Description
PhoneType	string	false	none	none
City	string	false	none	none
Number	string	false	none	none
SequenceNbr	integer(int32)	false	none	none

BookingNotepad

{
  "Remark": "string",
  "CreatedDate": "2019-03-18T11:42:49Z",
  "CreatedTime": "string",
  "Qualifier": "string",
  "SequenceNbr": 0
}

BookingNotepad

Properties

Name	Type	Required	Restrictions	Description
Remark	string	false	none	none
CreatedDate	string(date-time)	false	none	none
CreatedTime	string	false	none	none
Qualifier	string	false	none	none
SequenceNbr	integer(int32)	false	none	none

VendorRemark

{
  "DateStamp": "2019-03-18T11:42:49Z",
  "Remark": "string",
  "RemarkType": "string",
  "RmkNum": 0,
  "TimeStamp": "string",
  "TravelOrderIdentifier": 0,
  "Vendor": "string",
  "VendorType": "string",
  "VendorRemarkID": 0
}

VendorRemark

Properties

Name	Type	Required	Restrictions	Description
DateStamp	string(date-time)	false	none	none
Remark	string	false	none	none
RemarkType	string	false	none	none
RmkNum	integer(int32)	false	none	none
TimeStamp	string	false	none	none
TravelOrderIdentifier	integer(int32)	false	none	none
Vendor	string	false	none	none
VendorType	string	false	none	none
VendorRemarkID	integer(int32)	false	none	none

DiEntry

{
  "SequenceNbr": 0,
  "Keyword": "string",
  "Remark": "string"
}

DiEntry

Properties

Name	Type	Required	Restrictions	Description
SequenceNbr	integer(int32)	false	none	none
Keyword	string	false	none	none
Remark	string	false	none	none

BookingTicket

{
  "SegmentNbr": 0,
  "TicketNumber": "string"
}

BookingTicket

Properties

Name	Type	Required	Restrictions	Description
SegmentNbr	integer(int32)	false	none	none
TicketNumber	string	false	none	none

BookingVersion

{
  "AgentivityRef": 0,
  "DataBaseTimeStamp": "2019-03-18T11:42:49Z",
  "EventType": "string",
  "PnrTicketed": "string",
  "LastActionAgentId": "string",
  "AirSegs": 0,
  "AirPSegs": 0,
  "HtlSegs": 0,
  "HtlPSegs": 0,
  "CarSegs": 0,
  "CarPSegs": 0
}

BookingVersion

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
DataBaseTimeStamp	string(date-time)	false	none	none
EventType	string	false	none	none
PnrTicketed	string	false	none	none
LastActionAgentId	string	false	none	none
AirSegs	integer(int32)	false	none	none
AirPSegs	integer(int32)	false	none	none
HtlSegs	integer(int32)	false	none	none
HtlPSegs	integer(int32)	false	none	none
CarSegs	integer(int32)	false	none	none
CarPSegs	integer(int32)	false	none	none

BookingVendorLocator

{
  "AirSegmentNbr": 0,
  "CarrierCode": "string",
  "VendorLocator": "string"
}

BookingVendorLocator

Properties

Name	Type	Required	Restrictions	Description
AirSegmentNbr	integer(int32)	false	none	none
CarrierCode	string	false	none	none
VendorLocator	string	false	none	none

HtlPropertyNight

{
  "HotelVendorCode": "string",
  "PropertyCityCode": "string",
  "PropertyName": "string",
  "GalileoPropertyNbr": "string",
  "NbrNights": "string"
}

HtlPropertyNight

Properties

Name	Type	Required	Restrictions	Description
HotelVendorCode	string	false	none	none
PropertyCityCode	string	false	none	none
PropertyName	string	false	none	none
GalileoPropertyNbr	string	false	none	none
NbrNights	string	false	none	none

MirGenerationLogByAccountItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyLocationID": "string",
      "Account": "string",
      "Success": true,
      "ResultMessage": "string",
      "EventType": "string",
      "EventTypeDesc": "string",
      "OwningConsultant": "string",
      "SiteId": 0,
      "SiteName": "string",
      "SiteQueue": "string",
      "DateTimeSent": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

MirGenerationLogByAccountItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	MirGenerationLogByAccountResponseReport	false	none	MirGenerationLogByAccountResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

MirGenerationLogByAccountResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "OwningAgencyLocationID": "string",
    "Account": "string",
    "Success": true,
    "ResultMessage": "string",
    "EventType": "string",
    "EventTypeDesc": "string",
    "OwningConsultant": "string",
    "SiteId": 0,
    "SiteName": "string",
    "SiteQueue": "string",
    "DateTimeSent": "2019-03-18T11:42:49Z"
  }
}

MirGenerationLogByAccountResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	MirGenerationLog	false	none	MirGenerationLog

MirGenerationLog

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "OwningAgencyLocationID": "string",
  "Account": "string",
  "Success": true,
  "ResultMessage": "string",
  "EventType": "string",
  "EventTypeDesc": "string",
  "OwningConsultant": "string",
  "SiteId": 0,
  "SiteName": "string",
  "SiteQueue": "string",
  "DateTimeSent": "2019-03-18T11:42:49Z"
}

MirGenerationLog

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
OwningAgencyLocationID	string	false	none	none
Account	string	false	none	none
Success	boolean	false	none	none
ResultMessage	string	false	none	none
EventType	string	false	none	none
EventTypeDesc	string	false	none	none
OwningConsultant	string	false	none	none
SiteId	integer(int32)	false	none	none
SiteName	string	false	none	none
SiteQueue	string	false	none	none
DateTimeSent	string(date-time)	false	none	none

MissedHotelOpportunitiesByCityItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "CityCode": "string",
      "Account": "string",
      "Passengers": "string",
      "OwningConsultant": "string",
      "From": "2019-03-18T11:42:49Z",
      "To": "2019-03-18T11:42:49Z",
      "NightsNumber": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

MissedHotelOpportunitiesByCityItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	MissedHotelOpportunitiesByCityResponseReport	false	none	MissedHotelOpportunitiesByCityResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

MissedHotelOpportunitiesByCityResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "CityCode": "string",
    "Account": "string",
    "Passengers": "string",
    "OwningConsultant": "string",
    "From": "2019-03-18T11:42:49Z",
    "To": "2019-03-18T11:42:49Z",
    "NightsNumber": 0
  }
}

MissedHotelOpportunitiesByCityResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	MissedHotelOpportunity	false	none	MissedHotelOpportunity

MissedHotelOpportunity

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "CityCode": "string",
  "Account": "string",
  "Passengers": "string",
  "OwningConsultant": "string",
  "From": "2019-03-18T11:42:49Z",
  "To": "2019-03-18T11:42:49Z",
  "NightsNumber": 0
}

MissedHotelOpportunity

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
CityCode	string	false	none	none
Account	string	false	none	none
Passengers	string	false	none	none
OwningConsultant	string	false	none	none
From	string(date-time)	false	none	none
To	string(date-time)	false	none	none
NightsNumber	integer(int32)	false	none	none

MissedHotelOpportunitiesPerCityItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "CityCode": "string",
      "Account": "string",
      "CityName": "string",
      "CountryCode": "string",
      "TotalMissed": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

MissedHotelOpportunitiesPerCityItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	MissedHotelOpportunitiesPerCityResponseReport	false	none	MissedHotelOpportunitiesPerCityResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

MissedHotelOpportunitiesPerCityResponseReport

{
  "Item": {
    "CityCode": "string",
    "Account": "string",
    "CityName": "string",
    "CountryCode": "string",
    "TotalMissed": 0
  }
}

MissedHotelOpportunitiesPerCityResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	MissedHotelOpportunityPerCity	false	none	MissedHotelOpportunityPerCity

MissedHotelOpportunityPerCity

{
  "CityCode": "string",
  "Account": "string",
  "CityName": "string",
  "CountryCode": "string",
  "TotalMissed": 0
}

MissedHotelOpportunityPerCity

Properties

Name	Type	Required	Restrictions	Description
CityCode	string	false	none	none
Account	string	false	none	none
CityName	string	false	none	none
CountryCode	string	false	none	none
TotalMissed	integer(int32)	false	none	none

PassengerAirSegmentsWithMaxTravellerFlagByUserResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Account": "string",
      "ArrivalCity": "string",
      "ArrivalDate": "string",
      "ArrivalTime": "string",
      "CostCentre": "string",
      "DepartureCity": "string",
      "DepartureDate": "string",
      "DepartureTime": "string",
      "FlightNbr": "string",
      "MaxTravellerCount": 0,
      "MaxTravellerCountExceededFlag": true,
      "OperatingCarrierCode": "string",
      "Passenger": "string",
      "PNRTicketed": "string",
      "RecordLocator": "string",
      "TravellerCount": 0
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

PassengerAirSegmentsWithMaxTravellerFlagByUserResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[PassengerAirSegmentWithMaxTravellerFlag]	false	none	[PassengerAirSegmentWithMaxTravellerFlag]
ResponseError	AgentivityError	false	none	AgentivityError

PassengerAirSegmentWithMaxTravellerFlag

{
  "Account": "string",
  "ArrivalCity": "string",
  "ArrivalDate": "string",
  "ArrivalTime": "string",
  "CostCentre": "string",
  "DepartureCity": "string",
  "DepartureDate": "string",
  "DepartureTime": "string",
  "FlightNbr": "string",
  "MaxTravellerCount": 0,
  "MaxTravellerCountExceededFlag": true,
  "OperatingCarrierCode": "string",
  "Passenger": "string",
  "PNRTicketed": "string",
  "RecordLocator": "string",
  "TravellerCount": 0
}

PassengerAirSegmentWithMaxTravellerFlag

Properties

Name	Type	Required	Restrictions	Description
Account	string	false	none	none
ArrivalCity	string	false	none	none
ArrivalDate	string	false	none	none
ArrivalTime	string	false	none	none
CostCentre	string	false	none	none
DepartureCity	string	false	none	none
DepartureDate	string	false	none	none
DepartureTime	string	false	none	none
FlightNbr	string	false	none	none
MaxTravellerCount	integer(int32)	false	none	none
MaxTravellerCountExceededFlag	boolean	false	none	none
OperatingCarrierCode	string	false	none	none
Passenger	string	false	none	none
PNRTicketed	string	false	none	none
RecordLocator	string	false	none	none
TravellerCount	integer(int32)	false	none	none

BookingsByAirSegmentsCountItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "OwningAgencyPseudo": "string",
      "Passengers": "string",
      "OwningConsultant": "string",
      "Account": "string",
      "AirSegmentsCount": 0,
      "TravelDate": "2019-03-18T11:42:49Z",
      "PNRTicketed": "string",
      "PNRCancelled": "string",
      "Itinerary": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsByAirSegmentsCountItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsByAirSegmentsCountResponseReport	false	none	BookingsByAirSegmentsCountResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsByAirSegmentsCountResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "OwningAgencyPseudo": "string",
    "Passengers": "string",
    "OwningConsultant": "string",
    "Account": "string",
    "AirSegmentsCount": 0,
    "TravelDate": "2019-03-18T11:42:49Z",
    "PNRTicketed": "string",
    "PNRCancelled": "string",
    "Itinerary": "string"
  }
}

BookingsByAirSegmentsCountResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingByAirSegmentsCount	false	none	BookingByAirSegmentsCount

BookingByAirSegmentsCount

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "OwningAgencyPseudo": "string",
  "Passengers": "string",
  "OwningConsultant": "string",
  "Account": "string",
  "AirSegmentsCount": 0,
  "TravelDate": "2019-03-18T11:42:49Z",
  "PNRTicketed": "string",
  "PNRCancelled": "string",
  "Itinerary": "string"
}

BookingByAirSegmentsCount

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
OwningAgencyPseudo	string	false	none	none
Passengers	string	false	none	none
OwningConsultant	string	false	none	none
Account	string	false	none	none
AirSegmentsCount	integer(int32)	false	none	none
TravelDate	string(date-time)	false	none	none
PNRTicketed	string	false	none	none
PNRCancelled	string	false	none	none
Itinerary	string	false	none	none

BookingsBasicWithoutMobileByUserResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "TravelDate": "string",
      "OwningConsultant": "string",
      "Account": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsBasicWithoutMobileByUserResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[BasicBooking]	false	none	[BasicBooking]
ResponseError	AgentivityError	false	none	AgentivityError

CarrierWithBookingCounts

{
  "CarrierCode": "string",
  "CarrierName": "string",
  "BookingCount": "string"
}

CarrierWithBookingCounts

Properties

Name	Type	Required	Restrictions	Description
CarrierCode	string	false	none	none
CarrierName	string	false	none	none
BookingCount	string	false	none	none

BookingsTurnAroundItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "TicketingDate": "2019-03-18T11:42:49Z",
      "ContainsAir": "string",
      "ContainsCar": "string",
      "ContainsHotel": "string",
      "DestinationCountriesCount": 0,
      "PNRTicketed": "string",
      "PNRCancelled": "string",
      "OwningConsultant": "string",
      "Passengers": "string",
      "TouchpointNotes": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsTurnAroundItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	BookingsTurnAroundResponseReport	false	none	BookingsTurnAroundResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

BookingsTurnAroundResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "TicketingDate": "2019-03-18T11:42:49Z",
    "ContainsAir": "string",
    "ContainsCar": "string",
    "ContainsHotel": "string",
    "DestinationCountriesCount": 0,
    "PNRTicketed": "string",
    "PNRCancelled": "string",
    "OwningConsultant": "string",
    "Passengers": "string",
    "TouchpointNotes": "string"
  }
}

BookingsTurnAroundResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	BookingTurnAround	false	none	BookingTurnAround

BookingTurnAround

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "TicketingDate": "2019-03-18T11:42:49Z",
  "ContainsAir": "string",
  "ContainsCar": "string",
  "ContainsHotel": "string",
  "DestinationCountriesCount": 0,
  "PNRTicketed": "string",
  "PNRCancelled": "string",
  "OwningConsultant": "string",
  "Passengers": "string",
  "TouchpointNotes": "string"
}

BookingTurnAround

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
TicketingDate	string(date-time)	false	none	none
ContainsAir	string	false	none	none
ContainsCar	string	false	none	none
ContainsHotel	string	false	none	none
DestinationCountriesCount	integer(int32)	false	none	none
PNRTicketed	string	false	none	none
PNRCancelled	string	false	none	none
OwningConsultant	string	false	none	none
Passengers	string	false	none	none
TouchpointNotes	string	false	none	none

CityPassengerCount

{
  "CityCode": "string",
  "PassengerCount": "string"
}

CityPassengerCount

Properties

Name	Type	Required	Restrictions	Description
CityCode	string	false	none	none
PassengerCount	string	false	none	none

CountryPassengerCountsByCompanyResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "CountryCode": "string",
      "PassengerCount": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

CountryPassengerCountsByCompanyResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[CountryPassengerCount]	false	none	[CountryPassengerCount]
ResponseError	AgentivityError	false	none	AgentivityError

CountryPassengerCount

{
  "CountryCode": "string",
  "PassengerCount": "string"
}

CountryPassengerCount

Properties

Name	Type	Required	Restrictions	Description
CountryCode	string	false	none	none
PassengerCount	string	false	none	none

EventBookingsItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "PaxList": "string",
      "ItineraryFormatted": "string",
      "Notes": "string",
      "AgentivityRef": 0,
      "Itinerary": {
        "SegmentTypesFilter": [
          "string"
        ],
        "FilteredSegments": null,
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "ArrivalTimeFormatted": "string",
          "BoardPoint": "string",
          "ChangeOfDayFormatted": "string",
          "DepartureTimeFormatted": "string",
          "EndDate": "string",
          "OffPoint": "string",
          "OperatorCode": "string",
          "OperatorService": "string",
          "SegmentNbr": 0,
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceCode": "string",
          "StartDate": "string",
          "TicketNumber": "string"
        }
      }
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

EventBookingsItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	EventBookingsResponseReport	false	none	EventBookingsResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

EventBookingsResponseReport

{
  "Item": {
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "PaxList": "string",
    "ItineraryFormatted": "string",
    "Notes": "string",
    "AgentivityRef": 0,
    "Itinerary": {
      "SegmentTypesFilter": [
        "string"
      ],
      "FilteredSegments": null,
      "Capacity": 0,
      "Count": 0,
      "Item": {
        "ArrivalTimeFormatted": "string",
        "BoardPoint": "string",
        "ChangeOfDayFormatted": "string",
        "DepartureTimeFormatted": "string",
        "EndDate": "string",
        "OffPoint": "string",
        "OperatorCode": "string",
        "OperatorService": "string",
        "SegmentNbr": 0,
        "SegmentStatus": "string",
        "SegmentType": "string",
        "ServiceCode": "string",
        "StartDate": "string",
        "TicketNumber": "string"
      }
    }
  }
}

EventBookingsResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	EventBooking	false	none	EventBooking

EventBooking

{
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "PaxList": "string",
  "ItineraryFormatted": "string",
  "Notes": "string",
  "AgentivityRef": 0,
  "Itinerary": {
    "SegmentTypesFilter": [
      "string"
    ],
    "FilteredSegments": null,
    "Capacity": 0,
    "Count": 0,
    "Item": {
      "ArrivalTimeFormatted": "string",
      "BoardPoint": "string",
      "ChangeOfDayFormatted": "string",
      "DepartureTimeFormatted": "string",
      "EndDate": "string",
      "OffPoint": "string",
      "OperatorCode": "string",
      "OperatorService": "string",
      "SegmentNbr": 0,
      "SegmentStatus": "string",
      "SegmentType": "string",
      "ServiceCode": "string",
      "StartDate": "string",
      "TicketNumber": "string"
    }
  }
}

EventBooking

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
PaxList	string	false	none	none
ItineraryFormatted	string	false	none	none
Notes	string	false	none	none
AgentivityRef	integer(int32)	false	none	none
Itinerary	ItinerarySegmentsCollection	false	none	ItinerarySegmentsCollection

HealthCheckStats

{
  "Data": {}
}

HealthCheckStats

Properties

Name	Type	Required	Restrictions	Description
Data	DataSet	false	none	Represents an in-memory cache of data.

LogEventTypeDetail

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "OwningAgencyLocationID": "string",
  "Account": "string",
  "OwningConsultant": "string",
  "Destination": "string",
  "RuleName": "string",
  "Success": "string",
  "LoggedDateTime": "2019-03-18T11:42:49Z"
}

LogEventTypeDetail

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
OwningAgencyLocationID	string	false	none	none
Account	string	false	none	none
OwningConsultant	string	false	none	none
Destination	string	false	none	none
RuleName	string	false	none	none
Success	string	false	none	none
LoggedDateTime	string(date-time)	false	none	none

PartnerBookingsDataCaptureItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "ADDRESS": "string",
      "AGENCY_IATA": "string",
      "AIR_BOOKED_FLAG": "string",
      "AIR_COMM_AMT": "string",
      "AIR_NO_ACCOMODATION_REASON_CODE": "string",
      "APPROVAL_CODE": "string",
      "APPROVER": "string",
      "AREA_CODE": "string",
      "CAR_BOOK_MODE": "string",
      "CAR_BOOKED_FLAG": "string",
      "CAR_GDS_PARTNER_CD_USED": "string",
      "CAR_ITINERARY_CD": "string",
      "CAR_REASON_CODE": "string",
      "CAR_RENT_RATE_CUR": "string",
      "CAR_VOUCHER_NO": "string",
      "CARRIER_CD": "string",
      "CHECKINDATE": "string",
      "CITY_COUNTRYCODE_ZIPCODE_PHONE": "string",
      "CLASS": "string",
      "COST_CENTER_CODE": "string",
      "CREDIT_CARD_COMPANY_CODE": "string",
      "CREDIT_CARD_NUMBER": "string",
      "CS_DATA1": "string",
      "CS_DATA2": "string",
      "CS_DATA3": "string",
      "CS_DATA4": "string",
      "CS_DATA7": "string",
      "CS_DATA8": "string",
      "DEPART_DATE": "2019-03-18T11:42:49Z",
      "DEPARTMENT_NUMBER": "string",
      "DEPARTURE_ARRIVAL_TIMES": "string",
      "EMPLOYEE_NUMBER": "string",
      "FARE_BASIS": "string",
      "FARE_PAID": "string",
      "FFLYR_NO": "string",
      "FULL_FARE": "string",
      "GDS_CAR_TYPE_CODE": "string",
      "GDS_MASTER_SUPPLIER_CODE": "string",
      "GDS_RECLOC": "string",
      "GDS_RM_TYPE_CODE": "string",
      "GLOBALCUST_NO": "string",
      "HOTEL_BOOK_MODE": "string",
      "HOTEL_BOOKED_FLAG": "string",
      "HOTEL_CHAIN_CODE": "string",
      "HOTEL_COMM_AMT": "string",
      "HOTEL_GDS_PARTNER_CD_USED": "string",
      "HOTEL_NAME": "string",
      "HOTEL_REASON_CODE": "string",
      "HOTEL_VOUCHER_NO": "string",
      "ITINERARY": "string",
      "ITINERARY_DATES": "string",
      "LOC_CUR": "string",
      "LOC_TAX": "string",
      "LOCALCUST_NO": "string",
      "LOW_FARE": "string",
      "MANAGER_SUPERIOR": "string",
      "NIGHT_STAYS": "string",
      "NO_OF_DOCUMENTS": 0,
      "OPR_FLT_NO": "string",
      "ORDER_REFERENCE": "string",
      "ORIGINAL_DOCUMENT": "string",
      "PAID_CAR_RENT_RATE_PER_DAY": "string",
      "PAID_ROOM_RATE_PER_NIGHT": "string",
      "PICKUPDATE": "string",
      "PNR_SEGMENT_NO": 0,
      "PROJECT_NUMBER": "string",
      "RAIL_FERRY_BOOKED_FLAG": "string",
      "RATE_TYPE_CODE": "string",
      "REASON_CODE": "string",
      "REASON_CODE_DENIED": "string",
      "REASON_OF_TRIP": "string",
      "REFUNDED_FARE": "string",
      "RENTAL_DAYS": "string",
      "RESERVATION_DATE": "2019-03-18T11:42:49Z",
      "RM_TYPE": "string",
      "ROOM_RATE_CUR": "string",
      "SALES_CHANNEL": "string",
      "STOPOVR_TRF_FLAG": "string",
      "SUPPLIER_NAME": "string",
      "TKT_NO": "string",
      "TKT_TYPE": "string",
      "TOUR_CODE": "string",
      "TRAVELLER_NAME": "string",
      "TRAVELLER_STATUS": "string",
      "TRVL_MTH": 0,
      "TRVL_YR": 0,
      "VALIDATING_CARRIER_CD": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

PartnerBookingsDataCaptureItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	PartnerBookingsDataCaptureResponseReport	false	none	PartnerBookingsDataCaptureResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

PartnerBookingsDataCaptureResponseReport

{
  "Item": {
    "ADDRESS": "string",
    "AGENCY_IATA": "string",
    "AIR_BOOKED_FLAG": "string",
    "AIR_COMM_AMT": "string",
    "AIR_NO_ACCOMODATION_REASON_CODE": "string",
    "APPROVAL_CODE": "string",
    "APPROVER": "string",
    "AREA_CODE": "string",
    "CAR_BOOK_MODE": "string",
    "CAR_BOOKED_FLAG": "string",
    "CAR_GDS_PARTNER_CD_USED": "string",
    "CAR_ITINERARY_CD": "string",
    "CAR_REASON_CODE": "string",
    "CAR_RENT_RATE_CUR": "string",
    "CAR_VOUCHER_NO": "string",
    "CARRIER_CD": "string",
    "CHECKINDATE": "string",
    "CITY_COUNTRYCODE_ZIPCODE_PHONE": "string",
    "CLASS": "string",
    "COST_CENTER_CODE": "string",
    "CREDIT_CARD_COMPANY_CODE": "string",
    "CREDIT_CARD_NUMBER": "string",
    "CS_DATA1": "string",
    "CS_DATA2": "string",
    "CS_DATA3": "string",
    "CS_DATA4": "string",
    "CS_DATA7": "string",
    "CS_DATA8": "string",
    "DEPART_DATE": "2019-03-18T11:42:49Z",
    "DEPARTMENT_NUMBER": "string",
    "DEPARTURE_ARRIVAL_TIMES": "string",
    "EMPLOYEE_NUMBER": "string",
    "FARE_BASIS": "string",
    "FARE_PAID": "string",
    "FFLYR_NO": "string",
    "FULL_FARE": "string",
    "GDS_CAR_TYPE_CODE": "string",
    "GDS_MASTER_SUPPLIER_CODE": "string",
    "GDS_RECLOC": "string",
    "GDS_RM_TYPE_CODE": "string",
    "GLOBALCUST_NO": "string",
    "HOTEL_BOOK_MODE": "string",
    "HOTEL_BOOKED_FLAG": "string",
    "HOTEL_CHAIN_CODE": "string",
    "HOTEL_COMM_AMT": "string",
    "HOTEL_GDS_PARTNER_CD_USED": "string",
    "HOTEL_NAME": "string",
    "HOTEL_REASON_CODE": "string",
    "HOTEL_VOUCHER_NO": "string",
    "ITINERARY": "string",
    "ITINERARY_DATES": "string",
    "LOC_CUR": "string",
    "LOC_TAX": "string",
    "LOCALCUST_NO": "string",
    "LOW_FARE": "string",
    "MANAGER_SUPERIOR": "string",
    "NIGHT_STAYS": "string",
    "NO_OF_DOCUMENTS": 0,
    "OPR_FLT_NO": "string",
    "ORDER_REFERENCE": "string",
    "ORIGINAL_DOCUMENT": "string",
    "PAID_CAR_RENT_RATE_PER_DAY": "string",
    "PAID_ROOM_RATE_PER_NIGHT": "string",
    "PICKUPDATE": "string",
    "PNR_SEGMENT_NO": 0,
    "PROJECT_NUMBER": "string",
    "RAIL_FERRY_BOOKED_FLAG": "string",
    "RATE_TYPE_CODE": "string",
    "REASON_CODE": "string",
    "REASON_CODE_DENIED": "string",
    "REASON_OF_TRIP": "string",
    "REFUNDED_FARE": "string",
    "RENTAL_DAYS": "string",
    "RESERVATION_DATE": "2019-03-18T11:42:49Z",
    "RM_TYPE": "string",
    "ROOM_RATE_CUR": "string",
    "SALES_CHANNEL": "string",
    "STOPOVR_TRF_FLAG": "string",
    "SUPPLIER_NAME": "string",
    "TKT_NO": "string",
    "TKT_TYPE": "string",
    "TOUR_CODE": "string",
    "TRAVELLER_NAME": "string",
    "TRAVELLER_STATUS": "string",
    "TRVL_MTH": 0,
    "TRVL_YR": 0,
    "VALIDATING_CARRIER_CD": "string"
  }
}

PartnerBookingsDataCaptureResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	PartnerBookingDataCapture	false	none	PartnerBookingDataCapture

PartnerBookingDataCapture

{
  "ADDRESS": "string",
  "AGENCY_IATA": "string",
  "AIR_BOOKED_FLAG": "string",
  "AIR_COMM_AMT": "string",
  "AIR_NO_ACCOMODATION_REASON_CODE": "string",
  "APPROVAL_CODE": "string",
  "APPROVER": "string",
  "AREA_CODE": "string",
  "CAR_BOOK_MODE": "string",
  "CAR_BOOKED_FLAG": "string",
  "CAR_GDS_PARTNER_CD_USED": "string",
  "CAR_ITINERARY_CD": "string",
  "CAR_REASON_CODE": "string",
  "CAR_RENT_RATE_CUR": "string",
  "CAR_VOUCHER_NO": "string",
  "CARRIER_CD": "string",
  "CHECKINDATE": "string",
  "CITY_COUNTRYCODE_ZIPCODE_PHONE": "string",
  "CLASS": "string",
  "COST_CENTER_CODE": "string",
  "CREDIT_CARD_COMPANY_CODE": "string",
  "CREDIT_CARD_NUMBER": "string",
  "CS_DATA1": "string",
  "CS_DATA2": "string",
  "CS_DATA3": "string",
  "CS_DATA4": "string",
  "CS_DATA7": "string",
  "CS_DATA8": "string",
  "DEPART_DATE": "2019-03-18T11:42:49Z",
  "DEPARTMENT_NUMBER": "string",
  "DEPARTURE_ARRIVAL_TIMES": "string",
  "EMPLOYEE_NUMBER": "string",
  "FARE_BASIS": "string",
  "FARE_PAID": "string",
  "FFLYR_NO": "string",
  "FULL_FARE": "string",
  "GDS_CAR_TYPE_CODE": "string",
  "GDS_MASTER_SUPPLIER_CODE": "string",
  "GDS_RECLOC": "string",
  "GDS_RM_TYPE_CODE": "string",
  "GLOBALCUST_NO": "string",
  "HOTEL_BOOK_MODE": "string",
  "HOTEL_BOOKED_FLAG": "string",
  "HOTEL_CHAIN_CODE": "string",
  "HOTEL_COMM_AMT": "string",
  "HOTEL_GDS_PARTNER_CD_USED": "string",
  "HOTEL_NAME": "string",
  "HOTEL_REASON_CODE": "string",
  "HOTEL_VOUCHER_NO": "string",
  "ITINERARY": "string",
  "ITINERARY_DATES": "string",
  "LOC_CUR": "string",
  "LOC_TAX": "string",
  "LOCALCUST_NO": "string",
  "LOW_FARE": "string",
  "MANAGER_SUPERIOR": "string",
  "NIGHT_STAYS": "string",
  "NO_OF_DOCUMENTS": 0,
  "OPR_FLT_NO": "string",
  "ORDER_REFERENCE": "string",
  "ORIGINAL_DOCUMENT": "string",
  "PAID_CAR_RENT_RATE_PER_DAY": "string",
  "PAID_ROOM_RATE_PER_NIGHT": "string",
  "PICKUPDATE": "string",
  "PNR_SEGMENT_NO": 0,
  "PROJECT_NUMBER": "string",
  "RAIL_FERRY_BOOKED_FLAG": "string",
  "RATE_TYPE_CODE": "string",
  "REASON_CODE": "string",
  "REASON_CODE_DENIED": "string",
  "REASON_OF_TRIP": "string",
  "REFUNDED_FARE": "string",
  "RENTAL_DAYS": "string",
  "RESERVATION_DATE": "2019-03-18T11:42:49Z",
  "RM_TYPE": "string",
  "ROOM_RATE_CUR": "string",
  "SALES_CHANNEL": "string",
  "STOPOVR_TRF_FLAG": "string",
  "SUPPLIER_NAME": "string",
  "TKT_NO": "string",
  "TKT_TYPE": "string",
  "TOUR_CODE": "string",
  "TRAVELLER_NAME": "string",
  "TRAVELLER_STATUS": "string",
  "TRVL_MTH": 0,
  "TRVL_YR": 0,
  "VALIDATING_CARRIER_CD": "string"
}

PartnerBookingDataCapture

Properties

Name	Type	Required	Restrictions	Description
ADDRESS	string	false	none	none
AGENCY_IATA	string	false	none	none
AIR_BOOKED_FLAG	string	false	none	none
AIR_COMM_AMT	string	false	none	none
AIR_NO_ACCOMODATION_REASON_CODE	string	false	none	none
APPROVAL_CODE	string	false	none	none
APPROVER	string	false	none	none
AREA_CODE	string	false	none	none
CAR_BOOK_MODE	string	false	none	none
CAR_BOOKED_FLAG	string	false	none	none
CAR_GDS_PARTNER_CD_USED	string	false	none	none
CAR_ITINERARY_CD	string	false	none	none
CAR_REASON_CODE	string	false	none	none
CAR_RENT_RATE_CUR	string	false	none	none
CAR_VOUCHER_NO	string	false	none	none
CARRIER_CD	string	false	none	none
CHECKINDATE	string	false	none	none
CITY_COUNTRYCODE_ZIPCODE_PHONE	string	false	none	none
CLASS	string	false	none	none
COST_CENTER_CODE	string	false	none	none
CREDIT_CARD_COMPANY_CODE	string	false	none	none
CREDIT_CARD_NUMBER	string	false	none	none
CS_DATA1	string	false	none	none
CS_DATA2	string	false	none	none
CS_DATA3	string	false	none	none
CS_DATA4	string	false	none	none
CS_DATA7	string	false	none	none
CS_DATA8	string	false	none	none
DEPART_DATE	string(date-time)	false	none	none
DEPARTMENT_NUMBER	string	false	none	none
DEPARTURE_ARRIVAL_TIMES	string	false	none	none
EMPLOYEE_NUMBER	string	false	none	none
FARE_BASIS	string	false	none	none
FARE_PAID	string	false	none	none
FFLYR_NO	string	false	none	none
FULL_FARE	string	false	none	none
GDS_CAR_TYPE_CODE	string	false	none	none
GDS_MASTER_SUPPLIER_CODE	string	false	none	none
GDS_RECLOC	string	false	none	none
GDS_RM_TYPE_CODE	string	false	none	none
GLOBALCUST_NO	string	false	none	none
HOTEL_BOOK_MODE	string	false	none	none
HOTEL_BOOKED_FLAG	string	false	none	none
HOTEL_CHAIN_CODE	string	false	none	none
HOTEL_COMM_AMT	string	false	none	none
HOTEL_GDS_PARTNER_CD_USED	string	false	none	none
HOTEL_NAME	string	false	none	none
HOTEL_REASON_CODE	string	false	none	none
HOTEL_VOUCHER_NO	string	false	none	none
ITINERARY	string	false	none	none
ITINERARY_DATES	string	false	none	none
LOC_CUR	string	false	none	none
LOC_TAX	string	false	none	none
LOCALCUST_NO	string	false	none	none
LOW_FARE	string	false	none	none
MANAGER_SUPERIOR	string	false	none	none
NIGHT_STAYS	string	false	none	none
NO_OF_DOCUMENTS	integer(int32)	false	none	none
OPR_FLT_NO	string	false	none	none
ORDER_REFERENCE	string	false	none	none
ORIGINAL_DOCUMENT	string	false	none	none
PAID_CAR_RENT_RATE_PER_DAY	string	false	none	none
PAID_ROOM_RATE_PER_NIGHT	string	false	none	none
PICKUPDATE	string	false	none	none
PNR_SEGMENT_NO	integer(int32)	false	none	none
PROJECT_NUMBER	string	false	none	none
RAIL_FERRY_BOOKED_FLAG	string	false	none	none
RATE_TYPE_CODE	string	false	none	none
REASON_CODE	string	false	none	none
REASON_CODE_DENIED	string	false	none	none
REASON_OF_TRIP	string	false	none	none
REFUNDED_FARE	string	false	none	none
RENTAL_DAYS	string	false	none	none
RESERVATION_DATE	string(date-time)	false	none	none
RM_TYPE	string	false	none	none
ROOM_RATE_CUR	string	false	none	none
SALES_CHANNEL	string	false	none	none
STOPOVR_TRF_FLAG	string	false	none	none
SUPPLIER_NAME	string	false	none	none
TKT_NO	string	false	none	none
TKT_TYPE	string	false	none	none
TOUR_CODE	string	false	none	none
TRAVELLER_NAME	string	false	none	none
TRAVELLER_STATUS	string	false	none	none
TRVL_MTH	integer(int32)	false	none	none
TRVL_YR	integer(int32)	false	none	none
VALIDATING_CARRIER_CD	string	false	none	none

PassengerArrivalsItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningConsultant": "string",
      "Passenger": "string",
      "Account": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "ArrivalDate": "2019-03-18T11:42:49Z",
      "DaysAway": 0,
      "DestinationCountries": "string",
      "MobileList": "string",
      "EmailList": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

PassengerArrivalsItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	PassengerArrivalsResponseReport	false	none	PassengerArrivalsResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

PassengerArrivalsResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "OwningConsultant": "string",
    "Passenger": "string",
    "Account": "string",
    "TravelDate": "2019-03-18T11:42:49Z",
    "ArrivalDate": "2019-03-18T11:42:49Z",
    "DaysAway": 0,
    "DestinationCountries": "string",
    "MobileList": "string",
    "EmailList": "string"
  }
}

PassengerArrivalsResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	PassengerArrival	false	none	PassengerArrival

PassengerArrival

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "OwningConsultant": "string",
  "Passenger": "string",
  "Account": "string",
  "TravelDate": "2019-03-18T11:42:49Z",
  "ArrivalDate": "2019-03-18T11:42:49Z",
  "DaysAway": 0,
  "DestinationCountries": "string",
  "MobileList": "string",
  "EmailList": "string"
}

PassengerArrival

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
OwningConsultant	string	false	none	none
Passenger	string	false	none	none
Account	string	false	none	none
TravelDate	string(date-time)	false	none	none
ArrivalDate	string(date-time)	false	none	none
DaysAway	integer(int32)	false	none	none
DestinationCountries	string	false	none	none
MobileList	string	false	none	none
EmailList	string	false	none	none

PassengerLocationsByAirlineItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningConsultantID": "string",
      "TravelDate": "2019-03-18T11:42:49Z",
      "PnrTicketed": "string",
      "PaxList": "string",
      "Account": "string",
      "DestinationCities": "string",
      "Connections": "string",
      "CarrierCodes": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

PassengerLocationsByAirlineItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	PassengerLocationsByAirlineResponseReport	false	none	PassengerLocationsByAirlineResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

PassengerLocationsByAirlineResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "OwningConsultantID": "string",
    "TravelDate": "2019-03-18T11:42:49Z",
    "PnrTicketed": "string",
    "PaxList": "string",
    "Account": "string",
    "DestinationCities": "string",
    "Connections": "string",
    "CarrierCodes": "string"
  }
}

PassengerLocationsByAirlineResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	PassengerLocationAirline	false	none	PassengerLocationAirline

PassengerLocationAirline

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "OwningConsultantID": "string",
  "TravelDate": "2019-03-18T11:42:49Z",
  "PnrTicketed": "string",
  "PaxList": "string",
  "Account": "string",
  "DestinationCities": "string",
  "Connections": "string",
  "CarrierCodes": "string"
}

PassengerLocationAirline

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
OwningConsultantID	string	false	none	none
TravelDate	string(date-time)	false	none	none
PnrTicketed	string	false	none	none
PaxList	string	false	none	none
Account	string	false	none	none
DestinationCities	string	false	none	none
Connections	string	false	none	none
CarrierCodes	string	false	none	none

PassengerLocationsByFlightNumberItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PaxList": "string",
      "OwningConsultantID": "string",
      "Account": "string",
      "DepartureDate": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

PassengerLocationsByFlightNumberItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	PassengerLocationsByFlightNumberResponseReport	false	none	PassengerLocationsByFlightNumberResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

PassengerLocationsByFlightNumberResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PaxList": "string",
    "OwningConsultantID": "string",
    "Account": "string",
    "DepartureDate": "2019-03-18T11:42:49Z"
  }
}

PassengerLocationsByFlightNumberResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	PassengerLocationFlightNumber	false	none	PassengerLocationFlightNumber

PassengerLocationFlightNumber

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PaxList": "string",
  "OwningConsultantID": "string",
  "Account": "string",
  "DepartureDate": "2019-03-18T11:42:49Z"
}

PassengerLocationFlightNumber

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PaxList	string	false	none	none
OwningConsultantID	string	false	none	none
Account	string	false	none	none
DepartureDate	string(date-time)	false	none	none

RebookingsItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Recordlocator": "string",
      "PNRCreationDate": "string",
      "OwningConsultantID": "string",
      "OwningAgencyLocationID": "string",
      "Account": "string",
      "RebookingOfRecordlocator": "string",
      "RebookingOfPNRCreationDate": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

RebookingsItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	RebookingsResponseReport	false	none	RebookingsResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

RebookingsResponseReport

{
  "Item": {
    "Recordlocator": "string",
    "PNRCreationDate": "string",
    "OwningConsultantID": "string",
    "OwningAgencyLocationID": "string",
    "Account": "string",
    "RebookingOfRecordlocator": "string",
    "RebookingOfPNRCreationDate": "string"
  }
}

RebookingsResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	Rebooking	false	none	Rebooking

Rebooking

{
  "Recordlocator": "string",
  "PNRCreationDate": "string",
  "OwningConsultantID": "string",
  "OwningAgencyLocationID": "string",
  "Account": "string",
  "RebookingOfRecordlocator": "string",
  "RebookingOfPNRCreationDate": "string"
}

Rebooking

Properties

Name	Type	Required	Restrictions	Description
Recordlocator	string	false	none	none
PNRCreationDate	string	false	none	none
OwningConsultantID	string	false	none	none
OwningAgencyLocationID	string	false	none	none
Account	string	false	none	none
RebookingOfRecordlocator	string	false	none	none
RebookingOfPNRCreationDate	string	false	none	none

DuplicateBookingsItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "PNRCreationDateFormatted": "string",
      "PaxList": "string",
      "Account": "string",
      "OwningConsultantID": "string",
      "OwningAgencyLocationID": "string",
      "DuplicateRef": 0,
      "SharedRef": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

DuplicateBookingsItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	DuplicateBookingsResponseReport	false	none	DuplicateBookingsResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

DuplicateBookingsResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "PNRCreationDateFormatted": "string",
    "PaxList": "string",
    "Account": "string",
    "OwningConsultantID": "string",
    "OwningAgencyLocationID": "string",
    "DuplicateRef": 0,
    "SharedRef": 0
  }
}

DuplicateBookingsResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	DuplicateBooking	false	none	DuplicateBooking

DuplicateBooking

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "PNRCreationDateFormatted": "string",
  "PaxList": "string",
  "Account": "string",
  "OwningConsultantID": "string",
  "OwningAgencyLocationID": "string",
  "DuplicateRef": 0,
  "SharedRef": 0
}

DuplicateBooking

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
PNRCreationDateFormatted	string	false	none	none
PaxList	string	false	none	none
Account	string	false	none	none
OwningConsultantID	string	false	none	none
OwningAgencyLocationID	string	false	none	none
DuplicateRef	integer(int32)	false	none	none
SharedRef	integer(int32)	false	none	none

RoutingInstancesByCityItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Routing": "string",
      "TotalInstances": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

RoutingInstancesByCityItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	RoutingInstancesByCityResponseReport	false	none	RoutingInstancesByCityResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

RoutingInstancesByCityResponseReport

{
  "Item": {
    "Routing": "string",
    "TotalInstances": "string"
  }
}

RoutingInstancesByCityResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	RoutingInstanceByCity	false	none	RoutingInstanceByCity

RoutingInstanceByCity

{
  "Routing": "string",
  "TotalInstances": "string"
}

RoutingInstanceByCity

Properties

Name	Type	Required	Restrictions	Description
Routing	string	false	none	none
TotalInstances	string	false	none	none

RoutingInstancesPerCityItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "CityCode": "string",
      "CityName": "string",
      "TotalInstances": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

RoutingInstancesPerCityItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	RoutingInstancesPerCityResponseReport	false	none	RoutingInstancesPerCityResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

RoutingInstancesPerCityResponseReport

{
  "Item": {
    "CityCode": "string",
    "CityName": "string",
    "TotalInstances": 0
  }
}

RoutingInstancesPerCityResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	RoutingInstancePerCity	false	none	RoutingInstancePerCity

RoutingInstancePerCity

{
  "CityCode": "string",
  "CityName": "string",
  "TotalInstances": 0
}

RoutingInstancePerCity

Properties

Name	Type	Required	Restrictions	Description
CityCode	string	false	none	none
CityName	string	false	none	none
TotalInstances	integer(int32)	false	none	none

SearchOptions

{
  "Accounts": [
    {
      "Name": "string"
    }
  ],
  "PCCs": [
    {
      "CountryCode": "string",
      "PCC": "string"
    }
  ],
  "Consultants": [
    {
      "Id": "string",
      "Name": "string"
    }
  ],
  "AirlinesTau": [
    {
      "CarrierCode": "string"
    }
  ],
  "Bars": [
    {
      "Name": "string"
    }
  ],
  "Teams": [
    {
      "Name": "string"
    }
  ],
  "IataNumbers": [
    {
      "Number": "string"
    }
  ],
  "GdsAccountValues": [
    {
      "AccountHeader": "string",
      "AccountManager": "string",
      "AccountName": "string",
      "AccountRuleID": 0,
      "AccountRulePCCID": 0,
      "AccountValue": "string",
      "EntryID": 0,
      "GDS": "string",
      "IsProQ": true,
      "LastActionDate": "2019-03-18T11:42:49Z",
      "QEBPCC": "string",
      "QEBPCCQ": "string",
      "QEBPCCQCat": "string",
      "SiteID": 0
    }
  ]
}

SearchOptions

Properties

Name	Type	Required	Restrictions	Description
Accounts	[AgAccount]	false	none	[AgAccount]
PCCs	[AgPCC]	false	none	[AgPCC]
Consultants	[AgConsultant]	false	none	[AgConsultant]
AirlinesTau	[AirlineTau]	false	none	[AirlineTau]
Bars	[AgBar]	false	none	[AgBar]
Teams	[AgTeam]	false	none	[AgTeam]
IataNumbers	[AgIata]	false	none	[AgIata]
GdsAccountValues	[GdsAccountValue]	false	none	[GdsAccountValue]

AgAccount

{
  "Name": "string"
}

AgAccount

Properties

Name	Type	Required	Restrictions	Description
Name	string	false	none	none

AgPCC

{
  "CountryCode": "string",
  "PCC": "string"
}

AgPCC

Properties

Name	Type	Required	Restrictions	Description
CountryCode	string	false	none	none
PCC	string	false	none	none

AgConsultant

{
  "Id": "string",
  "Name": "string"
}

AgConsultant

Properties

Name	Type	Required	Restrictions	Description
Id	string	false	none	none
Name	string	false	none	none

AirlineTau

{
  "CarrierCode": "string"
}

AirlineTau

Properties

Name	Type	Required	Restrictions	Description
CarrierCode	string	false	none	none

AgBar

{
  "Name": "string"
}

AgBar

Properties

Name	Type	Required	Restrictions	Description
Name	string	false	none	none

AgTeam

{
  "Name": "string"
}

AgTeam

Properties

Name	Type	Required	Restrictions	Description
Name	string	false	none	none

AgIata

{
  "Number": "string"
}

AgIata

Properties

Name	Type	Required	Restrictions	Description
Number	string	false	none	none

GdsAccountValue

{
  "AccountHeader": "string",
  "AccountManager": "string",
  "AccountName": "string",
  "AccountRuleID": 0,
  "AccountRulePCCID": 0,
  "AccountValue": "string",
  "EntryID": 0,
  "GDS": "string",
  "IsProQ": true,
  "LastActionDate": "2019-03-18T11:42:49Z",
  "QEBPCC": "string",
  "QEBPCCQ": "string",
  "QEBPCCQCat": "string",
  "SiteID": 0
}

GdsAccountValue

Properties

Name	Type	Required	Restrictions	Description
AccountHeader	string	false	none	none
AccountManager	string	false	none	none
AccountName	string	false	none	none
AccountRuleID	integer(int32)	false	none	none
AccountRulePCCID	integer(int32)	false	none	none
AccountValue	string	false	none	none
EntryID	integer(int32)	false	none	none
GDS	string	false	none	none
IsProQ	boolean	false	none	none
LastActionDate	string(date-time)	false	none	none
QEBPCC	string	false	none	none
QEBPCCQ	string	false	none	none
QEBPCCQCat	string	false	none	none
SiteID	integer(int32)	false	none	none

SegmentsQCItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "OwningConsultant": "string",
      "Passenger": "string",
      "Account": "string",
      "BoardPoint": "string",
      "OffPoint": "string",
      "DepartureTime": "string",
      "BookingClass": "string",
      "SegmentStatus": "string",
      "CarrierCode": "string",
      "FlightNbr": "string",
      "FlightNumberFromatted": "string",
      "SeatCheck": "string",
      "SeatFormatted": "string",
      "MealCheck": "string",
      "MealFormatted": "string",
      "ChauffeurDesc": "string",
      "TransferDesc": "string",
      "CarsFormatted": "string",
      "HoteCheck": "string",
      "Hotels": "string",
      "ShuttleDesc": "string",
      "TourDesc": "string",
      "FrequentFlyerNumbers": "string",
      "PnrTicketed": "string",
      "TicketNumber": "string",
      "Comments": "string",
      "OpsComments": "string",
      "IsVip": true
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

SegmentsQCItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	SegmentsQCResponseReport	false	none	SegmentsQCResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

SegmentsQCResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "OwningConsultant": "string",
    "Passenger": "string",
    "Account": "string",
    "BoardPoint": "string",
    "OffPoint": "string",
    "DepartureTime": "string",
    "BookingClass": "string",
    "SegmentStatus": "string",
    "CarrierCode": "string",
    "FlightNbr": "string",
    "FlightNumberFromatted": "string",
    "SeatCheck": "string",
    "SeatFormatted": "string",
    "MealCheck": "string",
    "MealFormatted": "string",
    "ChauffeurDesc": "string",
    "TransferDesc": "string",
    "CarsFormatted": "string",
    "HoteCheck": "string",
    "Hotels": "string",
    "ShuttleDesc": "string",
    "TourDesc": "string",
    "FrequentFlyerNumbers": "string",
    "PnrTicketed": "string",
    "TicketNumber": "string",
    "Comments": "string",
    "OpsComments": "string",
    "IsVip": true
  }
}

SegmentsQCResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	SegmentQC	false	none	SegmentQC

SegmentQC

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "OwningConsultant": "string",
  "Passenger": "string",
  "Account": "string",
  "BoardPoint": "string",
  "OffPoint": "string",
  "DepartureTime": "string",
  "BookingClass": "string",
  "SegmentStatus": "string",
  "CarrierCode": "string",
  "FlightNbr": "string",
  "FlightNumberFromatted": "string",
  "SeatCheck": "string",
  "SeatFormatted": "string",
  "MealCheck": "string",
  "MealFormatted": "string",
  "ChauffeurDesc": "string",
  "TransferDesc": "string",
  "CarsFormatted": "string",
  "HoteCheck": "string",
  "Hotels": "string",
  "ShuttleDesc": "string",
  "TourDesc": "string",
  "FrequentFlyerNumbers": "string",
  "PnrTicketed": "string",
  "TicketNumber": "string",
  "Comments": "string",
  "OpsComments": "string",
  "IsVip": true
}

SegmentQC

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
OwningConsultant	string	false	none	none
Passenger	string	false	none	none
Account	string	false	none	none
BoardPoint	string	false	none	none
OffPoint	string	false	none	none
DepartureTime	string	false	none	none
BookingClass	string	false	none	none
SegmentStatus	string	false	none	none
CarrierCode	string	false	none	none
FlightNbr	string	false	none	none
FlightNumberFromatted	string	false	none	none
SeatCheck	string	false	none	none
SeatFormatted	string	false	none	none
MealCheck	string	false	none	none
MealFormatted	string	false	none	none
ChauffeurDesc	string	false	none	none
TransferDesc	string	false	none	none
CarsFormatted	string	false	none	none
HoteCheck	string	false	none	none
Hotels	string	false	none	none
ShuttleDesc	string	false	none	none
TourDesc	string	false	none	none
FrequentFlyerNumbers	string	false	none	none
PnrTicketed	string	false	none	none
TicketNumber	string	false	none	none
Comments	string	false	none	none
OpsComments	string	false	none	none
IsVip	boolean	false	none	none

TicketAutomationSuccessPerPCCResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "OwningAgencyPseudo": "string",
      "TotalTicketedPNRs": "string",
      "Consultant": "string",
      "Requested": "string",
      "Success": "string",
      "Failed": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TicketAutomationSuccessPerPCCResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[TicketAutomationSuccessPerPCC]	false	none	[TicketAutomationSuccessPerPCC]
ResponseError	AgentivityError	false	none	AgentivityError

TicketAutomationSuccessPerPCC

{
  "OwningAgencyPseudo": "string",
  "TotalTicketedPNRs": "string",
  "Consultant": "string",
  "Requested": "string",
  "Success": "string",
  "Failed": "string"
}

TicketAutomationSuccessPerPCC

Properties

Name	Type	Required	Restrictions	Description
OwningAgencyPseudo	string	false	none	none
TotalTicketedPNRs	string	false	none	none
Consultant	string	false	none	none
Requested	string	false	none	none
Success	string	false	none	none
Failed	string	false	none	none

TicketDetailsItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "TktNumber": "string",
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "TktIssueDate": "2019-03-18T11:42:49Z",
      "PlatingCarrier": "string",
      "Status": "string",
      "BAR": "string",
      "PAR": "string",
      "LastName": "string",
      "FirstName": "string",
      "TicketExpiryDate": "2019-03-18T11:42:49Z",
      "FOP": "string",
      "FopFare": "string",
      "FOPCurrency": "string",
      "PrintedCurrency": "string",
      "PrintedFare": "string",
      "CreditCardFOPAcct": "string",
      "OwningAgencyLocationID": "string",
      "IATA": "string",
      "Coupons": [
        {
          "TktNumber": "string",
          "Carrier": "string",
          "CouponSequenceNbr": 0,
          "FlightNbr": "string",
          "BoardPoint": "string",
          "OffPoint": "string",
          "FlightServiceClass": "string",
          "FlightDate": "2019-03-18T11:42:49Z",
          "FlightCouponStatus": "string",
          "DateLastChecked": "2019-03-18T11:42:49Z",
          "AirTktSegId": 0,
          "EligibleForRefund": true
        }
      ],
      "EligibleForRefund": true
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TicketDetailsItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	TicketDetailsResponseReport	false	none	TicketDetailsResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

TicketDetailsResponseReport

{
  "Item": {
    "TktNumber": "string",
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "TktIssueDate": "2019-03-18T11:42:49Z",
    "PlatingCarrier": "string",
    "Status": "string",
    "BAR": "string",
    "PAR": "string",
    "LastName": "string",
    "FirstName": "string",
    "TicketExpiryDate": "2019-03-18T11:42:49Z",
    "FOP": "string",
    "FopFare": "string",
    "FOPCurrency": "string",
    "PrintedCurrency": "string",
    "PrintedFare": "string",
    "CreditCardFOPAcct": "string",
    "OwningAgencyLocationID": "string",
    "IATA": "string",
    "Coupons": [
      {
        "TktNumber": "string",
        "Carrier": "string",
        "CouponSequenceNbr": 0,
        "FlightNbr": "string",
        "BoardPoint": "string",
        "OffPoint": "string",
        "FlightServiceClass": "string",
        "FlightDate": "2019-03-18T11:42:49Z",
        "FlightCouponStatus": "string",
        "DateLastChecked": "2019-03-18T11:42:49Z",
        "AirTktSegId": 0,
        "EligibleForRefund": true
      }
    ],
    "EligibleForRefund": true
  }
}

TicketDetailsResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	TicketInfo	false	none	TicketInfo

TicketInfo

{
  "TktNumber": "string",
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "TktIssueDate": "2019-03-18T11:42:49Z",
  "PlatingCarrier": "string",
  "Status": "string",
  "BAR": "string",
  "PAR": "string",
  "LastName": "string",
  "FirstName": "string",
  "TicketExpiryDate": "2019-03-18T11:42:49Z",
  "FOP": "string",
  "FopFare": "string",
  "FOPCurrency": "string",
  "PrintedCurrency": "string",
  "PrintedFare": "string",
  "CreditCardFOPAcct": "string",
  "OwningAgencyLocationID": "string",
  "IATA": "string",
  "Coupons": [
    {
      "TktNumber": "string",
      "Carrier": "string",
      "CouponSequenceNbr": 0,
      "FlightNbr": "string",
      "BoardPoint": "string",
      "OffPoint": "string",
      "FlightServiceClass": "string",
      "FlightDate": "2019-03-18T11:42:49Z",
      "FlightCouponStatus": "string",
      "DateLastChecked": "2019-03-18T11:42:49Z",
      "AirTktSegId": 0,
      "EligibleForRefund": true
    }
  ],
  "EligibleForRefund": true
}

TicketInfo

Properties

Name	Type	Required	Restrictions	Description
TktNumber	string	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
TktIssueDate	string(date-time)	false	none	none
PlatingCarrier	string	false	none	none
Status	string	false	none	none
BAR	string	false	none	none
PAR	string	false	none	none
LastName	string	false	none	none
FirstName	string	false	none	none
TicketExpiryDate	string(date-time)	false	none	none
FOP	string	false	none	none
FopFare	string	false	none	none
FOPCurrency	string	false	none	none
PrintedCurrency	string	false	none	none
PrintedFare	string	false	none	none
CreditCardFOPAcct	string	false	none	none
OwningAgencyLocationID	string	false	none	none
IATA	string	false	none	none
Coupons	[TicketInfoFlightCoupon]	false	none	[TicketInfoFlightCoupon]
EligibleForRefund	boolean	false	none	none

TicketInfoFlightCoupon

{
  "TktNumber": "string",
  "Carrier": "string",
  "CouponSequenceNbr": 0,
  "FlightNbr": "string",
  "BoardPoint": "string",
  "OffPoint": "string",
  "FlightServiceClass": "string",
  "FlightDate": "2019-03-18T11:42:49Z",
  "FlightCouponStatus": "string",
  "DateLastChecked": "2019-03-18T11:42:49Z",
  "AirTktSegId": 0,
  "EligibleForRefund": true
}

TicketInfoFlightCoupon

Properties

Name	Type	Required	Restrictions	Description
TktNumber	string	false	none	none
Carrier	string	false	none	none
CouponSequenceNbr	integer(int32)	false	none	none
FlightNbr	string	false	none	none
BoardPoint	string	false	none	none
OffPoint	string	false	none	none
FlightServiceClass	string	false	none	none
FlightDate	string(date-time)	false	none	none
FlightCouponStatus	string	false	none	none
DateLastChecked	string(date-time)	false	none	none
AirTktSegId	integer(int32)	false	none	none
EligibleForRefund	boolean	false	none	none

TicketingStatsRequestItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "TraditionalCount": 0,
      "OnlineCount": 0,
      "TotalCount": 0,
      "ChangesCount": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TicketingStatsRequestItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	TicketingStatsRequestResponseReport	false	none	TicketingStatsRequestResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

TicketingStatsRequestResponseReport

{
  "Item": {
    "TraditionalCount": 0,
    "OnlineCount": 0,
    "TotalCount": 0,
    "ChangesCount": 0
  }
}

TicketingStatsRequestResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	TicketingStats	false	none	TicketingStats

TicketingStats

{
  "TraditionalCount": 0,
  "OnlineCount": 0,
  "TotalCount": 0,
  "ChangesCount": 0
}

TicketingStats

Properties

Name	Type	Required	Restrictions	Description
TraditionalCount	integer(int32)	false	none	none
OnlineCount	integer(int32)	false	none	none
TotalCount	integer(int32)	false	none	none
ChangesCount	integer(int32)	false	none	none

TicketRevalidationsItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "RecordLocator": "string",
      "TicketNumber": "string",
      "IssuedDate": "2019-03-18T11:42:49Z",
      "Account": "string",
      "OwningConsultantID": "string",
      "CouponSequenceNbr": "string",
      "DepartureDate": "2019-03-18T11:42:49Z",
      "BoardPoint": "string",
      "OffPoint": "string",
      "CarrierCode": "string",
      "LastChangedDate": "2019-03-18T11:42:49Z"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TicketRevalidationsItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	TicketRevalidationsResponseReport	false	none	TicketRevalidationsResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

TicketRevalidationsResponseReport

{
  "Item": {
    "RecordLocator": "string",
    "TicketNumber": "string",
    "IssuedDate": "2019-03-18T11:42:49Z",
    "Account": "string",
    "OwningConsultantID": "string",
    "CouponSequenceNbr": "string",
    "DepartureDate": "2019-03-18T11:42:49Z",
    "BoardPoint": "string",
    "OffPoint": "string",
    "CarrierCode": "string",
    "LastChangedDate": "2019-03-18T11:42:49Z"
  }
}

TicketRevalidationsResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	TicketRevalidation	false	none	TicketRevalidation

TicketRevalidation

{
  "RecordLocator": "string",
  "TicketNumber": "string",
  "IssuedDate": "2019-03-18T11:42:49Z",
  "Account": "string",
  "OwningConsultantID": "string",
  "CouponSequenceNbr": "string",
  "DepartureDate": "2019-03-18T11:42:49Z",
  "BoardPoint": "string",
  "OffPoint": "string",
  "CarrierCode": "string",
  "LastChangedDate": "2019-03-18T11:42:49Z"
}

TicketRevalidation

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
TicketNumber	string	false	none	none
IssuedDate	string(date-time)	false	none	none
Account	string	false	none	none
OwningConsultantID	string	false	none	none
CouponSequenceNbr	string	false	none	none
DepartureDate	string(date-time)	false	none	none
BoardPoint	string	false	none	none
OffPoint	string	false	none	none
CarrierCode	string	false	none	none
LastChangedDate	string(date-time)	false	none	none

Departure

{
  "RecordLocator": "string",
  "PNRCreationDate": "string",
  "AgentivityRef": "string",
  "Account": "string",
  "OwningConsultant": "string",
  "PNRTicketed": "string",
  "TravelDate": "string",
  "TicketedStatus": "string",
  "PaxList": "string",
  "Routing": "string",
  "AirSegCount": "string",
  "CarSegCount": "string",
  "HtlSegCount": "string",
  "CarPSegCount": "string",
  "HtlPSegCount": "string",
  "TrainSegCount": "string",
  "OtherSegCount": "string"
}

Departure

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
PNRCreationDate	string	false	none	none
AgentivityRef	string	false	none	none
Account	string	false	none	none
OwningConsultant	string	false	none	none
PNRTicketed	string	false	none	none
TravelDate	string	false	none	none
TicketedStatus	string	false	none	none
PaxList	string	false	none	none
Routing	string	false	none	none
AirSegCount	string	false	none	none
CarSegCount	string	false	none	none
HtlSegCount	string	false	none	none
CarPSegCount	string	false	none	none
HtlPSegCount	string	false	none	none
TrainSegCount	string	false	none	none
OtherSegCount	string	false	none	none

AirSegmentsWithVendorLocatorsByUserResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "PNRCreationDate": "string",
      "AgentivityRef": "string",
      "Account": "string",
      "OwningConsultantID": "string",
      "OwningConsultant": "string",
      "OwningAgencyLocationID": "string",
      "PaxList": "string",
      "AirSegmentNbr": "string",
      "SegmentStatus": "string",
      "BoardPoint": "string",
      "OffPoint": "string",
      "DepartureDate": "string",
      "DepartureTime": "string",
      "ArrivalTime": "string",
      "ChangeOfDay": "string",
      "CarrierCode": "string",
      "FlightNbr": "string",
      "BookingCode": "string",
      "PNRTicketed": "string",
      "VendorLocator": "string",
      "CheckInURL": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AirSegmentsWithVendorLocatorsByUserResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[AirSegmentWithVendorLocators]	false	none	[AirSegmentWithVendorLocators]
ResponseError	AgentivityError	false	none	AgentivityError

AirSegmentWithVendorLocators

{
  "RecordLocator": "string",
  "PNRCreationDate": "string",
  "AgentivityRef": "string",
  "Account": "string",
  "OwningConsultantID": "string",
  "OwningConsultant": "string",
  "OwningAgencyLocationID": "string",
  "PaxList": "string",
  "AirSegmentNbr": "string",
  "SegmentStatus": "string",
  "BoardPoint": "string",
  "OffPoint": "string",
  "DepartureDate": "string",
  "DepartureTime": "string",
  "ArrivalTime": "string",
  "ChangeOfDay": "string",
  "CarrierCode": "string",
  "FlightNbr": "string",
  "BookingCode": "string",
  "PNRTicketed": "string",
  "VendorLocator": "string",
  "CheckInURL": "string"
}

AirSegmentWithVendorLocators

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
PNRCreationDate	string	false	none	none
AgentivityRef	string	false	none	none
Account	string	false	none	none
OwningConsultantID	string	false	none	none
OwningConsultant	string	false	none	none
OwningAgencyLocationID	string	false	none	none
PaxList	string	false	none	none
AirSegmentNbr	string	false	none	none
SegmentStatus	string	false	none	none
BoardPoint	string	false	none	none
OffPoint	string	false	none	none
DepartureDate	string	false	none	none
DepartureTime	string	false	none	none
ArrivalTime	string	false	none	none
ChangeOfDay	string	false	none	none
CarrierCode	string	false	none	none
FlightNbr	string	false	none	none
BookingCode	string	false	none	none
PNRTicketed	string	false	none	none
VendorLocator	string	false	none	none
CheckInURL	string	false	none	none

BookingWithMergedSegments

{
  "AgentivityRef": "string",
  "RecordLocator": "string",
  "PNRCreationDate": "string",
  "TravelDate": "string",
  "PNRTicketed": "string",
  "PNRCancelled": "string",
  "Account": "string",
  "OwningConsultantID": "string",
  "OwningConsultant": "string",
  "LastActionConsultantID": "string",
  "PaxList": "string",
  "SegmentType": "string",
  "IsPassiveSegment": "string",
  "SegmentNumber": "string",
  "SegmentStatus": "string",
  "StartDate": "string",
  "StartTime": "string",
  "EndDate": "string",
  "EndTime": "string",
  "StartPoint": "string",
  "EndPoint": "string",
  "OperatorCode": "string",
  "ServiceCode": "string",
  "ConfirmationNumber": "string",
  "OperatingCarrierCode": "string",
  "OperatingCarrierName": "string"
}

BookingWithMergedSegments

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	string	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string	false	none	none
TravelDate	string	false	none	none
PNRTicketed	string	false	none	none
PNRCancelled	string	false	none	none
Account	string	false	none	none
OwningConsultantID	string	false	none	none
OwningConsultant	string	false	none	none
LastActionConsultantID	string	false	none	none
PaxList	string	false	none	none
SegmentType	string	false	none	none
IsPassiveSegment	string	false	none	none
SegmentNumber	string	false	none	none
SegmentStatus	string	false	none	none
StartDate	string	false	none	none
StartTime	string	false	none	none
EndDate	string	false	none	none
EndTime	string	false	none	none
StartPoint	string	false	none	none
EndPoint	string	false	none	none
OperatorCode	string	false	none	none
ServiceCode	string	false	none	none
ConfirmationNumber	string	false	none	none
OperatingCarrierCode	string	false	none	none
OperatingCarrierName	string	false	none	none

TicketsIssuedByNumber

{
  "RecordLocator": "string",
  "TktNumber": "string",
  "PlatingCarrier": "string",
  "Passenger": "string",
  "IATA": "string",
  "OwningAgencyLocationID": "string",
  "IssueDate": "2019-03-18T11:42:49Z",
  "ExpirationDate": "2019-03-18T11:42:49Z",
  "FOPFare": "string",
  "PrintedCurrency": "string"
}

TicketsIssuedByNumber

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
TktNumber	string	false	none	none
PlatingCarrier	string	false	none	none
Passenger	string	false	none	none
IATA	string	false	none	none
OwningAgencyLocationID	string	false	none	none
IssueDate	string(date-time)	false	none	none
ExpirationDate	string(date-time)	false	none	none
FOPFare	string	false	none	none
PrintedCurrency	string	false	none	none

TicketsIssuedResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "TktNumber": "string",
      "FOP": "string",
      "Passenger": "string",
      "Consultant": "string",
      "RemarkText": "string",
      "AirlineCode": "string",
      "TravAgntID": "string",
      "PCC": "string",
      "PrintedCurrency": "string",
      "FOPFare": "string",
      "Date": "2019-03-18T11:42:49Z",
      "DueDate": "2019-03-18T11:42:49Z"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TicketsIssuedResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[TicketsIssued]	false	none	[TicketsIssued]
ResponseError	AgentivityError	false	none	AgentivityError

TicketsIssued

{
  "RecordLocator": "string",
  "TktNumber": "string",
  "FOP": "string",
  "Passenger": "string",
  "Consultant": "string",
  "RemarkText": "string",
  "AirlineCode": "string",
  "TravAgntID": "string",
  "PCC": "string",
  "PrintedCurrency": "string",
  "FOPFare": "string",
  "Date": "2019-03-18T11:42:49Z",
  "DueDate": "2019-03-18T11:42:49Z"
}

TicketsIssued

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
TktNumber	string	false	none	none
FOP	string	false	none	none
Passenger	string	false	none	none
Consultant	string	false	none	none
RemarkText	string	false	none	none
AirlineCode	string	false	none	none
TravAgntID	string	false	none	none
PCC	string	false	none	none
PrintedCurrency	string	false	none	none
FOPFare	string	false	none	none
Date	string(date-time)	false	none	none
DueDate	string(date-time)	false	none	none

TicketSegmentsWithTaxByIssueDateResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "Recordlocator": "string",
      "PNRCreationDate": "string",
      "TicketNumber": "string",
      "Account": "string",
      "PrimaryPassenger": "string",
      "VndIssueDate": "string",
      "TravelAgentID": "string",
      "FOPFare": "string",
      "FOP": "string",
      "TotalTax": "string",
      "Tax1Code": "string",
      "Tax1Amt": "string",
      "Tax2Code": "string",
      "Tax2Amt": "string",
      "Tax3Code": "string",
      "Tax3Amt": "string",
      "Tax4Code": "string",
      "Tax4Amt": "string",
      "Tax5Code": "string",
      "Tax5Amt": "string",
      "ExchangedForTicket": "string",
      "CouponSequenceNbr": "string",
      "Carrier": "string",
      "BoardPoint": "string",
      "OffPoint": "string",
      "FlightDate": "string",
      "FlightServiceClass": "string",
      "FareBasis": "string",
      "FlightCouponStatus": "string",
      "DateLastChecked": "string",
      "OwningAgencyLocationID": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TicketSegmentsWithTaxByIssueDateResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[TicketSegmentsWithTax]	false	none	[TicketSegmentsWithTax]
ResponseError	AgentivityError	false	none	AgentivityError

TicketSegmentsWithTax

{
  "Recordlocator": "string",
  "PNRCreationDate": "string",
  "TicketNumber": "string",
  "Account": "string",
  "PrimaryPassenger": "string",
  "VndIssueDate": "string",
  "TravelAgentID": "string",
  "FOPFare": "string",
  "FOP": "string",
  "TotalTax": "string",
  "Tax1Code": "string",
  "Tax1Amt": "string",
  "Tax2Code": "string",
  "Tax2Amt": "string",
  "Tax3Code": "string",
  "Tax3Amt": "string",
  "Tax4Code": "string",
  "Tax4Amt": "string",
  "Tax5Code": "string",
  "Tax5Amt": "string",
  "ExchangedForTicket": "string",
  "CouponSequenceNbr": "string",
  "Carrier": "string",
  "BoardPoint": "string",
  "OffPoint": "string",
  "FlightDate": "string",
  "FlightServiceClass": "string",
  "FareBasis": "string",
  "FlightCouponStatus": "string",
  "DateLastChecked": "string",
  "OwningAgencyLocationID": "string"
}

TicketSegmentsWithTax

Properties

Name	Type	Required	Restrictions	Description
Recordlocator	string	false	none	none
PNRCreationDate	string	false	none	none
TicketNumber	string	false	none	none
Account	string	false	none	none
PrimaryPassenger	string	false	none	none
VndIssueDate	string	false	none	none
TravelAgentID	string	false	none	none
FOPFare	string	false	none	none
FOP	string	false	none	none
TotalTax	string	false	none	none
Tax1Code	string	false	none	none
Tax1Amt	string	false	none	none
Tax2Code	string	false	none	none
Tax2Amt	string	false	none	none
Tax3Code	string	false	none	none
Tax3Amt	string	false	none	none
Tax4Code	string	false	none	none
Tax4Amt	string	false	none	none
Tax5Code	string	false	none	none
Tax5Amt	string	false	none	none
ExchangedForTicket	string	false	none	none
CouponSequenceNbr	string	false	none	none
Carrier	string	false	none	none
BoardPoint	string	false	none	none
OffPoint	string	false	none	none
FlightDate	string	false	none	none
FlightServiceClass	string	false	none	none
FareBasis	string	false	none	none
FlightCouponStatus	string	false	none	none
DateLastChecked	string	false	none	none
OwningAgencyLocationID	string	false	none	none

TicketsByAccountItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": 0,
      "RecordLocator": "string",
      "PNRCreationDate": "2019-03-18T11:42:49Z",
      "Account": "string",
      "IssueDate": "2019-03-18T11:42:49Z",
      "TicketNumber": "string",
      "PrimaryPassenger": "string",
      "PlatingCarrier": "string",
      "IATA": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TicketsByAccountItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	TicketsByAccountResponseReport	false	none	TicketsByAccountResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

TicketsByAccountResponseReport

{
  "Item": {
    "AgentivityRef": 0,
    "RecordLocator": "string",
    "PNRCreationDate": "2019-03-18T11:42:49Z",
    "Account": "string",
    "IssueDate": "2019-03-18T11:42:49Z",
    "TicketNumber": "string",
    "PrimaryPassenger": "string",
    "PlatingCarrier": "string",
    "IATA": "string"
  }
}

TicketsByAccountResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	TicketByAccount	false	none	TicketByAccount

TicketByAccount

{
  "AgentivityRef": 0,
  "RecordLocator": "string",
  "PNRCreationDate": "2019-03-18T11:42:49Z",
  "Account": "string",
  "IssueDate": "2019-03-18T11:42:49Z",
  "TicketNumber": "string",
  "PrimaryPassenger": "string",
  "PlatingCarrier": "string",
  "IATA": "string"
}

TicketByAccount

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	integer(int32)	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string(date-time)	false	none	none
Account	string	false	none	none
IssueDate	string(date-time)	false	none	none
TicketNumber	string	false	none	none
PrimaryPassenger	string	false	none	none
PlatingCarrier	string	false	none	none
IATA	string	false	none	none

TicketTrackingFailuresByUserItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "AgentivityRef": "string",
      "RecordLocator": "string",
      "PrimaryPax": "string",
      "LastActionAgencyLocationID": "string",
      "OwningAgencyLocationID": "string",
      "Message": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TicketTrackingFailuresByUserItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	TicketTrackingFailuresByUserResponseReport	false	none	TicketTrackingFailuresByUserResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

TicketTrackingFailuresByUserResponseReport

{
  "Item": {
    "AgentivityRef": "string",
    "RecordLocator": "string",
    "PrimaryPax": "string",
    "LastActionAgencyLocationID": "string",
    "OwningAgencyLocationID": "string",
    "Message": "string"
  }
}

TicketTrackingFailuresByUserResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	TicketTrackingFailure	false	none	TicketTrackingFailure

TicketTrackingFailure

{
  "AgentivityRef": "string",
  "RecordLocator": "string",
  "PrimaryPax": "string",
  "LastActionAgencyLocationID": "string",
  "OwningAgencyLocationID": "string",
  "Message": "string"
}

TicketTrackingFailure

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	string	false	none	none
RecordLocator	string	false	none	none
PrimaryPax	string	false	none	none
LastActionAgencyLocationID	string	false	none	none
OwningAgencyLocationID	string	false	none	none
Message	string	false	none	none

PassengerBookingCount

{
  "LastName": "string",
  "FirstName": "string",
  "Account": "string",
  "TotalBookings": 0
}

PassengerBookingCount

Properties

Name	Type	Required	Restrictions	Description
LastName	string	false	none	none
FirstName	string	false	none	none
Account	string	false	none	none
TotalBookings	integer(int32)	false	none	none

CorporateAccountTicketingActivityPerDayByUserItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "RecordLocator": "string",
      "OwningAgencyPseudo": "string",
      "Account": "string",
      "TicketNumber": "string",
      "TourCode": "string",
      "PrimaryPax": "string",
      "FOPFare": "string",
      "FareBasis": "string",
      "Taxes": "string",
      "IATA": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

CorporateAccountTicketingActivityPerDayByUserItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	CorporateAccountTicketingActivityPerDaybyUserResponseReport	false	none	CorporateAccountTicketingActivityPerDaybyUserResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

CorporateAccountTicketingActivityPerDaybyUserResponseReport

{
  "Item": {
    "RecordLocator": "string",
    "OwningAgencyPseudo": "string",
    "Account": "string",
    "TicketNumber": "string",
    "TourCode": "string",
    "PrimaryPax": "string",
    "FOPFare": "string",
    "FareBasis": "string",
    "Taxes": "string",
    "IATA": "string"
  }
}

CorporateAccountTicketingActivityPerDaybyUserResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	CorporateAccountTicketingActivityPerDay	false	none	CorporateAccountTicketingActivityPerDay

CorporateAccountTicketingActivityPerDay

{
  "RecordLocator": "string",
  "OwningAgencyPseudo": "string",
  "Account": "string",
  "TicketNumber": "string",
  "TourCode": "string",
  "PrimaryPax": "string",
  "FOPFare": "string",
  "FareBasis": "string",
  "Taxes": "string",
  "IATA": "string"
}

CorporateAccountTicketingActivityPerDay

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
OwningAgencyPseudo	string	false	none	none
Account	string	false	none	none
TicketNumber	string	false	none	none
TourCode	string	false	none	none
PrimaryPax	string	false	none	none
FOPFare	string	false	none	none
FareBasis	string	false	none	none
Taxes	string	false	none	none
IATA	string	false	none	none

AirlineDemandsForTicketingByUserItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "RecordLocator": "string",
      "PrimaryPax": "string",
      "TransactionAgent": "string",
      "Account": "string",
      "AirlineCode": "string",
      "DueTime": "string",
      "AgentivityRef": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

AirlineDemandsForTicketingByUserItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	AirlineDemandsForTicketingbyUserResponseReport	false	none	AirlineDemandsForTicketingbyUserResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

AirlineDemandsForTicketingbyUserResponseReport

{
  "Item": {
    "RecordLocator": "string",
    "PrimaryPax": "string",
    "TransactionAgent": "string",
    "Account": "string",
    "AirlineCode": "string",
    "DueTime": "string",
    "AgentivityRef": 0
  }
}

AirlineDemandsForTicketingbyUserResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	AirlineDemandsForTicketing	false	none	AirlineDemandsForTicketing

AirlineDemandsForTicketing

{
  "RecordLocator": "string",
  "PrimaryPax": "string",
  "TransactionAgent": "string",
  "Account": "string",
  "AirlineCode": "string",
  "DueTime": "string",
  "AgentivityRef": 0
}

AirlineDemandsForTicketing

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
PrimaryPax	string	false	none	none
TransactionAgent	string	false	none	none
Account	string	false	none	none
AirlineCode	string	false	none	none
DueTime	string	false	none	none
AgentivityRef	integer(int32)	false	none	none

BookingsWithDestinationsByTravellerResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "AgentivityRef": "string",
      "PNR": "string",
      "PNRCreationDate": "string",
      "RecordLocator": "string",
      "TravelDate": "string",
      "PNRTicketed": "string",
      "PNRCancelled": "string",
      "Account": "string",
      "OwningConsultantID": "string",
      "OwningConsultant": "string",
      "LastActionConsultantID": "string",
      "DestinationCities": "string",
      "DestinationCountries": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingsWithDestinationsByTravellerResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[BookingWithDestinationsOLD2]	false	none	[BookingWithDestinationsOLD2]
ResponseError	AgentivityError	false	none	AgentivityError

BookingWithDestinationsOLD2

{
  "AgentivityRef": "string",
  "PNR": "string",
  "PNRCreationDate": "string",
  "RecordLocator": "string",
  "TravelDate": "string",
  "PNRTicketed": "string",
  "PNRCancelled": "string",
  "Account": "string",
  "OwningConsultantID": "string",
  "OwningConsultant": "string",
  "LastActionConsultantID": "string",
  "DestinationCities": "string",
  "DestinationCountries": "string"
}

BookingWithDestinationsOLD2

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	string	false	none	none
PNR	string	false	none	none
PNRCreationDate	string	false	none	none
RecordLocator	string	false	none	none
TravelDate	string	false	none	none
PNRTicketed	string	false	none	none
PNRCancelled	string	false	none	none
Account	string	false	none	none
OwningConsultantID	string	false	none	none
OwningConsultant	string	false	none	none
LastActionConsultantID	string	false	none	none
DestinationCities	string	false	none	none
DestinationCountries	string	false	none	none

SegmentsByPNRResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "PNRSummary": {
      "RecordLocator": "string",
      "AirlineReferences": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "Vendor": "string",
          "VendorLocator": "string"
        }
      },
      "Tickets": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "TktNumber": "string",
          "Passenger": {
            "LastName": "string",
            "FirstName": "string"
          },
          "Coupons": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "CouponSequenceNbr": "string",
              "CouponBoardPoint": "string",
              "CouponOffPoint": "string",
              "Carrier": "string",
              "FlightNbr": "string",
              "FlightDate": "string",
              "FlightTime": "string"
            }
          }
        }
      }
    },
    "Segments": {
      "AirSegments": [
        {
          "AirSegmentNbr": 0,
          "ArrivalTime": "string",
          "BoardPoint": "string",
          "BookingCode": "string",
          "CarrierCode": "string",
          "ChangeOfDay": "string",
          "ConnectionIndicator": "string",
          "DepartureDate": "string",
          "DepartureTime": "string",
          "FlightNbr": "string",
          "JourneyTime": "string",
          "NbrSeats": 0,
          "OffPoint": "string",
          "OperatingCarrierCode": "string",
          "OperatingCarrierName": "string",
          "SeatingData": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "SeatLocation": "string",
              "SeatStatusCode": "string"
            }
          },
          "SegmentStatus": "string"
        }
      ],
      "CarSegments": [
        {
          "AirportCode": "string",
          "CarAddress": "string",
          "CarLocationCategory": "string",
          "CarRateCode": "string",
          "CarRateType": "string",
          "CarSegmentNbr": 0,
          "CarType": "string",
          "CarVendorCode": "string",
          "CarYieldManagementNbr": "string",
          "ConfirmationNbr": "string",
          "CurrencyCode": "string",
          "DistanceAllowance": "string",
          "DistanceRateAmount": "string",
          "DropOffDate": "string",
          "DropOffTime": "string",
          "MilesKilometerIndicator": "string",
          "NbrOfCars": 0,
          "PickUpDate": "string",
          "PickUpTime": "string",
          "RateAmount": "string",
          "RateGuaranteeIndicator": "string",
          "SegmentStatus": "string"
        }
      ],
      "HotelSegments": [
        {
          "HotelSegmentNbr": "string",
          "StatusCode": "string",
          "ArrivalDate": "string",
          "DepartureDate": "string",
          "PropertyName": "string",
          "ChainCode": "string",
          "ChainName": "string",
          "CityCode": "string",
          "CityName": "string",
          "CountryCode": "string",
          "CountryName": "string",
          "Passenger": "string",
          "Account": "string",
          "ConfirmationNbr": "string",
          "Currency": "string",
          "Rate": "string",
          "RoomBookingCode": "string",
          "NbrNights": 0,
          "MultiLevelRateCode": "string",
          "NbrRooms": 0,
          "BookedInName": "string",
          "ServiceInformation": "string",
          "PropertyCityCode": "string",
          "SegmentStatus": "string",
          "HotelVendorCode": "string"
        }
      ],
      "PassiveSegments": [
        {
          "Address": "string",
          "BookingReasonCode": "string",
          "BookingSource": "string",
          "CityCode": "string",
          "CommissionInformation": "string",
          "ConfirmationNumber": "string",
          "DepartureDate": "string",
          "NbrNights": "string",
          "Passenger": "string",
          "PropertyName": "string",
          "PropertyNumber": "string",
          "RateAccessCode": "string",
          "RateCode": "string",
          "RateQuoted": "string",
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceInformation": "string",
          "StartDate": "string",
          "Text": "string",
          "VendorCode": "string"
        }
      ]
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

SegmentsByPNRResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	Report	false	none	Report
ResponseError	AgentivityError	false	none	AgentivityError

Report

{
  "PNRSummary": {
    "RecordLocator": "string",
    "AirlineReferences": {
      "Capacity": 0,
      "Count": 0,
      "Item": {
        "Vendor": "string",
        "VendorLocator": "string"
      }
    },
    "Tickets": {
      "Capacity": 0,
      "Count": 0,
      "Item": {
        "TktNumber": "string",
        "Passenger": {
          "LastName": "string",
          "FirstName": "string"
        },
        "Coupons": {
          "Capacity": 0,
          "Count": 0,
          "Item": {
            "CouponSequenceNbr": "string",
            "CouponBoardPoint": "string",
            "CouponOffPoint": "string",
            "Carrier": "string",
            "FlightNbr": "string",
            "FlightDate": "string",
            "FlightTime": "string"
          }
        }
      }
    }
  },
  "Segments": {
    "AirSegments": [
      {
        "AirSegmentNbr": 0,
        "ArrivalTime": "string",
        "BoardPoint": "string",
        "BookingCode": "string",
        "CarrierCode": "string",
        "ChangeOfDay": "string",
        "ConnectionIndicator": "string",
        "DepartureDate": "string",
        "DepartureTime": "string",
        "FlightNbr": "string",
        "JourneyTime": "string",
        "NbrSeats": 0,
        "OffPoint": "string",
        "OperatingCarrierCode": "string",
        "OperatingCarrierName": "string",
        "SeatingData": {
          "Capacity": 0,
          "Count": 0,
          "Item": {
            "SeatLocation": "string",
            "SeatStatusCode": "string"
          }
        },
        "SegmentStatus": "string"
      }
    ],
    "CarSegments": [
      {
        "AirportCode": "string",
        "CarAddress": "string",
        "CarLocationCategory": "string",
        "CarRateCode": "string",
        "CarRateType": "string",
        "CarSegmentNbr": 0,
        "CarType": "string",
        "CarVendorCode": "string",
        "CarYieldManagementNbr": "string",
        "ConfirmationNbr": "string",
        "CurrencyCode": "string",
        "DistanceAllowance": "string",
        "DistanceRateAmount": "string",
        "DropOffDate": "string",
        "DropOffTime": "string",
        "MilesKilometerIndicator": "string",
        "NbrOfCars": 0,
        "PickUpDate": "string",
        "PickUpTime": "string",
        "RateAmount": "string",
        "RateGuaranteeIndicator": "string",
        "SegmentStatus": "string"
      }
    ],
    "HotelSegments": [
      {
        "HotelSegmentNbr": "string",
        "StatusCode": "string",
        "ArrivalDate": "string",
        "DepartureDate": "string",
        "PropertyName": "string",
        "ChainCode": "string",
        "ChainName": "string",
        "CityCode": "string",
        "CityName": "string",
        "CountryCode": "string",
        "CountryName": "string",
        "Passenger": "string",
        "Account": "string",
        "ConfirmationNbr": "string",
        "Currency": "string",
        "Rate": "string",
        "RoomBookingCode": "string",
        "NbrNights": 0,
        "MultiLevelRateCode": "string",
        "NbrRooms": 0,
        "BookedInName": "string",
        "ServiceInformation": "string",
        "PropertyCityCode": "string",
        "SegmentStatus": "string",
        "HotelVendorCode": "string"
      }
    ],
    "PassiveSegments": [
      {
        "Address": "string",
        "BookingReasonCode": "string",
        "BookingSource": "string",
        "CityCode": "string",
        "CommissionInformation": "string",
        "ConfirmationNumber": "string",
        "DepartureDate": "string",
        "NbrNights": "string",
        "Passenger": "string",
        "PropertyName": "string",
        "PropertyNumber": "string",
        "RateAccessCode": "string",
        "RateCode": "string",
        "RateQuoted": "string",
        "SegmentStatus": "string",
        "SegmentType": "string",
        "ServiceInformation": "string",
        "StartDate": "string",
        "Text": "string",
        "VendorCode": "string"
      }
    ]
  }
}

Report

Properties

Name	Type	Required	Restrictions	Description
PNRSummary	PNRSummary	false	none	PNRSummary
Segments	Segments	false	none	Segments

PNRSummary

{
  "RecordLocator": "string",
  "AirlineReferences": {
    "Capacity": 0,
    "Count": 0,
    "Item": {
      "Vendor": "string",
      "VendorLocator": "string"
    }
  },
  "Tickets": {
    "Capacity": 0,
    "Count": 0,
    "Item": {
      "TktNumber": "string",
      "Passenger": {
        "LastName": "string",
        "FirstName": "string"
      },
      "Coupons": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "CouponSequenceNbr": "string",
          "CouponBoardPoint": "string",
          "CouponOffPoint": "string",
          "Carrier": "string",
          "FlightNbr": "string",
          "FlightDate": "string",
          "FlightTime": "string"
        }
      }
    }
  }
}

PNRSummary

Properties

Name	Type	Required	Restrictions	Description
RecordLocator	string	false	none	none
AirlineReferences	AirlineReferences	false	none	AirlineReferences
Tickets	PNRSummaryTickets	false	none	PNRSummaryTickets

AirlineReferences

{
  "Capacity": 0,
  "Count": 0,
  "Item": {
    "Vendor": "string",
    "VendorLocator": "string"
  }
}

AirlineReferences

Properties

Name	Type	Required	Restrictions	Description
Capacity	integer(int32)	false	none	none
Count	integer(int32)	false	none	none
Item	HostSystem	false	none	HostSystem

HostSystem

{
  "Vendor": "string",
  "VendorLocator": "string"
}

HostSystem

Properties

Name	Type	Required	Restrictions	Description
Vendor	string	false	none	none
VendorLocator	string	false	none	none

PNRSummaryTickets

{
  "Capacity": 0,
  "Count": 0,
  "Item": {
    "TktNumber": "string",
    "Passenger": {
      "LastName": "string",
      "FirstName": "string"
    },
    "Coupons": {
      "Capacity": 0,
      "Count": 0,
      "Item": {
        "CouponSequenceNbr": "string",
        "CouponBoardPoint": "string",
        "CouponOffPoint": "string",
        "Carrier": "string",
        "FlightNbr": "string",
        "FlightDate": "string",
        "FlightTime": "string"
      }
    }
  }
}

PNRSummaryTickets

Properties

Name	Type	Required	Restrictions	Description
Capacity	integer(int32)	false	none	none
Count	integer(int32)	false	none	none
Item	PNRSummaryTicket	false	none	PNRSummaryTicket

PNRSummaryTicket

{
  "TktNumber": "string",
  "Passenger": {
    "LastName": "string",
    "FirstName": "string"
  },
  "Coupons": {
    "Capacity": 0,
    "Count": 0,
    "Item": {
      "CouponSequenceNbr": "string",
      "CouponBoardPoint": "string",
      "CouponOffPoint": "string",
      "Carrier": "string",
      "FlightNbr": "string",
      "FlightDate": "string",
      "FlightTime": "string"
    }
  }
}

PNRSummaryTicket

Properties

Name	Type	Required	Restrictions	Description
TktNumber	string	false	none	none
Passenger	PassengerName	false	none	PassengerName
Coupons	Coupons	false	none	Coupons

PassengerName

{
  "LastName": "string",
  "FirstName": "string"
}

PassengerName

Properties

Name	Type	Required	Restrictions	Description
LastName	string	false	none	none
FirstName	string	false	none	none

Coupons

{
  "Capacity": 0,
  "Count": 0,
  "Item": {
    "CouponSequenceNbr": "string",
    "CouponBoardPoint": "string",
    "CouponOffPoint": "string",
    "Carrier": "string",
    "FlightNbr": "string",
    "FlightDate": "string",
    "FlightTime": "string"
  }
}

Coupons

Properties

Name	Type	Required	Restrictions	Description
Capacity	integer(int32)	false	none	none
Count	integer(int32)	false	none	none
Item	Coupon	false	none	Coupon

Coupon

{
  "CouponSequenceNbr": "string",
  "CouponBoardPoint": "string",
  "CouponOffPoint": "string",
  "Carrier": "string",
  "FlightNbr": "string",
  "FlightDate": "string",
  "FlightTime": "string"
}

Coupon

Properties

Name	Type	Required	Restrictions	Description
CouponSequenceNbr	string	false	none	none
CouponBoardPoint	string	false	none	none
CouponOffPoint	string	false	none	none
Carrier	string	false	none	none
FlightNbr	string	false	none	none
FlightDate	string	false	none	none
FlightTime	string	false	none	none

Segments

{
  "AirSegments": [
    {
      "AirSegmentNbr": 0,
      "ArrivalTime": "string",
      "BoardPoint": "string",
      "BookingCode": "string",
      "CarrierCode": "string",
      "ChangeOfDay": "string",
      "ConnectionIndicator": "string",
      "DepartureDate": "string",
      "DepartureTime": "string",
      "FlightNbr": "string",
      "JourneyTime": "string",
      "NbrSeats": 0,
      "OffPoint": "string",
      "OperatingCarrierCode": "string",
      "OperatingCarrierName": "string",
      "SeatingData": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "SeatLocation": "string",
          "SeatStatusCode": "string"
        }
      },
      "SegmentStatus": "string"
    }
  ],
  "CarSegments": [
    {
      "AirportCode": "string",
      "CarAddress": "string",
      "CarLocationCategory": "string",
      "CarRateCode": "string",
      "CarRateType": "string",
      "CarSegmentNbr": 0,
      "CarType": "string",
      "CarVendorCode": "string",
      "CarYieldManagementNbr": "string",
      "ConfirmationNbr": "string",
      "CurrencyCode": "string",
      "DistanceAllowance": "string",
      "DistanceRateAmount": "string",
      "DropOffDate": "string",
      "DropOffTime": "string",
      "MilesKilometerIndicator": "string",
      "NbrOfCars": 0,
      "PickUpDate": "string",
      "PickUpTime": "string",
      "RateAmount": "string",
      "RateGuaranteeIndicator": "string",
      "SegmentStatus": "string"
    }
  ],
  "HotelSegments": [
    {
      "HotelSegmentNbr": "string",
      "StatusCode": "string",
      "ArrivalDate": "string",
      "DepartureDate": "string",
      "PropertyName": "string",
      "ChainCode": "string",
      "ChainName": "string",
      "CityCode": "string",
      "CityName": "string",
      "CountryCode": "string",
      "CountryName": "string",
      "Passenger": "string",
      "Account": "string",
      "ConfirmationNbr": "string",
      "Currency": "string",
      "Rate": "string",
      "RoomBookingCode": "string",
      "NbrNights": 0,
      "MultiLevelRateCode": "string",
      "NbrRooms": 0,
      "BookedInName": "string",
      "ServiceInformation": "string",
      "PropertyCityCode": "string",
      "SegmentStatus": "string",
      "HotelVendorCode": "string"
    }
  ],
  "PassiveSegments": [
    {
      "Address": "string",
      "BookingReasonCode": "string",
      "BookingSource": "string",
      "CityCode": "string",
      "CommissionInformation": "string",
      "ConfirmationNumber": "string",
      "DepartureDate": "string",
      "NbrNights": "string",
      "Passenger": "string",
      "PropertyName": "string",
      "PropertyNumber": "string",
      "RateAccessCode": "string",
      "RateCode": "string",
      "RateQuoted": "string",
      "SegmentStatus": "string",
      "SegmentType": "string",
      "ServiceInformation": "string",
      "StartDate": "string",
      "Text": "string",
      "VendorCode": "string"
    }
  ]
}

Segments

Properties

Name	Type	Required	Restrictions	Description
AirSegments	[AirSegment]	false	none	[AirSegment]
CarSegments	[CarSegment]	false	none	[CarSegment]
HotelSegments	[HotelSegment]	false	none	[HotelSegment]
PassiveSegments	[PassiveSegment]	false	none	[PassiveSegment]

AirSegment

{
  "AirSegmentNbr": 0,
  "ArrivalTime": "string",
  "BoardPoint": "string",
  "BookingCode": "string",
  "CarrierCode": "string",
  "ChangeOfDay": "string",
  "ConnectionIndicator": "string",
  "DepartureDate": "string",
  "DepartureTime": "string",
  "FlightNbr": "string",
  "JourneyTime": "string",
  "NbrSeats": 0,
  "OffPoint": "string",
  "OperatingCarrierCode": "string",
  "OperatingCarrierName": "string",
  "SeatingData": {
    "Capacity": 0,
    "Count": 0,
    "Item": {
      "SeatLocation": "string",
      "SeatStatusCode": "string"
    }
  },
  "SegmentStatus": "string"
}

AirSegment

Properties

Name	Type	Required	Restrictions	Description
AirSegmentNbr	integer(int32)	false	none	none
ArrivalTime	string	false	none	none
BoardPoint	string	false	none	none
BookingCode	string	false	none	none
CarrierCode	string	false	none	none
ChangeOfDay	string	false	none	none
ConnectionIndicator	string	false	none	none
DepartureDate	string	false	none	none
DepartureTime	string	false	none	none
FlightNbr	string	false	none	none
JourneyTime	string	false	none	none
NbrSeats	integer(int32)	false	none	none
OffPoint	string	false	none	none
OperatingCarrierCode	string	false	none	none
OperatingCarrierName	string	false	none	none
SeatingData	SeatingData	false	none	SeatingData
SegmentStatus	string	false	none	none

SeatingData

{
  "Capacity": 0,
  "Count": 0,
  "Item": {
    "SeatLocation": "string",
    "SeatStatusCode": "string"
  }
}

SeatingData

Properties

Name	Type	Required	Restrictions	Description
Capacity	integer(int32)	false	none	none
Count	integer(int32)	false	none	none
Item	Seat	false	none	Seat

Seat

{
  "SeatLocation": "string",
  "SeatStatusCode": "string"
}

Seat

Properties

Name	Type	Required	Restrictions	Description
SeatLocation	string	false	none	none
SeatStatusCode	string	false	none	none

CarSegment

{
  "AirportCode": "string",
  "CarAddress": "string",
  "CarLocationCategory": "string",
  "CarRateCode": "string",
  "CarRateType": "string",
  "CarSegmentNbr": 0,
  "CarType": "string",
  "CarVendorCode": "string",
  "CarYieldManagementNbr": "string",
  "ConfirmationNbr": "string",
  "CurrencyCode": "string",
  "DistanceAllowance": "string",
  "DistanceRateAmount": "string",
  "DropOffDate": "string",
  "DropOffTime": "string",
  "MilesKilometerIndicator": "string",
  "NbrOfCars": 0,
  "PickUpDate": "string",
  "PickUpTime": "string",
  "RateAmount": "string",
  "RateGuaranteeIndicator": "string",
  "SegmentStatus": "string"
}

CarSegment

Properties

Name	Type	Required	Restrictions	Description
AirportCode	string	false	none	none
CarAddress	string	false	none	none
CarLocationCategory	string	false	none	none
CarRateCode	string	false	none	none
CarRateType	string	false	none	none
CarSegmentNbr	integer(int32)	false	none	none
CarType	string	false	none	none
CarVendorCode	string	false	none	none
CarYieldManagementNbr	string	false	none	none
ConfirmationNbr	string	false	none	none
CurrencyCode	string	false	none	none
DistanceAllowance	string	false	none	none
DistanceRateAmount	string	false	none	none
DropOffDate	string	false	none	none
DropOffTime	string	false	none	none
MilesKilometerIndicator	string	false	none	none
NbrOfCars	integer(int32)	false	none	none
PickUpDate	string	false	none	none
PickUpTime	string	false	none	none
RateAmount	string	false	none	none
RateGuaranteeIndicator	string	false	none	none
SegmentStatus	string	false	none	none

HotelSegment

{
  "HotelSegmentNbr": "string",
  "StatusCode": "string",
  "ArrivalDate": "string",
  "DepartureDate": "string",
  "PropertyName": "string",
  "ChainCode": "string",
  "ChainName": "string",
  "CityCode": "string",
  "CityName": "string",
  "CountryCode": "string",
  "CountryName": "string",
  "Passenger": "string",
  "Account": "string",
  "ConfirmationNbr": "string",
  "Currency": "string",
  "Rate": "string",
  "RoomBookingCode": "string",
  "NbrNights": 0,
  "MultiLevelRateCode": "string",
  "NbrRooms": 0,
  "BookedInName": "string",
  "ServiceInformation": "string",
  "PropertyCityCode": "string",
  "SegmentStatus": "string",
  "HotelVendorCode": "string"
}

HotelSegment

Properties

Name	Type	Required	Restrictions	Description
HotelSegmentNbr	string	false	none	none
StatusCode	string	false	none	none
ArrivalDate	string	false	none	none
DepartureDate	string	false	none	none
PropertyName	string	false	none	none
ChainCode	string	false	none	none
ChainName	string	false	none	none
CityCode	string	false	none	none
CityName	string	false	none	none
CountryCode	string	false	none	none
CountryName	string	false	none	none
Passenger	string	false	none	none
Account	string	false	none	none
ConfirmationNbr	string	false	none	none
Currency	string	false	none	none
Rate	string	false	none	none
RoomBookingCode	string	false	none	none
NbrNights	integer(int32)	false	none	none
MultiLevelRateCode	string	false	none	none
NbrRooms	integer(int32)	false	none	none
BookedInName	string	false	none	none
ServiceInformation	string	false	none	none
PropertyCityCode	string	false	none	none
SegmentStatus	string	false	none	none
HotelVendorCode	string	false	none	none

PassiveSegment

{
  "Address": "string",
  "BookingReasonCode": "string",
  "BookingSource": "string",
  "CityCode": "string",
  "CommissionInformation": "string",
  "ConfirmationNumber": "string",
  "DepartureDate": "string",
  "NbrNights": "string",
  "Passenger": "string",
  "PropertyName": "string",
  "PropertyNumber": "string",
  "RateAccessCode": "string",
  "RateCode": "string",
  "RateQuoted": "string",
  "SegmentStatus": "string",
  "SegmentType": "string",
  "ServiceInformation": "string",
  "StartDate": "string",
  "Text": "string",
  "VendorCode": "string"
}

PassiveSegment

Properties

Name	Type	Required	Restrictions	Description
Address	string	false	none	none
BookingReasonCode	string	false	none	none
BookingSource	string	false	none	none
CityCode	string	false	none	none
CommissionInformation	string	false	none	none
ConfirmationNumber	string	false	none	none
DepartureDate	string	false	none	none
NbrNights	string	false	none	none
Passenger	string	false	none	none
PropertyName	string	false	none	none
PropertyNumber	string	false	none	none
RateAccessCode	string	false	none	none
RateCode	string	false	none	none
RateQuoted	string	false	none	none
SegmentStatus	string	false	none	none
SegmentType	string	false	none	none
ServiceInformation	string	false	none	none
StartDate	string	false	none	none
Text	string	false	none	none
VendorCode	string	false	none	none

TravelHistorySummaryByTravellerResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "PNRSummary": {
      "RecordLocator": "string",
      "AirlineReferences": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "Vendor": "string",
          "VendorLocator": "string"
        }
      },
      "Tickets": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "TktNumber": "string",
          "Passenger": {
            "LastName": "string",
            "FirstName": "string"
          },
          "Coupons": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "CouponSequenceNbr": "string",
              "CouponBoardPoint": "string",
              "CouponOffPoint": "string",
              "Carrier": "string",
              "FlightNbr": "string",
              "FlightDate": "string",
              "FlightTime": "string"
            }
          }
        }
      }
    },
    "Segments": {
      "AirSegments": [
        {
          "AirSegmentNbr": 0,
          "ArrivalTime": "string",
          "BoardPoint": "string",
          "BookingCode": "string",
          "CarrierCode": "string",
          "ChangeOfDay": "string",
          "ConnectionIndicator": "string",
          "DepartureDate": "string",
          "DepartureTime": "string",
          "FlightNbr": "string",
          "JourneyTime": "string",
          "NbrSeats": 0,
          "OffPoint": "string",
          "OperatingCarrierCode": "string",
          "OperatingCarrierName": "string",
          "SeatingData": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "SeatLocation": "string",
              "SeatStatusCode": "string"
            }
          },
          "SegmentStatus": "string"
        }
      ],
      "CarSegments": [
        {
          "AirportCode": "string",
          "CarAddress": "string",
          "CarLocationCategory": "string",
          "CarRateCode": "string",
          "CarRateType": "string",
          "CarSegmentNbr": 0,
          "CarType": "string",
          "CarVendorCode": "string",
          "CarYieldManagementNbr": "string",
          "ConfirmationNbr": "string",
          "CurrencyCode": "string",
          "DistanceAllowance": "string",
          "DistanceRateAmount": "string",
          "DropOffDate": "string",
          "DropOffTime": "string",
          "MilesKilometerIndicator": "string",
          "NbrOfCars": 0,
          "PickUpDate": "string",
          "PickUpTime": "string",
          "RateAmount": "string",
          "RateGuaranteeIndicator": "string",
          "SegmentStatus": "string"
        }
      ],
      "HotelSegments": [
        {
          "HotelSegmentNbr": "string",
          "StatusCode": "string",
          "ArrivalDate": "string",
          "DepartureDate": "string",
          "PropertyName": "string",
          "ChainCode": "string",
          "ChainName": "string",
          "CityCode": "string",
          "CityName": "string",
          "CountryCode": "string",
          "CountryName": "string",
          "Passenger": "string",
          "Account": "string",
          "ConfirmationNbr": "string",
          "Currency": "string",
          "Rate": "string",
          "RoomBookingCode": "string",
          "NbrNights": 0,
          "MultiLevelRateCode": "string",
          "NbrRooms": 0,
          "BookedInName": "string",
          "ServiceInformation": "string",
          "PropertyCityCode": "string",
          "SegmentStatus": "string",
          "HotelVendorCode": "string"
        }
      ],
      "PassiveSegments": [
        {
          "Address": "string",
          "BookingReasonCode": "string",
          "BookingSource": "string",
          "CityCode": "string",
          "CommissionInformation": "string",
          "ConfirmationNumber": "string",
          "DepartureDate": "string",
          "NbrNights": "string",
          "Passenger": "string",
          "PropertyName": "string",
          "PropertyNumber": "string",
          "RateAccessCode": "string",
          "RateCode": "string",
          "RateQuoted": "string",
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceInformation": "string",
          "StartDate": "string",
          "Text": "string",
          "VendorCode": "string"
        }
      ]
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TravelHistorySummaryByTravellerResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	Report	false	none	Report
ResponseError	AgentivityError	false	none	AgentivityError

TotalSalesCurrentMonthItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Total": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TotalSalesCurrentMonthItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	TotalSalesCurrentMonthResponseReport	false	none	TotalSalesCurrentMonthResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

TotalSalesCurrentMonthResponseReport

{
  "Item": {
    "Total": 0
  }
}

TotalSalesCurrentMonthResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	TotalSalesCurrentMonth	false	none	TotalSalesCurrentMonth

TotalSalesCurrentMonth

{
  "Total": 0
}

TotalSalesCurrentMonth

Properties

Name	Type	Required	Restrictions	Description
Total	number(float)	false	none	none

TicketSegmentsByBARResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "TktNumber": "string",
      "RecordLocator": "string",
      "VndIssueDt": "string",
      "BAR": "string",
      "PAR": "string",
      "FOPCurrency": "string",
      "FOPFare": "string",
      "Segments": [
        {
          "Carrier": "string",
          "CouponBoardPoint": "string",
          "CouponOffPoint": "string",
          "CouponSequenceNbr": 0,
          "DateLastChecked": "string",
          "FareBasis": "string",
          "FlightCouponStatus": "string",
          "FlightServiceClass": "string",
          "FlightStatus": "string"
        }
      ]
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TicketSegmentsByBARResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[Ticket]	false	none	[Ticket]
ResponseError	AgentivityError	false	none	AgentivityError

Ticket

{
  "TktNumber": "string",
  "RecordLocator": "string",
  "VndIssueDt": "string",
  "BAR": "string",
  "PAR": "string",
  "FOPCurrency": "string",
  "FOPFare": "string",
  "Segments": [
    {
      "Carrier": "string",
      "CouponBoardPoint": "string",
      "CouponOffPoint": "string",
      "CouponSequenceNbr": 0,
      "DateLastChecked": "string",
      "FareBasis": "string",
      "FlightCouponStatus": "string",
      "FlightServiceClass": "string",
      "FlightStatus": "string"
    }
  ]
}

Ticket

Properties

Name	Type	Required	Restrictions	Description
TktNumber	string	false	none	none
RecordLocator	string	false	none	none
VndIssueDt	string	false	none	none
BAR	string	false	none	none
PAR	string	false	none	none
FOPCurrency	string	false	none	none
FOPFare	string	false	none	none
Segments	[AirSegInfo]	false	none	[AirSegInfo]

AirSegInfo

{
  "Carrier": "string",
  "CouponBoardPoint": "string",
  "CouponOffPoint": "string",
  "CouponSequenceNbr": 0,
  "DateLastChecked": "string",
  "FareBasis": "string",
  "FlightCouponStatus": "string",
  "FlightServiceClass": "string",
  "FlightStatus": "string"
}

AirSegInfo

Properties

Name	Type	Required	Restrictions	Description
Carrier	string	false	none	none
CouponBoardPoint	string	false	none	none
CouponOffPoint	string	false	none	none
CouponSequenceNbr	integer(int32)	false	none	none
DateLastChecked	string	false	none	none
FareBasis	string	false	none	none
FlightCouponStatus	string	false	none	none
FlightServiceClass	string	false	none	none
FlightStatus	string	false	none	none

TravelHistorySummaryByBARResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "PNRSummary": {
      "RecordLocator": "string",
      "AirlineReferences": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "Vendor": "string",
          "VendorLocator": "string"
        }
      },
      "Tickets": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "TktNumber": "string",
          "Passenger": {
            "LastName": "string",
            "FirstName": "string"
          },
          "Coupons": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "CouponSequenceNbr": "string",
              "CouponBoardPoint": "string",
              "CouponOffPoint": "string",
              "Carrier": "string",
              "FlightNbr": "string",
              "FlightDate": "string",
              "FlightTime": "string"
            }
          }
        }
      }
    },
    "Segments": {
      "AirSegments": [
        {
          "AirSegmentNbr": 0,
          "ArrivalTime": "string",
          "BoardPoint": "string",
          "BookingCode": "string",
          "CarrierCode": "string",
          "ChangeOfDay": "string",
          "ConnectionIndicator": "string",
          "DepartureDate": "string",
          "DepartureTime": "string",
          "FlightNbr": "string",
          "JourneyTime": "string",
          "NbrSeats": 0,
          "OffPoint": "string",
          "OperatingCarrierCode": "string",
          "OperatingCarrierName": "string",
          "SeatingData": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "SeatLocation": "string",
              "SeatStatusCode": "string"
            }
          },
          "SegmentStatus": "string"
        }
      ],
      "CarSegments": [
        {
          "AirportCode": "string",
          "CarAddress": "string",
          "CarLocationCategory": "string",
          "CarRateCode": "string",
          "CarRateType": "string",
          "CarSegmentNbr": 0,
          "CarType": "string",
          "CarVendorCode": "string",
          "CarYieldManagementNbr": "string",
          "ConfirmationNbr": "string",
          "CurrencyCode": "string",
          "DistanceAllowance": "string",
          "DistanceRateAmount": "string",
          "DropOffDate": "string",
          "DropOffTime": "string",
          "MilesKilometerIndicator": "string",
          "NbrOfCars": 0,
          "PickUpDate": "string",
          "PickUpTime": "string",
          "RateAmount": "string",
          "RateGuaranteeIndicator": "string",
          "SegmentStatus": "string"
        }
      ],
      "HotelSegments": [
        {
          "HotelSegmentNbr": "string",
          "StatusCode": "string",
          "ArrivalDate": "string",
          "DepartureDate": "string",
          "PropertyName": "string",
          "ChainCode": "string",
          "ChainName": "string",
          "CityCode": "string",
          "CityName": "string",
          "CountryCode": "string",
          "CountryName": "string",
          "Passenger": "string",
          "Account": "string",
          "ConfirmationNbr": "string",
          "Currency": "string",
          "Rate": "string",
          "RoomBookingCode": "string",
          "NbrNights": 0,
          "MultiLevelRateCode": "string",
          "NbrRooms": 0,
          "BookedInName": "string",
          "ServiceInformation": "string",
          "PropertyCityCode": "string",
          "SegmentStatus": "string",
          "HotelVendorCode": "string"
        }
      ],
      "PassiveSegments": [
        {
          "Address": "string",
          "BookingReasonCode": "string",
          "BookingSource": "string",
          "CityCode": "string",
          "CommissionInformation": "string",
          "ConfirmationNumber": "string",
          "DepartureDate": "string",
          "NbrNights": "string",
          "Passenger": "string",
          "PropertyName": "string",
          "PropertyNumber": "string",
          "RateAccessCode": "string",
          "RateCode": "string",
          "RateQuoted": "string",
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceInformation": "string",
          "StartDate": "string",
          "Text": "string",
          "VendorCode": "string"
        }
      ]
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TravelHistorySummaryByBARResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	Report	false	none	Report
ResponseError	AgentivityError	false	none	AgentivityError

BookingHistoryByBARResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "AgentivityRef": "string",
      "RecordLocator": "string",
      "PNRCreationDate": "string",
      "TravelDate": "string",
      "PNRTicketed": "string",
      "PNRCancelled": "string",
      "Account": "string",
      "OwningConsultantID": "string",
      "OwningConsultant": "string",
      "LastActionConsultantID": "string",
      "DestinationCities": "string",
      "DestinationCountries": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

BookingHistoryByBARResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[BookingWithDestinations]	false	none	[BookingWithDestinations]
ResponseError	AgentivityError	false	none	AgentivityError

BookingWithDestinations

{
  "AgentivityRef": "string",
  "RecordLocator": "string",
  "PNRCreationDate": "string",
  "TravelDate": "string",
  "PNRTicketed": "string",
  "PNRCancelled": "string",
  "Account": "string",
  "OwningConsultantID": "string",
  "OwningConsultant": "string",
  "LastActionConsultantID": "string",
  "DestinationCities": "string",
  "DestinationCountries": "string"
}

BookingWithDestinations

Properties

Name	Type	Required	Restrictions	Description
AgentivityRef	string	false	none	none
RecordLocator	string	false	none	none
PNRCreationDate	string	false	none	none
TravelDate	string	false	none	none
PNRTicketed	string	false	none	none
PNRCancelled	string	false	none	none
Account	string	false	none	none
OwningConsultantID	string	false	none	none
OwningConsultant	string	false	none	none
LastActionConsultantID	string	false	none	none
DestinationCities	string	false	none	none
DestinationCountries	string	false	none	none

SupplierPreferencesByOwningAgencyLocationIDResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "PNRSummary": {
      "RecordLocator": "string",
      "AirlineReferences": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "Vendor": "string",
          "VendorLocator": "string"
        }
      },
      "Tickets": {
        "Capacity": 0,
        "Count": 0,
        "Item": {
          "TktNumber": "string",
          "Passenger": {
            "LastName": "string",
            "FirstName": "string"
          },
          "Coupons": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "CouponSequenceNbr": "string",
              "CouponBoardPoint": "string",
              "CouponOffPoint": "string",
              "Carrier": "string",
              "FlightNbr": "string",
              "FlightDate": "string",
              "FlightTime": "string"
            }
          }
        }
      }
    },
    "Segments": {
      "AirSegments": [
        {
          "AirSegmentNbr": 0,
          "ArrivalTime": "string",
          "BoardPoint": "string",
          "BookingCode": "string",
          "CarrierCode": "string",
          "ChangeOfDay": "string",
          "ConnectionIndicator": "string",
          "DepartureDate": "string",
          "DepartureTime": "string",
          "FlightNbr": "string",
          "JourneyTime": "string",
          "NbrSeats": 0,
          "OffPoint": "string",
          "OperatingCarrierCode": "string",
          "OperatingCarrierName": "string",
          "SeatingData": {
            "Capacity": 0,
            "Count": 0,
            "Item": {
              "SeatLocation": "string",
              "SeatStatusCode": "string"
            }
          },
          "SegmentStatus": "string"
        }
      ],
      "CarSegments": [
        {
          "AirportCode": "string",
          "CarAddress": "string",
          "CarLocationCategory": "string",
          "CarRateCode": "string",
          "CarRateType": "string",
          "CarSegmentNbr": 0,
          "CarType": "string",
          "CarVendorCode": "string",
          "CarYieldManagementNbr": "string",
          "ConfirmationNbr": "string",
          "CurrencyCode": "string",
          "DistanceAllowance": "string",
          "DistanceRateAmount": "string",
          "DropOffDate": "string",
          "DropOffTime": "string",
          "MilesKilometerIndicator": "string",
          "NbrOfCars": 0,
          "PickUpDate": "string",
          "PickUpTime": "string",
          "RateAmount": "string",
          "RateGuaranteeIndicator": "string",
          "SegmentStatus": "string"
        }
      ],
      "HotelSegments": [
        {
          "HotelSegmentNbr": "string",
          "StatusCode": "string",
          "ArrivalDate": "string",
          "DepartureDate": "string",
          "PropertyName": "string",
          "ChainCode": "string",
          "ChainName": "string",
          "CityCode": "string",
          "CityName": "string",
          "CountryCode": "string",
          "CountryName": "string",
          "Passenger": "string",
          "Account": "string",
          "ConfirmationNbr": "string",
          "Currency": "string",
          "Rate": "string",
          "RoomBookingCode": "string",
          "NbrNights": 0,
          "MultiLevelRateCode": "string",
          "NbrRooms": 0,
          "BookedInName": "string",
          "ServiceInformation": "string",
          "PropertyCityCode": "string",
          "SegmentStatus": "string",
          "HotelVendorCode": "string"
        }
      ],
      "PassiveSegments": [
        {
          "Address": "string",
          "BookingReasonCode": "string",
          "BookingSource": "string",
          "CityCode": "string",
          "CommissionInformation": "string",
          "ConfirmationNumber": "string",
          "DepartureDate": "string",
          "NbrNights": "string",
          "Passenger": "string",
          "PropertyName": "string",
          "PropertyNumber": "string",
          "RateAccessCode": "string",
          "RateCode": "string",
          "RateQuoted": "string",
          "SegmentStatus": "string",
          "SegmentType": "string",
          "ServiceInformation": "string",
          "StartDate": "string",
          "Text": "string",
          "VendorCode": "string"
        }
      ]
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

SupplierPreferencesByOwningAgencyLocationIDResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	Report	false	none	Report
ResponseError	AgentivityError	false	none	AgentivityError

LocationListsRequestItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "TravelLocations": [
        {
          "CityCode": "string",
          "CityName": "string",
          "CountryCode": "string",
          "CountryName": "string",
          "PortCode": "string",
          "PortName": "string",
          "DisplayName": "string"
        }
      ],
      "AirlinesList": [
        {
          "Code": "string",
          "Name": "string"
        }
      ],
      "CitiesList": [
        {
          "Code": "string",
          "Name": "string",
          "CountryName": "string",
          "StateCode": "string",
          "StateName": "string"
        }
      ],
      "CountriesList": [
        {
          "Code": "string",
          "Name": "string"
        }
      ],
      "TravelLocationsFormatted": "string",
      "AirlinesListFormatted": "string",
      "CitiesListFormatted": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

LocationListsRequestItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	LocationListsRequestResponseReport	false	none	LocationListsRequestResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

LocationListsRequestResponseReport

{
  "Item": {
    "TravelLocations": [
      {
        "CityCode": "string",
        "CityName": "string",
        "CountryCode": "string",
        "CountryName": "string",
        "PortCode": "string",
        "PortName": "string",
        "DisplayName": "string"
      }
    ],
    "AirlinesList": [
      {
        "Code": "string",
        "Name": "string"
      }
    ],
    "CitiesList": [
      {
        "Code": "string",
        "Name": "string",
        "CountryName": "string",
        "StateCode": "string",
        "StateName": "string"
      }
    ],
    "CountriesList": [
      {
        "Code": "string",
        "Name": "string"
      }
    ],
    "TravelLocationsFormatted": "string",
    "AirlinesListFormatted": "string",
    "CitiesListFormatted": "string"
  }
}

LocationListsRequestResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	LocationLists	false	none	LocationLists

LocationLists

{
  "TravelLocations": [
    {
      "CityCode": "string",
      "CityName": "string",
      "CountryCode": "string",
      "CountryName": "string",
      "PortCode": "string",
      "PortName": "string",
      "DisplayName": "string"
    }
  ],
  "AirlinesList": [
    {
      "Code": "string",
      "Name": "string"
    }
  ],
  "CitiesList": [
    {
      "Code": "string",
      "Name": "string",
      "CountryName": "string",
      "StateCode": "string",
      "StateName": "string"
    }
  ],
  "CountriesList": [
    {
      "Code": "string",
      "Name": "string"
    }
  ],
  "TravelLocationsFormatted": "string",
  "AirlinesListFormatted": "string",
  "CitiesListFormatted": "string"
}

LocationLists

Properties

Name	Type	Required	Restrictions	Description
TravelLocations	[TravelLocation]	false	none	[TravelLocation]
AirlinesList	[AirlinesListItem]	false	none	[AirlinesListItem]
CitiesList	[CitiesListItem]	false	none	[CitiesListItem]
CountriesList	[CountriesListItem]	false	none	[CountriesListItem]
TravelLocationsFormatted	string	false	none	none
AirlinesListFormatted	string	false	none	none
CitiesListFormatted	string	false	none	none

TravelLocation

{
  "CityCode": "string",
  "CityName": "string",
  "CountryCode": "string",
  "CountryName": "string",
  "PortCode": "string",
  "PortName": "string",
  "DisplayName": "string"
}

TravelLocation

Properties

Name	Type	Required	Restrictions	Description
CityCode	string	false	none	none
CityName	string	false	none	none
CountryCode	string	false	none	none
CountryName	string	false	none	none
PortCode	string	false	none	none
PortName	string	false	none	none
DisplayName	string	false	none	none

AirlinesListItem

{
  "Code": "string",
  "Name": "string"
}

AirlinesListItem

Properties

Name	Type	Required	Restrictions	Description
Code	string	false	none	none
Name	string	false	none	none

CitiesListItem

{
  "Code": "string",
  "Name": "string",
  "CountryName": "string",
  "StateCode": "string",
  "StateName": "string"
}

CitiesListItem

Properties

Name	Type	Required	Restrictions	Description
Code	string	false	none	none
Name	string	false	none	none
CountryName	string	false	none	none
StateCode	string	false	none	none
StateName	string	false	none	none

CountriesListItem

{
  "Code": "string",
  "Name": "string"
}

CountriesListItem

Properties

Name	Type	Required	Restrictions	Description
Code	string	false	none	none
Name	string	false	none	none

TravellerFlightMemberResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "GroupID": 0,
      "TravellerID": 0,
      "Account": "string",
      "FirstName": "string",
      "GroupName": "string",
      "LastName": "string",
      "Rowversion": 0
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TravellerFlightMemberResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	TravellerFlightMemberReport	false	none	TravellerFlightMemberReport
ResponseError	AgentivityError	false	none	AgentivityError

TravellerFlightMemberReport

{
  "Item": {
    "GroupID": 0,
    "TravellerID": 0,
    "Account": "string",
    "FirstName": "string",
    "GroupName": "string",
    "LastName": "string",
    "Rowversion": 0
  }
}

TravellerFlightMemberReport

Properties

Name	Type	Required	Restrictions	Description
Item	TravellerFlightMember	false	none	TravellerFlightMember

TravellerFlightMember

{
  "GroupID": 0,
  "TravellerID": 0,
  "Account": "string",
  "FirstName": "string",
  "GroupName": "string",
  "LastName": "string",
  "Rowversion": 0
}

TravellerFlightMember

Properties

Name	Type	Required	Restrictions	Description
GroupID	integer(int32)	false	none	none
TravellerID	integer(int32)	false	none	none
Account	string	false	none	none
FirstName	string	false	none	none
GroupName	string	false	none	none
LastName	string	false	none	none
Rowversion	integer(int64)	false	none	none

TravellersByAccountItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "Passenger": "string",
      "TravellerID": "string"
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

TravellersByAccountItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	TravellersByAccountResponseReport	false	none	TravellersByAccountResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

TravellersByAccountResponseReport

{
  "Item": {
    "Passenger": "string",
    "TravellerID": "string"
  }
}

TravellersByAccountResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	TravellerByAccount	false	none	TravellerByAccount

TravellerByAccount

{
  "Passenger": "string",
  "TravellerID": "string"
}

TravellerByAccount

Properties

Name	Type	Required	Restrictions	Description
Passenger	string	false	none	none
TravellerID	string	false	none	none

UsersPCCsMappingItemResponse

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": {
    "Item": {
      "UserID": 0,
      "UserName": "string",
      "LastName": "string",
      "FirstName": "string",
      "LocationCountryCode": "string",
      "LocationCountryName": "string",
      "LastLogin": "2019-03-18T11:42:49Z",
      "PCCList": "string",
      "IsUserActive": true,
      "IsDeleted": true
    }
  },
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

UsersPCCsMappingItemResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	UsersPCCsMappingResponseReport	false	none	UsersPCCsMappingResponseReport
ResponseError	AgentivityError	false	none	AgentivityError

UsersPCCsMappingResponseReport

{
  "Item": {
    "UserID": 0,
    "UserName": "string",
    "LastName": "string",
    "FirstName": "string",
    "LocationCountryCode": "string",
    "LocationCountryName": "string",
    "LastLogin": "2019-03-18T11:42:49Z",
    "PCCList": "string",
    "IsUserActive": true,
    "IsDeleted": true
  }
}

UsersPCCsMappingResponseReport

Properties

Name	Type	Required	Restrictions	Description
Item	UserPCCMapping	false	none	UserPCCMapping

UserPCCMapping

{
  "UserID": 0,
  "UserName": "string",
  "LastName": "string",
  "FirstName": "string",
  "LocationCountryCode": "string",
  "LocationCountryName": "string",
  "LastLogin": "2019-03-18T11:42:49Z",
  "PCCList": "string",
  "IsUserActive": true,
  "IsDeleted": true
}

UserPCCMapping

Properties

Name	Type	Required	Restrictions	Description
UserID	integer(int32)	false	none	none
UserName	string	false	none	none
LastName	string	false	none	none
FirstName	string	false	none	none
LocationCountryCode	string	false	none	none
LocationCountryName	string	false	none	none
LastLogin	string(date-time)	false	none	none
PCCList	string	false	none	none
IsUserActive	boolean	false	none	none
IsDeleted	boolean	false	none	none

CollectionResponse_TicketsIssuedByNumber_

{
  "ResponseMetadata": {
    "Success": true,
    "HasCache": true,
    "HasPaging": true,
    "CacheMetadata": {
      "IsFromCache": true,
      "CachedAt": "2019-03-18T11:42:49Z",
      "CacheExpiresAt": "2019-03-18T11:42:49Z"
    },
    "PagingMetadata": {
      "Limit": "string",
      "Offset": "string",
      "ResponseRecords": "string",
      "TotalRecords": "string"
    }
  },
  "ResponseReport": [
    {
      "RecordLocator": "string",
      "TktNumber": "string",
      "PlatingCarrier": "string",
      "Passenger": "string",
      "IATA": "string",
      "OwningAgencyLocationID": "string",
      "IssueDate": "2019-03-18T11:42:49Z",
      "ExpirationDate": "2019-03-18T11:42:49Z",
      "FOPFare": "string",
      "PrintedCurrency": "string"
    }
  ],
  "ResponseError": {
    "ErrorCode": "string",
    "Message": "string",
    "StatusCode": "string",
    "VerboseMessage": "string"
  }
}

CollectionResponse`1

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	ResponseMetadata
ResponseReport	[TicketsIssuedByNumber]	false	none	[TicketsIssuedByNumber]
ResponseError	AgentivityError	false	none	AgentivityError