| GET | /HotelSegments |
|---|
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;
namespace AgentivityAPI.ServiceModel
{
[DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
public partial class ItemResponse<TItem, TReport>
{
[DataMember(Order=1)]
public virtual ResponseMetadata ResponseMetadata { get; set; }
[DataMember(Order=2, EmitDefaultValue=false)]
public virtual TReport ResponseReport { get; set; }
[DataMember(Order=3, EmitDefaultValue=false)]
public virtual AgentivityError ResponseError { get; set; }
}
[DataContract(Namespace="schemas.agentivity.com/types")]
public partial class Report<TItemResponse, TItem>
{
[DataMember(Order=1, EmitDefaultValue=false)]
public virtual TItem Item { 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.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="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 GetHotelSegments
: CompanyLevelRequestBase
{
///<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>
///Comma Delimited List of Accounts
///</summary>
[DataMember]
public virtual string[] Account { get; set; }
///<summary>
///3 letter city code
///</summary>
[DataMember]
public virtual string CityCode { get; set; }
///<summary>
///Include Notepad Entry: 1=Yes
///</summary>
[DataMember]
public virtual string WithNotepad { get; set; }
///<summary>
///Comma Delimited List of PCCs
///</summary>
[DataMember]
public virtual string[] OwningAgencyLocationID { get; set; }
///<summary>
///Comma Delimited List of CountryCodes
///</summary>
[DataMember]
public virtual string[] OwningAgencyCountryCode { get; set; }
///<summary>
///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).
///</summary>
[DataMember]
public virtual string DateSearchType { get; set; }
///<summary>
///IsGDS=0 (bookings from Non-GDS eg Supplier Direct). IsGDS=1 (bookings from GDS).
///</summary>
[DataMember]
public virtual string IsGDS { get; set; }
///<summary>
///IsPassive=0 (only include non-passive segments). IsPassive=1 (only include passive segments).
///</summary>
[DataMember]
public virtual string IsPassive { get; set; }
///<summary>
///Comma Delimited List of Custom Fields
///</summary>
[DataMember]
public virtual string[] CustomField { get; set; }
}
[DataContract(Name="Segment", Namespace="schemas.agentivity.com/types")]
public partial class HotelSegment
: IBookingCustomFields
{
[DataMember(Order=10)]
public virtual int AgentivityRef { get; set; }
[DataMember(Order=15)]
public virtual DateTime? PNRCreationDate { get; set; }
[DataMember(Order=20)]
public virtual string HotelSegmentNbr { get; set; }
[DataMember(Order=30)]
public virtual string RecordLocator { get; set; }
[DataMember(Order=50)]
public virtual string OwningAgencyLocationID { get; set; }
[DataMember(Order=60)]
public virtual string Account { get; set; }
[DataMember(Order=70)]
public virtual string OwningConsultantID { get; set; }
[DataMember(Order=80)]
public virtual string OwningConsultant { get; set; }
[DataMember(Order=90)]
public virtual string StatusCode { get; set; }
[DataMember(Order=95)]
public virtual DateTime? SegmentCreationDate { get; set; }
[DataMember(Order=100)]
public virtual DateTime? ArrivalDate { get; set; }
[DataMember(Order=110)]
public virtual DateTime? DepartureDate { get; set; }
[DataMember(Order=120)]
public virtual int NbrNights { get; set; }
[DataMember(Order=130)]
public virtual string VendorCode { get; set; }
[DataMember(Order=140)]
public virtual string PropertyName { get; set; }
[DataMember(Order=150)]
public virtual string PropertyNbr { get; set; }
[DataMember(Order=160)]
public virtual string PropertyAddress { get; set; }
[DataMember(Order=145)]
public virtual string PropertyPhoneNbr { get; set; }
[DataMember(Order=170)]
public virtual string CityCode { get; set; }
[DataMember(Order=170)]
public virtual string CityName { get; set; }
[DataMember(Order=180)]
public virtual string CountryCode { get; set; }
[DataMember(Order=190)]
public virtual string CountryName { get; set; }
[DataMember(Order=200)]
public virtual string Passenger { get; set; }
[DataMember(Order=210)]
public virtual string ConfirmationNbr { get; set; }
[DataMember(Order=220)]
public virtual string RateAccessCode { get; set; }
[DataMember(Order=230)]
public virtual string RoomBookingCode { get; set; }
[DataMember(Order=240)]
public virtual string CurrencyCode { get; set; }
[DataMember(Order=250)]
public virtual string RateAmount { get; set; }
[DataMember(Order=260)]
public virtual int NbrRooms { get; set; }
[DataMember(Order=270)]
public virtual string BookedInName { get; set; }
[DataMember(Order=275)]
public virtual string ServiceInformation { get; set; }
[DataMember(Order=280)]
public virtual string TotalAirSegs { get; set; }
[DataMember(Order=290)]
public virtual string CreatingAgencyIata { get; set; }
[DataMember(Order=310)]
public virtual bool? IsCommissionable { get; set; }
[DataMember(Order=320)]
public virtual string Commission { get; set; }
[DataMember(Order=330)]
public virtual bool IsPassive { get; set; }
[DataMember(Order=340)]
public virtual CustomFieldsCollection CustomFields { get; set; }
[DataMember(Order=350)]
public virtual string HotelNotepad { get; set; }
}
[DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
public partial class HotelSegmentsItemResponse
: ItemResponse<HotelSegment, HotelSegmentsResponseReport>
{
}
[DataContract(Name="HotelSegment", Namespace="schemas.agentivity.com/types")]
public partial class HotelSegmentsResponseReport
: Report<HotelSegmentsItemResponse, HotelSegment>
{
}
[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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=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"}}