Agentivity API

<back to all web services

GetCarSegments

The following routes are available for this service:
GET/CarSegments
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:="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:="Segment", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CarSegmentAndVendor
            <DataMember(Order:=1)>
            Public Overridable Property OwningAgencyLocation As String

            <DataMember(Order:=2)>
            Public Overridable Property PNR As String

            <DataMember(Order:=3)>
            Public Overridable Property Consultant As String

            <DataMember(Order:=4)>
            Public Overridable Property SegmentStatus As String

            <DataMember(Order:=5)>
            Public Overridable Property PickUpDate As String

            <DataMember(Order:=6)>
            Public Overridable Property DropOffDate As String

            <DataMember(Order:=7)>
            Public Overridable Property CarVendorCode As String

            <DataMember(Order:=8)>
            Public Overridable Property VendorName As String

            <DataMember(Order:=9)>
            Public Overridable Property AirportCode As String

            <DataMember(Order:=10)>
            Public Overridable Property Passenger As String

            <DataMember(Order:=11)>
            Public Overridable Property Account As String

            <DataMember(Order:=12)>
            Public Overridable Property ConfirmationNbr As String

            <DataMember(Order:=13)>
            Public Overridable Property CurrencyCode As String

            <DataMember(Order:=14)>
            Public Overridable Property RateAmount As String

            <DataMember(Order:=15)>
            Public Overridable Property CarType As String

            <DataMember(Order:=16)>
            Public Overridable Property NbrOfCars As String

            <DataMember(Order:=17)>
            Public Overridable Property BookedInName As String

            <DataMember(Order:=18)>
            Public Overridable Property ServiceInformation As String

            <DataMember(Order:=19)>
            Public Overridable Property BRInformation As String
        End Class

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CarSegmentsByUserResponse
            Inherits CollectionResponse(Of CarSegmentAndVendor)
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class GetCarSegments
            Inherits CompanyLevelRequestBase
            <DataMember>
            Public Overridable Property PickUpDateStart As String

            <DataMember>
            Public Overridable Property PickUpDateEnd As String
        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 GetCarSegments 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 /CarSegments 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":[{"OwningAgencyLocation":"String","PNR":"String","Consultant":"String","SegmentStatus":"String","PickUpDate":"String","DropOffDate":"String","CarVendorCode":"String","VendorName":"String","AirportCode":"String","Passenger":"String","Account":"String","ConfirmationNbr":"String","CurrencyCode":"String","RateAmount":"String","CarType":"String","NbrOfCars":"String","BookedInName":"String","ServiceInformation":"String","BRInformation":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}