GET | /HotelSegments |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserName | query | string | Yes | UserName in form of an email address |
ArrivalDateStart | query | string | Yes | Date in format YYYYMMDD |
ArrivalDateEnd | query | string | Yes | Date in format YYYYMMDD |
Account | query | string | No | Comma Delimited List of Accounts |
CityCode | query | string | No | 3 letter city code |
DateSearchType | query | string | No | Date search type option, a single character (T to search by segment start dates, C to search by booking creation dates). |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | query | string | No | Starting Record |
Limit | query | string | No | Number of records to return (PageSize) |
TotalRecords | query | string | No | Total Number of Records in a Full Reponse (if no paging) |
ResponseRecords | query | string | No | Total Number of Records in this Reponse (on this page) |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseMetadata | form | ResponseMetadata | No | |
ResponseReport | form | TReport | No | |
ResponseError | form | AgentivityError | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Success | form | bool | No | |
HasCache | form | bool | No | |
HasPaging | form | bool | No | |
CacheMetadata | form | CacheMetadata | No | |
PagingMetadata | form | PagingMetadata | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CachedAt | form | DateTime | No | |
CacheExpiresAt | form | DateTime | No | |
IsFromCache | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ErrorCode | form | string | No | |
Message | form | string | No | |
StatusCode | form | string | No | |
VerboseMessage | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
HotelSegmentNbr | form | string | No | |
PCC | form | string | No | |
PNR | form | string | No | |
Consultant | form | string | No | |
StatusCode | form | string | No | |
ArrivalDate | form | string | No | |
DepartureDate | form | string | No | |
PropertyName | form | string | No | |
ChainCode | form | string | No | |
ChainName | form | string | No | |
City | form | string | No | |
CityCode | form | string | No | |
CityName | form | string | No | |
CountryCode | form | string | No | |
CountryName | form | string | No | |
Passenger | form | string | No | |
Account | form | string | No | |
ConfirmationNbr | form | string | No | |
Currency | form | string | No | |
Rate | form | string | No | |
RoomBookingCode | form | string | No | |
NbrNights | form | int | No | |
MultiLevelRateCode | form | string | No | |
NbrRooms | form | int | No | |
BookedInName | form | string | No | |
ServiceInformation | form | string | No | |
TotalAirSegs | form | string | No | |
CreatingAgencyIata | form | string | No | |
AgentivityRef | form | int | No | |
Commissionable | form | bool? | No | |
HotelCommission | form | string | No | |
PropertyID | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Item | form | TItem | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK Content-Type: text/csv 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"}}