Agentivity API

<back to all web services

GetApiRequestsPerHour

"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 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 GetApiRequestsPerHour extends PagingMetadata {
    /** @param {{DateStart?:string,DateEnd?: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 */
    DateStart;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    DateEnd;
}
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} */
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;
}

JavaScript GetApiRequestsPerHour DTOs

GET /ApiRequestsPerHour 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>
    <ApiRequestPerHour>
      <RequestDate>0001-01-01T00:00:00</RequestDate>
      <Hour0>0</Hour0>
      <Hour1>0</Hour1>
      <Hour2>0</Hour2>
      <Hour3>0</Hour3>
      <Hour4>0</Hour4>
      <Hour5>0</Hour5>
      <Hour6>0</Hour6>
      <Hour7>0</Hour7>
      <Hour8>0</Hour8>
      <Hour9>0</Hour9>
      <Hour10>0</Hour10>
      <Hour11>0</Hour11>
      <Hour12>0</Hour12>
      <Hour13>0</Hour13>
      <Hour14>0</Hour14>
      <Hour15>0</Hour15>
      <Hour16>0</Hour16>
      <Hour17>0</Hour17>
      <Hour18>0</Hour18>
      <Hour19>0</Hour19>
      <Hour20>0</Hour20>
      <Hour21>0</Hour21>
      <Hour22>0</Hour22>
      <Hour23>0</Hour23>
    </ApiRequestPerHour>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>