Agentivity API

<back to all web services

GetHotelSegments

The following routes are available for this service:
GET/HotelSegments
GetHotelSegments Parameters:
NameParameterData TypeRequiredDescription
UserNamequerystringYesUserName in form of an email address
ArrivalDateStartquerystringYesDate in format YYYYMMDD
ArrivalDateEndquerystringYesDate in format YYYYMMDD
AccountquerystringNoComma Delimited List of Accounts
CityCodequerystringNo3 letter city code
DateSearchTypequerystringNoDate search type option, a single character (T to search by segment start dates, C to search by booking creation dates).
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
HotelSegmentWithOwner Parameters:
NameParameterData TypeRequiredDescription
HotelSegmentNbrformstringNo
PCCformstringNo
PNRformstringNo
ConsultantformstringNo
StatusCodeformstringNo
ArrivalDateformstringNo
DepartureDateformstringNo
PropertyNameformstringNo
ChainCodeformstringNo
ChainNameformstringNo
CityformstringNo
CityCodeformstringNo
CityNameformstringNo
CountryCodeformstringNo
CountryNameformstringNo
PassengerformstringNo
AccountformstringNo
ConfirmationNbrformstringNo
CurrencyformstringNo
RateformstringNo
RoomBookingCodeformstringNo
NbrNightsformintNo
MultiLevelRateCodeformstringNo
NbrRoomsformintNo
BookedInNameformstringNo
ServiceInformationformstringNo
TotalAirSegsformstringNo
CreatingAgencyIataformstringNo
AgentivityRefformintNo
Commissionableformbool?No
HotelCommissionformstringNo
PropertyIDformstringNo
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: api.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":{"HotelSegmentNbr":"String","PCC":"String","PNR":"String","Consultant":"String","StatusCode":"String","ArrivalDate":"String","DepartureDate":"String","PropertyName":"String","ChainCode":"String","ChainName":"String","City":"String","CityCode":"String","CityName":"String","CountryCode":"String","CountryName":"String","Passenger":"String","Account":"String","ConfirmationNbr":"String","Currency":"String","Rate":"String","RoomBookingCode":"String","NbrNights":0,"MultiLevelRateCode":"String","NbrRooms":0,"BookedInName":"String","ServiceInformation":"String","TotalAirSegs":"String","CreatingAgencyIata":"String","AgentivityRef":0,"Commissionable":false,"HotelCommission":"String","PropertyID":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}