Agentivity API

<back to all web services

GetPnrInfo

The following routes are available for this service:
All Verbs/PNRInformation
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@DataContract(Namespace="schemas.agentivity.com/types")
open class GetPnrInfo : PagingMetadata(), IRequestConsultantID
{
    /**
    * Record locator
    */
    @DataMember
    open var RecordLocator:String? = null

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

    /**
    * Request Consultant ID (sign on)
    */
    @DataMember
    override var RequestConsultantID: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 GetPnrInfoResponse : CollectionResponse<PnrInfo>()
{
}

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

    @DataMember(Order=2, EmitDefaultValue=false)
    open var ResponseReport:ArrayList<ApiRequestPerHour>? = 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="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
open class ApiRequestPerHour
{
    @DataMember(Order=10)
    open var RequestDate:Date? = null

    @DataMember(Order=100)
    open var Hour0:Int? = null

    @DataMember(Order=110)
    open var Hour1:Int? = null

    @DataMember(Order=120)
    open var Hour2:Int? = null

    @DataMember(Order=130)
    open var Hour3:Int? = null

    @DataMember(Order=140)
    open var Hour4:Int? = null

    @DataMember(Order=150)
    open var Hour5:Int? = null

    @DataMember(Order=160)
    open var Hour6:Int? = null

    @DataMember(Order=170)
    open var Hour7:Int? = null

    @DataMember(Order=180)
    open var Hour8:Int? = null

    @DataMember(Order=190)
    open var Hour9:Int? = null

    @DataMember(Order=200)
    open var Hour10:Int? = null

    @DataMember(Order=210)
    open var Hour11:Int? = null

    @DataMember(Order=220)
    open var Hour12:Int? = null

    @DataMember(Order=230)
    open var Hour13:Int? = null

    @DataMember(Order=240)
    open var Hour14:Int? = null

    @DataMember(Order=250)
    open var Hour15:Int? = null

    @DataMember(Order=260)
    open var Hour16:Int? = null

    @DataMember(Order=270)
    open var Hour17:Int? = null

    @DataMember(Order=280)
    open var Hour18:Int? = null

    @DataMember(Order=290)
    open var Hour19:Int? = null

    @DataMember(Order=300)
    open var Hour20:Int? = null

    @DataMember(Order=310)
    open var Hour21:Int? = null

    @DataMember(Order=320)
    open var Hour22:Int? = null

    @DataMember(Order=330)
    open var Hour23:Int? = 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="PNRInformation", Namespace="schemas.agentivity.com/types")
open class PnrInfo
{
    @DataMember(Order=10)
    open var AgentivityRef:Int? = null

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

    @DataMember(Order=30)
    open var PNRCreationDate:Date? = null

    @DataMember(Order=35)
    open var PNRTicketed:String? = null

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

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

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

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

    @DataMember(Order=80)
    open var HasDocs:Boolean? = null

    @DataMember(Order=90)
    open var CountryCount:Int? = null

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

    @DataMember(Order=110)
    open var CTCMMobile:String? = null

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

    @DataMember(Order=200)
    open var OutOfHoursServicedIndicator:Int? = null

    @DataMember(Order=210)
    open var ChangeCount:Int? = null

    @DataMember(Order=220)
    open var ItineraryChanges:Int? = null

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

    @DataMember(Order=235)
    open var AirlineTicketingDues:ArrayList<PnrInfoAirlineTicketingDue>? = null

    @DataMember(Order=240)
    open var AgentivityWarnings:ArrayList<PnrInfoAgentivityWarning>? = null

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

    @DataMember(Order=300)
    open var SuspectedDupeCount:Int? = null

    @DataMember(Order=310)
    open var SuspectedDupes:ArrayList<PnrInfoSuspectedDuplicate>? = null

    @DataMember(Order=320)
    open var CarbonTonnage:Double? = null

    @DataMember(Order=330)
    open var TravellerGUID:String? = null
}

@DataContract(Name="TicketingDue", Namespace="schemas.agentivity.com/types")
open class PnrInfoAirlineTicketingDue
{
    @DataMember(Order=10)
    open var Airline:String? = null

    @DataMember(Order=20)
    open var DueDate:Date? = null

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

@DataContract(Name="Warning", Namespace="schemas.agentivity.com/types")
open class PnrInfoAgentivityWarning
{
    @DataMember(Order=10)
    open var Message:String? = null

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

    @DataMember(Order=30)
    open var Timestamp:Date? = null

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

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

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

    @DataMember(Order=30)
    open var PNRCreationDate:Date? = null

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

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

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

POST /PNRInformation HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetPnrInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <Limit>String</Limit>
  <Offset>String</Offset>
  <ResponseRecords>0</ResponseRecords>
  <TotalRecords>0</TotalRecords>
  <PNRCreationDate>String</PNRCreationDate>
  <RecordLocator>String</RecordLocator>
  <RequestConsultantID>String</RequestConsultantID>
</GetPnrInfo>

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>
    <PNRInformation>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <PNRTicketed>String</PNRTicketed>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <Account>String</Account>
      <HasDocs>false</HasDocs>
      <CountryCount>0</CountryCount>
      <Mobile>String</Mobile>
      <CTCMMobile>String</CTCMMobile>
      <CTCE>String</CTCE>
      <OutOfHoursServicedIndicator>0</OutOfHoursServicedIndicator>
      <ChangeCount>0</ChangeCount>
      <ItineraryChanges>0</ItineraryChanges>
      <TripID>String</TripID>
      <AirlineTicketingDues>
        <TicketingDue>
          <Airline>String</Airline>
          <DueDate>0001-01-01T00:00:00</DueDate>
          <DueTime>String</DueTime>
        </TicketingDue>
      </AirlineTicketingDues>
      <AgentivityWarnings>
        <Warning>
          <Message>String</Message>
          <Vendor>String</Vendor>
          <Timestamp>0001-01-01T00:00:00</Timestamp>
          <Details>String</Details>
        </Warning>
      </AgentivityWarnings>
      <Cabin>String</Cabin>
      <SuspectedDupeCount>0</SuspectedDupeCount>
      <SuspectedDupes>
        <SuspectedDupe>
          <AgentivityRef>0</AgentivityRef>
          <RecordLocator>String</RecordLocator>
          <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
          <DestinationCities>String</DestinationCities>
          <Ticketed>String</Ticketed>
        </SuspectedDupe>
      </SuspectedDupes>
      <CarbonTonnage>0</CarbonTonnage>
      <TravellerGUID>String</TravellerGUID>
    </PNRInformation>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>