| All Verbs | /ConsultantWorkMissedHotelOpportunities |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TravelDateStart | query | string | Yes | Date in format YYYYMMDD |
| TravelDateEnd | query | string | No | Date in format YYYYMMDD |
| HasNoHotelReason | query | boolean | No | Return only PNRs with/without a NoHotelReason specified |
| OwningConsultantID | query | string | Yes | Comma delimited list of owning consultants ids |
| RequestConsultantID | query | string | No | Request Consultant ID (sign on) |
| 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 |
|---|---|---|---|---|
| AgentivityRef | form | int | No | |
| RecordLocator | form | string | No | |
| PNRCreationDate | form | DateTime? | No | |
| CityCode | form | string | No | |
| Account | form | string | No | |
| Passengers | form | string | No | |
| OwningConsultant | form | string | No | |
| OwningConsultantID | form | string | No | |
| GdsCode | form | string | No | |
| From | form | DateTime? | No | |
| To | form | DateTime? | No | |
| NightsNumber | form | int? | No | |
| NoHotelReason | 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ConsultantWorkMissedHotelOpportunities HTTP/1.1
Host: api.agentivity.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"TravelDateStart":"String","TravelDateEnd":"String","HasNoHotelReason":false,"OwningConsultantID":["String"],"RequestConsultantID":"String","OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}
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,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","CityCode":"String","Account":"String","Passengers":"String","OwningConsultant":"String","OwningConsultantID":"String","GdsCode":"String","From":"\/Date(-62135596800000-0000)\/","To":"\/Date(-62135596800000-0000)\/","NightsNumber":0,"NoHotelReason":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}