Agentivity API

<back to all web services

GetPnrInfo

The following routes are available for this service:
All Verbs/PNRInformation

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
export class PagingMetadata
{
    /** @description Starting Record */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public Offset: string;

    /** @description Number of records to return (PageSize) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public Limit: string;

    /** @description 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")
    public TotalRecords: number;

    /** @description 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")
    public ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="TicketingDue", Namespace="schemas.agentivity.com/types")
export class PnrInfoAirlineTicketingDue
{
    // @DataMember(Order=10)
    public Airline: string;

    // @DataMember(Order=20)
    public DueDate?: string;

    // @DataMember(Order=30)
    public DueTime: string;

    public constructor(init?: Partial<PnrInfoAirlineTicketingDue>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="Warning", Namespace="schemas.agentivity.com/types")
export class PnrInfoAgentivityWarning
{
    // @DataMember(Order=10)
    public Message: string;

    // @DataMember(Order=20)
    public Vendor: string;

    // @DataMember(Order=30)
    public Timestamp?: string;

    // @DataMember(Order=40)
    public Details: string;

    public constructor(init?: Partial<PnrInfoAgentivityWarning>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="SuspectedDupe", Namespace="schemas.agentivity.com/types")
export class PnrInfoSuspectedDuplicate
{
    // @DataMember(Order=10)
    public AgentivityRef: number;

    // @DataMember(Order=20)
    public RecordLocator: string;

    // @DataMember(Order=30)
    public PNRCreationDate?: string;

    // @DataMember(Order=40)
    public DestinationCities: string;

    // @DataMember(Order=50)
    public Ticketed: string;

    public constructor(init?: Partial<PnrInfoSuspectedDuplicate>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="PNRInformation", Namespace="schemas.agentivity.com/types")
export class PnrInfo
{
    // @DataMember(Order=10)
    public AgentivityRef?: number;

    // @DataMember(Order=20)
    public RecordLocator: string;

    // @DataMember(Order=30)
    public PNRCreationDate?: string;

    // @DataMember(Order=35)
    public PNRTicketed: string;

    // @DataMember(Order=40)
    public OwningConsultantID: string;

    // @DataMember(Order=45)
    public OwningConsultant: string;

    // @DataMember(Order=50)
    public OwningAgencyLocationID: string;

    // @DataMember(Order=60)
    public Account: string;

    // @DataMember(Order=80)
    public HasDocs: boolean;

    // @DataMember(Order=90)
    public CountryCount: number;

    // @DataMember(Order=100)
    public Mobile: string;

    // @DataMember(Order=110)
    public CTCMMobile: string;

    // @DataMember(Order=120)
    public CTCE: string;

    // @DataMember(Order=200)
    public OutOfHoursServicedIndicator: number;

    // @DataMember(Order=210)
    public ChangeCount: number;

    // @DataMember(Order=220)
    public ItineraryChanges: number;

    // @DataMember(Order=230)
    public TripID: string;

    // @DataMember(Order=235)
    public AirlineTicketingDues: PnrInfoAirlineTicketingDue[];

    // @DataMember(Order=240)
    public AgentivityWarnings: PnrInfoAgentivityWarning[];

    // @DataMember(Order=250)
    public Cabin: string;

    // @DataMember(Order=300)
    public SuspectedDupeCount: number;

    // @DataMember(Order=310)
    public SuspectedDupes: PnrInfoSuspectedDuplicate[];

    // @DataMember(Order=320)
    public CarbonTonnage?: number;

    // @DataMember(Order=330)
    public TravellerGUID: string;

    public constructor(init?: Partial<PnrInfo>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
export class CacheMetadata
{
    // @DataMember(Order=1)
    public CachedAt: string;

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class ResponseMetadata
{
    // @DataMember(Order=0)
    public Success: boolean;

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public CacheMetadata: CacheMetadata;

    // @DataMember(Order=4, EmitDefaultValue=false)
    public PagingMetadata: PagingMetadata;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
export class ApiRequestPerHour
{
    // @DataMember(Order=10)
    public RequestDate: string;

    // @DataMember(Order=100)
    public Hour0: number;

    // @DataMember(Order=110)
    public Hour1: number;

    // @DataMember(Order=120)
    public Hour2: number;

    // @DataMember(Order=130)
    public Hour3: number;

    // @DataMember(Order=140)
    public Hour4: number;

    // @DataMember(Order=150)
    public Hour5: number;

    // @DataMember(Order=160)
    public Hour6: number;

    // @DataMember(Order=170)
    public Hour7: number;

    // @DataMember(Order=180)
    public Hour8: number;

    // @DataMember(Order=190)
    public Hour9: number;

    // @DataMember(Order=200)
    public Hour10: number;

    // @DataMember(Order=210)
    public Hour11: number;

    // @DataMember(Order=220)
    public Hour12: number;

    // @DataMember(Order=230)
    public Hour13: number;

    // @DataMember(Order=240)
    public Hour14: number;

    // @DataMember(Order=250)
    public Hour15: number;

    // @DataMember(Order=260)
    public Hour16: number;

    // @DataMember(Order=270)
    public Hour17: number;

    // @DataMember(Order=280)
    public Hour18: number;

    // @DataMember(Order=290)
    public Hour19: number;

    // @DataMember(Order=300)
    public Hour20: number;

    // @DataMember(Order=310)
    public Hour21: number;

    // @DataMember(Order=320)
    public Hour22: number;

    // @DataMember(Order=330)
    public Hour23: number;

    public constructor(init?: Partial<ApiRequestPerHour>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class CollectionResponse<TItem>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: ApiRequestPerHour[];

    // @DataMember(Order=3, EmitDefaultValue=false)
    public ResponseError: AgentivityError;

    public constructor(init?: Partial<CollectionResponse<TItem>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class GetPnrInfoResponse extends CollectionResponse<PnrInfo>
{

    public constructor(init?: Partial<GetPnrInfoResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetPnrInfo extends PagingMetadata implements IRequestConsultantID
{
    /** @description Record locator */
    // @DataMember
    public RecordLocator: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public PNRCreationDate: string;

    /** @description Request Consultant ID (sign on) */
    // @DataMember
    public RequestConsultantID: string;

    public constructor(init?: Partial<GetPnrInfo>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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>