Agentivity API

<back to all web services

GetGroupAirTravel

// @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(Namespace="schemas.agentivity.com/types")
export class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
    /** @description Comma Delimited List of Owning Company Codes */
    // @DataMember
    public OwningCompanyCode: string[];

    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

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

// @DataContract(Name="VendorLocator", Namespace="schemas.agentivity.com/types")
export class BookingExtVendorLocator implements IBookingIdentifier
{
    // @DataMember(Order=10)
    public CarrierCode: string;

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

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

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

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

    // @DataMember(Order=30)
    public PassengerDataId: number;

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

// @DataContract(Name="CustomField", Namespace="schemas.agentivity.com/types")
export class CustomFieldData
{
    // @DataMember(Order=20)
    public FieldName: string;

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

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

export class CustomFieldsCollection extends Array<CustomFieldData>
{

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

// @DataContract(Name="GroupAirTravelItem", Namespace="schemas.agentivity.com/types")
export class GroupAirTravelItem implements IBookingIdentifier, ITicketNumbers, IVendorLocators, IBookingCustomFields, IPassengerInfo
{
    // @DataMember(Order=10)
    public RecordLocator: string;

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

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

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

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

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

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

    // @DataMember(Order=80)
    public PaxList: string;

    // @DataMember(Order=90)
    public Connections: string;

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

    // @DataMember(Order=102)
    public FlightNumber: string;

    // @DataMember(Order=110)
    public TicketNumbers: string[];

    // @DataMember(Order=120)
    public VendorLocators: BookingExtVendorLocator[];

    // @DataMember(Order=130)
    public PassengerInfo: BookingPassengerModel[];

    // @DataMember(Order=140)
    public DepartureDateTime?: string;

    // @DataMember(Order=150)
    public CurrentArrivalDateTime?: string;

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

    // @DataMember(Order=170)
    public CustomFields: CustomFieldsCollection;

    public constructor(init?: Partial<GroupAirTravelItem>) { (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 GetGroupAirTravelResponse extends CollectionResponse<GroupAirTravelItem>
{

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

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetGroupAirTravel extends CompanyLevelRequestBase
{
    /** @description Comma Delimited List of Accounts */
    // @DataMember
    public Account: string[];

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

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

    /** @description From Airport Code */
    // @DataMember
    public FromAirportCode: string;

    /** @description To Airport Code */
    // @DataMember
    public ToAirportCode: string;

    /** @description Option to place passenger names on separate lines in the downloadable result (spreadsheet) */
    // @DataMember
    public RepeatByPassenger: boolean;

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

TypeScript GetGroupAirTravel DTOs

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

<GetGroupAirTravel 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>
  <OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningCompanyCode>
  <UserName>String</UserName>
  <Account xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Account>
  <DateEnd>String</DateEnd>
  <DateStart>String</DateStart>
  <FromAirportCode>String</FromAirportCode>
  <RepeatByPassenger>false</RepeatByPassenger>
  <ToAirportCode>String</ToAirportCode>
</GetGroupAirTravel>

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>
    <GroupAirTravelItem>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <DepartureDate>0001-01-01T00:00:00</DepartureDate>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <PnrTicketed>String</PnrTicketed>
      <Account>String</Account>
      <PaxList>String</PaxList>
      <Connections>String</Connections>
      <CarrierCode>String</CarrierCode>
      <FlightNumber>String</FlightNumber>
      <TicketNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </TicketNumbers>
      <VendorLocators>
        <VendorLocator>
          <CarrierCode>String</CarrierCode>
          <VendorLocator>String</VendorLocator>
        </VendorLocator>
      </VendorLocators>
      <PassengerInfo>
        <Passenger>
          <FirstName>String</FirstName>
          <LastName>String</LastName>
          <PassengerDataId>0</PassengerDataId>
          <Tickets>
            <Ticket>
              <Number>String</Number>
              <Type>String</Type>
            </Ticket>
          </Tickets>
        </Passenger>
      </PassengerInfo>
      <DepartureDateTime>0001-01-01T00:00:00</DepartureDateTime>
      <CurrentArrivalDateTime>0001-01-01T00:00:00</CurrentArrivalDateTime>
      <AgentivityRef>0</AgentivityRef>
      <CustomFields>
        <CustomField>
          <FieldName>String</FieldName>
          <FieldValue>String</FieldValue>
        </CustomField>
      </CustomFields>
    </GroupAirTravelItem>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>