Agentivity API

GetPassengerLocationsByFlightNumber

The following routes are available for this service:
GET	/PassengerLocationsByFlightNumber

**GetPassengerLocationsByFlightNumber** Parameters:
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

**CompanyLevelRequestBase** Parameters:
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

**PagingMetadata** Parameters:
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)

**ItemResponse<TItem, TReport>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	TReport	No
ResponseError	form	AgentivityError	No

**ResponseMetadata** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
HasCache	form	bool	No
HasPaging	form	bool	No
CacheMetadata	form	CacheMetadata	No
PagingMetadata	form	PagingMetadata	No

**CacheMetadata** Parameters:
Name	Parameter	Data Type	Required
CachedAt	form	DateTime	No
CacheExpiresAt	form	DateTime	No
IsFromCache	form	bool	No

**AgentivityError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StatusCode	form	string	No
VerboseMessage	form	string	No

**PassengerLocationFlightNumber** Parameters:
Name	Parameter	Data Type	Required
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

**CustomFieldData** Parameters:
Name	Parameter	Data Type	Required	Description
FieldName	form	string	No
FieldValue	form	string	No

**Report<TItemResponse, TItem>** Parameters:
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

HTTP + XML

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/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>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <PaxList>String</PaxList>
      <OwningConsultantID>String</OwningConsultantID>
      <Account>String</Account>
      <DepartureDate>0001-01-01T00:00:00</DepartureDate>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <DepartureTime>String</DepartureTime>
      <ArrivalTime>String</ArrivalTime>
      <ChangeOfDay>String</ChangeOfDay>
      <EmailAddress>String</EmailAddress>
      <PhoneNbr>String</PhoneNbr>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <IataCodes>String</IataCodes>
      <CustomFields>
        <CustomField>
          <FieldName>String</FieldName>
          <FieldValue>String</FieldValue>
        </CustomField>
      </CustomFields>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>