Agentivity API

<back to all web services

QLogEm

The following routes are available for this service:
All Verbs/QLogEm
"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 QLogEmItem {
    /** @param {{AgentivityRef?:number,EntryID?:number,MatchedOn?:string,RecordLocator?:string,LogDate?:string,EventType?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentivityRef;
    /** @type {number} */
    EntryID;
    /** @type {string} */
    MatchedOn;
    /** @type {string} */
    RecordLocator;
    /** @type {?string} */
    LogDate;
    /** @type {string} */
    EventType;
}
/** @typedef TItemResponse {any} */
/** @typedef  TItem {any} */
export class Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {TItem} */
    Item;
}
export class QLogEmResponseReport extends Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
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 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} */
/** @typedef  TReport {any} */
export class ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseMetadata} */
    ResponseMetadata;
    /** @type {TReport} */
    ResponseReport;
    /** @type {AgentivityError} */
    ResponseError;
}
export class QLogEmItemResponse extends ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class QLogEm extends PagingMetadata {
    /** @param {{CompanyID?:number,QueueEntryID?:number,LogDateStart?:string,LogDateEnd?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {number}
     * @description ID of a Company (travel agency) */
    CompanyID;
    /**
     * @type {number}
     * @description ID for queue entry */
    QueueEntryID;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    LogDateStart;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    LogDateEnd;
}

JavaScript QLogEm DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /QLogEm HTTP/1.1 
Host: api.agentivity.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyID":0,"QueueEntryID":0,"LogDateStart":"String","LogDateEnd":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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":{"Item":{"AgentivityRef":0,"EntryID":0,"MatchedOn":"String","RecordLocator":"String","LogDate":"\/Date(-62135596800000-0000)\/","EventType":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}