| All Verbs | /ConsultantFocus |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AgentivityAPI.ServiceModel.Types
Imports AgentivityAPI.ServiceModel.Base
Imports AgentivityAPI.ServiceModel
Namespace Global
Namespace AgentivityAPI.ServiceModel
<DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
Public Partial Class CollectionResponse(Of TItem)
<DataMember(Order:=1)>
Public Overridable Property ResponseMetadata As ResponseMetadata
<DataMember(Order:=2, EmitDefaultValue:=false)>
Public Overridable Property ResponseReport As List(Of ApiRequestPerHour)
<DataMember(Order:=3, EmitDefaultValue:=false)>
Public Overridable Property ResponseError As AgentivityError
End Class
End Namespace
Namespace AgentivityAPI.ServiceModel.Base
<DataContract(Namespace:="schemas.agentivity.com/types")>
Public Partial Class CompanyLevelRequestBase
Inherits PagingMetadata
Implements IMemberUsername
Implements IMemberOwningCompanyCode
'''<Summary>
'''Comma Delimited List of Owning Company Codes
'''</Summary>
<DataMember>
Public Overridable Property OwningCompanyCode As String() Implements IMemberOwningCompanyCode.OwningCompanyCode
'''<Summary>
'''UserName in form of an email address
'''</Summary>
<DataMember>
Public Overridable Property UserName As String Implements IMemberUsername.UserName
End Class
End Namespace
Namespace AgentivityAPI.ServiceModel.Types
<DataContract(Name:="ActiveUnsoldAirBookings", Namespace:="schemas.agentivity.com/types")>
Public Partial Class ActiveUnsoldAirBookings
Implements IBookingItinerary
<DataMember(Order:=10)>
Public Overridable Property RecordLocator As String
<DataMember(Order:=20)>
Public Overridable Property PNRCreationDate As Date?
<DataMember(Order:=30)>
Public Overridable Property OwningAgencyLocationID As String
<DataMember(Order:=35)>
Public Overridable Property GdsCode As String
<DataMember(Order:=40)>
Public Overridable Property PrimaryPax As String
<DataMember(Order:=50)>
Public Overridable Property OwningConsultant As String
<DataMember(Order:=55)>
Public Overridable Property OwningConsultantID As String
<DataMember(Order:=60)>
Public Overridable Property Account As String
<DataMember(Order:=100)>
Public Overridable Property PrimaryCarrierCode As String
<DataMember(Order:=110)>
Public Overridable Property FiledFare As String
<DataMember(Order:=120)>
Public Overridable Property TravelDate As Date?
<DataMember(Order:=130)>
Public Overridable Property DestinationCities As String
<DataMember(Order:=140)>
Public Overridable Property BookingClasses As String
<DataMember(Order:=90)>
Public Overridable Property AgentivityRef As Integer Implements IBookingItinerary.AgentivityRef
<DataMember(Order:=200)>
Public Overridable Property Itinerary As ItinerarySegmentsCollection Implements IBookingItinerary.Itinerary
<DataMember(Order:=210)>
Public Overridable Property ItineraryFormatted As String Implements IBookingItinerary.ItineraryFormatted
End Class
<DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
Public Partial Class AgentivityError
<DataMember>
Public Overridable Property ErrorCode As String
<DataMember>
Public Overridable Property Message As String
<DataMember>
Public Overridable Property StatusCode As String
<DataMember>
Public Overridable Property VerboseMessage As String
End Class
<DataContract(Name:="AirlineDemandsForTicketing", Namespace:="schemas.agentivity.com/types")>
Public Partial Class AirlineDemandsForTicketing
<DataMember(Order:=10)>
Public Overridable Property RecordLocator As String
<DataMember(Order:=15)>
Public Overridable Property PNRCreationDate As Date?
<DataMember(Order:=20)>
Public Overridable Property PrimaryPax As String
<DataMember(Order:=30)>
Public Overridable Property OwningConsultantID As String
<DataMember(Order:=35)>
Public Overridable Property OwningConsultant As String
<DataMember(Order:=40)>
Public Overridable Property Account As String
<DataMember(Order:=50)>
Public Overridable Property AirlineCode As String
<DataMember(Order:=55)>
Public Overridable Property DueDate As Date?
<DataMember(Order:=60)>
Public Overridable Property DueTime As String
<DataMember(Order:=70)>
Public Overridable Property OwningAgencyLocationID As String
<DataMember(Order:=80)>
Public Overridable Property GdsCode As String
<DataMember(Order:=90)>
Public Overridable Property AgentivityRef As Integer?
End Class
<DataContract(Name:="ApiRequestPerHour", Namespace:="schemas.agentivity.com/types")>
Public Partial Class ApiRequestPerHour
<DataMember(Order:=10)>
Public Overridable Property RequestDate As Date
<DataMember(Order:=100)>
Public Overridable Property Hour0 As Integer
<DataMember(Order:=110)>
Public Overridable Property Hour1 As Integer
<DataMember(Order:=120)>
Public Overridable Property Hour2 As Integer
<DataMember(Order:=130)>
Public Overridable Property Hour3 As Integer
<DataMember(Order:=140)>
Public Overridable Property Hour4 As Integer
<DataMember(Order:=150)>
Public Overridable Property Hour5 As Integer
<DataMember(Order:=160)>
Public Overridable Property Hour6 As Integer
<DataMember(Order:=170)>
Public Overridable Property Hour7 As Integer
<DataMember(Order:=180)>
Public Overridable Property Hour8 As Integer
<DataMember(Order:=190)>
Public Overridable Property Hour9 As Integer
<DataMember(Order:=200)>
Public Overridable Property Hour10 As Integer
<DataMember(Order:=210)>
Public Overridable Property Hour11 As Integer
<DataMember(Order:=220)>
Public Overridable Property Hour12 As Integer
<DataMember(Order:=230)>
Public Overridable Property Hour13 As Integer
<DataMember(Order:=240)>
Public Overridable Property Hour14 As Integer
<DataMember(Order:=250)>
Public Overridable Property Hour15 As Integer
<DataMember(Order:=260)>
Public Overridable Property Hour16 As Integer
<DataMember(Order:=270)>
Public Overridable Property Hour17 As Integer
<DataMember(Order:=280)>
Public Overridable Property Hour18 As Integer
<DataMember(Order:=290)>
Public Overridable Property Hour19 As Integer
<DataMember(Order:=300)>
Public Overridable Property Hour20 As Integer
<DataMember(Order:=310)>
Public Overridable Property Hour21 As Integer
<DataMember(Order:=320)>
Public Overridable Property Hour22 As Integer
<DataMember(Order:=330)>
Public Overridable Property Hour23 As Integer
End Class
<DataContract(Name:="Warning", Namespace:="schemas.agentivity.com/types")>
Public Partial Class BookingWarning
<DataMember(Order:=10)>
Public Overridable Property WarningType As String
<DataMember(Order:=20)>
Public Overridable Property Vendor As String
<DataMember(Order:=30)>
Public Overridable Property VendorType As String
<DataMember(Order:=40)>
Public Overridable Property WarningDateTime As Date?
<DataMember(Order:=50)>
Public Overridable Property LogDateTime As Date?
<DataMember(Order:=60)>
Public Overridable Property OriginalRemark As String
<DataMember(Order:=70)>
Public Overridable Property PropertiesList As List(Of BookingWarningProperty)
End Class
<DataContract(Name:="Property", Namespace:="schemas.agentivity.com/types")>
Public Partial Class BookingWarningProperty
<DataMember(Order:=10)>
Public Overridable Property Name As String
<DataMember(Order:=20)>
Public Overridable Property Value As String
End Class
<DataContract(Name:="BookingWithWarnings", Namespace:="schemas.agentivity.com/types")>
Public Partial Class BookingWithWarnings
<DataMember(Order:=10)>
Public Overridable Property RecordLocator As String
<DataMember(Order:=20)>
Public Overridable Property PNRCreationDate As Date
<DataMember(Order:=30)>
Public Overridable Property AgentivityRef As Integer
<DataMember(Order:=40)>
Public Overridable Property OwningConsultant As String
<DataMember(Order:=50)>
Public Overridable Property Account As String
<DataMember(Order:=60)>
Public Overridable Property OwningConsultantID As String
<DataMember(Order:=70)>
Public Overridable Property OwningAgencyLocationID As String
<DataMember(Order:=75)>
Public Overridable Property GdsCode As String
<DataMember(Order:=80)>
Public Overridable Property TravelDate As Date?
<DataMember(Order:=90)>
Public Overridable Property PrimaryPax As String
<DataMember(Order:=1000)>
Public Overridable Property WarningsList As List(Of BookingWarning)
End Class
<DataContract(Name:="CacheMetadata", Namespace:="schemas.agentivity.com/types")>
Public Partial Class CacheMetadata
<DataMember(Order:=1)>
Public Overridable Property CachedAt As Date
<DataMember(Order:=2)>
Public Overridable Property CacheExpiresAt As Date
<DataMember(Order:=0)>
Public Overridable Property IsFromCache As Boolean
End Class
<Flags>
Public Enum ConsultantFocusOptions
[Default] = 0
ProblematicSegments = 1
AirlineDemandsForTicketing = 2
Standard = 3
ActiveUnsoldAirBookings = 4
BookingsWithWarnings = 8
All = 15
End Enum
<DataContract(Name:="ConsultantFocusResult", Namespace:="schemas.agentivity.com/types")>
Public Partial Class ConsultantFocusResult
<DataMember(Order:=10)>
Public Overridable Property ProblematicSegments As List(Of ProblematicSegment)
<DataMember(Order:=20)>
Public Overridable Property AirlineDemandsForTicketing As List(Of AirlineDemandsForTicketing)
<DataMember(Order:=30)>
Public Overridable Property ActiveUnsoldAirBookings As List(Of ActiveUnsoldAirBookings)
<DataMember(Order:=40)>
Public Overridable Property BookingsWithWarnings As List(Of BookingWithWarnings)
End Class
<DataContract(Namespace:="schemas.agentivity.com/types")>
Public Partial Class GetConsultantFocus
Inherits CompanyLevelRequestBase
Implements IRequestConsultantID
'''<Summary>
'''Date in format YYYYMMDD
'''</Summary>
<DataMember>
Public Overridable Property DateStart As String
'''<Summary>
'''Date in format YYYYMMDD
'''</Summary>
<DataMember>
Public Overridable Property DateEnd As String
'''<Summary>
'''Comma delimited list of owning consultants ids
'''</Summary>
<DataMember>
Public Overridable Property OwningConsultantID As String() = New String(){}
'''<Summary>
'''Comma delimited list of transaction agency location ids
'''</Summary>
<DataMember>
Public Overridable Property TransactionAgencyLocationID As String()
'''<Summary>
'''Options to retrieve consultant focus data. Use All to include the Active Unsold Air Bookings.
'''</Summary>
<DataMember>
Public Overridable Property Options As ConsultantFocusOptions
'''<Summary>
'''Request Consultant ID (sign on)
'''</Summary>
<DataMember>
Public Overridable Property RequestConsultantID As String Implements IRequestConsultantID.RequestConsultantID
End Class
<DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
Public Partial Class GetConsultantFocusResponse
Inherits CollectionResponse(Of ConsultantFocusResult)
End Class
<DataContract(Name:="ItinerarySegment", Namespace:="schemas.agentivity.com/types")>
Public Partial Class ItinerarySegment
<DataMember>
Public Overridable Property SegmentType As String
<DataMember>
Public Overridable Property SegmentNbr As Integer
<DataMember>
Public Overridable Property BoardPoint As String
<DataMember>
Public Overridable Property OffPoint As String
<DataMember>
Public Overridable Property OperatorCode As String
<DataMember>
Public Overridable Property OperatorService As String
<DataMember>
Public Overridable Property SegmentStatus As String
<DataMember>
Public Overridable Property DepartureTimeFormatted As String
<DataMember>
Public Overridable Property ArrivalTimeFormatted As String
<DataMember>
Public Overridable Property ChangeOfDayFormatted As String
<DataMember>
Public Overridable Property ServiceCode As String
<DataMember>
Public Overridable Property StartDate As String
<DataMember>
Public Overridable Property EndDate As String
<DataMember>
Public Overridable Property TicketNumber As String
'''<Summary>
'''Comma separated list of vendor locators
'''</Summary>
<DataMember>
Public Overridable Property VendorLocators As String
<DataMember>
Public Overridable Property EquipmentCode As String
<DataMember>
Public Overridable Property Equipment As String
End Class
Public Partial Class ItinerarySegmentsCollection
Inherits List(Of ItinerarySegment)
End Class
<DataContract(Name:="Metadata", Namespace:="schemas.agentivity.com/types")>
Public Partial Class PagingMetadata
'''<Summary>
'''Starting Record
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Starting Record", Name:="Offset", ParameterType:="query")>
Public Overridable Property Offset As String
'''<Summary>
'''Number of records to return (PageSize)
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Number of records to return (PageSize)", Name:="Limit", ParameterType:="query")>
Public Overridable Property Limit As String
'''<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")>
Public Overridable Property TotalRecords As Integer
'''<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")>
Public Overridable Property ResponseRecords As Integer
End Class
<DataContract(Name:="ProblematicSegment", Namespace:="schemas.agentivity.com/types")>
Public Partial Class ProblematicSegment
<DataMember(Order:=10)>
Public Overridable Property RecordLocator As String
<DataMember(Order:=15)>
Public Overridable Property PNRCreationDate As Date?
<DataMember(Order:=20)>
Public Overridable Property OwningConsultantID As String
<DataMember(Order:=25)>
Public Overridable Property OwningConsultant As String
<DataMember(Order:=30)>
Public Overridable Property PrimaryPax As String
<DataMember(Order:=50)>
Public Overridable Property Account As String
<DataMember(Order:=60)>
Public Overridable Property SegmentStatus As String
<DataMember(Order:=70)>
Public Overridable Property Segment As String
<DataMember(Order:=80)>
Public Overridable Property OwningAgencyLocationID As String
<DataMember(Order:=90)>
Public Overridable Property GdsCode As String
<DataMember(Order:=100)>
Public Overridable Property DepartureDate As Date?
<DataMember(Order:=110)>
Public Overridable Property AgentivityRef As String
End Class
<DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
Public Partial Class ResponseMetadata
<DataMember(Order:=0)>
Public Overridable Property Success As Boolean
<DataMember(Order:=1)>
Public Overridable Property HasCache As Boolean
<DataMember(Order:=2)>
Public Overridable Property HasPaging As Boolean
<DataMember(Order:=3, EmitDefaultValue:=false)>
Public Overridable Property CacheMetadata As CacheMetadata
<DataMember(Order:=4, EmitDefaultValue:=false)>
Public Overridable Property PagingMetadata As PagingMetadata
End Class
End Namespace
End Namespace
VB.NET GetConsultantFocus DTOs
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>