| GET | /EventBookings |
|---|
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="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="EventBooking", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type EventBooking() =
[<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 PaxList:String = null with get,set
[<DataMember(Order=35)>]
member val PaxCount:Int32 = new Int32() with get,set
[<DataMember(Order=70)>]
member val InboundAirline:String = null with get,set
[<DataMember(Order=80)>]
member val InboundFlightNumber:String = null with get,set
[<DataMember(Order=90)>]
member val InboundArrivalCity:String = null with get,set
[<DataMember(Order=100)>]
member val InboundArrivalDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=110)>]
member val InboundArrivalTime:String = null with get,set
[<DataMember(Order=120)>]
member val OutboundAirline:String = null with get,set
[<DataMember(Order=130)>]
member val OutboundFlightNumber:String = null with get,set
[<DataMember(Order=140)>]
member val OutboundDepartureCity:String = null with get,set
[<DataMember(Order=150)>]
member val OutboundDepartureDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=160)>]
member val OutboundDepartureTime:String = null with get,set
[<DataMember(Order=170)>]
member val Notes:String = null with get,set
[<DataMember(Order=180)>]
member val Emails:String = null with get,set
[<DataMember(Order=190)>]
member val Mobile:String = null with get,set
[<DataMember(Order=200)>]
member val TotalTicketedValue:String = null with get,set
[<DataMember(Order=40)>]
member val AgentivityRef:Int32 = new Int32() with get,set
[<DataMember(Order=50)>]
member val ItineraryFormatted:String = null with get,set
[<DataMember(Order=60)>]
member val Itinerary:ItinerarySegmentsCollection = 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="EventBooking", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type EventBookingsResponseReport() =
inherit Report<EventBookingsItemResponse, EventBooking>()
[<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 EventBookingsItemResponse() =
inherit ItemResponse<EventBooking, EventBookingsResponseReport>()
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type EventBookingsRequest() =
inherit PagingMetadata()
///<summary>
///UserName in form of an email address
///</summary>
[<DataMember>]
member val UserName:String = null with get,set
///<summary>
///Event code
///</summary>
[<DataMember>]
member val EventCode:String = null with get,set
///<summary>
///Split multiple passengers
///</summary>
[<DataMember>]
member val SplitMultiplePassengers:Boolean = new Boolean() with get,set
///<summary>
///Include notes in the response
///</summary>
[<DataMember>]
member val IncludeNotes:Boolean = new Boolean() with get,set
///<summary>
///Include arrival departures
///</summary>
[<DataMember>]
member val IncludeArrivalDepartures:Boolean = new Boolean() with get,set
///<summary>
///Indicate the required formatting: 0=None(Default), 1=Html, 2=Chart
///</summary>
[<DataMember>]
member val FormattingStyle:Int32 = new Int32() with get,set
///<summary>
///Itinerary segments to show
///</summary>
[<DataMember>]
member val ItinerarySegmentsToShow: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 /EventBookings 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>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<PaxList>String</PaxList>
<PaxCount>0</PaxCount>
<AgentivityRef>0</AgentivityRef>
<ItineraryFormatted>String</ItineraryFormatted>
<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>
<InboundAirline>String</InboundAirline>
<InboundFlightNumber>String</InboundFlightNumber>
<InboundArrivalCity>String</InboundArrivalCity>
<InboundArrivalDate>0001-01-01T00:00:00</InboundArrivalDate>
<InboundArrivalTime>String</InboundArrivalTime>
<OutboundAirline>String</OutboundAirline>
<OutboundFlightNumber>String</OutboundFlightNumber>
<OutboundDepartureCity>String</OutboundDepartureCity>
<OutboundDepartureDate>0001-01-01T00:00:00</OutboundDepartureDate>
<OutboundDepartureTime>String</OutboundDepartureTime>
<Notes>String</Notes>
<Emails>String</Emails>
<Mobile>String</Mobile>
<TotalTicketedValue>String</TotalTicketedValue>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>