Agentivity API

<back to all web services

GetHotelSegments

The following routes are available for this service:
GET/HotelSegments
GetHotelSegments Parameters:
NameParameterData TypeRequiredDescription
DateStartquerystringYesDate in format YYYYMMDD
DateEndquerystringYesDate in format YYYYMMDD
AccountquerystringNoComma Delimited List of Accounts
CityCodequerystringNo3 letter city code
WithNotepadquerystringNoInclude Notepad Entry: 1=Yes
OwningAgencyLocationIDquerystringNoComma Delimited List of PCCs
OwningAgencyCountryCodequerystringNoComma Delimited List of CountryCodes
DateSearchTypequerystringNoDate 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).
IsGDSquerybooleanNoIsGDS=0 (bookings from Non-GDS eg Supplier Direct). IsGDS=1 (bookings from GDS).
IsPassivequerystringNoIsPassive=0 (only include non-passive segments). IsPassive=1 (only include passive segments).
CustomFieldquerystringNoComma Delimited List of Custom Fields
CompanyLevelRequestBase Parameters:
NameParameterData TypeRequiredDescription
OwningCompanyCodequerystringNoComma Delimited List of Owning Company Codes
UserNamequerystringNoUserName in form of an email address
PagingMetadata Parameters:
NameParameterData TypeRequiredDescription
OffsetquerystringNoStarting Record
LimitquerystringNoNumber of records to return (PageSize)
TotalRecordsquerystringNoTotal Number of Records in a Full Reponse (if no paging)
ResponseRecordsquerystringNoTotal Number of Records in this Reponse (on this page)
ItemResponse<TItem, TReport> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformTReportNo
ResponseErrorformAgentivityErrorNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
HasCacheformboolNo
HasPagingformboolNo
CacheMetadataformCacheMetadataNo
PagingMetadataformPagingMetadataNo
CacheMetadata Parameters:
NameParameterData TypeRequiredDescription
CachedAtformDateTimeNo
CacheExpiresAtformDateTimeNo
IsFromCacheformboolNo
AgentivityError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StatusCodeformstringNo
VerboseMessageformstringNo
HotelSegment Parameters:
NameParameterData TypeRequiredDescription
AgentivityRefformintNo
PNRCreationDateformDateTime?No
HotelSegmentNbrformstringNo
RecordLocatorformstringNo
OwningAgencyLocationIDformstringNo
AccountformstringNo
OwningConsultantIDformstringNo
OwningConsultantformstringNo
StatusCodeformstringNo
SegmentCreationDateformDateTime?No
ArrivalDateformDateTime?No
DepartureDateformDateTime?No
NbrNightsformintNo
VendorCodeformstringNo
PropertyNameformstringNo
PropertyNbrformstringNo
PropertyAddressformstringNo
PropertyPhoneNbrformstringNo
CityCodeformstringNo
CityNameformstringNo
CountryCodeformstringNo
CountryNameformstringNo
PassengerformstringNo
ConfirmationNbrformstringNo
RateAccessCodeformstringNo
RoomBookingCodeformstringNo
CurrencyCodeformstringNo
RateAmountformstringNo
NbrRoomsformintNo
BookedInNameformstringNo
ServiceInformationformstringNo
TotalAirSegsformstringNo
CreatingAgencyIataformstringNo
IsCommissionableformbool?No
CommissionformstringNo
IsPassiveformboolNo
CustomFieldsformCustomFieldsCollectionNo
HotelNotepadformstringNo
CustomFieldData Parameters:
NameParameterData TypeRequiredDescription
FieldNameformstringNo
FieldValueformstringNo
Report<TItemResponse, TItem> Parameters:
NameParameterData TypeRequiredDescription
ItemformTItemNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /HotelSegments HTTP/1.1 
Host: servicestack.agentivity.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}