| GET | /PassiveSegments |
|---|
import Foundation
import ServiceStack
// @DataContract(Namespace="schemas.agentivity.com/types")
public class PassiveSegmentsByUser : CompanyLevelRequestBase
{
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var arrivalDateEnd:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var arrivalDateStart:String
/**
* Type of segment
*/
// @DataMember
public var segmentType:String
/**
* Account
*/
// @DataMember
public var account:String
/**
* 3 letter city code
*/
// @DataMember
public var cityCode:String
/**
* Date search type option, a single character (T to search by segment start dates, C to search by booking creation dates).
*/
// @DataMember
public var dateSearchType:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case arrivalDateEnd
case arrivalDateStart
case segmentType
case account
case cityCode
case dateSearchType
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
arrivalDateEnd = try container.decodeIfPresent(String.self, forKey: .arrivalDateEnd)
arrivalDateStart = try container.decodeIfPresent(String.self, forKey: .arrivalDateStart)
segmentType = try container.decodeIfPresent(String.self, forKey: .segmentType)
account = try container.decodeIfPresent(String.self, forKey: .account)
cityCode = try container.decodeIfPresent(String.self, forKey: .cityCode)
dateSearchType = try container.decodeIfPresent(String.self, forKey: .dateSearchType)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if arrivalDateEnd != nil { try container.encode(arrivalDateEnd, forKey: .arrivalDateEnd) }
if arrivalDateStart != nil { try container.encode(arrivalDateStart, forKey: .arrivalDateStart) }
if segmentType != nil { try container.encode(segmentType, forKey: .segmentType) }
if account != nil { try container.encode(account, forKey: .account) }
if cityCode != nil { try container.encode(cityCode, forKey: .cityCode) }
if dateSearchType != nil { try container.encode(dateSearchType, forKey: .dateSearchType) }
}
}
// @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 PassiveSegmentsResponse : ItemResponse<PassiveSegmentWithOwningInformation, PassiveSegmentsByUserResponseReport>
{
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="PassiveSegmentWithOwningInformation", Namespace="schemas.agentivity.com/types")
public class PassiveSegmentWithOwningInformation : Codable
{
// @DataMember
public var agentivityRef:Int
// @DataMember(Order=20)
public var owningAgencyLocationID:String
// @DataMember(Order=10)
public var recordLocator:String
// @DataMember
public var owningConsultantID:String
// @DataMember(Order=30)
public var owningConsultant:String
// @DataMember(Order=40)
public var account:String
// @DataMember(Order=70)
public var segmentStatus:String
// @DataMember
public var startDate:String
// @DataMember(Order=60)
public var departureDate:String
// @DataMember
public var nbrNights:String
// @DataMember
public var vendorCode:String
// @DataMember
public var cityCode:String
// @DataMember
public var segmentType:String
// @DataMember
public var text:String
// @DataMember(Order=50)
public var passenger:String
// @DataMember
public var address:String
// @DataMember
public var bookingReasonCode:String
// @DataMember
public var bookingSource:String
// @DataMember
public var commissionInformation:String
// @DataMember
public var confirmationNumber:String
// @DataMember
public var rateCode:String
// @DataMember
public var rateQuoted:String
// @DataMember
public var rateAccessCode:String
// @DataMember
public var propertyName:String
// @DataMember
public var propertyNumber:String
// @DataMember
public var serviceInformation:String
// @DataMember
public var totalAirSegs:String
// @DataMember
public var hotelCommission:String
// @DataMember
public var countryName:String
required public init(){}
}
// @DataContract(Name="PassiveSegmentWithOwningInformation", Namespace="schemas.agentivity.com/types")
public class PassiveSegmentsByUserResponseReport : Report<PassiveSegmentsResponse, PassiveSegmentWithOwningInformation>
{
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 PassiveSegmentsByUser 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 /PassiveSegments 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,"OwningConsultantID":"String","StartDate":"String","NbrNights":"String","VendorCode":"String","CityCode":"String","SegmentType":"String","Text":"String","Address":"String","BookingReasonCode":"String","BookingSource":"String","CommissionInformation":"String","ConfirmationNumber":"String","RateCode":"String","RateQuoted":"String","RateAccessCode":"String","PropertyName":"String","PropertyNumber":"String","ServiceInformation":"String","TotalAirSegs":"String","HotelCommission":"String","CountryName":"String","RecordLocator":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","Account":"String","Passenger":"String","DepartureDate":"String","SegmentStatus":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}