| GET | /PassiveSegments |
|---|
namespace AgentivityAPI.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract(Name="PassiveSegmentWithOwningInformation", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PassiveSegmentWithOwningInformation() =
[<DataMember>]
member val AgentivityRef:Int32 = new Int32() with get,set
[<DataMember(Order=20)>]
member val OwningAgencyLocationID:String = null with get,set
[<DataMember(Order=10)>]
member val RecordLocator:String = null with get,set
[<DataMember>]
member val OwningConsultantID:String = null with get,set
[<DataMember(Order=30)>]
member val OwningConsultant:String = null with get,set
[<DataMember(Order=40)>]
member val Account:String = null with get,set
[<DataMember(Order=70)>]
member val SegmentStatus:String = null with get,set
[<DataMember>]
member val StartDate:String = null with get,set
[<DataMember(Order=60)>]
member val DepartureDate:String = null with get,set
[<DataMember>]
member val NbrNights:String = null with get,set
[<DataMember>]
member val VendorCode:String = null with get,set
[<DataMember>]
member val CityCode:String = null with get,set
[<DataMember>]
member val SegmentType:String = null with get,set
[<DataMember>]
member val Text:String = null with get,set
[<DataMember(Order=50)>]
member val Passenger:String = null with get,set
[<DataMember>]
member val Address:String = null with get,set
[<DataMember>]
member val BookingReasonCode:String = null with get,set
[<DataMember>]
member val BookingSource:String = null with get,set
[<DataMember>]
member val CommissionInformation:String = null with get,set
[<DataMember>]
member val ConfirmationNumber:String = null with get,set
[<DataMember>]
member val RateCode:String = null with get,set
[<DataMember>]
member val RateQuoted:String = null with get,set
[<DataMember>]
member val RateAccessCode:String = null with get,set
[<DataMember>]
member val PropertyName:String = null with get,set
[<DataMember>]
member val PropertyNumber:String = null with get,set
[<DataMember>]
member val ServiceInformation:String = null with get,set
[<DataMember>]
member val TotalAirSegs:String = null with get,set
[<DataMember>]
member val HotelCommission:String = null with get,set
[<DataMember>]
member val CountryName:String = null with get,set
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type Report<TItemResponse, TItem>() =
[<DataMember(Order=1, EmitDefaultValue=false)>]
member val Item:TItem = null with get,set
[<DataContract(Name="PassiveSegmentWithOwningInformation", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PassiveSegmentsByUserResponseReport() =
inherit Report<PassiveSegmentsResponse, PassiveSegmentWithOwningInformation>()
[<DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CacheMetadata() =
[<DataMember(Order=1)>]
member val CachedAt:DateTime = new DateTime() with get,set
[<DataMember(Order=2)>]
member val CacheExpiresAt:DateTime = new DateTime() with get,set
[<DataMember(Order=0)>]
member val IsFromCache:Boolean = new Boolean() with get,set
[<DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PagingMetadata() =
///<summary>
///Starting Record
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")>]
member val Offset:String = null with get,set
///<summary>
///Number of records to return (PageSize)
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")>]
member val Limit:String = null with get,set
///<summary>
///Total Number of Records in a Full Reponse (if no paging)
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")>]
member val TotalRecords:Int32 = new Int32() with get,set
///<summary>
///Total Number of Records in this Reponse (on this page)
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")>]
member val ResponseRecords:Int32 = new Int32() with get,set
[<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ResponseMetadata() =
[<DataMember(Order=0)>]
member val Success:Boolean = new Boolean() with get,set
[<DataMember(Order=1)>]
member val HasCache:Boolean = new Boolean() with get,set
[<DataMember(Order=2)>]
member val HasPaging:Boolean = new Boolean() with get,set
[<DataMember(Order=3, EmitDefaultValue=false)>]
member val CacheMetadata:CacheMetadata = null with get,set
[<DataMember(Order=4, EmitDefaultValue=false)>]
member val PagingMetadata:PagingMetadata = null with get,set
[<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type AgentivityError() =
[<DataMember>]
member val ErrorCode:String = null with get,set
[<DataMember>]
member val Message:String = null with get,set
[<DataMember>]
member val StatusCode:String = null with get,set
[<DataMember>]
member val VerboseMessage:String = null with get,set
[<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ItemResponse<TItem, TReport>() =
[<DataMember(Order=1)>]
member val ResponseMetadata:ResponseMetadata = null with get,set
[<DataMember(Order=2, EmitDefaultValue=false)>]
member val ResponseReport:TReport = null with get,set
[<DataMember(Order=3, EmitDefaultValue=false)>]
member val ResponseError:AgentivityError = null with get,set
[<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PassiveSegmentsResponse() =
inherit ItemResponse<PassiveSegmentWithOwningInformation, PassiveSegmentsByUserResponseReport>()
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CompanyLevelRequestBase() =
inherit PagingMetadata()
///<summary>
///Comma Delimited List of Owning Company Codes
///</summary>
[<DataMember>]
member val OwningCompanyCode:String[] = null with get,set
///<summary>
///UserName in form of an email address
///</summary>
[<DataMember>]
member val UserName:String = null with get,set
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PassiveSegmentsByUser() =
inherit CompanyLevelRequestBase()
///<summary>
///Date in format YYYYMMDD
///</summary>
[<DataMember>]
member val ArrivalDateEnd:String = null with get,set
///<summary>
///Date in format YYYYMMDD
///</summary>
[<DataMember>]
member val ArrivalDateStart:String = null with get,set
///<summary>
///Type of segment
///</summary>
[<DataMember>]
member val SegmentType:String = null with get,set
///<summary>
///Account
///</summary>
[<DataMember>]
member val Account:String = null with get,set
///<summary>
///3 letter city code
///</summary>
[<DataMember>]
member val CityCode:String = null with get,set
///<summary>
///Date search type option, a single character (T to search by segment start dates, C to search by booking creation dates).
///</summary>
[<DataMember>]
member val DateSearchType:String = null with get,set
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 /PassiveSegments 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>
<Address>String</Address>
<AgentivityRef>0</AgentivityRef>
<BookingReasonCode>String</BookingReasonCode>
<BookingSource>String</BookingSource>
<CityCode>String</CityCode>
<CommissionInformation>String</CommissionInformation>
<ConfirmationNumber>String</ConfirmationNumber>
<CountryName>String</CountryName>
<HotelCommission>String</HotelCommission>
<NbrNights>String</NbrNights>
<OwningConsultantID>String</OwningConsultantID>
<PropertyName>String</PropertyName>
<PropertyNumber>String</PropertyNumber>
<RateAccessCode>String</RateAccessCode>
<RateCode>String</RateCode>
<RateQuoted>String</RateQuoted>
<SegmentType>String</SegmentType>
<ServiceInformation>String</ServiceInformation>
<StartDate>String</StartDate>
<Text>String</Text>
<TotalAirSegs>String</TotalAirSegs>
<VendorCode>String</VendorCode>
<RecordLocator>String</RecordLocator>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<OwningConsultant>String</OwningConsultant>
<Account>String</Account>
<Passenger>String</Passenger>
<DepartureDate>String</DepartureDate>
<SegmentStatus>String</SegmentStatus>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>