Update a Spending Limit Control Subscription
{apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId}
Request
-
subscriptionId(required): string
Identifies an individual spending limit retrieval subscription.
- application/json
object
-
expiry: string
(date-time)
The date and time when the spending limit subscription expires.
-
gpsi: string
Pattern:
^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$
The unique 5G Generic Public Subscription Identifier (GPSI). It contains either an external ID or an MSISDN. -
notifUri: string
The recipient of the spending limit notifications sent to the NF service consumer by the CHF.
-
policyCounterIds: array
policyCounterIds
Minimum Number of Items:
1
A list of policy counter identifiers. -
supi: string
Pattern:
^(imsi-[0-9]{5,15}|nai-.+|.+)$
The unique 5G Subscription Permanent Identifier (SUPI). A SUPI is usually a string of 15 decimal digits. -
supportedFeatures: string
Pattern:
^[A-Fa-f0-9]*$
The list of supported features.
array
1
-
Array of:
string
The ID of the requested policy counter.
Response
- application/json
- application/json;charset=utf-8
200 Response
object
-
expiry: string
(date-time)
The date and time the spending limit subscription expires.
-
statusInfos: object
statusInfos
Minimum Number of Properties:
1
Additional Properties Allowed: PolicyCounterInfoThe status of the requested policy counters. The key of the map is the policyCounterId attribute. -
supi: string
Pattern:
^(imsi-[0-9]{5,15}|nai-.+|.+)$
The unique 5G Subscription Permanent Identifier (SUPI). A SUPI is usually a string of 15 decimal digits. -
supportedFeatures: string
Pattern:
^[A-Fa-f0-9]*$
The list of supported features.
object
1
-
object PolicyCounterInfo
Information about a policy counter.
object
-
currentStatus(required): string
The current status of the policy counter. The values such as valid or invalid are not specified.
-
penPolCounterStatuses: array
penPolCounterStatuses
Minimum Number of Items:
1
The status of the pending policy counter. -
policyCounterId(required): string
The ID of the requested policy counter.
array
1
-
Array of:
object PendingPolicyCounterStatus
The status of the pending policy counter.
object
-
activationTime(required): string
(date-time)
The activation times per required policy counter.
-
policyCounterStatus(required): string
The status of the policy counter. The values, such as valid, invalid, or any other status, are not specified.
400 Response
object
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
The URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
The error code, which contains application-relevant detail.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
The URI to the documentation describing the error.
-
status: string
The HTTP error code extension.
401 Response
object
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
The URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
The error code, which contains application-relevant detail.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
The URI to the documentation describing the error.
-
status: string
The HTTP error code extension.
403 Response
object
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
The URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
The error code, which contains application-relevant detail.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
The URI to the documentation describing the error.
-
status: string
The HTTP error code extension.
404 Response
object
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
The URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
The error code, which contains application-relevant detail.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
The URI to the documentation describing the error.
-
status: string
The HTTP error code extension.
411 Response
object
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
The URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
The error code, which contains application-relevant detail.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
The URI to the documentation describing the error.
-
status: string
The HTTP error code extension.
413 Response
object
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
The URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
The error code, which contains application-relevant detail.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
The URI to the documentation describing the error.
-
status: string
The HTTP error code extension.
415 Response
object
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
The URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
The error code, which contains application-relevant detail.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
The URI to the documentation describing the error.
-
status: string
The HTTP error code extension.
429 Response
object
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
The URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
The error code, which contains application-relevant detail.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
The URI to the documentation describing the error.
-
status: string
The HTTP error code extension.
500 Response
object
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
The URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
The error code, which contains application-relevant detail.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
The URI to the documentation describing the error.
-
status: string
The HTTP error code extension.
503 Response
object
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
The URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
The error code, which contains application-relevant detail.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
The URI to the documentation describing the error.
-
status: string
The HTTP error code extension.
Examples
The following example shows how to update an existing spending limit subscription by submitting a PUT request on the REST resource using cURL. For more information about cURL, see "Use cURL".
The -d option specifies the file to attach as the request body.
curl -X PUT 'apiRoot/nchf-spendinglimitcontrol/v1/subscriptions/imsi-6500000427" -H "accept: */*" -H "Content-Type: application/json" -d @file.json
where:
-
apiRoot is for accessing the HTTP Gateway server at either http://hostname:httpPort or https://hostname:httpsPort.
- file.json is the JSON file that specifies the spending limit subscription to update.
Example of Request Body
The following is an example of the contents of the file.json file sent as the request body:
{ "supi": "imsi-6500000427", "expiry": "2022-07-12T03:12:10.293Z", "notifUri": "http://test.example.com", "policyCounterIds": [ "FREE_MIN" ], "supportedFeatures": "F" }
Example of Response Body
If successful, the 200 response code is returned along with a header and response body. The following shows sample header contents:
connection: keep-alive content-length: 50 content-type: application/json date: Tue, 12 Jul 2022 09:33:33 +0530
The following shows sample response body contents:
{ "supi": "imsi-6500000427", "statusInfos": { "FREE_MIN": { "policyCounterId": "FREE_MIN", "currentStatus": "Active" } }, "expiry": null, "supportedFeatures": null }