Agentivity API

<back to all web services

AgencyActivitiesByConsultant

"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 AgencyActivityItem {
    /** @param {{EventHour?:number,EventType?:string,TotalBookings?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    EventHour;
    /** @type {string} */
    EventType;
    /** @type {number} */
    TotalBookings;
}
export class AgencyActivityByConsultant {
    /** @param {{Items?:AgencyActivityItem[],Formatted?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AgencyActivityItem[]} */
    Items;
    /** @type {string} */
    Formatted;
}
/** @typedef TItemResponse {any} */
/** @typedef  TItem {any} */
export class Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {TItem} */
    Item;
}
export class AgencyActivitiesByConsultantResponseReport 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 AgencyActivitiesByConsultantItemResponse extends ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef {number} */
export var FormattingStyle;
(function (FormattingStyle) {
    FormattingStyle[FormattingStyle["None"] = 0] = "None"
    FormattingStyle[FormattingStyle["Html"] = 1] = "Html"
    FormattingStyle[FormattingStyle["Charting"] = 2] = "Charting"
})(FormattingStyle || (FormattingStyle = {}));
export class AgencyActivitiesByConsultant extends CompanyLevelRequestBase {
    /** @param {{EventDateStart?:string,EventDateEnd?:string,OwningConsultantID?:string,OwningAgencyLocationID?:string[],Team?:string,FormatStyle?:FormattingStyle,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 Id of the owning consultant */
    OwningConsultantID;
    /**
     * @type {string[]}
     * @description Comma Delimited List of PCCs */
    OwningAgencyLocationID;
    /**
     * @type {string}
     * @description Team name */
    Team;
    /**
     * @type {FormattingStyle}
     * @description Format style */
    FormatStyle;
}

JavaScript AgencyActivitiesByConsultant DTOs

GET /AgencyActivityByConsultants HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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":{"Items":[{"EventHour":0,"EventType":"String","TotalBookings":0}],"Formatted":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}