Agentivity API

<back to all web services

GetBookingsCreated

// @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="ItinerarySegment", Namespace="schemas.agentivity.com/types")
export class ItinerarySegment
{
    // @DataMember
    public SegmentType: string;

    // @DataMember
    public SegmentNbr: number;

    // @DataMember
    public BoardPoint: string;

    // @DataMember
    public OffPoint: string;

    // @DataMember
    public OperatorCode: string;

    // @DataMember
    public OperatorService: string;

    // @DataMember
    public SegmentStatus: string;

    // @DataMember
    public DepartureTimeFormatted: string;

    // @DataMember
    public ArrivalTimeFormatted: string;

    // @DataMember
    public ChangeOfDayFormatted: string;

    // @DataMember
    public ServiceCode: string;

    // @DataMember
    public StartDate: string;

    // @DataMember
    public EndDate: string;

    // @DataMember
    public TicketNumber: string;

    /** @description Comma separated list of vendor locators */
    // @DataMember
    public VendorLocators: string;

    // @DataMember
    public EquipmentCode: string;

    // @DataMember
    public Equipment: string;

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

export class ItinerarySegmentsCollection extends Array<ItinerarySegment>
{

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

// @DataContract(Name="BookingCreated", Namespace="schemas.agentivity.com/types")
export class BookingCreated implements IBookingItinerary, ICarbonTonnage
{
    // @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 PNRTicketed: string;

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

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

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

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

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

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

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

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

    // @DataMember(Order=170)
    public IsVip: boolean;

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

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

    // @DataMember(Order=200)
    public Itinerary: ItinerarySegmentsCollection;

    // @DataMember(Order=210)
    public ItineraryFormatted: string;

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

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

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

// @Flags()
export enum FormattingStyle
{
    None = 0,
    Html = 1,
    Charting = 2,
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetBookingsCreated extends CompanyLevelRequestBase implements IMemberAccount, IMemberPNRCreationDateStart, IMemberPNRCreationDateEnd, IMemberPNRCancelled, IMemberHasMobile, IMemberHasEmail, IMemberMissingEmailOrPhone, IMemberHasHotel, IMemberHasAccount, IMemberIncludeItinerary, IMemberMinSegments, IMemberIsVip, IMemberItineraryFormatting
{
    /** @description Includes CTCM and CTCE in results */
    // @DataMember
    public IncludeCTFields: boolean;

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

    /** @description Return only PNRs with/without an account */
    // @DataMember
    public HasAccount?: boolean;

    /** @description Return only PNRs with/without an email address */
    // @DataMember
    public HasEmail?: boolean;

    /** @description Return only PNRs with/without a hotel */
    // @DataMember
    public HasHotel?: boolean;

    /** @description Return only PNRs with/without a mobile number */
    // @DataMember
    public HasMobile?: boolean;

    /** @description Include Itinerary in the response */
    // @DataMember
    public IncludeItinerary: boolean;

    /** @description Return only PNRs that are or are not flagged as VIP bookings */
    // @DataMember
    public IsVip?: boolean;

    /** @description Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart */
    // @DataMember
    public ItineraryFormatting: FormattingStyle;

    /** @description Return only PNRs that equal or exceed a certain number of segments */
    // @DataMember
    public MinSegments?: number;

    /** @description Return only PNRs with/without an email address OR a mobile number */
    // @DataMember
    public MissingEmailOrPhone?: boolean;

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

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

    /** @description Return only PNRs that are cancelled(Y)/not cancelled(N)/all */
    // @DataMember
    public PNRCancelled: string;

    /** @description Comma Delimited List of PCCs */
    // @DataMember
    public OwningAgencyLocationID: string[];

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

TypeScript GetBookingsCreated DTOs

GET /BookingsCreated HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml

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>
    <BookingCreated>
      <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>
      <PNRTicketed>String</PNRTicketed>
      <PNRTicketedDate>0001-01-01T00:00:00</PNRTicketedDate>
      <PNRCancelled>String</PNRCancelled>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <CancelledTravelDate>0001-01-01T00:00:00</CancelledTravelDate>
      <Passengers>String</Passengers>
      <Mobile>String</Mobile>
      <Emails>String</Emails>
      <DestinationCount>0</DestinationCount>
      <IsVip>false</IsVip>
      <CTCM>String</CTCM>
      <CTCE>String</CTCE>
      <Itinerary>
        <ItinerarySegment>
          <ArrivalTimeFormatted>String</ArrivalTimeFormatted>
          <BoardPoint>String</BoardPoint>
          <ChangeOfDayFormatted>String</ChangeOfDayFormatted>
          <DepartureTimeFormatted>String</DepartureTimeFormatted>
          <EndDate>String</EndDate>
          <Equipment>String</Equipment>
          <EquipmentCode>String</EquipmentCode>
          <OffPoint>String</OffPoint>
          <OperatorCode>String</OperatorCode>
          <OperatorService>String</OperatorService>
          <SegmentNbr>0</SegmentNbr>
          <SegmentStatus>String</SegmentStatus>
          <SegmentType>String</SegmentType>
          <ServiceCode>String</ServiceCode>
          <StartDate>String</StartDate>
          <TicketNumber>String</TicketNumber>
          <VendorLocators>String</VendorLocators>
        </ItinerarySegment>
      </Itinerary>
      <ItineraryFormatted>String</ItineraryFormatted>
      <CarbonTonnage>0</CarbonTonnage>
    </BookingCreated>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>