| All Verbs | /TravellersByCRM |
|---|
"use strict";
export class PagingMetadata {
/** @param {{Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Starting Record */
Offset;
/**
* @type {string}
* @description Number of records to return (PageSize) */
Limit;
/**
* @type {number}
* @description Total Number of Records in a Full Reponse (if no paging) */
TotalRecords;
/**
* @type {number}
* @description Total Number of Records in this Reponse (on this page) */
ResponseRecords;
}
export class CompanyLevelRequestBase extends PagingMetadata {
/** @param {{OwningCompanyCode?:string[],UserName?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string[]}
* @description Comma Delimited List of Owning Company Codes */
OwningCompanyCode;
/**
* @type {string}
* @description UserName in form of an email address */
UserName;
}
export class Aliases {
/** @param {{FirstName?:string,LastName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
FirstName;
/** @type {string} */
LastName;
}
export class PNRStats {
/** @param {{PNRsCreatedPreviousThreeYears?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
PNRsCreatedPreviousThreeYears;
}
export class Accounts {
/** @param {{AccountID?:string,AccountName?:string,PNRStats?:PNRStats}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
AccountID;
/** @type {string} */
AccountName;
/** @type {PNRStats} */
PNRStats;
}
export class BARS {
/** @param {{BAR?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
BAR;
}
export class MARS {
/** @param {{MAR?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
MAR;
}
export class PARS {
/** @param {{PAR?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
PAR;
}
export class TravellerByNameNested {
/** @param {{TravellerGUID?:string,FirstName?:string,LastName?:string,BAR?:string,MAR?:string,PAR?:string,Aliases?:Aliases[],Accounts?:Accounts[],BARS?:BARS[],MARS?:MARS[],PARS?:PARS[],PNRStats?:PNRStats}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
TravellerGUID;
/** @type {string} */
FirstName;
/** @type {string} */
LastName;
/** @type {string} */
BAR;
/** @type {string} */
MAR;
/** @type {string} */
PAR;
/** @type {Aliases[]} */
Aliases;
/** @type {Accounts[]} */
Accounts;
/** @type {BARS[]} */
BARS;
/** @type {MARS[]} */
MARS;
/** @type {PARS[]} */
PARS;
/** @type {PNRStats} */
PNRStats;
}
export class CacheMetadata {
/** @param {{CachedAt?:string,CacheExpiresAt?:string,IsFromCache?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CachedAt;
/** @type {string} */
CacheExpiresAt;
/** @type {boolean} */
IsFromCache;
}
export class ResponseMetadata {
/** @param {{Success?:boolean,HasCache?:boolean,HasPaging?:boolean,CacheMetadata?:CacheMetadata,PagingMetadata?:PagingMetadata}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
Success;
/** @type {boolean} */
HasCache;
/** @type {boolean} */
HasPaging;
/** @type {CacheMetadata} */
CacheMetadata;
/** @type {PagingMetadata} */
PagingMetadata;
}
export class ApiRequestPerHour {
/** @param {{RequestDate?:string,Hour0?:number,Hour1?:number,Hour2?:number,Hour3?:number,Hour4?:number,Hour5?:number,Hour6?:number,Hour7?:number,Hour8?:number,Hour9?:number,Hour10?:number,Hour11?:number,Hour12?:number,Hour13?:number,Hour14?:number,Hour15?:number,Hour16?:number,Hour17?:number,Hour18?:number,Hour19?:number,Hour20?:number,Hour21?:number,Hour22?:number,Hour23?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RequestDate;
/** @type {number} */
Hour0;
/** @type {number} */
Hour1;
/** @type {number} */
Hour2;
/** @type {number} */
Hour3;
/** @type {number} */
Hour4;
/** @type {number} */
Hour5;
/** @type {number} */
Hour6;
/** @type {number} */
Hour7;
/** @type {number} */
Hour8;
/** @type {number} */
Hour9;
/** @type {number} */
Hour10;
/** @type {number} */
Hour11;
/** @type {number} */
Hour12;
/** @type {number} */
Hour13;
/** @type {number} */
Hour14;
/** @type {number} */
Hour15;
/** @type {number} */
Hour16;
/** @type {number} */
Hour17;
/** @type {number} */
Hour18;
/** @type {number} */
Hour19;
/** @type {number} */
Hour20;
/** @type {number} */
Hour21;
/** @type {number} */
Hour22;
/** @type {number} */
Hour23;
}
export class AgentivityError {
/** @param {{ErrorCode?:string,Message?:string,StatusCode?:string,VerboseMessage?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ErrorCode;
/** @type {string} */
Message;
/** @type {string} */
StatusCode;
/** @type {string} */
VerboseMessage;
}
/** @typedef TItem {any} */
export class CollectionResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseMetadata} */
ResponseMetadata;
/** @type {ApiRequestPerHour[]} */
ResponseReport;
/** @type {AgentivityError} */
ResponseError;
}
export class TravellersByCrmResponse extends CollectionResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class GetTravellersByCrm extends CompanyLevelRequestBase {
/** @param {{CrmCode?:number,CrmTravellerId?:string,OwningCompanyCode?:string[],UserName?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
CrmCode;
/** @type {string} */
CrmTravellerId;
}
JavaScript GetTravellersByCrm DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /TravellersByCRM HTTP/1.1
Host: api.agentivity.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetTravellersByCrm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
<OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OwningCompanyCode>
<UserName>String</UserName>
<CrmCode>0</CrmCode>
<CrmTravellerId>String</CrmTravellerId>
</GetTravellersByCrm>
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>