| GET | /EventBookings |
|---|
import Foundation
import ServiceStack
// @DataContract(Namespace="schemas.agentivity.com/types")
public class EventBookingsRequest : PagingMetadata
{
/**
* UserName in form of an email address
*/
// @DataMember
public var userName:String
/**
* Event code
*/
// @DataMember
public var eventCode:String
/**
* Split multiple passengers
*/
// @DataMember
public var splitMultiplePassengers:Bool
/**
* Include notes in the response
*/
// @DataMember
public var includeNotes:Bool
/**
* Include arrival departures
*/
// @DataMember
public var includeArrivalDepartures:Bool
/**
* Indicate the required formatting: 0=None(Default), 1=Html, 2=Chart
*/
// @DataMember
public var formattingStyle:Int
/**
* Itinerary segments to show
*/
// @DataMember
public var itinerarySegmentsToShow:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case userName
case eventCode
case splitMultiplePassengers
case includeNotes
case includeArrivalDepartures
case formattingStyle
case itinerarySegmentsToShow
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
userName = try container.decodeIfPresent(String.self, forKey: .userName)
eventCode = try container.decodeIfPresent(String.self, forKey: .eventCode)
splitMultiplePassengers = try container.decodeIfPresent(Bool.self, forKey: .splitMultiplePassengers)
includeNotes = try container.decodeIfPresent(Bool.self, forKey: .includeNotes)
includeArrivalDepartures = try container.decodeIfPresent(Bool.self, forKey: .includeArrivalDepartures)
formattingStyle = try container.decodeIfPresent(Int.self, forKey: .formattingStyle)
itinerarySegmentsToShow = try container.decodeIfPresent(String.self, forKey: .itinerarySegmentsToShow)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if userName != nil { try container.encode(userName, forKey: .userName) }
if eventCode != nil { try container.encode(eventCode, forKey: .eventCode) }
if splitMultiplePassengers != nil { try container.encode(splitMultiplePassengers, forKey: .splitMultiplePassengers) }
if includeNotes != nil { try container.encode(includeNotes, forKey: .includeNotes) }
if includeArrivalDepartures != nil { try container.encode(includeArrivalDepartures, forKey: .includeArrivalDepartures) }
if formattingStyle != nil { try container.encode(formattingStyle, forKey: .formattingStyle) }
if itinerarySegmentsToShow != nil { try container.encode(itinerarySegmentsToShow, forKey: .itinerarySegmentsToShow) }
}
}
// @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 EventBookingsItemResponse : ItemResponse<EventBooking, EventBookingsResponseReport>
{
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="EventBooking", Namespace="schemas.agentivity.com/types")
public class EventBooking : IBookingItinerary, Codable
{
// @DataMember(Order=10)
public var recordLocator:String
// @DataMember(Order=20)
public var pnrCreationDate:Date
// @DataMember(Order=30)
public var paxList:String
// @DataMember(Order=35)
public var paxCount:Int
// @DataMember(Order=70)
public var inboundAirline:String
// @DataMember(Order=80)
public var inboundFlightNumber:String
// @DataMember(Order=90)
public var inboundArrivalCity:String
// @DataMember(Order=100)
public var inboundArrivalDate:Date?
// @DataMember(Order=110)
public var inboundArrivalTime:String
// @DataMember(Order=120)
public var outboundAirline:String
// @DataMember(Order=130)
public var outboundFlightNumber:String
// @DataMember(Order=140)
public var outboundDepartureCity:String
// @DataMember(Order=150)
public var outboundDepartureDate:Date?
// @DataMember(Order=160)
public var outboundDepartureTime:String
// @DataMember(Order=170)
public var notes:String
// @DataMember(Order=180)
public var emails:String
// @DataMember(Order=190)
public var mobile:String
// @DataMember(Order=200)
public var totalTicketedValue:String
// @DataMember(Order=40)
public var agentivityRef:Int
// @DataMember(Order=50)
public var itineraryFormatted:String
// @DataMember(Order=60)
public var itinerary:ItinerarySegmentsCollection
required public init(){}
}
public class ItinerarySegmentsCollection : List<ItinerarySegment>
{
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="ItinerarySegment", Namespace="schemas.agentivity.com/types")
public class ItinerarySegment : Codable
{
// @DataMember
public var segmentType:String
// @DataMember
public var segmentNbr:Int
// @DataMember
public var boardPoint:String
// @DataMember
public var offPoint:String
// @DataMember
public var operatorCode:String
// @DataMember
public var operatorService:String
// @DataMember
public var segmentStatus:String
// @DataMember
public var departureTimeFormatted:String
// @DataMember
public var arrivalTimeFormatted:String
// @DataMember
public var changeOfDayFormatted:String
// @DataMember
public var serviceCode:String
// @DataMember
public var startDate:String
// @DataMember
public var endDate:String
// @DataMember
public var ticketNumber:String
/**
* Comma separated list of vendor locators
*/
// @DataMember
public var vendorLocators:String
// @DataMember
public var equipmentCode:String
// @DataMember
public var equipment:String
required public init(){}
}
// @DataContract(Name="EventBooking", Namespace="schemas.agentivity.com/types")
public class EventBookingsResponseReport : Report<EventBookingsItemResponse, EventBooking>
{
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 EventBookingsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /EventBookings HTTP/1.1 Host: api.agentivity.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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":{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","PaxList":"String","PaxCount":0,"AgentivityRef":0,"ItineraryFormatted":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"InboundAirline":"String","InboundFlightNumber":"String","InboundArrivalCity":"String","InboundArrivalDate":"\/Date(-62135596800000-0000)\/","InboundArrivalTime":"String","OutboundAirline":"String","OutboundFlightNumber":"String","OutboundDepartureCity":"String","OutboundDepartureDate":"\/Date(-62135596800000-0000)\/","OutboundDepartureTime":"String","Notes":"String","Emails":"String","Mobile":"String","TotalTicketedValue":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}