CAP

Retrieve a Capped data

Work with Capped data record.Retrieves the Capped data record with the given ID.

get/admin/fup/capped-data/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/fup/capped-data/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the desired Capped data record.

Response

idnumber required

CAP Id.

service_idnumber required

Service Id.

quantitynumber required

Traffic quantity.

quantity_remindnumber required

Remind traffic quantity.

over_usagenumber

Represents the amount of traffic that exceeds the FUP limit. If the usage surpasses the FUP limit, over_usage is calculated as usage - fup limit.

valid_tillstring required

Valid till date.

end_of_periodstring

End of period.

transaction_idnumber required

Transaction Id.

pricenumber required

Price of the Capped data.

added_bystring

Added by: 'api', 'admin', 'customer', 'system'. Default value: 'system'

typestring

Type: 'admin_top_up', 'customer_top_up', 'api_top_up', 'auto_top_up', 'rollover_unused', 'rollover_to_next_month'.

descriptionstring

A dynamic description that provides information about the traffic rollover. The value depends on the specific context: it can describe the rollover traffic for a single service or the transfer of unused traffic from one service to another.

Example response

{
  "id": 15,
  "service_id": 100,
  "quantity": 50000000,
  "quantity_remind": 50000000,
  "over_usage": 1,
  "valid_till": "0000-00-00 00:00:00",
  "end_of_period": "0000-00-00 00:00:00",
  "transaction_id": 50,
  "price": 0,
  "added_by": "api",
  "type": "admin_top_up",
  "description": "``"
}

Changes

No recorded changes to this operation across all 1 revision of this API.