Agentivity API

<back to all web services

GetBookingsCreated

The following routes are available for this service:
GET/BookingsCreated
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:="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:="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:="BookingCreated", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class BookingCreated
            Implements IBookingItinerary
            Implements ICarbonTonnage
            <DataMember(Order:=10)>
            Public Overridable Property AgentivityRef As Integer Implements IBookingItinerary.AgentivityRef

            <DataMember(Order:=20)>
            Public Overridable Property RecordLocator As String

            <DataMember(Order:=30)>
            Public Overridable Property PNRCreationDate As Date?

            <DataMember(Order:=40)>
            Public Overridable Property OwningAgencyLocationID 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 OwningConsultant As String

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

            <DataMember(Order:=90)>
            Public Overridable Property PNRTicketedDate As Date?

            <DataMember(Order:=100)>
            Public Overridable Property PNRCancelled As String

            <DataMember(Order:=110)>
            Public Overridable Property TravelDate As Date?

            <DataMember(Order:=120)>
            Public Overridable Property CancelledTravelDate As Date?

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

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

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

            <DataMember(Order:=160)>
            Public Overridable Property DestinationCount As Integer

            <DataMember(Order:=170)>
            Public Overridable Property IsVip As Boolean

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

            <DataMember(Order:=190)>
            Public Overridable Property CTCE 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

            <DataMember(Order:=220)>
            Public Overridable Property CarbonTonnage As Double? Implements ICarbonTonnage.CarbonTonnage
        End Class

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class BookingsCreatedResponse
            Inherits CollectionResponse(Of BookingCreated)
        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 GetBookingsCreated
            Inherits CompanyLevelRequestBase
            Implements IMemberAccount
            Implements IMemberPNRCreationDateStart
            Implements IMemberPNRCreationDateEnd
            Implements IMemberPNRCancelled
            Implements IMemberHasMobile
            Implements IMemberHasEmail
            Implements IMemberMissingEmailOrPhone
            Implements IMemberHasHotel
            Implements IMemberHasAccount
            Implements IMemberIncludeItinerary
            Implements IMemberMinSegments
            Implements IMemberIsVip
            Implements IMemberItineraryFormatting
            '''<Summary>
            '''Includes CTCM and CTCE in results
            '''</Summary>
            <DataMember>
            Public Overridable Property IncludeCTFields As Boolean

            '''<Summary>
            '''Comma Delimited List of Accounts
            '''</Summary>
            <DataMember>
            Public Overridable Property Account As String() Implements IMemberAccount.Account

            '''<Summary>
            '''Return only PNRs with/without an account
            '''</Summary>
            <DataMember>
            Public Overridable Property HasAccount As Boolean? Implements IMemberHasAccount.HasAccount

            '''<Summary>
            '''Return only PNRs with/without an email address
            '''</Summary>
            <DataMember>
            Public Overridable Property HasEmail As Boolean? Implements IMemberHasEmail.HasEmail

            '''<Summary>
            '''Return only PNRs with/without a hotel
            '''</Summary>
            <DataMember>
            Public Overridable Property HasHotel As Boolean? Implements IMemberHasHotel.HasHotel

            '''<Summary>
            '''Return only PNRs with/without a mobile number
            '''</Summary>
            <DataMember>
            Public Overridable Property HasMobile As Boolean? Implements IMemberHasMobile.HasMobile

            '''<Summary>
            '''Include Itinerary in the response
            '''</Summary>
            <DataMember>
            Public Overridable Property IncludeItinerary As Boolean Implements IMemberIncludeItinerary.IncludeItinerary

            '''<Summary>
            '''Return only PNRs that are or are not flagged as VIP bookings
            '''</Summary>
            <DataMember>
            Public Overridable Property IsVip As Boolean? Implements IMemberIsVip.IsVip

            '''<Summary>
            '''Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
            '''</Summary>
            <DataMember>
            Public Overridable Property ItineraryFormatting As FormattingStyle Implements IMemberItineraryFormatting.ItineraryFormatting

            '''<Summary>
            '''Return only PNRs that equal or exceed a certain number of segments
            '''</Summary>
            <DataMember>
            Public Overridable Property MinSegments As Integer? Implements IMemberMinSegments.MinSegments

            '''<Summary>
            '''Return only PNRs with/without an email address OR a mobile number
            '''</Summary>
            <DataMember>
            Public Overridable Property MissingEmailOrPhone As Boolean? Implements IMemberMissingEmailOrPhone.MissingEmailOrPhone

            '''<Summary>
            '''Date in format YYYYMMDD
            '''</Summary>
            <DataMember>
            Public Overridable Property PNRCreationDateEnd As String Implements IMemberPNRCreationDateEnd.PNRCreationDateEnd

            '''<Summary>
            '''Date in format YYYYMMDD
            '''</Summary>
            <DataMember>
            Public Overridable Property PNRCreationDateStart As String Implements IMemberPNRCreationDateStart.PNRCreationDateStart

            '''<Summary>
            '''Return only PNRs that are cancelled(Y)/not cancelled(N)/all
            '''</Summary>
            <DataMember>
            Public Overridable Property PNRCancelled As String Implements IMemberPNRCancelled.PNRCancelled

            '''<Summary>
            '''Comma Delimited List of PCCs
            '''</Summary>
            <DataMember>
            Public Overridable Property OwningAgencyLocationID As String()
        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 GetBookingsCreated 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 /BookingsCreated 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":[{"AgentivityRef":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","Account":"String","OwningConsultantID":"String","OwningConsultant":"String","PNRTicketed":"String","PNRTicketedDate":"\/Date(-62135596800000-0000)\/","PNRCancelled":"String","TravelDate":"\/Date(-62135596800000-0000)\/","CancelledTravelDate":"\/Date(-62135596800000-0000)\/","Passengers":"String","Mobile":"String","Emails":"String","DestinationCount":0,"IsVip":false,"CTCM":"String","CTCE":"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","CarbonTonnage":0}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}