Requires any of the roles: | SystemAdministrator, Manager, Customer |
GET | /reports |
---|
import 'package:servicestack/servicestack.dart';
enum ReportStatuses
{
Queued,
Running,
Completed,
Error,
}
class ReportInfo implements IConvertible
{
String? id;
String? name;
ReportStatuses? status;
String? statusMessage;
String? dateCreated;
String? dateUpdated;
String? downloadLink;
String? jobId;
String? emailAddressToNotify;
String? server;
ReportInfo({this.id,this.name,this.status,this.statusMessage,this.dateCreated,this.dateUpdated,this.downloadLink,this.jobId,this.emailAddressToNotify,this.server});
ReportInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
name = json['name'];
status = JsonConverters.fromJson(json['status'],'ReportStatuses',context!);
statusMessage = json['statusMessage'];
dateCreated = json['dateCreated'];
dateUpdated = json['dateUpdated'];
downloadLink = json['downloadLink'];
jobId = json['jobId'];
emailAddressToNotify = json['emailAddressToNotify'];
server = json['server'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'name': name,
'status': JsonConverters.toJson(status,'ReportStatuses',context!),
'statusMessage': statusMessage,
'dateCreated': dateCreated,
'dateUpdated': dateUpdated,
'downloadLink': downloadLink,
'jobId': jobId,
'emailAddressToNotify': emailAddressToNotify,
'server': server
};
getTypeName() => "ReportInfo";
TypeContext? context = _ctx;
}
class ListReportsResponse implements IConvertible
{
List<ReportInfo>? reports;
ListReportsResponse({this.reports});
ListReportsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
reports = JsonConverters.fromJson(json['reports'],'List<ReportInfo>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'reports': JsonConverters.toJson(reports,'List<ReportInfo>',context!)
};
getTypeName() => "ListReportsResponse";
TypeContext? context = _ctx;
}
/**
* Returns all of the active/completed reports for the current user
*/
// @Api(Description="Returns all of the active/completed reports for the current user")
class ListReports implements IConvertible
{
String? accountId;
ListReports({this.accountId});
ListReports.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
accountId = json['accountId'];
return this;
}
Map<String, dynamic> toJson() => {
'accountId': accountId
};
getTypeName() => "ListReports";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'evovoice.io', types: <String, TypeInfo> {
'ReportStatuses': TypeInfo(TypeOf.Enum, enumValues:ReportStatuses.values),
'ReportInfo': TypeInfo(TypeOf.Class, create:() => ReportInfo()),
'ListReportsResponse': TypeInfo(TypeOf.Class, create:() => ListReportsResponse()),
'List<ReportInfo>': TypeInfo(TypeOf.Class, create:() => <ReportInfo>[]),
'ListReports': TypeInfo(TypeOf.Class, create:() => ListReports()),
});
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: 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>