Agentivity API

<back to all web services

GetTravellersByName

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

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
export class PagingMetadata
{
    /** @description Starting Record */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public Offset: string;

    /** @description Number of records to return (PageSize) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public Limit: string;

    /** @description Total Number of Records in a Full Reponse (if no paging) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
    public TotalRecords: number;

    /** @description Total Number of Records in this Reponse (on this page) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
    public ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
    /** @description Comma Delimited List of Owning Company Codes */
    // @DataMember
    public OwningCompanyCode: string[];

    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

    public constructor(init?: Partial<CompanyLevelRequestBase>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="AliasesItem", Namespace="schemas.agentivity.com/types")
export class Aliases
{
    // @DataMember
    public FirstName: string;

    // @DataMember
    public LastName: string;

    public constructor(init?: Partial<Aliases>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="PNRStatsItem", Namespace="schemas.agentivity.com/types")
export class PNRStats
{
    // @DataMember
    public PNRsCreatedPreviousThreeYears: number;

    public constructor(init?: Partial<PNRStats>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="Account", Namespace="schemas.agentivity.com/types")
export class Accounts
{
    // @DataMember
    public AccountID: string;

    // @DataMember
    public AccountName: string;

    // @DataMember
    public PNRStats: PNRStats;

    public constructor(init?: Partial<Accounts>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="BARItem", Namespace="schemas.agentivity.com/types")
export class BARS
{
    // @DataMember
    public BAR: string;

    public constructor(init?: Partial<BARS>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="MARItem", Namespace="schemas.agentivity.com/types")
export class MARS
{
    // @DataMember
    public MAR: string;

    public constructor(init?: Partial<MARS>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="PARitem", Namespace="schemas.agentivity.com/types")
export class PARS
{
    // @DataMember
    public PAR: string;

    public constructor(init?: Partial<PARS>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="Traveller", Namespace="schemas.agentivity.com/types")
export class TravellerByNameNested
{
    // @DataMember(Order=10)
    public TravellerGUID: string;

    // @DataMember(Order=20)
    public FirstName: string;

    // @DataMember(Order=30)
    public LastName: string;

    // @DataMember(Order=40)
    public BAR: string;

    // @DataMember(Order=50)
    public MAR: string;

    // @DataMember(Order=60)
    public PAR: string;

    // @DataMember(Order=70)
    public Aliases: Aliases[];

    // @DataMember(Order=80)
    public Accounts: Accounts[];

    // @DataMember(Order=90)
    public BARS: BARS[];

    // @DataMember(Order=100)
    public MARS: MARS[];

    // @DataMember(Order=110)
    public PARS: PARS[];

    // @DataMember(Order=120)
    public PNRStats: PNRStats;

    public constructor(init?: Partial<TravellerByNameNested>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
export class CacheMetadata
{
    // @DataMember(Order=1)
    public CachedAt: string;

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class ResponseMetadata
{
    // @DataMember(Order=0)
    public Success: boolean;

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public CacheMetadata: CacheMetadata;

    // @DataMember(Order=4, EmitDefaultValue=false)
    public PagingMetadata: PagingMetadata;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
export class ApiRequestPerHour
{
    // @DataMember(Order=10)
    public RequestDate: string;

    // @DataMember(Order=100)
    public Hour0: number;

    // @DataMember(Order=110)
    public Hour1: number;

    // @DataMember(Order=120)
    public Hour2: number;

    // @DataMember(Order=130)
    public Hour3: number;

    // @DataMember(Order=140)
    public Hour4: number;

    // @DataMember(Order=150)
    public Hour5: number;

    // @DataMember(Order=160)
    public Hour6: number;

    // @DataMember(Order=170)
    public Hour7: number;

    // @DataMember(Order=180)
    public Hour8: number;

    // @DataMember(Order=190)
    public Hour9: number;

    // @DataMember(Order=200)
    public Hour10: number;

    // @DataMember(Order=210)
    public Hour11: number;

    // @DataMember(Order=220)
    public Hour12: number;

    // @DataMember(Order=230)
    public Hour13: number;

    // @DataMember(Order=240)
    public Hour14: number;

    // @DataMember(Order=250)
    public Hour15: number;

    // @DataMember(Order=260)
    public Hour16: number;

    // @DataMember(Order=270)
    public Hour17: number;

    // @DataMember(Order=280)
    public Hour18: number;

    // @DataMember(Order=290)
    public Hour19: number;

    // @DataMember(Order=300)
    public Hour20: number;

    // @DataMember(Order=310)
    public Hour21: number;

    // @DataMember(Order=320)
    public Hour22: number;

    // @DataMember(Order=330)
    public Hour23: number;

    public constructor(init?: Partial<ApiRequestPerHour>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class CollectionResponse<TItem>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: ApiRequestPerHour[];

    // @DataMember(Order=3, EmitDefaultValue=false)
    public ResponseError: AgentivityError;

    public constructor(init?: Partial<CollectionResponse<TItem>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class TravellersByNameResponse extends CollectionResponse<TravellerByNameNested>
{

    public constructor(init?: Partial<TravellersByNameResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetTravellersByName extends CompanyLevelRequestBase implements IRequestConsultantID
{
    /** @description Last name */
    // @DataMember
    public LastName: string;

    /** @description First name */
    // @DataMember
    public FirstName: string;

    /** @description Request Consultant ID (sign on) */
    // @DataMember
    public RequestConsultantID: string;

    public constructor(init?: Partial<GetTravellersByName>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetTravellersByName DTOs

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>