GET | /api/resellers/{ResellerGuid}/serviceusercountreport | Gets a Resellers ServiceUserCount Report. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResellerGuid | path | Guid | Yes | The Guid of the Reseller |
StartPeriod | query | DateTime | Yes | The start period of the Report. Only the Year/Month are currently used and any Day or Time values will be ignored. |
EndPeriod | query | DateTime | No | The end period of the Report. Only the Year/Month are currently used and any Day or Time values will be ignored. EndPeriod defaults to todays UTC date if left null. |
Page | query | Integer | No | The Page number being requested. Defaults to 1. |
PageSize | query | Integer | No | The Page Size returned by the operation. Defaults to 25. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StartPeriod | body | DateTime | No | |
EndPeriod | body | DateTime | No | |
TotalPeriodProUserCounts | body | PeriodStat[] | No | |
TotalPeriodGuestUserCounts | body | PeriodStat[] | No | |
PageSize | body | Integer | No | |
TotalPages | body | Integer | No | |
TotalItems | body | Integer | No | |
CurrentPage | body | Integer | No | |
Results | body | PeriodServiceUserCountRecord[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
sPeriod | body | DateTime | No | |
Total | body | Integer | No | |
PercentageChanged | body | Double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ServiceGuid | body | Guid | No | |
ServiceCode | form | string | No | |
ServiceStatus | form | ServiceStatus | No | Allowable Values
|
CreatedOn | body | DateTime | No | |
TrialEndDate | body | DateTime | No | |
ReferenceId | form | string | No | |
CollectionName | form | string | No | |
ResellerName | form | string | No | |
CompanyName | form | string | No | |
CompanyCity | form | string | No | |
CompanyPostalCode | form | string | No | |
PrimaryDomain | form | string | No | |
ProUserStats | body | PeriodStat[] | No | |
GuestUserStats | body | PeriodStat[] | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/resellers/{ResellerGuid}/serviceusercountreport HTTP/1.1 Host: api.secure-messaging.com Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length { "startPeriod": "0001-01-01T00:00:00Z", "endPeriod": "0001-01-01T00:00:00Z", "totalPeriodProUserCounts": [ { "period": "0001-01-01", "total": 0, "pctChg": 0 } ], "totalPeriodGuestUserCounts": [ { "period": "0001-01-01", "total": 0, "pctChg": 0 } ], "pageSize": 0, "totalPages": 0, "totalItems": 0, "currentPage": 0, "results": [ { "serviceGuid": "00000000000000000000000000000000", "serviceCode": "String", "serviceStatus": "Blocked", "createdOn": "0001-01-01T00:00:00Z", "trialEndDate": "0001-01-01T00:00:00Z", "referenceId": "String", "collectionName": "String", "resellerName": "String", "companyName": "String", "companyCity": "String", "companyPostalCode": "String", "primaryDomain": "String", "proUserStats": [ { "period": "0001-01-01", "total": 0, "pctChg": 0 } ], "guestUserStats": [ { "period": "0001-01-01", "total": 0, "pctChg": 0 } ] } ], "responseStatus": { "errorCode": "String", "message": "String", "stackTrace": "String", "errors": [ { "errorCode": "String", "fieldName": "String", "message": "String", "meta": { "String": "String" } } ], "meta": { "String": "String" } } }