Requires any of the roles: | SystemAdministrator, Manager, Customer |
GET | /reports |
---|
"use strict";
/** @typedef {'Queued'|'Running'|'Completed'|'Error'} */
export var ReportStatuses;
(function (ReportStatuses) {
ReportStatuses["Queued"] = "Queued"
ReportStatuses["Running"] = "Running"
ReportStatuses["Completed"] = "Completed"
ReportStatuses["Error"] = "Error"
})(ReportStatuses || (ReportStatuses = {}));
export class ReportInfo {
/** @param {{id?:string,name?:string,status?:ReportStatuses,statusMessage?:string,dateCreated?:string,dateUpdated?:string,downloadLink?:string,jobId?:string,emailAddressToNotify?:string,server?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
name;
/** @type {ReportStatuses} */
status;
/** @type {string} */
statusMessage;
/** @type {string} */
dateCreated;
/** @type {string} */
dateUpdated;
/** @type {string} */
downloadLink;
/** @type {string} */
jobId;
/** @type {string} */
emailAddressToNotify;
/** @type {string} */
server;
}
export class ListReportsResponse {
/** @param {{reports?:ReportInfo[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ReportInfo[]} */
reports;
}
export class ListReports {
/** @param {{accountId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
accountId;
}
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.
GET /reports HTTP/1.1 Host: team.evovoice.io Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ListReportsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Reports"> <Reports> <ReportInfo> <DateCreated>String</DateCreated> <DateUpdated>String</DateUpdated> <DownloadLink>String</DownloadLink> <EmailAddressToNotify>String</EmailAddressToNotify> <Id>String</Id> <JobId>String</JobId> <Name>String</Name> <Server>String</Server> <Status>Queued</Status> <StatusMessage>String</StatusMessage> </ReportInfo> </Reports> </ListReportsResponse>