| GET | /CancelledHotelSegments |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CancelledDateStart | query | string | Yes | Date in format YYYYMMDD |
| CancelledDateEnd | query | string | Yes | Date in format YYYYMMDD |
| OwningAgencyCountryCode | query | string | No | Comma Delimited List of CountryCodes |
| HasCancellationRemark | query | boolean | No | Return only PNRs with/without an Cancellation Reference |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OwningCompanyCode | query | string | No | Comma Delimited List of Owning Company Codes |
| UserName | query | string | No | UserName in form of an email address |
| 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 |
|---|---|---|---|---|
| RecordLocator | form | string | No | |
| PNRCreationDate | form | DateTime? | No | |
| OwningAgencyLocationID | form | string | No | |
| Account | form | string | No | |
| OwningConsultantID | form | string | No | |
| OwningConsultant | form | string | No | |
| StatusCode | form | string | No | |
| ArrivalDate | form | DateTime? | No | |
| DepartureDate | form | DateTime? | No | |
| PropertyName | form | string | No | |
| Chain | form | string | No | |
| City | form | string | No | |
| Passenger | 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 | |
| CancellationDate | form | DateTime? | No | |
| CancellationRemark | 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 /CancelledHotelSegments HTTP/1.1 Host: servicestack.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>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<Account>String</Account>
<OwningConsultantID>String</OwningConsultantID>
<OwningConsultant>String</OwningConsultant>
<StatusCode>String</StatusCode>
<ArrivalDate>0001-01-01T00:00:00</ArrivalDate>
<DepartureDate>0001-01-01T00:00:00</DepartureDate>
<PropertyName>String</PropertyName>
<Chain>String</Chain>
<City>String</City>
<Passenger>String</Passenger>
<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>
<CancellationDate>0001-01-01T00:00:00</CancellationDate>
<CancellationRemark>String</CancellationRemark>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>