Agentivity API

<back to all web services

SegmentsQC

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@DataContract(Namespace="schemas.agentivity.com/types")
open class SegmentsQC : CompanyLevelRequestBase()
{
    /**
    * Comma Delimited List of Accounts
    */
    @DataMember
    open var Account:ArrayList<String>? = null

    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var DepartureDateStart:String? = null

    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var DepartureDateEnd:String? = null

    /**
    * Return only segments that are flagged as VIP only
    */
    @DataMember
    open var VipOnly:Boolean? = null
}

@DataContract(Namespace="schemas.agentivity.com/types")
open class CompanyLevelRequestBase : PagingMetadata(), IMemberUsername, IMemberOwningCompanyCode
{
    /**
    * Comma Delimited List of Owning Company Codes
    */
    @DataMember
    override var OwningCompanyCode:ArrayList<String>? = null

    /**
    * UserName in form of an email address
    */
    @DataMember
    override var UserName:String? = null
}

@DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
open class PagingMetadata
{
    /**
    * Starting Record
    */
    @DataMember
    @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    open var Offset:String? = null

    /**
    * Number of records to return (PageSize)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    open var Limit:String? = null

    /**
    * Total Number of Records in a Full Reponse (if no paging)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
    open var TotalRecords:Int? = null

    /**
    * Total Number of Records in this Reponse (on this page)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
    open var ResponseRecords:Int? = null
}

@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class SegmentsQCItemResponse : ItemResponse<SegmentQC, SegmentsQCResponseReport>()
{
}

@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class ItemResponse<TItem, TReport>
{
    @DataMember(Order=1)
    open var ResponseMetadata:ResponseMetadata? = null

    @DataMember(Order=2, EmitDefaultValue=false)
    open var ResponseReport:TReport? = null

    @DataMember(Order=3, EmitDefaultValue=false)
    open var ResponseError:AgentivityError? = null
}

@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class ResponseMetadata
{
    @DataMember(Order=0)
    open var Success:Boolean? = null

    @DataMember(Order=1)
    open var HasCache:Boolean? = null

    @DataMember(Order=2)
    open var HasPaging:Boolean? = null

    @DataMember(Order=3, EmitDefaultValue=false)
    open var CacheMetadata:CacheMetadata? = null

    @DataMember(Order=4, EmitDefaultValue=false)
    open var PagingMetadata:PagingMetadata? = null
}

@DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
open class CacheMetadata
{
    @DataMember(Order=1)
    open var CachedAt:Date? = null

    @DataMember(Order=2)
    open var CacheExpiresAt:Date? = null

    @DataMember(Order=0)
    open var IsFromCache:Boolean? = null
}

@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class AgentivityError
{
    @DataMember
    open var ErrorCode:String? = null

    @DataMember
    open var Message:String? = null

    @DataMember
    open var StatusCode:String? = null

    @DataMember
    open var VerboseMessage:String? = null
}

@DataContract(Name="SegmentQC", Namespace="schemas.agentivity.com/types")
open class SegmentQC
{
    @DataMember(Order=10)
    open var AgentivityRef:Int? = null

    @DataMember(Order=20)
    open var RecordLocator:String? = null

    @DataMember(Order=30)
    open var OwningConsultant:String? = null

    @DataMember(Order=40)
    open var Passenger:String? = null

    @DataMember(Order=45)
    open var Account:String? = null

    @DataMember(Order=50)
    open var BoardPoint:String? = null

    @DataMember(Order=50)
    open var OffPoint:String? = null

    @DataMember(Order=60)
    open var DepartureTime:String? = null

    @DataMember(Order=70)
    open var BookingClass:String? = null

    @DataMember(Order=80)
    open var SegmentStatus:String? = null

    @DataMember(Order=90)
    open var CarrierCode:String? = null

    @DataMember(Order=100)
    open var FlightNbr:String? = null

    @DataMember(Order=105)
    open var FlightNumberFromatted:String? = null

    @DataMember(Order=110)
    open var SeatCheck:QcCheck? = null

    @DataMember(Order=120)
    open var SeatFormatted:String? = null

    @DataMember(Order=130)
    open var MealCheck:QcCheck? = null

    @DataMember(Order=155)
    open var MealFormatted:String? = null

    @DataMember(Order=160)
    open var ChauffeurDesc:String? = null

    @DataMember(Order=170)
    open var TransferDesc:String? = null

    @DataMember(Order=180)
    open var CarsFormatted:String? = null

    @DataMember(Order=190)
    open var HoteCheck:QcCheck? = null

    @DataMember(Order=200)
    open var Hotels:String? = null

    @DataMember(Order=210)
    open var ShuttleDesc:String? = null

    @DataMember(Order=220)
    open var TourDesc:String? = null

    @DataMember(Order=230)
    open var FrequentFlyerNumbers:String? = null

    @DataMember(Order=240)
    open var PnrTicketed:String? = null

    @DataMember(Order=250)
    open var TicketNumber:String? = null

    @DataMember(Order=260)
    open var Comments:String? = null

    @DataMember(Order=270)
    open var OpsComments:String? = null

    @DataMember(Order=280)
    open var IsVip:Boolean? = null

    @DataMember(Order=290)
    open var CorporateFFs:String? = null

    @DataMember(Order=300)
    open var VendorLocator:String? = null
}

enum class QcCheck
{
    Missing,
    Warning,
    Valid,
    Denied,
}

@DataContract(Name="SegmentQC", Namespace="schemas.agentivity.com/types")
open class SegmentsQCResponseReport : Report<SegmentsQCItemResponse, SegmentQC>()
{
}

@DataContract(Namespace="schemas.agentivity.com/types")
open class Report<TItemResponse, TItem>
{
    @DataMember(Order=1, EmitDefaultValue=false)
    open var Item:TItem? = null
}

Kotlin SegmentsQC DTOs

GET /SegmentsQC HTTP/1.1 
Host: servicestack.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>