Agentivity API

SegmentsQC

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

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 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.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:="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:="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

        Public Enum QcCheck
            Missing
            Warning
            Valid
            Denied
        End Enum

        <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

        <DataContract(Name:="SegmentQC", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class SegmentQC
            <DataMember(Order:=10)>
            Public Overridable Property AgentivityRef As Integer

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

            <DataMember(Order:=30)>
            Public Overridable Property OwningConsultant As String

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

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

            <DataMember(Order:=50)>
            Public Overridable Property BoardPoint As String

            <DataMember(Order:=50)>
            Public Overridable Property OffPoint As String

            <DataMember(Order:=60)>
            Public Overridable Property DepartureTime As String

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

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

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

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

            <DataMember(Order:=105)>
            Public Overridable Property FlightNumberFromatted As String

            <DataMember(Order:=110)>
            Public Overridable Property SeatCheck As QcCheck

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

            <DataMember(Order:=130)>
            Public Overridable Property MealCheck As QcCheck

            <DataMember(Order:=155)>
            Public Overridable Property MealFormatted As String

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

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

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

            <DataMember(Order:=190)>
            Public Overridable Property HoteCheck As QcCheck

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

            <DataMember(Order:=210)>
            Public Overridable Property ShuttleDesc As String

            <DataMember(Order:=220)>
            Public Overridable Property TourDesc As String

            <DataMember(Order:=230)>
            Public Overridable Property FrequentFlyerNumbers As String

            <DataMember(Order:=240)>
            Public Overridable Property PnrTicketed As String

            <DataMember(Order:=250)>
            Public Overridable Property TicketNumber As String

            <DataMember(Order:=260)>
            Public Overridable Property Comments As String

            <DataMember(Order:=270)>
            Public Overridable Property OpsComments As String

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

            <DataMember(Order:=290)>
            Public Overridable Property CorporateFFs As String

            <DataMember(Order:=300)>
            Public Overridable Property VendorLocator As String
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class SegmentsQC
            Inherits CompanyLevelRequestBase
            '''<Summary>
            '''Comma Delimited List of Accounts
            '''</Summary>
            <DataMember>
            Public Overridable Property Account As String()

            '''<Summary>
            '''Date in format YYYYMMDD
            '''</Summary>
            <DataMember>
            Public Overridable Property DepartureDateStart As String

            '''<Summary>
            '''Date in format YYYYMMDD
            '''</Summary>
            <DataMember>
            Public Overridable Property DepartureDateEnd As String

            '''<Summary>
            '''Return only segments that are flagged as VIP only
            '''</Summary>
            <DataMember>
            Public Overridable Property VipOnly As Boolean
        End Class

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

        <DataContract(Name:="SegmentQC", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class SegmentsQCResponseReport
            Inherits Report(Of SegmentsQCItemResponse, SegmentQC)
        End Class
    End Namespace
End Namespace

VB.NET SegmentsQC DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /SegmentsQC 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>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <OwningConsultant>String</OwningConsultant>
      <Passenger>String</Passenger>
      <Account>String</Account>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <DepartureTime>String</DepartureTime>
      <BookingClass>String</BookingClass>
      <SegmentStatus>String</SegmentStatus>
      <CarrierCode>String</CarrierCode>
      <FlightNbr>String</FlightNbr>
      <FlightNumberFromatted>String</FlightNumberFromatted>
      <SeatCheck>Missing</SeatCheck>
      <SeatFormatted>String</SeatFormatted>
      <MealCheck>Missing</MealCheck>
      <MealFormatted>String</MealFormatted>
      <ChauffeurDesc>String</ChauffeurDesc>
      <TransferDesc>String</TransferDesc>
      <CarsFormatted>String</CarsFormatted>
      <HoteCheck>Missing</HoteCheck>
      <Hotels>String</Hotels>
      <ShuttleDesc>String</ShuttleDesc>
      <TourDesc>String</TourDesc>
      <FrequentFlyerNumbers>String</FrequentFlyerNumbers>
      <PnrTicketed>String</PnrTicketed>
      <TicketNumber>String</TicketNumber>
      <Comments>String</Comments>
      <OpsComments>String</OpsComments>
      <IsVip>false</IsVip>
      <CorporateFFs>String</CorporateFFs>
      <VendorLocator>String</VendorLocator>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>