| GET | /ItineraryChangeEvents |
|---|
import Foundation
import ServiceStack
// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetItineraryChangeEvents : PagingMetadata
{
/**
* Comma Delimited List of Accounts
*/
// @DataMember
public var account:[String]
/**
* UserName in form of an email address
*/
// @DataMember
public var userName:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var changeDateStart:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var changeDateEnd:String
/**
* Return only PNRs that are ticketed/all
*/
// @DataMember
public var pnrTicketed:String
/**
* Add document information line
*/
// @DataMember
public var addDILine:Bool
/**
* Comma Delimited List of Event Type Details. Valid values are: AirBkgCodeChanged, AirRouteChanged, AirStatusChanged, AirSupplierChanged, AirTimingsChanged, CarDatesTimingsChanged, CarLocationChanged, CarStatusChanged, CarSupplierChanged, CarTypeCodeChanged, FewerAirSegs, FewerCar_PSegs, FewerCarSegs, FewerHtl_PSegs, FewerHtlSegs, FewerTrn_PSegs, FlightNbrChanged, Htl_PChainChanged, Htl_PDatesChanged, Htl_PLocationChanged, Htl_PTextChanged, HtlChainChanged, HtlDatesChanged, HtlLocationChanged, HtlPropertyChanged, HtlRateCodeChanged, HtlRoomCodeChanged, HtlStatusChanged, MoreAirSegs, MoreCar_PSegs, MoreCarSegs, MoreHtl_PSegs, MoreHtlSegs, MoreTrn_PSegs, TrainDatesChanged
*/
// @DataMember
public var eventTypeDetail:[String]
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case account
case userName
case changeDateStart
case changeDateEnd
case pnrTicketed
case addDILine
case eventTypeDetail
}
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) ?? []
userName = try container.decodeIfPresent(String.self, forKey: .userName)
changeDateStart = try container.decodeIfPresent(String.self, forKey: .changeDateStart)
changeDateEnd = try container.decodeIfPresent(String.self, forKey: .changeDateEnd)
pnrTicketed = try container.decodeIfPresent(String.self, forKey: .pnrTicketed)
addDILine = try container.decodeIfPresent(Bool.self, forKey: .addDILine)
eventTypeDetail = try container.decodeIfPresent([String].self, forKey: .eventTypeDetail) ?? []
}
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 userName != nil { try container.encode(userName, forKey: .userName) }
if changeDateStart != nil { try container.encode(changeDateStart, forKey: .changeDateStart) }
if changeDateEnd != nil { try container.encode(changeDateEnd, forKey: .changeDateEnd) }
if pnrTicketed != nil { try container.encode(pnrTicketed, forKey: .pnrTicketed) }
if addDILine != nil { try container.encode(addDILine, forKey: .addDILine) }
if eventTypeDetail != nil { try container.encode(eventTypeDetail, forKey: .eventTypeDetail) }
}
}
// @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 ItineraryChangeEventsItemResponse : ItemResponse<ItineraryChangeEvent, ItineraryChangeEventsResponseReport>
{
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="ItineraryChangeEvent", Namespace="schemas.agentivity.com/types")
public class ItineraryChangeEvent : Codable
{
// @DataMember(Order=10)
public var agentivityRef:String
// @DataMember(Order=20)
public var recordLocator:String
// @DataMember(Order=30)
public var lastActionConsultant:String
// @DataMember(Order=40)
public var passengers:String
// @DataMember(Order=50)
public var eventDateTime:Date?
// @DataMember(Order=55)
public var eventDateTimeFormatted:String
// @DataMember(Order=60)
public var eventTypeDetail:String
// @DataMember(Order=65)
public var eventTypeGroup:String
// @DataMember(Order=70)
public var oldData:String
// @DataMember(Order=80)
public var newData:String
// @DataMember(Order=90)
public var pnrTicketed:String
// @DataMember(Order=100)
public var firstDILine:String
// @DataMember(Order=110)
public var account:String
// @DataMember(Order=120)
public var purchaseOrder:String
// @DataMember(Order=130)
public var divisionCode:String
// @DataMember(Order=140)
public var businessUnit:String
// @DataMember(Order=150)
public var accountCode:String
required public init(){}
}
// @DataContract(Name="ItineraryChangeEvent", Namespace="schemas.agentivity.com/types")
public class ItineraryChangeEventsResponseReport : Report<ItineraryChangeEventsItemResponse, ItineraryChangeEvent>
{
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 GetItineraryChangeEvents 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 /ItineraryChangeEvents 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":"String","RecordLocator":"String","LastActionConsultant":"String","Passengers":"String","EventDateTime":"\/Date(-62135596800000-0000)\/","EventDateTimeFormatted":"String","EventTypeDetail":"String","EventTypeGroup":"String","OldData":"String","NewData":"String","PNRTicketed":"String","FirstDILine":"String","Account":"String","PurchaseOrder":"String","DivisionCode":"String","BusinessUnit":"String","AccountCode":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}