| GET | /PassengerDepartures |
|---|
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 ItemResponse(Of TItem, TReport)
<DataMember(Order:=1)>
Public Overridable Property ResponseMetadata As ResponseMetadata
<DataMember(Order:=2, EmitDefaultValue:=false)>
Public Overridable Property ResponseReport As TReport
<DataMember(Order:=3, EmitDefaultValue:=false)>
Public Overridable Property ResponseError As AgentivityError
End Class
<DataContract(Namespace:="schemas.agentivity.com/types")>
Public Partial Class Report(Of TItemResponse, TItem)
<DataMember(Order:=1, EmitDefaultValue:=false)>
Public Overridable Property Item As TItem
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:="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:="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 FormattingStyle
None = 0
Html = 1
Charting = 2
End Enum
<DataContract(Namespace:="schemas.agentivity.com/types")>
Public Partial Class GetPassengerDepartures
Inherits CompanyLevelRequestBase
'''<Summary>
'''Comma Delimited List of Accounts
'''</Summary>
<DataMember>
Public Overridable Property Account As String()
'''<Summary>
'''Name of the class
'''</Summary>
<DataMember>
Public Overridable Property ClassName As String()
'''<Summary>
'''Carrier name
'''</Summary>
<DataMember>
Public Overridable Property Carrier As String()
'''<Summary>
'''Date in format YYYYMMDD
'''</Summary>
<DataMember>
Public Overridable Property TravelDateStart As String
'''<Summary>
'''Date in format YYYYMMDD
'''</Summary>
<DataMember>
Public Overridable Property TravelDateEnd As String
'''<Summary>
'''Include items with SMS sent in response
'''</Summary>
<DataMember>
Public Overridable Property WithSMS As Boolean?
'''<Summary>
'''Add transfers
'''</Summary>
<DataMember>
Public Overridable Property AddVouchers As Boolean
'''<Summary>
'''Add transfers
'''</Summary>
<DataMember>
Public Overridable Property AddTransfers As Boolean
'''<Summary>
'''Include Itinerary in the response
'''</Summary>
<DataMember>
Public Overridable Property IncludeItinerary As Boolean
'''<Summary>
'''Return only PNRs that are or are not flagged as VIP bookings
'''</Summary>
<DataMember>
Public Overridable Property IsVip As Boolean?
'''<Summary>
'''Show SMS
'''</Summary>
<DataMember>
Public Overridable Property ShowSMS As Boolean
'''<Summary>
'''Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
'''</Summary>
<DataMember>
Public Overridable Property ItineraryFormatting As FormattingStyle
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:="PassengerDeparture", Namespace:="schemas.agentivity.com/types")>
Public Partial Class PassengerDeparture
Implements IBookingItinerary
<DataMember(Order:=10)>
Public Overridable Property AgentivityRef As Integer Implements IBookingItinerary.AgentivityRef
<DataMember(Order:=20)>
Public Overridable Property RecordLocator As String
<DataMember(Order:=25)>
Public Overridable Property OwningAgencyLocationID As String
<DataMember(Order:=30)>
Public Overridable Property OwningConsultant As String
<DataMember(Order:=35)>
Public Overridable Property OwningConsultantID As String
<DataMember(Order:=40)>
Public Overridable Property GdsCode As String
<DataMember(Order:=45)>
Public Overridable Property Passenger As String
<DataMember(Order:=50)>
Public Overridable Property Account As String
<DataMember(Order:=60)>
Public Overridable Property TravelDate As Date?
<DataMember(Order:=70)>
Public Overridable Property TicketedStatusCode As String
<DataMember(Order:=75)>
Public Overridable Property TicketedStatus As String
<DataMember(Order:=80)>
Public Overridable Property SupplierReference As String
<DataMember(Order:=85)>
Public Overridable Property SMS As String
<DataMember(Order:=90)>
Public Overridable Property Vouchers As String
<DataMember(Order:=100)>
Public Overridable Property Transfers As String
<DataMember(Order:=110)>
Public Overridable Property IsVip As Boolean
<DataMember(Order:=120)>
Public Overridable Property PhoneNbr As String
<DataMember(Order:=130)>
Public Overridable Property EmailAddress As String
<DataMember(Order:=140)>
Public Overridable Property DestinationCities As String
<DataMember(Order:=150)>
Public Overridable Property DestinationCountries As String
<DataMember(Order:=160)>
Public Overridable Property Connections As String
<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:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
Public Partial Class PassengerDeparturesItemResponse
Inherits ItemResponse(Of PassengerDeparture, PassengerDeparturesResponseReport)
End Class
<DataContract(Name:="PassengerDeparture", Namespace:="schemas.agentivity.com/types")>
Public Partial Class PassengerDeparturesResponseReport
Inherits Report(Of PassengerDeparturesItemResponse, PassengerDeparture)
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 GetPassengerDepartures 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 /PassengerDepartures 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,"RecordLocator":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","OwningConsultantID":"String","GdsCode":"String","Passenger":"String","Account":"String","TravelDate":"\/Date(-62135596800000-0000)\/","TicketedStatusCode":"String","TicketedStatus":"String","SupplierReference":"String","SMS":"String","Vouchers":"String","Transfers":"String","IsVip":false,"PhoneNbr":"String","EmailAddress":"String","DestinationCities":"String","DestinationCountries":"String","Connections":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"ItineraryFormatted":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}