Agentivity API

<back to all web services

BookingEventsSummaryRequest

The following routes are available for this service:
All Verbs/BookingEventsSummary
"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 EventsSummary {
    /** @param {{Create?:string,Cancel?:string,Change?:string,Ticketing?:string,Service?:string,TicketsIssued?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Create;
    /** @type {string} */
    Cancel;
    /** @type {string} */
    Change;
    /** @type {string} */
    Ticketing;
    /** @type {string} */
    Service;
    /** @type {number} */
    TicketsIssued;
}
export class ConsultantEventsSummary {
    /** @param {{ConsultantId?:string,Events?:EventsSummary}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ConsultantId;
    /** @type {EventsSummary} */
    Events;
}
export class AccountEventsSummary {
    /** @param {{AccountId?:string,Events?:EventsSummary,Consultants?:ConsultantEventsSummary[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AccountId;
    /** @type {EventsSummary} */
    Events;
    /** @type {ConsultantEventsSummary[]} */
    Consultants;
}
export class OwningAgencyLocationIdEventsSummary {
    /** @param {{BranchId?:string,Events?:EventsSummary,Accounts?:AccountEventsSummary[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    BranchId;
    /** @type {EventsSummary} */
    Events;
    /** @type {AccountEventsSummary[]} */
    Accounts;
}
export class BookingEventsSummary {
    /** @param {{DateStart?:string,DateEnd?:string,Events?:EventsSummary,Branches?:OwningAgencyLocationIdEventsSummary[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    DateStart;
    /** @type {?string} */
    DateEnd;
    /** @type {EventsSummary} */
    Events;
    /** @type {OwningAgencyLocationIdEventsSummary[]} */
    Branches;
}
/** @typedef TItemResponse {any} */
/** @typedef  TItem {any} */
export class Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {TItem} */
    Item;
}
export class BookingEventsSummaryRequestResponseReport 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 BookingEventsSummaryRequestItemResponse extends ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class BookingEventsSummaryRequest extends CompanyLevelRequestBase {
    /** @param {{EventDateStart?:string,EventDateEnd?:string,OwningAgencyLocationID?:string[],OwningCompanyCode?:string[],UserName?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    EventDateStart;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    EventDateEnd;
    /**
     * @type {string[]}
     * @description Comma Delimited List of PCCs */
    OwningAgencyLocationID;
}

JavaScript BookingEventsSummaryRequest DTOs

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.

POST /BookingEventsSummary HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"EventDateStart":"String","EventDateEnd":"String","OwningAgencyLocationID":["String"],"OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}

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":{"Item":{"DateStart":"\/Date(-62135596800000-0000)\/","DateEnd":"\/Date(-62135596800000-0000)\/","Events":{"Create":"String","Cancel":"String","Change":"String","Ticketing":"String","Service":"String","TicketsIssued":0},"Branches":[{"BranchId":"String","Events":{"Create":"String","Cancel":"String","Change":"String","Ticketing":"String","Service":"String","TicketsIssued":0},"Accounts":[{"AccountId":"String","Events":{"Create":"String","Cancel":"String","Change":"String","Ticketing":"String","Service":"String","TicketsIssued":0},"Consultants":[{"ConsultantId":"String","Events":{"Create":"String","Cancel":"String","Change":"String","Ticketing":"String","Service":"String","TicketsIssued":0}}]}]}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}