| All Verbs | /BookingsWithActiveSegments |
|---|
import Foundation
import ServiceStack
// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetBookingsWithActiveSegments : CompanyLevelRequestBase
{
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var travelDateStart:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var travelDateEnd:String
/**
* All future date
*/
// @DataMember
public var allFutureDate:Bool
/**
* Comma Delimited List of Accounts
*/
// @DataMember
public var account:[String]
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case travelDateStart
case travelDateEnd
case allFutureDate
case account
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
travelDateStart = try container.decodeIfPresent(String.self, forKey: .travelDateStart)
travelDateEnd = try container.decodeIfPresent(String.self, forKey: .travelDateEnd)
allFutureDate = try container.decodeIfPresent(Bool.self, forKey: .allFutureDate)
account = try container.decodeIfPresent([String].self, forKey: .account) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if travelDateStart != nil { try container.encode(travelDateStart, forKey: .travelDateStart) }
if travelDateEnd != nil { try container.encode(travelDateEnd, forKey: .travelDateEnd) }
if allFutureDate != nil { try container.encode(allFutureDate, forKey: .allFutureDate) }
if account != nil { try container.encode(account, forKey: .account) }
}
}
// @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 GetBookingsWithActiveSegmentsItemResponse : ItemResponse<BookingWithActiveSegments, GetBookingsWithActiveSegmentsResponseReport>
{
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 ItemResponse<TItem : Codable, TReport : Codable> : Codable
{
// @DataMember(Order=1)
public var responseMetadata:ResponseMetadata
// @DataMember(Order=2, EmitDefaultValue=false)
public var responseReport:TReport
// @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="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="BookingWithActiveSegments", Namespace="schemas.agentivity.com/types")
public class BookingWithActiveSegments : IBookingIdentifier, ITicketNumbers, IVendorLocators, Codable
{
// @DataMember(Order=10)
public var agentivityRef:Int
// @DataMember(Order=20)
public var recordLocator:String
// @DataMember(Order=30)
public var pnrCreationDate:Date?
// @DataMember(Order=40)
public var owningAgencyLocationID:String
// @DataMember(Order=50)
public var account:String
// @DataMember(Order=60)
public var owningConsultantID:String
// @DataMember(Order=70)
public var owningConsultant:String
// @DataMember(Order=80)
public var travelDate:Date?
// @DataMember(Order=85)
public var passenger:String
// @DataMember(Order=90)
public var pnrTicketed:String
// @DataMember(Order=100)
public var emailAddress:String
// @DataMember(Order=110)
public var phoneNbr:String
// @DataMember(Order=120)
public var hasAir:Bool
// @DataMember(Order=130)
public var hasHtl:Bool
// @DataMember(Order=140)
public var hasCar:Bool
// @DataMember(Order=150)
public var destinationCities:String
// @DataMember(Order=160)
public var connections:String
// @DataMember(Order=170)
public var carrierCodes:String
// @DataMember(Order=180)
public var flightNumbers:String
// @DataMember(Order=190)
public var iataCodes:String
// @DataMember(Order=200)
public var ticketNumbers:[String]
// @DataMember(Order=210)
public var vendorLocators:[BookingExtVendorLocator]
required public init(){}
}
// @DataContract(Name="VendorLocator", Namespace="schemas.agentivity.com/types")
public class BookingExtVendorLocator : IBookingIdentifier, Codable
{
// @DataMember(Order=10)
public var carrierCode:String
// @DataMember(Order=20)
public var vendorLocator:String
required public init(){}
}
// @DataContract(Name="BookingWithActiveSegments", Namespace="schemas.agentivity.com/types")
public class GetBookingsWithActiveSegmentsResponseReport : Report<GetBookingsWithActiveSegmentsItemResponse, BookingWithActiveSegments>
{
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(Namespace="schemas.agentivity.com/types")
public class Report<TItemResponse : Codable, TItem : Codable> : Codable
{
// @DataMember(Order=1, EmitDefaultValue=false)
public var item:TItem
required public init(){}
}
Swift GetBookingsWithActiveSegments DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /BookingsWithActiveSegments HTTP/1.1
Host: api.agentivity.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"TravelDateStart":"String","TravelDateEnd":"String","AllFutureDate":false,"Account":["String"],"OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":{"Item":{"AgentivityRef":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","Account":"String","OwningConsultantID":"String","OwningConsultant":"String","TravelDate":"\/Date(-62135596800000-0000)\/","Passenger":"String","PNRTicketed":"String","EmailAddress":"String","PhoneNbr":"String","HasAir":false,"HasHtl":false,"HasCar":false,"DestinationCities":"String","Connections":"String","CarrierCodes":"String","FlightNumbers":"String","IataCodes":"String","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}