Agentivity API

<back to all web services

GetHotelSegments

The following routes are available for this service:
GET/HotelSegments

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

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

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

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

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

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

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

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

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

    // @DataMember(Order=95)
    public SegmentCreationDate?: string;

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

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

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

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

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

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

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

    // @DataMember(Order=145)
    public PropertyPhoneNbr: string;

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

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

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

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

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

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

    // @DataMember(Order=220)
    public RateAccessCode: string;

    // @DataMember(Order=230)
    public RoomBookingCode: string;

    // @DataMember(Order=240)
    public CurrencyCode: string;

    // @DataMember(Order=250)
    public RateAmount: string;

    // @DataMember(Order=260)
    public NbrRooms: number;

    // @DataMember(Order=270)
    public BookedInName: string;

    // @DataMember(Order=275)
    public ServiceInformation: string;

    // @DataMember(Order=280)
    public TotalAirSegs: string;

    // @DataMember(Order=290)
    public CreatingAgencyIata: string;

    // @DataMember(Order=310)
    public IsCommissionable?: boolean;

    // @DataMember(Order=320)
    public Commission: string;

    // @DataMember(Order=330)
    public IsPassive: boolean;

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

    // @DataMember(Order=350)
    public HotelNotepad: string;

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

    public constructor(init?: Partial<HotelSegmentsResponseReport>) { 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 HotelSegmentsItemResponse extends ItemResponse<HotelSegment, HotelSegmentsResponseReport>
{

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

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

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

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

    /** @description 3 letter city code */
    // @DataMember
    public CityCode: string;

    /** @description Include Notepad Entry: 1=Yes */
    // @DataMember
    public WithNotepad: string;

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

    /** @description Comma Delimited List of CountryCodes */
    // @DataMember
    public OwningAgencyCountryCode: string[];

    /** @description Date search type option, a single character (A to search by Arrival dates, C to search by booking creation dates, S to search by segment creation dates). */
    // @DataMember
    public DateSearchType: string;

    /** @description IsGDS=0 (bookings from Non-GDS eg Supplier Direct). IsGDS=1 (bookings from GDS). */
    // @DataMember
    public IsGDS: string;

    /** @description IsPassive=0 (only include non-passive segments). IsPassive=1 (only include passive segments). */
    // @DataMember
    public IsPassive: string;

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

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

TypeScript GetHotelSegments DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /HotelSegments 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,"PNRCreationDate":"\/Date(-62135596800000-0000)\/","HotelSegmentNbr":"String","RecordLocator":"String","OwningAgencyLocationID":"String","Account":"String","OwningConsultantID":"String","OwningConsultant":"String","StatusCode":"String","SegmentCreationDate":"\/Date(-62135596800000-0000)\/","ArrivalDate":"\/Date(-62135596800000-0000)\/","DepartureDate":"\/Date(-62135596800000-0000)\/","NbrNights":0,"VendorCode":"String","PropertyName":"String","PropertyPhoneNbr":"String","PropertyNbr":"String","PropertyAddress":"String","CityCode":"String","CityName":"String","CountryCode":"String","CountryName":"String","Passenger":"String","ConfirmationNbr":"String","RateAccessCode":"String","RoomBookingCode":"String","CurrencyCode":"String","RateAmount":"String","NbrRooms":0,"BookedInName":"String","ServiceInformation":"String","TotalAirSegs":"String","CreatingAgencyIata":"String","IsCommissionable":false,"Commission":"String","IsPassive":false,"CustomFields":[{"FieldName":"String","FieldValue":"String"}],"HotelNotepad":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}