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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/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":[{"TravellerGUID":"String","FirstName":"String","LastName":"String","BAR":"String","MAR":"String","PAR":"String","Aliases":[{"FirstName":"String","LastName":"String"}],"Accounts":[{"AccountID":"String","AccountName":"String","PNRStats":{"PNRsCreatedPreviousThreeYears":0}}],"BARS":[{"BAR":"String"}],"MARS":[{"MAR":"String"}],"PARS":[{"PAR":"String"}],"PNRStats":{"PNRsCreatedPreviousThreeYears":0}}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}