Agentivity API

GetTravellersByName

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

**GetTravellersByName** Parameters:
Name	Parameter	Data Type	Required	Description
LastName	query	string	No	Last name
FirstName	query	string	No	First name
RequestConsultantID	query	string	No	Request Consultant ID (sign on)

**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)

**CollectionResponse<TItem>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	List<TItem>	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

**TravellerByNameNested** Parameters:
Name	Parameter	Data Type	Required
TravellerGUID	form	string	No
FirstName	form	string	No
LastName	form	string	No
BAR	form	string	No
MAR	form	string	No
PAR	form	string	No
Aliases	form	List<Aliases>	No
Accounts	form	List<Accounts>	No
BARS	form	List<BARS>	No
MARS	form	List<MARS>	No
PARS	form	List<PARS>	No
PNRStats	form	PNRStats	No

**Aliases** Parameters:
Name	Parameter	Data Type	Required	Description
FirstName	form	string	No
LastName	form	string	No

**Accounts** Parameters:
Name	Parameter	Data Type	Required
AccountID	form	string	No
AccountName	form	string	No
PNRStats	form	PNRStats	No

**PNRStats** Parameters:
Name	Parameter	Data Type	Required	Description
PNRsCreatedPreviousThreeYears	form	int	No

**BARS** Parameters:
Name	Parameter	Data Type	Required	Description
BAR	form	string	No

**MARS** Parameters:
Name	Parameter	Data Type	Required	Description
MAR	form	string	No

**PARS** Parameters:
Name	Parameter	Data Type	Required	Description
PAR	form	string	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 //TravellersByName 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>
    <Traveller>
      <TravellerGUID>String</TravellerGUID>
      <FirstName>String</FirstName>
      <LastName>String</LastName>
      <BAR>String</BAR>
      <MAR>String</MAR>
      <PAR>String</PAR>
      <Aliases>
        <AliasesItem>
          <FirstName>String</FirstName>
          <LastName>String</LastName>
        </AliasesItem>
      </Aliases>
      <Accounts>
        <Account>
          <AccountID>String</AccountID>
          <AccountName>String</AccountName>
          <PNRStats>
            <PNRsCreatedPreviousThreeYears>0</PNRsCreatedPreviousThreeYears>
          </PNRStats>
        </Account>
      </Accounts>
      <BARS>
        <BARItem>
          <BAR>String</BAR>
        </BARItem>
      </BARS>
      <MARS>
        <MARItem>
          <MAR>String</MAR>
        </MARItem>
      </MARS>
      <PARS>
        <PARitem>
          <PAR>String</PAR>
        </PARitem>
      </PARS>
      <PNRStats>
        <PNRsCreatedPreviousThreeYears>0</PNRsCreatedPreviousThreeYears>
      </PNRStats>
    </Traveller>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>