| GET | /TravelHistorySummary/Traveller |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
@DataContract(Namespace="schemas.agentivity.com/types")
public static class GetTravelHistorySummaryByTraveller extends CompanyLevelRequestBase implements IRequestConsultantID
{
/**
* Return only PNRs that are ticketed/all
*/
@DataMember
public String PNRTicketed = null;
/**
* Traveller CRM ID or reference
*/
@DataMember
public String TravellerReference = null;
/**
* Agentivity Traveller GUID
*/
@DataMember
public String TravellerGUID = null;
/**
* An email of a traveller
*/
@DataMember
public String TravellerEmail = null;
/**
* Traveller phone number
*/
@DataMember
public String TravellerPhoneNbr = null;
/**
* Date in format YYYYMMDD
*/
@DataMember
public String TravelDateStart = null;
/**
* Date in format YYYYMMDD
*/
@DataMember
public String TravelDateEnd = null;
/**
* CRM System Name used by Agency
*/
@DataMember
public String CRM = null;
/**
* Request Consultant ID (sign on)
*/
@DataMember
public String RequestConsultantID = null;
public String getPnrTicketed() { return PNRTicketed; }
public GetTravelHistorySummaryByTraveller setPnrTicketed(String value) { this.PNRTicketed = value; return this; }
public String getTravellerReference() { return TravellerReference; }
public GetTravelHistorySummaryByTraveller setTravellerReference(String value) { this.TravellerReference = value; return this; }
public String getTravellerGUID() { return TravellerGUID; }
public GetTravelHistorySummaryByTraveller setTravellerGUID(String value) { this.TravellerGUID = value; return this; }
public String getTravellerEmail() { return TravellerEmail; }
public GetTravelHistorySummaryByTraveller setTravellerEmail(String value) { this.TravellerEmail = value; return this; }
public String getTravellerPhoneNbr() { return TravellerPhoneNbr; }
public GetTravelHistorySummaryByTraveller setTravellerPhoneNbr(String value) { this.TravellerPhoneNbr = value; return this; }
public String getTravelDateStart() { return TravelDateStart; }
public GetTravelHistorySummaryByTraveller setTravelDateStart(String value) { this.TravelDateStart = value; return this; }
public String getTravelDateEnd() { return TravelDateEnd; }
public GetTravelHistorySummaryByTraveller setTravelDateEnd(String value) { this.TravelDateEnd = value; return this; }
public String getCrm() { return CRM; }
public GetTravelHistorySummaryByTraveller setCrm(String value) { this.CRM = value; return this; }
public String getRequestConsultantID() { return RequestConsultantID; }
public GetTravelHistorySummaryByTraveller setRequestConsultantID(String value) { this.RequestConsultantID = value; return this; }
}
@DataContract(Namespace="schemas.agentivity.com/types")
public static class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
/**
* Comma Delimited List of Owning Company Codes
*/
@DataMember
public ArrayList<String> OwningCompanyCode = null;
/**
* UserName in form of an email address
*/
@DataMember
public String UserName = null;
public ArrayList<String> getOwningCompanyCode() { return OwningCompanyCode; }
public CompanyLevelRequestBase setOwningCompanyCode(ArrayList<String> value) { this.OwningCompanyCode = value; return this; }
public String getUserName() { return UserName; }
public CompanyLevelRequestBase setUserName(String value) { this.UserName = value; return this; }
}
@DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
public static class PagingMetadata
{
/**
* Starting Record
*/
@DataMember
@ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
public String Offset = null;
/**
* Number of records to return (PageSize)
*/
@DataMember
@ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
public String Limit = null;
/**
* Total Number of Records in a Full Reponse (if no paging)
*/
@DataMember
@ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
public Integer TotalRecords = null;
/**
* Total Number of Records in this Reponse (on this page)
*/
@DataMember
@ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
public Integer ResponseRecords = null;
public String getOffset() { return Offset; }
public PagingMetadata setOffset(String value) { this.Offset = value; return this; }
public String getLimit() { return Limit; }
public PagingMetadata setLimit(String value) { this.Limit = value; return this; }
public Integer getTotalRecords() { return TotalRecords; }
public PagingMetadata setTotalRecords(Integer value) { this.TotalRecords = value; return this; }
public Integer getResponseRecords() { return ResponseRecords; }
public PagingMetadata setResponseRecords(Integer value) { this.ResponseRecords = value; return this; }
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public static class TravellerHistoryResponse extends CollectionResponse<TravelHistorySummaryV3>
{
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public static class CollectionResponse<TItem>
{
@DataMember(Order=1)
public ResponseMetadata ResponseMetadata = null;
@DataMember(Order=2, EmitDefaultValue=false)
public ArrayList<ApiRequestPerHour> ResponseReport = null;
@DataMember(Order=3, EmitDefaultValue=false)
public AgentivityError ResponseError = null;
public ResponseMetadata getResponseMetadata() { return ResponseMetadata; }
public CollectionResponse<TItem> setResponseMetadata(ResponseMetadata value) { this.ResponseMetadata = value; return this; }
public ArrayList<ApiRequestPerHour> getResponseReport() { return ResponseReport; }
public CollectionResponse<TItem> setResponseReport(ArrayList<ApiRequestPerHour> value) { this.ResponseReport = value; return this; }
public AgentivityError getResponseError() { return ResponseError; }
public CollectionResponse<TItem> setResponseError(AgentivityError value) { this.ResponseError = value; return this; }
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public static class ResponseMetadata
{
@DataMember(Order=0)
public Boolean Success = null;
@DataMember(Order=1)
public Boolean HasCache = null;
@DataMember(Order=2)
public Boolean HasPaging = null;
@DataMember(Order=3, EmitDefaultValue=false)
public CacheMetadata CacheMetadata = null;
@DataMember(Order=4, EmitDefaultValue=false)
public PagingMetadata PagingMetadata = null;
public Boolean isSuccess() { return Success; }
public ResponseMetadata setSuccess(Boolean value) { this.Success = value; return this; }
public Boolean isHasCache() { return HasCache; }
public ResponseMetadata setHasCache(Boolean value) { this.HasCache = value; return this; }
public Boolean isHasPaging() { return HasPaging; }
public ResponseMetadata setHasPaging(Boolean value) { this.HasPaging = value; return this; }
public CacheMetadata getCacheMetadata() { return CacheMetadata; }
public ResponseMetadata setCacheMetadata(CacheMetadata value) { this.CacheMetadata = value; return this; }
public PagingMetadata getPagingMetadata() { return PagingMetadata; }
public ResponseMetadata setPagingMetadata(PagingMetadata value) { this.PagingMetadata = value; return this; }
}
@DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
public static class CacheMetadata
{
@DataMember(Order=1)
public Date CachedAt = null;
@DataMember(Order=2)
public Date CacheExpiresAt = null;
@DataMember(Order=0)
public Boolean IsFromCache = null;
public Date getCachedAt() { return CachedAt; }
public CacheMetadata setCachedAt(Date value) { this.CachedAt = value; return this; }
public Date getCacheExpiresAt() { return CacheExpiresAt; }
public CacheMetadata setCacheExpiresAt(Date value) { this.CacheExpiresAt = value; return this; }
public Boolean getIsFromCache() { return IsFromCache; }
public CacheMetadata setIsFromCache(Boolean value) { this.IsFromCache = value; return this; }
}
@DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
public static class ApiRequestPerHour
{
@DataMember(Order=10)
public Date RequestDate = null;
@DataMember(Order=100)
public Integer Hour0 = null;
@DataMember(Order=110)
public Integer Hour1 = null;
@DataMember(Order=120)
public Integer Hour2 = null;
@DataMember(Order=130)
public Integer Hour3 = null;
@DataMember(Order=140)
public Integer Hour4 = null;
@DataMember(Order=150)
public Integer Hour5 = null;
@DataMember(Order=160)
public Integer Hour6 = null;
@DataMember(Order=170)
public Integer Hour7 = null;
@DataMember(Order=180)
public Integer Hour8 = null;
@DataMember(Order=190)
public Integer Hour9 = null;
@DataMember(Order=200)
public Integer Hour10 = null;
@DataMember(Order=210)
public Integer Hour11 = null;
@DataMember(Order=220)
public Integer Hour12 = null;
@DataMember(Order=230)
public Integer Hour13 = null;
@DataMember(Order=240)
public Integer Hour14 = null;
@DataMember(Order=250)
public Integer Hour15 = null;
@DataMember(Order=260)
public Integer Hour16 = null;
@DataMember(Order=270)
public Integer Hour17 = null;
@DataMember(Order=280)
public Integer Hour18 = null;
@DataMember(Order=290)
public Integer Hour19 = null;
@DataMember(Order=300)
public Integer Hour20 = null;
@DataMember(Order=310)
public Integer Hour21 = null;
@DataMember(Order=320)
public Integer Hour22 = null;
@DataMember(Order=330)
public Integer Hour23 = null;
public Date getRequestDate() { return RequestDate; }
public ApiRequestPerHour setRequestDate(Date value) { this.RequestDate = value; return this; }
public Integer getHour0() { return Hour0; }
public ApiRequestPerHour setHour0(Integer value) { this.Hour0 = value; return this; }
public Integer getHour1() { return Hour1; }
public ApiRequestPerHour setHour1(Integer value) { this.Hour1 = value; return this; }
public Integer getHour2() { return Hour2; }
public ApiRequestPerHour setHour2(Integer value) { this.Hour2 = value; return this; }
public Integer getHour3() { return Hour3; }
public ApiRequestPerHour setHour3(Integer value) { this.Hour3 = value; return this; }
public Integer getHour4() { return Hour4; }
public ApiRequestPerHour setHour4(Integer value) { this.Hour4 = value; return this; }
public Integer getHour5() { return Hour5; }
public ApiRequestPerHour setHour5(Integer value) { this.Hour5 = value; return this; }
public Integer getHour6() { return Hour6; }
public ApiRequestPerHour setHour6(Integer value) { this.Hour6 = value; return this; }
public Integer getHour7() { return Hour7; }
public ApiRequestPerHour setHour7(Integer value) { this.Hour7 = value; return this; }
public Integer getHour8() { return Hour8; }
public ApiRequestPerHour setHour8(Integer value) { this.Hour8 = value; return this; }
public Integer getHour9() { return Hour9; }
public ApiRequestPerHour setHour9(Integer value) { this.Hour9 = value; return this; }
public Integer getHour10() { return Hour10; }
public ApiRequestPerHour setHour10(Integer value) { this.Hour10 = value; return this; }
public Integer getHour11() { return Hour11; }
public ApiRequestPerHour setHour11(Integer value) { this.Hour11 = value; return this; }
public Integer getHour12() { return Hour12; }
public ApiRequestPerHour setHour12(Integer value) { this.Hour12 = value; return this; }
public Integer getHour13() { return Hour13; }
public ApiRequestPerHour setHour13(Integer value) { this.Hour13 = value; return this; }
public Integer getHour14() { return Hour14; }
public ApiRequestPerHour setHour14(Integer value) { this.Hour14 = value; return this; }
public Integer getHour15() { return Hour15; }
public ApiRequestPerHour setHour15(Integer value) { this.Hour15 = value; return this; }
public Integer getHour16() { return Hour16; }
public ApiRequestPerHour setHour16(Integer value) { this.Hour16 = value; return this; }
public Integer getHour17() { return Hour17; }
public ApiRequestPerHour setHour17(Integer value) { this.Hour17 = value; return this; }
public Integer getHour18() { return Hour18; }
public ApiRequestPerHour setHour18(Integer value) { this.Hour18 = value; return this; }
public Integer getHour19() { return Hour19; }
public ApiRequestPerHour setHour19(Integer value) { this.Hour19 = value; return this; }
public Integer getHour20() { return Hour20; }
public ApiRequestPerHour setHour20(Integer value) { this.Hour20 = value; return this; }
public Integer getHour21() { return Hour21; }
public ApiRequestPerHour setHour21(Integer value) { this.Hour21 = value; return this; }
public Integer getHour22() { return Hour22; }
public ApiRequestPerHour setHour22(Integer value) { this.Hour22 = value; return this; }
public Integer getHour23() { return Hour23; }
public ApiRequestPerHour setHour23(Integer value) { this.Hour23 = value; return this; }
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public static class AgentivityError
{
@DataMember
public String ErrorCode = null;
@DataMember
public String Message = null;
@DataMember
public String StatusCode = null;
@DataMember
public String VerboseMessage = null;
public String getErrorCode() { return ErrorCode; }
public AgentivityError setErrorCode(String value) { this.ErrorCode = value; return this; }
public String getMessage() { return Message; }
public AgentivityError setMessage(String value) { this.Message = value; return this; }
public String getStatusCode() { return StatusCode; }
public AgentivityError setStatusCode(String value) { this.StatusCode = value; return this; }
public String getVerboseMessage() { return VerboseMessage; }
public AgentivityError setVerboseMessage(String value) { this.VerboseMessage = value; return this; }
}
@DataContract(Name="TravellerHistory", Namespace="schemas.agentivity.com/types")
public static class TravelHistorySummaryV3
{
@DataMember
public Float AverageItineraryChanges = null;
@DataMember
public Integer BookingsMade = null;
@DataMember
public String CountriesVisited = null;
@DataMember
public String TripClasses = null;
@DataMember
public Integer BookingsCancelled = null;
@DataMember
public String AirSuppliersUsed = null;
@DataMember
public Integer Ticketed = null;
@DataMember
public String HotelChainsUsed = null;
@DataMember
public Integer AdvancePurchaseAverageDays = null;
@DataMember
public String CarSuppliersUsed = null;
@DataMember(Order=100)
public String TopAirSupplierSupport = null;
@DataMember(Order=110)
public String TopDepartureAirports = null;
public Float getAverageItineraryChanges() { return AverageItineraryChanges; }
public TravelHistorySummaryV3 setAverageItineraryChanges(Float value) { this.AverageItineraryChanges = value; return this; }
public Integer getBookingsMade() { return BookingsMade; }
public TravelHistorySummaryV3 setBookingsMade(Integer value) { this.BookingsMade = value; return this; }
public String getCountriesVisited() { return CountriesVisited; }
public TravelHistorySummaryV3 setCountriesVisited(String value) { this.CountriesVisited = value; return this; }
public String getTripClasses() { return TripClasses; }
public TravelHistorySummaryV3 setTripClasses(String value) { this.TripClasses = value; return this; }
public Integer getBookingsCancelled() { return BookingsCancelled; }
public TravelHistorySummaryV3 setBookingsCancelled(Integer value) { this.BookingsCancelled = value; return this; }
public String getAirSuppliersUsed() { return AirSuppliersUsed; }
public TravelHistorySummaryV3 setAirSuppliersUsed(String value) { this.AirSuppliersUsed = value; return this; }
public Integer getTicketed() { return Ticketed; }
public TravelHistorySummaryV3 setTicketed(Integer value) { this.Ticketed = value; return this; }
public String getHotelChainsUsed() { return HotelChainsUsed; }
public TravelHistorySummaryV3 setHotelChainsUsed(String value) { this.HotelChainsUsed = value; return this; }
public Integer getAdvancePurchaseAverageDays() { return AdvancePurchaseAverageDays; }
public TravelHistorySummaryV3 setAdvancePurchaseAverageDays(Integer value) { this.AdvancePurchaseAverageDays = value; return this; }
public String getCarSuppliersUsed() { return CarSuppliersUsed; }
public TravelHistorySummaryV3 setCarSuppliersUsed(String value) { this.CarSuppliersUsed = value; return this; }
public String getTopAirSupplierSupport() { return TopAirSupplierSupport; }
public TravelHistorySummaryV3 setTopAirSupplierSupport(String value) { this.TopAirSupplierSupport = value; return this; }
public String getTopDepartureAirports() { return TopDepartureAirports; }
public TravelHistorySummaryV3 setTopDepartureAirports(String value) { this.TopDepartureAirports = value; return this; }
}
}
Java GetTravelHistorySummaryByTraveller DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /TravelHistorySummary/Traveller HTTP/1.1 Host: api.agentivity.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<ResponseMetadata>
<Success>false</Success>
<HasCache>false</HasCache>
<HasPaging>false</HasPaging>
<CacheMetadata>
<IsFromCache>false</IsFromCache>
<CachedAt>0001-01-01T00:00:00</CachedAt>
<CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
</CacheMetadata>
<PagingMetadata>
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
</PagingMetadata>
</ResponseMetadata>
<ResponseReport>
<TravellerHistory>
<AdvancePurchaseAverageDays>0</AdvancePurchaseAverageDays>
<AirSuppliersUsed>String</AirSuppliersUsed>
<AverageItineraryChanges>0</AverageItineraryChanges>
<BookingsCancelled>0</BookingsCancelled>
<BookingsMade>0</BookingsMade>
<CarSuppliersUsed>String</CarSuppliersUsed>
<CountriesVisited>String</CountriesVisited>
<HotelChainsUsed>String</HotelChainsUsed>
<Ticketed>0</Ticketed>
<TripClasses>String</TripClasses>
<TopAirSupplierSupport>String</TopAirSupplierSupport>
<TopDepartureAirports>String</TopDepartureAirports>
</TravellerHistory>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>