Agentivity API

<back to all web services

GetBookingsWithActiveSegments

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

// @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="BookingWithActiveSegments", Namespace="schemas.agentivity.com/types")
export class BookingWithActiveSegments implements IBookingIdentifier, ITicketNumbers, IVendorLocators
{
    // @DataMember(Order=10)
    public AgentivityRef: number;

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

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

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

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

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

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

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

    // @DataMember(Order=85)
    public Passenger: string;

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

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

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

    // @DataMember(Order=120)
    public HasAir: boolean;

    // @DataMember(Order=130)
    public HasHtl: boolean;

    // @DataMember(Order=140)
    public HasCar: boolean;

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

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

    // @DataMember(Order=170)
    public CarrierCodes: string;

    // @DataMember(Order=180)
    public FlightNumbers: string;

    // @DataMember(Order=190)
    public IataCodes: string;

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

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

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

// @DataContract(Namespace="schemas.agentivity.com/types")
export class Report<TItemResponse, TItem>
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    public Item: TItem;

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

// @DataContract(Name="BookingWithActiveSegments", Namespace="schemas.agentivity.com/types")
export class GetBookingsWithActiveSegmentsResponseReport extends Report<GetBookingsWithActiveSegmentsItemResponse, BookingWithActiveSegments>
{

    public constructor(init?: Partial<GetBookingsWithActiveSegmentsResponseReport>) { super(init); (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="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 ItemResponse<TItem, TReport>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: TReport;

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

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

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class GetBookingsWithActiveSegmentsItemResponse extends ItemResponse<BookingWithActiveSegments, GetBookingsWithActiveSegmentsResponseReport>
{

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

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetBookingsWithActiveSegments extends CompanyLevelRequestBase
{
    /** @description Date in format YYYYMMDD */
    // @DataMember
    public TravelDateStart: string;

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

    /** @description All future date */
    // @DataMember
    public AllFutureDate: boolean;

    /** @description Comma Delimited List of Accounts */
    // @DataMember
    public Account: string[];

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

TypeScript GetBookingsWithActiveSegments 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 /BookingsWithActiveSegments HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetBookingsWithActiveSegments 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>
  <AllFutureDate>false</AllFutureDate>
  <TravelDateEnd>String</TravelDateEnd>
  <TravelDateStart>String</TravelDateStart>
</GetBookingsWithActiveSegments>

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>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <Account>String</Account>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <Passenger>String</Passenger>
      <PNRTicketed>String</PNRTicketed>
      <EmailAddress>String</EmailAddress>
      <PhoneNbr>String</PhoneNbr>
      <HasAir>false</HasAir>
      <HasHtl>false</HasHtl>
      <HasCar>false</HasCar>
      <DestinationCities>String</DestinationCities>
      <Connections>String</Connections>
      <CarrierCodes>String</CarrierCodes>
      <FlightNumbers>String</FlightNumbers>
      <IataCodes>String</IataCodes>
      <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>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>