| GET | /BookingsTravelling |
|---|
import Foundation
import ServiceStack
// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetBookingsTravelling : CompanyLevelRequestBase
{
/**
* Comma Delimited List of Accounts
*/
// @DataMember
public var account:[String]
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var travelDateStart:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var travelDateEnd:String
/**
* Return only PNRs with/without a mobile number
*/
// @DataMember
public var hasMobile:Bool?
/**
* Return only PNRs with/without an email address
*/
// @DataMember
public var hasEmail:Bool?
/**
* Return only PNRs with/without an email address OR a mobile number
*/
// @DataMember
public var missingEmailOrPhone:Bool?
/**
* Return only PNRs with/without a hotel
*/
// @DataMember
public var hasHotel:Bool?
/**
* Return only PNRs with/without an account
*/
// @DataMember
public var hasAccount:Bool?
/**
* Include Itinerary in the response
*/
// @DataMember
public var includeItinerary:Bool
/**
* Return only PNRs that equal or exceed a certain number of segments
*/
// @DataMember
public var minSegments:Int?
/**
* Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
*/
// @DataMember
public var itineraryFormatting:FormattingStyle
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case account
case travelDateStart
case travelDateEnd
case hasMobile
case hasEmail
case missingEmailOrPhone
case hasHotel
case hasAccount
case includeItinerary
case minSegments
case itineraryFormatting
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
account = try container.decodeIfPresent([String].self, forKey: .account) ?? []
travelDateStart = try container.decodeIfPresent(String.self, forKey: .travelDateStart)
travelDateEnd = try container.decodeIfPresent(String.self, forKey: .travelDateEnd)
hasMobile = try container.decodeIfPresent(Bool.self, forKey: .hasMobile)
hasEmail = try container.decodeIfPresent(Bool.self, forKey: .hasEmail)
missingEmailOrPhone = try container.decodeIfPresent(Bool.self, forKey: .missingEmailOrPhone)
hasHotel = try container.decodeIfPresent(Bool.self, forKey: .hasHotel)
hasAccount = try container.decodeIfPresent(Bool.self, forKey: .hasAccount)
includeItinerary = try container.decodeIfPresent(Bool.self, forKey: .includeItinerary)
minSegments = try container.decodeIfPresent(Int.self, forKey: .minSegments)
itineraryFormatting = try container.decodeIfPresent(FormattingStyle.self, forKey: .itineraryFormatting)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if account != nil { try container.encode(account, forKey: .account) }
if travelDateStart != nil { try container.encode(travelDateStart, forKey: .travelDateStart) }
if travelDateEnd != nil { try container.encode(travelDateEnd, forKey: .travelDateEnd) }
if hasMobile != nil { try container.encode(hasMobile, forKey: .hasMobile) }
if hasEmail != nil { try container.encode(hasEmail, forKey: .hasEmail) }
if missingEmailOrPhone != nil { try container.encode(missingEmailOrPhone, forKey: .missingEmailOrPhone) }
if hasHotel != nil { try container.encode(hasHotel, forKey: .hasHotel) }
if hasAccount != nil { try container.encode(hasAccount, forKey: .hasAccount) }
if includeItinerary != nil { try container.encode(includeItinerary, forKey: .includeItinerary) }
if minSegments != nil { try container.encode(minSegments, forKey: .minSegments) }
if itineraryFormatting != nil { try container.encode(itineraryFormatting, forKey: .itineraryFormatting) }
}
}
// @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(){}
}
// @Flags()
public enum FormattingStyle : Int, Codable
{
case None = 0
case Html = 1
case Charting = 2
}
// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class BookingsTravellingResponse : CollectionResponse<BookingTravelling>
{
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="BookingTravelling", Namespace="schemas.agentivity.com/types")
public class BookingTravelling : IBookingItinerary, Codable
{
// @DataMember(Order=20)
public var recordLocator:String
// @DataMember(Order=25)
public var owningAgencyLocationID:String
// @DataMember(Order=30)
public var pnrCreationDate:Date?
// @DataMember(Order=40)
public var passengers:String
// @DataMember(Order=50)
public var owningConsultant:String
// @DataMember(Order=60)
public var account:String
// @DataMember(Order=70)
public var travelDate:Date?
// @DataMember(Order=80)
public var mobile:String
// @DataMember(Order=90)
public var emails:String
// @DataMember(Order=100)
public var pnrTicketed:String
// @DataMember(Order=110)
public var destinationCount:Int
// @DataMember(Order=100)
public var ctcm:String
// @DataMember(Order=110)
public var ctce:String
// @DataMember(Order=10)
public var agentivityRef:Int
// @DataMember(Order=300)
public var itineraryFormatted:String
required public init(){}
}
Swift GetBookingsTravelling 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 /BookingsTravelling 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>
<BookingTravelling>
<AgentivityRef>0</AgentivityRef>
<RecordLocator>String</RecordLocator>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<Passengers>String</Passengers>
<OwningConsultant>String</OwningConsultant>
<Account>String</Account>
<TravelDate>0001-01-01T00:00:00</TravelDate>
<Mobile>String</Mobile>
<Emails>String</Emails>
<CTCM>String</CTCM>
<PNRTicketed>String</PNRTicketed>
<CTCE>String</CTCE>
<DestinationCount>0</DestinationCount>
<ItineraryFormatted>String</ItineraryFormatted>
</BookingTravelling>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>