| GET | /CancelledHotelSegments |
|---|
import Foundation
import ServiceStack
// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetCancelledHotelSegments : CompanyLevelRequestBase
{
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var cancelledDateStart:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var cancelledDateEnd:String
/**
* Comma Delimited List of CountryCodes
*/
// @DataMember
public var owningAgencyCountryCode:[String]
/**
* Return only PNRs with/without an Cancellation Reference
*/
// @DataMember
public var hasCancellationRemark:Bool?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case cancelledDateStart
case cancelledDateEnd
case owningAgencyCountryCode
case hasCancellationRemark
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
cancelledDateStart = try container.decodeIfPresent(String.self, forKey: .cancelledDateStart)
cancelledDateEnd = try container.decodeIfPresent(String.self, forKey: .cancelledDateEnd)
owningAgencyCountryCode = try container.decodeIfPresent([String].self, forKey: .owningAgencyCountryCode) ?? []
hasCancellationRemark = try container.decodeIfPresent(Bool.self, forKey: .hasCancellationRemark)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if cancelledDateStart != nil { try container.encode(cancelledDateStart, forKey: .cancelledDateStart) }
if cancelledDateEnd != nil { try container.encode(cancelledDateEnd, forKey: .cancelledDateEnd) }
if owningAgencyCountryCode != nil { try container.encode(owningAgencyCountryCode, forKey: .owningAgencyCountryCode) }
if hasCancellationRemark != nil { try container.encode(hasCancellationRemark, forKey: .hasCancellationRemark) }
}
}
// @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 GetCancelledHotelSegmentsItemResponse : ItemResponse<CancelledHotelSegment, GetCancelledHotelSegmentsResponseReport>
{
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="Segment", Namespace="schemas.agentivity.com/types")
public class CancelledHotelSegment : Codable
{
// @DataMember(Order=10)
public var recordLocator:String
// @DataMember(Order=20)
public var pnrCreationDate:Date?
// @DataMember(Order=30)
public var owningAgencyLocationID:String
// @DataMember(Order=40)
public var account:String
// @DataMember(Order=50)
public var owningConsultantID:String
// @DataMember(Order=60)
public var owningConsultant:String
// @DataMember(Order=70)
public var statusCode:String
// @DataMember(Order=80)
public var arrivalDate:Date?
// @DataMember(Order=90)
public var departureDate:Date?
// @DataMember(Order=100)
public var propertyName:String
// @DataMember(Order=110)
public var chain:String
// @DataMember(Order=120)
public var city:String
// @DataMember(Order=130)
public var passenger:String
// @DataMember(Order=140)
public var confirmationNbr:String
// @DataMember(Order=150)
public var currency:String
// @DataMember(Order=160)
public var rate:String
// @DataMember(Order=170)
public var roomBookingCode:String
// @DataMember(Order=180)
public var nbrNights:Int?
// @DataMember(Order=190)
public var multiLevelRateCode:String
// @DataMember(Order=200)
public var nbrRooms:Int?
// @DataMember(Order=210)
public var bookedInName:String
// @DataMember(Order=220)
public var serviceInformation:String
// @DataMember(Order=230)
public var cancellationDate:Date?
// @DataMember(Order=240)
public var cancellationRemark:String
required public init(){}
}
// @DataContract(Name="CancelledHotelSegment", Namespace="schemas.agentivity.com/types")
public class GetCancelledHotelSegmentsResponseReport : Report<GetCancelledHotelSegmentsItemResponse, CancelledHotelSegment>
{
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 GetCancelledHotelSegments 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 /CancelledHotelSegments 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)\/","OwningAgencyLocationID":"String","Account":"String","OwningConsultantID":"String","OwningConsultant":"String","StatusCode":"String","ArrivalDate":"\/Date(-62135596800000-0000)\/","DepartureDate":"\/Date(-62135596800000-0000)\/","PropertyName":"String","Chain":"String","City":"String","Passenger":"String","ConfirmationNbr":"String","Currency":"String","Rate":"String","RoomBookingCode":"String","NbrNights":0,"MultiLevelRateCode":"String","NbrRooms":0,"BookedInName":"String","ServiceInformation":"String","CancellationDate":"\/Date(-62135596800000-0000)\/","CancellationRemark":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}