| All Verbs | /BookingEventsDetails |
|---|
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="Event", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type EventTypeItem() =
[<DataMember(Order=10)>]
member val EventType:String = null with get,set
[<DataMember(Order=20)>]
member val EventDateTime:Nullable<DateTime> = new Nullable<DateTime>() 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
[<DataContract(Name="ItinerarySegment", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type BookingExtItinerarySegment() =
inherit ItinerarySegment()
[<DataMember>]
member val OperatorCodeName:String = null with get,set
[<DataMember>]
member val ServiceCodeName:String = null with get,set
[<DataContract(Name="BookingEvents", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type BookingEventsDetail() =
[<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 Events:ResizeArray<EventTypeItem> = null with get,set
[<DataMember(Order=40)>]
member val AgentivityRef:Int32 = new Int32() with get,set
[<DataMember(Order=50)>]
member val Itinerary:ResizeArray<BookingExtItinerarySegment> = null with get,set
[<DataMember(Order=60)>]
member val TicketNumbers:String[] = 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 GetBookingEventsDetailsResponse() =
inherit CollectionResponse<BookingEventsDetail>()
[<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 GetBookingEventsDetails() =
inherit CompanyLevelRequestBase()
///<summary>
///Date in format YYYYMMDD
///</summary>
[<DataMember>]
member val EventDateStart:String = null with get,set
///<summary>
///Date in format YYYYMMDD
///</summary>
[<DataMember>]
member val EventDateEnd:String = null with get,set
///<summary>
///Comma Delimited List of Event Types
///</summary>
[<DataMember>]
member val EventType:String[] = null with get,set
///<summary>
///Comma Delimited List of PCCs
///</summary>
[<DataMember>]
member val OwningAgencyLocationID:String[] = null with get,set
F# GetBookingEventsDetails DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /BookingEventsDetails HTTP/1.1
Host: api.agentivity.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"EventDateStart":"String","EventDateEnd":"String","EventType":["String"],"OwningAgencyLocationID":["String"],"OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","Events":[{"EventType":"String","EventDateTime":"\/Date(-62135596800000-0000)\/"}],"AgentivityRef":0,"Itinerary":[{"OperatorCodeName":"String","ServiceCodeName":"String","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"}],"TicketNumbers":["String"]}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}