| GET | /BookingsCancelled |
|---|
import Foundation
import ServiceStack
// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetBookingsCancelled : CompanyLevelRequestBase
{
/**
* Comma Delimited List of Accounts
*/
// @DataMember
public var account:[String]
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var pnrCancellationDateStart:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var pnrCancellationDateEnd:String
// @DataMember
public var includeItinerary:Bool
// @DataMember
public var itineraryFormatting:FormattingStyle
// @DataMember
public var repeat:Bool
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case account
case pnrCancellationDateStart
case pnrCancellationDateEnd
case includeItinerary
case itineraryFormatting
case repeat
}
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) ?? []
pnrCancellationDateStart = try container.decodeIfPresent(String.self, forKey: .pnrCancellationDateStart)
pnrCancellationDateEnd = try container.decodeIfPresent(String.self, forKey: .pnrCancellationDateEnd)
includeItinerary = try container.decodeIfPresent(Bool.self, forKey: .includeItinerary)
itineraryFormatting = try container.decodeIfPresent(FormattingStyle.self, forKey: .itineraryFormatting)
repeat = try container.decodeIfPresent(Bool.self, forKey: .repeat)
}
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 pnrCancellationDateStart != nil { try container.encode(pnrCancellationDateStart, forKey: .pnrCancellationDateStart) }
if pnrCancellationDateEnd != nil { try container.encode(pnrCancellationDateEnd, forKey: .pnrCancellationDateEnd) }
if includeItinerary != nil { try container.encode(includeItinerary, forKey: .includeItinerary) }
if itineraryFormatting != nil { try container.encode(itineraryFormatting, forKey: .itineraryFormatting) }
if repeat != nil { try container.encode(repeat, forKey: .repeat) }
}
}
// @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 BookingsCancelledItemResponse : ItemResponse<BookingCancelled, BookingsCancelledResponseReport>
{
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="BookingCancelled", Namespace="schemas.agentivity.com/types")
public class BookingCancelled : IBookingItinerary, 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 passengers:String
// @DataMember(Order=60)
public var account:String
// @DataMember(Order=70)
public var owningConsultant:String
// @DataMember(Order=80)
public var pnrTicketed:String
// @DataMember(Order=120)
public var itinerary:ItinerarySegmentsCollection
// @DataMember(Order=130)
public var itineraryFormatted:String
// @DataMember(Order=140)
public var pnrCancelledDate:Date?
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="BookingCancelled", Namespace="schemas.agentivity.com/types")
public class BookingsCancelledResponseReport : Report<BookingsCancelledItemResponse, BookingCancelled>
{
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 GetBookingsCancelled DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /BookingsCancelled HTTP/1.1 Host: api.agentivity.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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","Passengers":"String","Account":"String","OwningConsultant":"String","PNRTicketed":"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"}],"ItineraryFormatted":"String","PNRCancelledDate":"\/Date(-62135596800000-0000)\/"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}