Get usage report

Reports usage.

GET /{external_URI_context}/quotanotification?{requestParametersGoHere}

accept: application/JSON/XML

The SDGW receives syslog messages from the OCSG, decodes these and converts them to HTTP GET requests.

Request parameters table

Table 1. Reports Usage Parameters Table
Parameter Description

methodId

Integer that identifies the method to be executed. So, when you want a usage report this is the request parameter for that.

values

  • 1 = usage report

/{external_URI_context}/quotanotification?methodId=1

MSISDN

A string that encodes the MSISDN.

This parameter expects a fully-qualified MSISDN.

/{external_URI_context}/quotanotification?methodId=1&msisdn=521551234567

campaignId

Integer that uniquely identifies the campaign. Important stuff here!

/{external_URI_context}/quotanotification?methodId=1&msisdn=521551234567&campaignId=19

sequenceNumber

An incremental number that locates the report within the sequence of reports for the subscriber (MSISDN) and campaign (campaignId).

/{external_URI_context}/quotanotification?methodId=1&msisdn=521551234567&campaignId=19&sequenceNumber=12345

usage

The data usage reported (byte count).

/{external_URI_context}/quotanotification?methodId=1&msisdn=521551234567&campaignId=19&sequenceNumber=12345&usage=1024120231

timestamp

Specifies the end date of the reporting period covered by the report.

/{external_URI_context}/quotanotification?methodId=1&msisdn=521551234567&campaignId=19&sequenceNumber=12345&usage=1024120231timestamp=2019-02-14T15:15:15.235-00:00

Response parameters table

The SDGW expects the SDS platform to return HTTP 200 for any accepted usage report.

If the SDS platform does not accept the usage report, it responds with any other standard HTTP code. The SDS platform responds to the SDGW with the following JSON for success and error cases.
Table 2. Reports Usage Response Table
Parameter Description

responseCode

Integer showing the result of the operation.

responseDescription

A text string that describes the result of the operation.

This should be used at the discretion of the external system.

sequenceNumber

The sequence number passed on the request for correlation.


Usage Report response

{
   "responseCode": "0",
   "responseDescription": "SUCCESS",
   "sequenceNumber": "18"
}