NAV Navigation
Subscribe
cURL C# Python Java

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:

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

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:

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.getInp