Agentivity API

<back to all web services

GetTravellersByName

The following routes are available for this service:
GET/TravellersByName
GetTravellersByName Parameters:
NameParameterData TypeRequiredDescription
LastNamequerystringNoLast name
FirstNamequerystringNoFirst name
RequestConsultantIDquerystringNoRequest Consultant ID (sign on)
CompanyLevelRequestBase Parameters:
NameParameterData TypeRequiredDescription
OwningCompanyCodequerystringNoComma Delimited List of Owning Company Codes
UserNamequerystringNoUserName in form of an email address
PagingMetadata Parameters:
NameParameterData TypeRequiredDescription
OffsetquerystringNoStarting Record
LimitquerystringNoNumber of records to return (PageSize)
TotalRecordsquerystringNoTotal Number of Records in a Full Reponse (if no paging)
ResponseRecordsquerystringNoTotal Number of Records in this Reponse (on this page)
CollectionResponse<TItem> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformList<TItem>No
ResponseErrorformAgentivityErrorNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
HasCacheformboolNo
HasPagingformboolNo
CacheMetadataformCacheMetadataNo
PagingMetadataformPagingMetadataNo
CacheMetadata Parameters:
NameParameterData TypeRequiredDescription
CachedAtformDateTimeNo
CacheExpiresAtformDateTimeNo
IsFromCacheformboolNo
AgentivityError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StatusCodeformstringNo
VerboseMessageformstringNo
TravellerByNameNested Parameters:
NameParameterData TypeRequiredDescription
TravellerGUIDformstringNo
FirstNameformstringNo
LastNameformstringNo
BARformstringNo
MARformstringNo
PARformstringNo
AliasesformList<Aliases>No
AccountsformList<Accounts>No
BARSformList<BARS>No
MARSformList<MARS>No
PARSformList<PARS>No
PNRStatsformPNRStatsNo
Aliases Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
Accounts Parameters:
NameParameterData TypeRequiredDescription
AccountIDformstringNo
AccountNameformstringNo
PNRStatsformPNRStatsNo
PNRStats Parameters:
NameParameterData TypeRequiredDescription
PNRsCreatedPreviousThreeYearsformintNo
BARS Parameters:
NameParameterData TypeRequiredDescription
BARformstringNo
MARS Parameters:
NameParameterData TypeRequiredDescription
MARformstringNo
PARS Parameters:
NameParameterData TypeRequiredDescription
PARformstringNo

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>