| GET | /TravelHistorySummary/Traveller |
|---|
import Foundation
import ServiceStack
// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetTravelHistorySummaryByTraveller : CompanyLevelRequestBase, IRequestConsultantID
{
/**
* Return only PNRs that are ticketed/all
*/
// @DataMember
public var pnrTicketed:String
/**
* Traveller CRM ID or reference
*/
// @DataMember
public var travellerReference:String
/**
* Agentivity Traveller GUID
*/
// @DataMember
public var travellerGUID:String
/**
* An email of a traveller
*/
// @DataMember
public var travellerEmail:String
/**
* Traveller phone number
*/
// @DataMember
public var travellerPhoneNbr:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var travelDateStart:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var travelDateEnd:String
/**
* CRM System Name used by Agency
*/
// @DataMember
public var crm:String
/**
* Request Consultant ID (sign on)
*/
// @DataMember
public var requestConsultantID:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case pnrTicketed
case travellerReference
case travellerGUID
case travellerEmail
case travellerPhoneNbr
case travelDateStart
case travelDateEnd
case crm
case requestConsultantID
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
pnrTicketed = try container.decodeIfPresent(String.self, forKey: .pnrTicketed)
travellerReference = try container.decodeIfPresent(String.self, forKey: .travellerReference)
travellerGUID = try container.decodeIfPresent(String.self, forKey: .travellerGUID)
travellerEmail = try container.decodeIfPresent(String.self, forKey: .travellerEmail)
travellerPhoneNbr = try container.decodeIfPresent(String.self, forKey: .travellerPhoneNbr)
travelDateStart = try container.decodeIfPresent(String.self, forKey: .travelDateStart)
travelDateEnd = try container.decodeIfPresent(String.self, forKey: .travelDateEnd)
crm = try container.decodeIfPresent(String.self, forKey: .crm)
requestConsultantID = try container.decodeIfPresent(String.self, forKey: .requestConsultantID)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if pnrTicketed != nil { try container.encode(pnrTicketed, forKey: .pnrTicketed) }
if travellerReference != nil { try container.encode(travellerReference, forKey: .travellerReference) }
if travellerGUID != nil { try container.encode(travellerGUID, forKey: .travellerGUID) }
if travellerEmail != nil { try container.encode(travellerEmail, forKey: .travellerEmail) }
if travellerPhoneNbr != nil { try container.encode(travellerPhoneNbr, forKey: .travellerPhoneNbr) }
if travelDateStart != nil { try container.encode(travelDateStart, forKey: .travelDateStart) }
if travelDateEnd != nil { try container.encode(travelDateEnd, forKey: .travelDateEnd) }
if crm != nil { try container.encode(crm, forKey: .crm) }
if requestConsultantID != nil { try container.encode(requestConsultantID, forKey: .requestConsultantID) }
}
}
// @DataContract(Namespace="schemas.agentivity.com/types")
public class CompanyLevelRequestBase : PagingMetadata, IMemberUsername, IMemberOwningCompanyCode
{
/**
* Comma Delimited List of Owning Company Codes
*/
// @DataMember
public var owningCompanyCode:[String]
/**
* UserName in form of an email address
*/
// @DataMember
public var userName:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case owningCompanyCode
case userName
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
owningCompanyCode = try container.decodeIfPresent([String].self, forKey: .owningCompanyCode) ?? []
userName = try container.decodeIfPresent(String.self, forKey: .userName)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if owningCompanyCode != nil { try container.encode(owningCompanyCode, forKey: .owningCompanyCode) }
if userName != nil { try container.encode(userName, forKey: .userName) }
}
}
// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
public class PagingMetadata : Codable
{
/**
* Starting Record
*/
// @DataMember
// @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
public var offset:String
/**
* Number of records to return (PageSize)
*/
// @DataMember
// @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
public var limit:String
/**
* 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 var totalRecords:Int
/**
* 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 var responseRecords:Int
required public init(){}
}
// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class TravellerHistoryResponse : CollectionResponse<TravelHistorySummaryV3>
{
required public init(){ super.init() }
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
}
}
// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class CollectionResponse<TItem : Codable> : Codable
{
// @DataMember(Order=1)
public var responseMetadata:ResponseMetadata
// @DataMember(Order=2, EmitDefaultValue=false)
public var responseReport:[ApiRequestPerHour]
// @DataMember(Order=3, EmitDefaultValue=false)
public var responseError:AgentivityError
required public init(){}
}
// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public class ResponseMetadata : Codable
{
// @DataMember(Order=0)
public var success:Bool
// @DataMember(Order=1)
public var hasCache:Bool
// @DataMember(Order=2)
public var hasPaging:Bool
// @DataMember(Order=3, EmitDefaultValue=false)
public var cacheMetadata:CacheMetadata
// @DataMember(Order=4, EmitDefaultValue=false)
public var pagingMetadata:PagingMetadata
required public init(){}
}
// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
public class CacheMetadata : Codable
{
// @DataMember(Order=1)
public var cachedAt:Date
// @DataMember(Order=2)
public var cacheExpiresAt:Date
// @DataMember(Order=0)
public var isFromCache:Bool
required public init(){}
}
// @DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
public class ApiRequestPerHour : Codable
{
// @DataMember(Order=10)
public var requestDate:Date
// @DataMember(Order=100)
public var hour0:Int
// @DataMember(Order=110)
public var hour1:Int
// @DataMember(Order=120)
public var hour2:Int
// @DataMember(Order=130)
public var hour3:Int
// @DataMember(Order=140)
public var hour4:Int
// @DataMember(Order=150)
public var hour5:Int
// @DataMember(Order=160)
public var hour6:Int
// @DataMember(Order=170)
public var hour7:Int
// @DataMember(Order=180)
public var hour8:Int
// @DataMember(Order=190)
public var hour9:Int
// @DataMember(Order=200)
public var hour10:Int
// @DataMember(Order=210)
public var hour11:Int
// @DataMember(Order=220)
public var hour12:Int
// @DataMember(Order=230)
public var hour13:Int
// @DataMember(Order=240)
public var hour14:Int
// @DataMember(Order=250)
public var hour15:Int
// @DataMember(Order=260)
public var hour16:Int
// @DataMember(Order=270)
public var hour17:Int
// @DataMember(Order=280)
public var hour18:Int
// @DataMember(Order=290)
public var hour19:Int
// @DataMember(Order=300)
public var hour20:Int
// @DataMember(Order=310)
public var hour21:Int
// @DataMember(Order=320)
public var hour22:Int
// @DataMember(Order=330)
public var hour23:Int
required public init(){}
}
// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public class AgentivityError : Codable
{
// @DataMember
public var errorCode:String
// @DataMember
public var message:String
// @DataMember
public var statusCode:String
// @DataMember
public var verboseMessage:String
required public init(){}
}
// @DataContract(Name="TravellerHistory", Namespace="schemas.agentivity.com/types")
public class TravelHistorySummaryV3 : Codable
{
// @DataMember
public var averageItineraryChanges:Float
// @DataMember
public var bookingsMade:Int
// @DataMember
public var countriesVisited:String
// @DataMember
public var tripClasses:String
// @DataMember
public var bookingsCancelled:Int
// @DataMember
public var airSuppliersUsed:String
// @DataMember
public var ticketed:Int
// @DataMember
public var hotelChainsUsed:String
// @DataMember
public var advancePurchaseAverageDays:Int
// @DataMember
public var carSuppliersUsed:String
// @DataMember(Order=100)
public var topAirSupplierSupport:String
// @DataMember(Order=110)
public var topDepartureAirports:String
required public init(){}
}
Swift 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>