Agentivity API

<back to all web services

FindBookings

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

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

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

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

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

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

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

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

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

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

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

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

    // @DataMember(Order=110)
    public IsFrequentFlyer?: boolean;

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

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

    public constructor(init?: Partial<BookingSearchResult>) { (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="BookingSearchResult", Namespace="schemas.agentivity.com/types")
export class FindBookingsResponseReport extends Report<FindBookingsItemResponse, BookingSearchResult>
{

    public constructor(init?: Partial<FindBookingsResponseReport>) { 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 FindBookingsItemResponse extends ItemResponse<BookingSearchResult, FindBookingsResponseReport>
{

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

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

    /** @description Airline locator */
    // @DataMember
    public AirlineLocator: string;

    /** @description Surname */
    // @DataMember
    public Surname: string;

    /** @description Comma Delimited List of Custom Fields */
    // @DataMember
    public CustomField: string[];

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

TypeScript FindBookings DTOs

GET /FindBookings HTTP/1.1 
Host: api.agentivity.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":{"Item":{"AgentivityRef":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","Passengers":"String","Account":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","OwningConsultantID":"String","TravelDate":"\/Date(-62135596800000-0000)\/","PnrTicketed":"String","PnrCancelled":"String","AirSegBookingCodeList":"String","IsFrequentFlyer":false,"ItineraryChanges":0,"CustomFields":[{"FieldName":"String","FieldValue":"String"}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}