| GET | /HotelSegments |
|---|
import Foundation
import ServiceStack
// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetHotelSegments : CompanyLevelRequestBase
{
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var dateStart:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var dateEnd:String
/**
* Comma Delimited List of Accounts
*/
// @DataMember
public var account:[String]
/**
* 3 letter city code
*/
// @DataMember
public var cityCode:String
/**
* Include Notepad Entry: 1=Yes
*/
// @DataMember
public var withNotepad:String
/**
* Comma Delimited List of PCCs
*/
// @DataMember
public var owningAgencyLocationID:[String]
/**
* Comma Delimited List of CountryCodes
*/
// @DataMember
public var owningAgencyCountryCode:[String]
/**
* Date search type option, a single character (A to search by Arrival dates, C to search by booking creation dates, S to search by segment creation dates).
*/
// @DataMember
public var dateSearchType:String
/**
* IsGDS=0 (bookings from Non-GDS eg Supplier Direct). IsGDS=1 (bookings from GDS).
*/
// @DataMember
public var isGDS:String
/**
* IsPassive=0 (only include non-passive segments). IsPassive=1 (only include passive segments).
*/
// @DataMember
public var isPassive:String
/**
* Comma Delimited List of Custom Fields
*/
// @DataMember
public var customField:[String]
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case dateStart
case dateEnd
case account
case cityCode
case withNotepad
case owningAgencyLocationID
case owningAgencyCountryCode
case dateSearchType
case isGDS
case isPassive
case customField
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
dateStart = try container.decodeIfPresent(String.self, forKey: .dateStart)
dateEnd = try container.decodeIfPresent(String.self, forKey: .dateEnd)
account = try container.decodeIfPresent([String].self, forKey: .account) ?? []
cityCode = try container.decodeIfPresent(String.self, forKey: .cityCode)
withNotepad = try container.decodeIfPresent(String.self, forKey: .withNotepad)
owningAgencyLocationID = try container.decodeIfPresent([String].self, forKey: .owningAgencyLocationID) ?? []
owningAgencyCountryCode = try container.decodeIfPresent([String].self, forKey: .owningAgencyCountryCode) ?? []
dateSearchType = try container.decodeIfPresent(String.self, forKey: .dateSearchType)
isGDS = try container.decodeIfPresent(String.self, forKey: .isGDS)
isPassive = try container.decodeIfPresent(String.self, forKey: .isPassive)
customField = try container.decodeIfPresent([String].self, forKey: .customField) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if dateStart != nil { try container.encode(dateStart, forKey: .dateStart) }
if dateEnd != nil { try container.encode(dateEnd, forKey: .dateEnd) }
if account != nil { try container.encode(account, forKey: .account) }
if cityCode != nil { try container.encode(cityCode, forKey: .cityCode) }
if withNotepad != nil { try container.encode(withNotepad, forKey: .withNotepad) }
if owningAgencyLocationID != nil { try container.encode(owningAgencyLocationID, forKey: .owningAgencyLocationID) }
if owningAgencyCountryCode != nil { try container.encode(owningAgencyCountryCode, forKey: .owningAgencyCountryCode) }
if dateSearchType != nil { try container.encode(dateSearchType, forKey: .dateSearchType) }
if isGDS != nil { try container.encode(isGDS, forKey: .isGDS) }
if isPassive != nil { try container.encode(isPassive, forKey: .isPassive) }
if customField != nil { try container.encode(customField, forKey: .customField) }
}
}
// @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 HotelSegmentsItemResponse : ItemResponse<HotelSegment, HotelSegmentsResponseReport>
{
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 HotelSegment : IBookingCustomFields, Codable
{
// @DataMember(Order=10)
public var agentivityRef:Int
// @DataMember(Order=15)
public var pnrCreationDate:Date?
// @DataMember(Order=20)
public var hotelSegmentNbr:String
// @DataMember(Order=30)
public var recordLocator:String
// @DataMember(Order=50)
public var owningAgencyLocationID:String
// @DataMember(Order=60)
public var account:String
// @DataMember(Order=70)
public var owningConsultantID:String
// @DataMember(Order=80)
public var owningConsultant:String
// @DataMember(Order=90)
public var statusCode:String
// @DataMember(Order=95)
public var segmentCreationDate:Date?
// @DataMember(Order=100)
public var arrivalDate:Date?
// @DataMember(Order=110)
public var departureDate:Date?
// @DataMember(Order=120)
public var nbrNights:Int
// @DataMember(Order=130)
public var vendorCode:String
// @DataMember(Order=140)
public var propertyName:String
// @DataMember(Order=150)
public var propertyNbr:String
// @DataMember(Order=160)
public var propertyAddress:String
// @DataMember(Order=145)
public var propertyPhoneNbr:String
// @DataMember(Order=170)
public var cityCode:String
// @DataMember(Order=170)
public var cityName:String
// @DataMember(Order=180)
public var countryCode:String
// @DataMember(Order=190)
public var countryName:String
// @DataMember(Order=200)
public var passenger:String
// @DataMember(Order=210)
public var confirmationNbr:String
// @DataMember(Order=220)
public var rateAccessCode:String
// @DataMember(Order=230)
public var roomBookingCode:String
// @DataMember(Order=240)
public var currencyCode:String
// @DataMember(Order=250)
public var rateAmount:String
// @DataMember(Order=260)
public var nbrRooms:Int
// @DataMember(Order=270)
public var bookedInName:String
// @DataMember(Order=275)
public var serviceInformation:String
// @DataMember(Order=280)
public var totalAirSegs:String
// @DataMember(Order=290)
public var creatingAgencyIata:String
// @DataMember(Order=310)
public var isCommissionable:Bool?
// @DataMember(Order=320)
public var commission:String
// @DataMember(Order=330)
public var isPassive:Bool
// @DataMember(Order=340)
public var customFields:CustomFieldsCollection
// @DataMember(Order=350)
public var hotelNotepad:String
required public init(){}
}
public class CustomFieldsCollection : List<CustomFieldData>
{
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="CustomField", Namespace="schemas.agentivity.com/types")
public class CustomFieldData : Codable
{
// @DataMember(Order=20)
public var fieldName:String
// @DataMember(Order=30)
public var fieldValue:String
required public init(){}
}
// @DataContract(Name="HotelSegment", Namespace="schemas.agentivity.com/types")
public class HotelSegmentsResponseReport : Report<HotelSegmentsItemResponse, HotelSegment>
{
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(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /HotelSegments HTTP/1.1 Host: api.agentivity.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<ResponseMetadata>
<Success>false</Success>
<HasCache>false</HasCache>
<HasPaging>false</HasPaging>
<CacheMetadata>
<IsFromCache>false</IsFromCache>
<CachedAt>0001-01-01T00:00:00</CachedAt>
<CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
</CacheMetadata>
<PagingMetadata>
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
</PagingMetadata>
</ResponseMetadata>
<ResponseReport>
<Item>
<AgentivityRef>0</AgentivityRef>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<HotelSegmentNbr>String</HotelSegmentNbr>
<RecordLocator>String</RecordLocator>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<Account>String</Account>
<OwningConsultantID>String</OwningConsultantID>
<OwningConsultant>String</OwningConsultant>
<StatusCode>String</StatusCode>
<SegmentCreationDate>0001-01-01T00:00:00</SegmentCreationDate>
<ArrivalDate>0001-01-01T00:00:00</ArrivalDate>
<DepartureDate>0001-01-01T00:00:00</DepartureDate>
<NbrNights>0</NbrNights>
<VendorCode>String</VendorCode>
<PropertyName>String</PropertyName>
<PropertyPhoneNbr>String</PropertyPhoneNbr>
<PropertyNbr>String</PropertyNbr>
<PropertyAddress>String</PropertyAddress>
<CityCode>String</CityCode>
<CityName>String</CityName>
<CountryCode>String</CountryCode>
<CountryName>String</CountryName>
<Passenger>String</Passenger>
<ConfirmationNbr>String</ConfirmationNbr>
<RateAccessCode>String</RateAccessCode>
<RoomBookingCode>String</RoomBookingCode>
<CurrencyCode>String</CurrencyCode>
<RateAmount>String</RateAmount>
<NbrRooms>0</NbrRooms>
<BookedInName>String</BookedInName>
<ServiceInformation>String</ServiceInformation>
<TotalAirSegs>String</TotalAirSegs>
<CreatingAgencyIata>String</CreatingAgencyIata>
<IsCommissionable>false</IsCommissionable>
<Commission>String</Commission>
<IsPassive>false</IsPassive>
<CustomFields>
<CustomField>
<FieldName>String</FieldName>
<FieldValue>String</FieldValue>
</CustomField>
</CustomFields>
<HotelNotepad>String</HotelNotepad>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>