Agentivity API

EventBookingsRequest

The following routes are available for this service:
GET	/EventBookings

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

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.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

        <DataContract(Name:="EventBooking", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class EventBooking
            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 PaxList As String

            <DataMember(Order:=35)>
            Public Overridable Property PaxCount As Integer

            <DataMember(Order:=70)>
            Public Overridable Property InboundAirline As String

            <DataMember(Order:=80)>
            Public Overridable Property InboundFlightNumber As String

            <DataMember(Order:=90)>
            Public Overridable Property InboundArrivalCity As String

            <DataMember(Order:=100)>
            Public Overridable Property InboundArrivalDate As Date?

            <DataMember(Order:=110)>
            Public Overridable Property InboundArrivalTime As String

            <DataMember(Order:=120)>
            Public Overridable Property OutboundAirline As String

            <DataMember(Order:=130)>
            Public Overridable Property OutboundFlightNumber As String

            <DataMember(Order:=140)>
            Public Overridable Property OutboundDepartureCity As String

            <DataMember(Order:=150)>
            Public Overridable Property OutboundDepartureDate As Date?

            <DataMember(Order:=160)>
            Public Overridable Property OutboundDepartureTime As String

            <DataMember(Order:=170)>
            Public Overridable Property Notes As String

            <DataMember(Order:=180)>
            Public Overridable Property Emails As String

            <DataMember(Order:=190)>
            Public Overridable Property Mobile As String

            <DataMember(Order:=200)>
            Public Overridable Property TotalTicketedValue As String

            <DataMember(Order:=40)>
            Public Overridable Property AgentivityRef As Integer Implements IBookingItinerary.AgentivityRef

            <DataMember(Order:=50)>
            Public Overridable Property ItineraryFormatted As String Implements IBookingItinerary.ItineraryFormatted

            <DataMember(Order:=60)>
            Public Overridable Property Itinerary As ItinerarySegmentsCollection Implements IBookingItinerary.Itinerary
        End Class

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class EventBookingsItemResponse
            Inherits ItemResponse(Of EventBooking, EventBookingsResponseReport)
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class EventBookingsRequest
            Inherits PagingMetadata
            '''<Summary>
            '''UserName in form of an email address
            '''</Summary>
            <DataMember>
            Public Overridable Property UserName As String

            '''<Summary>
            '''Event code
            '''</Summary>
            <DataMember>
            Public Overridable Property EventCode As String

            '''<Summary>
            '''Split multiple passengers
            '''</Summary>
            <DataMember>
            Public Overridable Property SplitMultiplePassengers As Boolean

            '''<Summary>
            '''Include notes in the response
            '''</Summary>
            <DataMember>
            Public Overridable Property IncludeNotes As Boolean

            '''<Summary>
            '''Include arrival departures
            '''</Summary>
            <DataMember>
            Public Overridable Property IncludeArrivalDepartures As Boolean

            '''<Summary>
            '''Indicate the required formatting: 0=None(Default), 1=Html, 2=Chart
            '''</Summary>
            <DataMember>
            Public Overridable Property FormattingStyle As Integer

            '''<Summary>
            '''Itinerary segments to show
            '''</Summary>
            <DataMember>
            Public Overridable Property ItinerarySegmentsToShow As String
        End Class

        <DataContract(Name:="EventBooking", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class EventBookingsResponseReport
            Inherits Report(Of EventBookingsItemResponse, EventBooking)
        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:="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 EventBookingsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl

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":{"Item":{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","PaxList":"String","PaxCount":0,"AgentivityRef":0,"ItineraryFormatted":"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"}],"InboundAirline":"String","InboundFlightNumber":"String","InboundArrivalCity":"String","InboundArrivalDate":"\/Date(-62135596800000-0000)\/","InboundArrivalTime":"String","OutboundAirline":"String","OutboundFlightNumber":"String","OutboundDepartureCity":"String","OutboundDepartureDate":"\/Date(-62135596800000-0000)\/","OutboundDepartureTime":"String","Notes":"String","Emails":"String","Mobile":"String","TotalTicketedValue":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}