Agentivity API

GetGroupAirTravel

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

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AgentivityAPI.ServiceModel.Types;
using AgentivityAPI.ServiceModel.Base;
using AgentivityAPI.ServiceModel;
using AgentivityAPI.ServiceModel.ExtendedModels;

namespace AgentivityAPI.ServiceModel
{
    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class CollectionResponse<TItem>
    {
        [DataMember(Order=1)]
        public virtual ResponseMetadata ResponseMetadata { get; set; }

        [DataMember(Order=2, EmitDefaultValue=false)]
        public virtual List<ApiRequestPerHour> ResponseReport { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual AgentivityError ResponseError { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.Base
{
    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class CompanyLevelRequestBase
        : PagingMetadata, IMemberUsername, IMemberOwningCompanyCode
    {
        ///<summary>
        ///Comma Delimited List of Owning Company Codes
        ///</summary>
        [DataMember]
        public virtual string[] OwningCompanyCode { get; set; }

        ///<summary>
        ///UserName in form of an email address
        ///</summary>
        [DataMember]
        public virtual string UserName { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.ExtendedModels
{
    [DataContract(Name="VendorLocator", Namespace="schemas.agentivity.com/types")]
    public partial class BookingExtVendorLocator
        : IBookingIdentifier
    {
        [DataMember(Order=10)]
        public virtual string CarrierCode { get; set; }

        [DataMember(Order=20)]
        public virtual string VendorLocator { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.Types
{
    [DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class AgentivityError
    {
        [DataMember]
        public virtual string ErrorCode { get; set; }

        [DataMember]
        public virtual string Message { get; set; }

        [DataMember]
        public virtual string StatusCode { get; set; }

        [DataMember]
        public virtual string VerboseMessage { get; set; }
    }

    [DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")]
    public partial class ApiRequestPerHour
    {
        [DataMember(Order=10)]
        public virtual DateTime RequestDate { get; set; }

        [DataMember(Order=100)]
        public virtual int Hour0 { get; set; }

        [DataMember(Order=110)]
        public virtual int Hour1 { get; set; }

        [DataMember(Order=120)]
        public virtual int Hour2 { get; set; }

        [DataMember(Order=130)]
        public virtual int Hour3 { get; set; }

        [DataMember(Order=140)]
        public virtual int Hour4 { get; set; }

        [DataMember(Order=150)]
        public virtual int Hour5 { get; set; }

        [DataMember(Order=160)]
        public virtual int Hour6 { get; set; }

        [DataMember(Order=170)]
        public virtual int Hour7 { get; set; }

        [DataMember(Order=180)]
        public virtual int Hour8 { get; set; }

        [DataMember(Order=190)]
        public virtual int Hour9 { get; set; }

        [DataMember(Order=200)]
        public virtual int Hour10 { get; set; }

        [DataMember(Order=210)]
        public virtual int Hour11 { get; set; }

        [DataMember(Order=220)]
        public virtual int Hour12 { get; set; }

        [DataMember(Order=230)]
        public virtual int Hour13 { get; set; }

        [DataMember(Order=240)]
        public virtual int Hour14 { get; set; }

        [DataMember(Order=250)]
        public virtual int Hour15 { get; set; }

        [DataMember(Order=260)]
        public virtual int Hour16 { get; set; }

        [DataMember(Order=270)]
        public virtual int Hour17 { get; set; }

        [DataMember(Order=280)]
        public virtual int Hour18 { get; set; }

        [DataMember(Order=290)]
        public virtual int Hour19 { get; set; }

        [DataMember(Order=300)]
        public virtual int Hour20 { get; set; }

        [DataMember(Order=310)]
        public virtual int Hour21 { get; set; }

        [DataMember(Order=320)]
        public virtual int Hour22 { get; set; }

        [DataMember(Order=330)]
        public virtual int Hour23 { get; set; }
    }

    [DataContract(Name="Passenger", Namespace="schemas.agentivity.com/types")]
    public partial class BookingPassengerModel
    {
        [DataMember(Order=10)]
        public virtual string FirstName { get; set; }

        [DataMember(Order=20)]
        public virtual string LastName { get; set; }

        [DataMember(Order=30)]
        public virtual int PassengerDataId { get; set; }
    }

    [DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class CacheMetadata
    {
        [DataMember(Order=1)]
        public virtual DateTime CachedAt { get; set; }

        [DataMember(Order=2)]
        public virtual DateTime CacheExpiresAt { get; set; }

        [DataMember(Order=0)]
        public virtual bool IsFromCache { get; set; }
    }

    [DataContract(Name="CustomField", Namespace="schemas.agentivity.com/types")]
    public partial class CustomFieldData
    {
        [DataMember(Order=20)]
        public virtual string FieldName { get; set; }

        [DataMember(Order=30)]
        public virtual string FieldValue { get; set; }
    }

    public partial class CustomFieldsCollection
        : List<CustomFieldData>
    {
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class GetGroupAirTravel
        : CompanyLevelRequestBase
    {
        ///<summary>
        ///Comma Delimited List of Accounts
        ///</summary>
        [DataMember]
        public virtual string[] Account { get; set; }

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string DateStart { get; set; }

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string DateEnd { get; set; }

        ///<summary>
        ///From Airport Code
        ///</summary>
        [DataMember]
        public virtual string FromAirportCode { get; set; }

        ///<summary>
        ///To Airport Code
        ///</summary>
        [DataMember]
        public virtual string ToAirportCode { get; set; }

        ///<summary>
        ///Option to place passenger names on separate lines in the downloadable result (spreadsheet)
        ///</summary>
        [DataMember]
        public virtual bool RepeatByPassenger { get; set; }
    }

    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class GetGroupAirTravelResponse
        : CollectionResponse<GroupAirTravelItem>
    {
    }

    [DataContract(Name="GroupAirTravelItem", Namespace="schemas.agentivity.com/types")]
    public partial class GroupAirTravelItem
        : IBookingIdentifier, ITicketNumbers, IVendorLocators, IBookingCustomFields, IPassengerInfo
    {
        [DataMember(Order=10)]
        public virtual string RecordLocator { get; set; }

        [DataMember(Order=20)]
        public virtual DateTime? PNRCreationDate { get; set; }

        [DataMember(Order=30)]
        public virtual DateTime? DepartureDate { get; set; }

        [DataMember(Order=40)]
        public virtual string BoardPoint { get; set; }

        [DataMember(Order=50)]
        public virtual string OffPoint { get; set; }

        [DataMember(Order=60)]
        public virtual string PnrTicketed { get; set; }

        [DataMember(Order=70)]
        public virtual string Account { get; set; }

        [DataMember(Order=80)]
        public virtual string PaxList { get; set; }

        [DataMember(Order=90)]
        public virtual string Connections { get; set; }

        [DataMember(Order=100)]
        public virtual string CarrierCode { get; set; }

        [DataMember(Order=102)]
        public virtual string FlightNumber { get; set; }

        [DataMember(Order=110)]
        public virtual string[] TicketNumbers { get; set; }

        [DataMember(Order=120)]
        public virtual BookingExtVendorLocator[] VendorLocators { get; set; }

        [DataMember(Order=130)]
        public virtual BookingPassengerModel[] PassengerInfo { get; set; }

        [DataMember(Order=140)]
        public virtual DateTime? DepartureDateTime { get; set; }

        [DataMember(Order=150)]
        public virtual DateTime? CurrentArrivalDateTime { get; set; }

        [DataMember(Order=160)]
        public virtual int AgentivityRef { get; set; }

        [DataMember(Order=170)]
        public virtual CustomFieldsCollection CustomFields { get; set; }
    }

    [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 virtual string Offset { get; set; }

        ///<summary>
        ///Number of records to return (PageSize)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")]
        public virtual string Limit { get; set; }

        ///<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 virtual int TotalRecords { get; set; }

        ///<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 virtual int ResponseRecords { get; set; }
    }

    [DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class ResponseMetadata
    {
        [DataMember(Order=0)]
        public virtual bool Success { get; set; }

        [DataMember(Order=1)]
        public virtual bool HasCache { get; set; }

        [DataMember(Order=2)]
        public virtual bool HasPaging { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual CacheMetadata CacheMetadata { get; set; }

        [DataMember(Order=4, EmitDefaultValue=false)]
        public virtual PagingMetadata PagingMetadata { get; set; }
    }

}

C# GetGroupAirTravel 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 /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>