AIM Web Services

<back to all web services

ReportingOptionsRequest

ReportingOptions
Requires active-e Mobile Employee Service

The following routes are available for this service:
GET/api/ReportingOptions
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
ReportingOptionsResponse Parameters:
NameParameterData TypeRequiredDescription
ReportsformList<ApiReportObject>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
ApiReportObject Parameters:
NameParameterData TypeRequiredDescription
ReportNameformstringNo
ReportIdformlongNo
PrefsformList<ReportPref>No
ReportPref Parameters:
NameParameterData TypeRequiredDescription
PrefIdformlongNo
NameformstringNo

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.

GET /api/ReportingOptions HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Reports":[{"ReportName":"String","ReportId":0,"Prefs":[{"PrefId":0,"Name":"String"}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}