| All Verbs | /ConsultantFocus |
|---|
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="ProblematicSegment", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ProblematicSegment() =
[<DataMember(Order=10)>]
member val RecordLocator:String = null with get,set
[<DataMember(Order=15)>]
member val PNRCreationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=20)>]
member val OwningConsultantID:String = null with get,set
[<DataMember(Order=25)>]
member val OwningConsultant:String = null with get,set
[<DataMember(Order=30)>]
member val PrimaryPax:String = null with get,set
[<DataMember(Order=50)>]
member val Account:String = null with get,set
[<DataMember(Order=60)>]
member val SegmentStatus:String = null with get,set
[<DataMember(Order=70)>]
member val Segment:String = null with get,set
[<DataMember(Order=80)>]
member val OwningAgencyLocationID:String = null with get,set
[<DataMember(Order=90)>]
member val GdsCode:String = null with get,set
[<DataMember(Order=100)>]
member val DepartureDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=110)>]
member val AgentivityRef:String = null with get,set
[<DataContract(Name="AirlineDemandsForTicketing", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type AirlineDemandsForTicketing() =
[<DataMember(Order=10)>]
member val RecordLocator:String = null with get,set
[<DataMember(Order=15)>]
member val PNRCreationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=20)>]
member val PrimaryPax:String = null with get,set
[<DataMember(Order=30)>]
member val OwningConsultantID:String = null with get,set
[<DataMember(Order=35)>]
member val OwningConsultant:String = null with get,set
[<DataMember(Order=40)>]
member val Account:String = null with get,set
[<DataMember(Order=50)>]
member val AirlineCode:String = null with get,set
[<DataMember(Order=55)>]
member val DueDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=60)>]
member val DueTime:String = null with get,set
[<DataMember(Order=70)>]
member val OwningAgencyLocationID:String = null with get,set
[<DataMember(Order=80)>]
member val GdsCode:String = null with get,set
[<DataMember(Order=90)>]
member val AgentivityRef:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataContract(Name="ItinerarySegment", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ItinerarySegment() =
[<DataMember>]
member val SegmentType:String = null with get,set
[<DataMember>]
member val SegmentNbr:Int32 = new Int32() with get,set
[<DataMember>]
member val BoardPoint:String = null with get,set
[<DataMember>]
member val OffPoint:String = null with get,set
[<DataMember>]
member val OperatorCode:String = null with get,set
[<DataMember>]
member val OperatorService:String = null with get,set
[<DataMember>]
member val SegmentStatus:String = null with get,set
[<DataMember>]
member val DepartureTimeFormatted:String = null with get,set
[<DataMember>]
member val ArrivalTimeFormatted:String = null with get,set
[<DataMember>]
member val ChangeOfDayFormatted:String = null with get,set
[<DataMember>]
member val ServiceCode:String = null with get,set
[<DataMember>]
member val StartDate:String = null with get,set
[<DataMember>]
member val EndDate:String = null with get,set
[<DataMember>]
member val TicketNumber:String = null with get,set
///<summary>
///Comma separated list of vendor locators
///</summary>
[<DataMember>]
member val VendorLocators:String = null with get,set
[<DataMember>]
member val EquipmentCode:String = null with get,set
[<DataMember>]
member val Equipment:String = null with get,set
[<AllowNullLiteral>]
type ItinerarySegmentsCollection() =
inherit ResizeArray<ItinerarySegment>()
[<DataContract(Name="ActiveUnsoldAirBookings", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ActiveUnsoldAirBookings() =
[<DataMember(Order=10)>]
member val RecordLocator:String = null with get,set
[<DataMember(Order=20)>]
member val PNRCreationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=30)>]
member val OwningAgencyLocationID:String = null with get,set
[<DataMember(Order=35)>]
member val GdsCode:String = null with get,set
[<DataMember(Order=40)>]
member val PrimaryPax:String = null with get,set
[<DataMember(Order=50)>]
member val OwningConsultant:String = null with get,set
[<DataMember(Order=55)>]
member val OwningConsultantID:String = null with get,set
[<DataMember(Order=60)>]
member val Account:String = null with get,set
[<DataMember(Order=100)>]
member val PrimaryCarrierCode:String = null with get,set
[<DataMember(Order=110)>]
member val FiledFare:String = null with get,set
[<DataMember(Order=120)>]
member val TravelDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=130)>]
member val DestinationCities:String = null with get,set
[<DataMember(Order=140)>]
member val BookingClasses:String = null with get,set
[<DataMember(Order=90)>]
member val AgentivityRef:Int32 = new Int32() with get,set
[<DataMember(Order=200)>]
member val Itinerary:ItinerarySegmentsCollection = null with get,set
[<DataMember(Order=210)>]
member val ItineraryFormatted:String = null with get,set
[<DataContract(Name="Property", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type BookingWarningProperty() =
[<DataMember(Order=10)>]
member val Name:String = null with get,set
[<DataMember(Order=20)>]
member val Value:String = null with get,set
[<DataContract(Name="Warning", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type BookingWarning() =
[<DataMember(Order=10)>]
member val WarningType:String = null with get,set
[<DataMember(Order=20)>]
member val Vendor:String = null with get,set
[<DataMember(Order=30)>]
member val VendorType:String = null with get,set
[<DataMember(Order=40)>]
member val WarningDateTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=50)>]
member val LogDateTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=60)>]
member val OriginalRemark:String = null with get,set
[<DataMember(Order=70)>]
member val PropertiesList:ResizeArray<BookingWarningProperty> = null with get,set
[<DataContract(Name="BookingWithWarnings", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type BookingWithWarnings() =
[<DataMember(Order=10)>]
member val RecordLocator:String = null with get,set
[<DataMember(Order=20)>]
member val PNRCreationDate:DateTime = new DateTime() with get,set
[<DataMember(Order=30)>]
member val AgentivityRef:Int32 = new Int32() with get,set
[<DataMember(Order=40)>]
member val OwningConsultant:String = null with get,set
[<DataMember(Order=50)>]
member val Account:String = null with get,set
[<DataMember(Order=60)>]
member val OwningConsultantID:String = null with get,set
[<DataMember(Order=70)>]
member val OwningAgencyLocationID:String = null with get,set
[<DataMember(Order=75)>]
member val GdsCode:String = null with get,set
[<DataMember(Order=80)>]
member val TravelDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=90)>]
member val PrimaryPax:String = null with get,set
[<DataMember(Order=1000)>]
member val WarningsList:ResizeArray<BookingWarning> = null with get,set
[<DataContract(Name="ConsultantFocusResult", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ConsultantFocusResult() =
[<DataMember(Order=10)>]
member val ProblematicSegments:ResizeArray<ProblematicSegment> = null with get,set
[<DataMember(Order=20)>]
member val AirlineDemandsForTicketing:ResizeArray<AirlineDemandsForTicketing> = null with get,set
[<DataMember(Order=30)>]
member val ActiveUnsoldAirBookings:ResizeArray<ActiveUnsoldAirBookings> = null with get,set
[<DataMember(Order=40)>]
member val BookingsWithWarnings:ResizeArray<BookingWithWarnings> = null with get,set
[<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="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ApiRequestPerHour() =
[<DataMember(Order=10)>]
member val RequestDate:DateTime = new DateTime() with get,set
[<DataMember(Order=100)>]
member val Hour0:Int32 = new Int32() with get,set
[<DataMember(Order=110)>]
member val Hour1:Int32 = new Int32() with get,set
[<DataMember(Order=120)>]
member val Hour2:Int32 = new Int32() with get,set
[<DataMember(Order=130)>]
member val Hour3:Int32 = new Int32() with get,set
[<DataMember(Order=140)>]
member val Hour4:Int32 = new Int32() with get,set
[<DataMember(Order=150)>]
member val Hour5:Int32 = new Int32() with get,set
[<DataMember(Order=160)>]
member val Hour6:Int32 = new Int32() with get,set
[<DataMember(Order=170)>]
member val Hour7:Int32 = new Int32() with get,set
[<DataMember(Order=180)>]
member val Hour8:Int32 = new Int32() with get,set
[<DataMember(Order=190)>]
member val Hour9:Int32 = new Int32() with get,set
[<DataMember(Order=200)>]
member val Hour10:Int32 = new Int32() with get,set
[<DataMember(Order=210)>]
member val Hour11:Int32 = new Int32() with get,set
[<DataMember(Order=220)>]
member val Hour12:Int32 = new Int32() with get,set
[<DataMember(Order=230)>]
member val Hour13:Int32 = new Int32() with get,set
[<DataMember(Order=240)>]
member val Hour14:Int32 = new Int32() with get,set
[<DataMember(Order=250)>]
member val Hour15:Int32 = new Int32() with get,set
[<DataMember(Order=260)>]
member val Hour16:Int32 = new Int32() with get,set
[<DataMember(Order=270)>]
member val Hour17:Int32 = new Int32() with get,set
[<DataMember(Order=280)>]
member val Hour18:Int32 = new Int32() with get,set
[<DataMember(Order=290)>]
member val Hour19:Int32 = new Int32() with get,set
[<DataMember(Order=300)>]
member val Hour20:Int32 = new Int32() with get,set
[<DataMember(Order=310)>]
member val Hour21:Int32 = new Int32() with get,set
[<DataMember(Order=320)>]
member val Hour22:Int32 = new Int32() with get,set
[<DataMember(Order=330)>]
member val Hour23:Int32 = new Int32() 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 CollectionResponse<TItem>() =
[<DataMember(Order=1)>]
member val ResponseMetadata:ResponseMetadata = null with get,set
[<DataMember(Order=2, EmitDefaultValue=false)>]
member val ResponseReport:ResizeArray<ApiRequestPerHour> = 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 GetConsultantFocusResponse() =
inherit CollectionResponse<ConsultantFocusResult>()
[<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
[<Flags>]
type ConsultantFocusOptions =
| Default = 0
| ProblematicSegments = 1
| AirlineDemandsForTicketing = 2
| Standard = 3
| ActiveUnsoldAirBookings = 4
| BookingsWithWarnings = 8
| All = 15
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type GetConsultantFocus() =
inherit CompanyLevelRequestBase()
///<summary>
///Date in format YYYYMMDD
///</summary>
[<DataMember>]
member val DateStart:String = null with get,set
///<summary>
///Date in format YYYYMMDD
///</summary>
[<DataMember>]
member val DateEnd:String = null with get,set
///<summary>
///Comma delimited list of owning consultants ids
///</summary>
[<DataMember>]
member val OwningConsultantID:String[] = null with get,set
///<summary>
///Comma delimited list of transaction agency location ids
///</summary>
[<DataMember>]
member val TransactionAgencyLocationID:String[] = null with get,set
///<summary>
///Options to retrieve consultant focus data. Use All to include the Active Unsold Air Bookings.
///</summary>
[<DataMember>]
member val Options:ConsultantFocusOptions = new ConsultantFocusOptions() with get,set
///<summary>
///Request Consultant ID (sign on)
///</summary>
[<DataMember>]
member val RequestConsultantID: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.
POST /ConsultantFocus HTTP/1.1
Host: api.agentivity.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetConsultantFocus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
<OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OwningCompanyCode>
<UserName>String</UserName>
<DateEnd>String</DateEnd>
<DateStart>String</DateStart>
<Options>Default</Options>
<OwningConsultantID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OwningConsultantID>
<RequestConsultantID>String</RequestConsultantID>
<TransactionAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TransactionAgencyLocationID>
</GetConsultantFocus>
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>
<ConsultantFocusResult>
<ProblematicSegments>
<ProblematicSegment>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<OwningConsultantID>String</OwningConsultantID>
<OwningConsultant>String</OwningConsultant>
<PrimaryPax>String</PrimaryPax>
<Account>String</Account>
<SegmentStatus>String</SegmentStatus>
<Segment>String</Segment>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<GdsCode>String</GdsCode>
<DepartureDate>0001-01-01T00:00:00</DepartureDate>
<AgentivityRef>String</AgentivityRef>
</ProblematicSegment>
</ProblematicSegments>
<AirlineDemandsForTicketing>
<AirlineDemandsForTicketing>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<PrimaryPax>String</PrimaryPax>
<OwningConsultantID>String</OwningConsultantID>
<OwningConsultant>String</OwningConsultant>
<Account>String</Account>
<AirlineCode>String</AirlineCode>
<DueDate>0001-01-01T00:00:00</DueDate>
<DueTime>String</DueTime>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<GdsCode>String</GdsCode>
<AgentivityRef>0</AgentivityRef>
</AirlineDemandsForTicketing>
</AirlineDemandsForTicketing>
<ActiveUnsoldAirBookings>
<ActiveUnsoldAirBookings>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<GdsCode>String</GdsCode>
<PrimaryPax>String</PrimaryPax>
<OwningConsultant>String</OwningConsultant>
<OwningConsultantID>String</OwningConsultantID>
<Account>String</Account>
<AgentivityRef>0</AgentivityRef>
<PrimaryCarrierCode>String</PrimaryCarrierCode>
<FiledFare>String</FiledFare>
<TravelDate>0001-01-01T00:00:00</TravelDate>
<DestinationCities>String</DestinationCities>
<BookingClasses>String</BookingClasses>
<Itinerary>
<ItinerarySegment>
<ArrivalTimeFormatted>String</ArrivalTimeFormatted>
<BoardPoint>String</BoardPoint>
<ChangeOfDayFormatted>String</ChangeOfDayFormatted>
<DepartureTimeFormatted>String</DepartureTimeFormatted>
<EndDate>String</EndDate>
<Equipment>String</Equipment>
<EquipmentCode>String</EquipmentCode>
<OffPoint>String</OffPoint>
<OperatorCode>String</OperatorCode>
<OperatorService>String</OperatorService>
<SegmentNbr>0</SegmentNbr>
<SegmentStatus>String</SegmentStatus>
<SegmentType>String</SegmentType>
<ServiceCode>String</ServiceCode>
<StartDate>String</StartDate>
<TicketNumber>String</TicketNumber>
<VendorLocators>String</VendorLocators>
</ItinerarySegment>
</Itinerary>
<ItineraryFormatted>String</ItineraryFormatted>
</ActiveUnsoldAirBookings>
</ActiveUnsoldAirBookings>
<BookingsWithWarnings>
<BookingWithWarnings>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<AgentivityRef>0</AgentivityRef>
<OwningConsultant>String</OwningConsultant>
<Account>String</Account>
<OwningConsultantID>String</OwningConsultantID>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<GdsCode>String</GdsCode>
<TravelDate>0001-01-01T00:00:00</TravelDate>
<PrimaryPax>String</PrimaryPax>
<WarningsList>
<Warning>
<WarningType>String</WarningType>
<Vendor>String</Vendor>
<VendorType>String</VendorType>
<WarningDateTime>0001-01-01T00:00:00</WarningDateTime>
<LogDateTime>0001-01-01T00:00:00</LogDateTime>
<OriginalRemark>String</OriginalRemark>
<PropertiesList>
<Property>
<Name>String</Name>
<Value>String</Value>
</Property>
</PropertiesList>
</Warning>
</WarningsList>
</BookingWithWarnings>
</BookingsWithWarnings>
</ConsultantFocusResult>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>