GET | /PassengerLocationsByFlightNumber |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Account | query | string | No | Comma Delimited List of Accounts |
DepartureDateStart | query | string | Yes | Date in format YYYYMMDD |
DepartureDateEnd | query | string | Yes | Date in format YYYYMMDD |
CarrierCode | query | string | Yes | Two letter code for carrier |
FlightNumber | query | string | Yes | Flight number without spaces |
AllFutureDate | query | boolean | No | All future date |
CustomField | query | string | No | Comma Delimited List of Custom Fields |
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 | |
PaxList | form | string | No | |
OwningConsultantID | form | string | No | |
Account | form | string | No | |
DepartureDate | form | DateTime? | No | |
BoardPoint | form | string | No | |
OffPoint | form | string | No | |
DepartureTime | form | string | No | |
ArrivalTime | form | string | No | |
ChangeOfDay | form | string | No | |
EmailAddress | form | string | No | |
PhoneNbr | form | string | No | |
OwningAgencyLocationID | form | string | No | |
IataCodes | form | string | No | |
CustomFields | form | CustomFieldsCollection | No | |
PNRCreationDate | form | DateTime? | No | |
TicketNumbers | form | string[] | No | |
VendorLocators | form | BookingExtVendorLocator[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FieldName | form | string | No | |
FieldValue | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CarrierCode | form | string | No | |
VendorLocator | 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.
GET //PassengerLocationsByFlightNumber 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":{"Item":{"AgentivityRef":0,"RecordLocator":"String","PaxList":"String","OwningConsultantID":"String","Account":"String","DepartureDate":"\/Date(-62135596800000-0000)\/","BoardPoint":"String","OffPoint":"String","DepartureTime":"String","ArrivalTime":"String","ChangeOfDay":"String","EmailAddress":"String","PhoneNbr":"String","OwningAgencyLocationID":"String","IataCodes":"String","CustomFields":[{"FieldName":"String","FieldValue":"String"}],"PNRCreationDate":"\/Date(-62135596800000-0000)\/","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}