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 .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types"> <ResponseMetadata> <Success>false</Success> <HasCache>false</HasCache> <HasPaging>false</HasPaging> <CacheMetadata> <IsFromCache>false</IsFromCache> <CachedAt>0001-01-01T00:00:00</CachedAt> <CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt> </CacheMetadata> <PagingMetadata> <Limit>String</Limit> <Offset>String</Offset> <ResponseRecords>0</ResponseRecords> <TotalRecords>0</TotalRecords> </PagingMetadata> </ResponseMetadata> <ResponseReport> <Item> <HotelSegmentNbr>String</HotelSegmentNbr> <PCC>String</PCC> <PNR>String</PNR> <Consultant>String</Consultant> <StatusCode>String</StatusCode> <ArrivalDate>String</ArrivalDate> <DepartureDate>String</DepartureDate> <PropertyName>String</PropertyName> <ChainCode>String</ChainCode> <ChainName>String</ChainName> <City>String</City> <CityCode>String</CityCode> <CityName>String</CityName> <CountryCode>String</CountryCode> <CountryName>String</CountryName> <Passenger>String</Passenger> <Account>String</Account> <ConfirmationNbr>String</ConfirmationNbr> <Currency>String</Currency> <Rate>String</Rate> <RoomBookingCode>String</RoomBookingCode> <NbrNights>0</NbrNights> <MultiLevelRateCode>String</MultiLevelRateCode> <NbrRooms>0</NbrRooms> <BookedInName>String</BookedInName> <ServiceInformation>String</ServiceInformation> <TotalAirSegs>String</TotalAirSegs> <CreatingAgencyIata>String</CreatingAgencyIata> <AgentivityRef>0</AgentivityRef> <Commissionable>false</Commissionable> <HotelCommission>String</HotelCommission> <PropertyID>String</PropertyID> </Item> </ResponseReport> <ResponseError> <ErrorCode>String</ErrorCode> <Message>String</Message> <StatusCode>String</StatusCode> <VerboseMessage>String</VerboseMessage> </ResponseError> </AgentivityResponse>