GET | /DeparturesByClassName |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Account | query | string | No | Comma Delimited List of Accounts |
ClassName | query | string | No | Name of the class |
TravelDateStart | query | string | Yes | Date in format YYYYMMDD |
TravelDateEnd | query | string | Yes | Date in format YYYYMMDD |
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 | List<TItem> | 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 | string | No | |
AgentivityRef | form | string | No | |
Account | form | string | No | |
OwningConsultant | form | string | No | |
PNRTicketed | form | string | No | |
TravelDate | form | string | No | |
TicketedStatus | form | string | No | |
PaxList | form | string | No | |
Routing | form | string | No | |
AirSegCount | form | string | No | |
CarSegCount | form | string | No | |
HtlSegCount | form | string | No | |
CarPSegCount | form | string | No | |
HtlPSegCount | form | string | No | |
TrainSegCount | form | string | No | |
OtherSegCount | form | string | 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.
GET //DeparturesByClassName 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":[{"RecordLocator":"String","PNRCreationDate":"String","AgentivityRef":"String","Account":"String","OwningConsultant":"String","PNRTicketed":"String","TravelDate":"String","TicketedStatus":"String","PaxList":"String","Routing":"String","AirSegCount":"String","CarSegCount":"String","HtlSegCount":"String","CarPSegCount":"String","HtlPSegCount":"String","TrainSegCount":"String","OtherSegCount":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}