6.1.3 Resources
32.2913GPP5G system, charging serviceCharging managementRelease 17Stage 3Telecommunication managementTS
6.1.3.1 Overview
Figure 6.1.3.1-1: Resource URI structure of the Nchf_ConvergedCharging API
Charging Data Ref is a unique identifier for a charging data resource in a PLMN. It’s created in CHF when CHF receives a Nchf_ ConvergedCharging_Create request and provided to NF (CTF) in the Location header field in the Nchf_ ConvergedCharging_Create response. The NF (CTF) shall use the Charging Data Ref received in subsequent requests to the CHF for the same charging data resource.
Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 6.1.3.1-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
Corresponding service operation |
|
Charging Data |
{apiRoot}/ |
POST |
Create a new Charging Data resource |
Nchf_ ConvergedCharging_Create |
|
Individual Charging Data |
{apiRoot}/ |
update (POST) |
Update an existing Charging Data resource. |
Nchf_ ConvergedCharging_Update |
|
{apiRoot}/ |
release (POST) |
Update and release an existing Charging Data resource. |
Nchf_ ConvergedCharging_Release |
6.1.3.2 Resource: Charging Data
6.1.3.2.1 Description
Charging Data resource represents a collection of the different charging data resources created by the CHF for converged charging as defined in 3GPP TS 32.290 [58].
6.1.3.2.2 Resource Definition
Resource URI: {apiRoot}/nchf-convergedcharging/{apiVersion}/chargingData
This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.
Table 6.1.3.2.2-1: Resource URI variables for this resource
|
Name |
Definition |
|
apiRoot |
See subclause 6.1.1 |
6.1.3.2.3 Resource Standard Methods
6.1.3.2.3.1 POST
This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1.
Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3.
Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
ChargingDataRequest |
M |
1 |
Parameters to create a new Charging Data resource. |
Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
ChargingDataResponse |
M |
1 |
201 Created |
The creation of a Charging Data resource is confirmed, and a representation of that resource is returned. The Charging Data resource which is created and returned successfully. The representation of created resource is identified via Location header field in the 201 response. |
|
n/a |
307 Temporary Redirect |
Dependent on support of ES3XX (NOTE 2) |
||
|
n/a |
308 Permanent Redirect |
Dependent on support of ES3XX (NOTE 2) |
||
|
ProblemDetails |
O |
0..1 |
400 Bad Request |
Dependent on support of ES4XX (NOTE 2) |
|
ChargingDataResponse |
O |
0..1 |
400 Bad Request |
Dependent on support of ES4XX (NOTE 2) |
|
n/a |
401 Unauthorized |
(NOTE 2) |
||
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
Dependent on support of ES4XX (NOTE 2) |
|
ChargingDataResponse |
O |
0..1 |
403 Forbidden |
Dependent on support of ES4XX (NOTE 2) |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
Dependent on support of ES4XX (NOTE 2) |
|
ChargingDataResponse |
O |
0..1 |
404 Not Found |
Dependent on support of ES4XX (NOTE 2) |
|
n/a |
405 Method Not Allowed |
(NOTE 2) |
||
|
n/a |
408 Request Timeout |
(NOTE 2) |
||
|
n/a |
410 Gone |
(NOTE 2) |
||
|
n/a |
411 Length Required |
(NOTE 2) |
||
|
n/a |
413 Payload Too Large |
(NOTE 2) |
||
|
n/a |
500 Internal Server Error |
(NOTE 2) |
||
|
n/a |
503 Service Unavailable |
(NOTE 2) |
||
|
NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [299] for the POST method also apply. NOTE 2: Failure cases are described in clause 6.1.7. |
||||
Table 6.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nchf-convergedcharging/[apiversion}/chargingdata/{chargingDataRef} |
Table 6.1.3.2.3.1-5: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
String |
M |
1 |
An alternative URI of the resource located in an alternative CHF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
String |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |
Table 6.1.3.2.3.1-6: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative CHF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |
6.1.3.2.4 Resource Custom Operations
None.
6.1.3.3 Resource: Individual Charging Data
6.1.3.3.1 Description
Individual Charging Data resource represents a Charging data resource created in the CHF.
6.1.3.3.2 Resource Definition
Resource URI: {apiRoot}/nchf-convergedcharging/{apiVersion} /chargingdata/{ChargingDataRef}
This resource shall support the resource URI variables defined in table 6.1.3.3.2-1.
Table 6.1.3.3.2-1: Resource URI variables for this resource
|
Name |
Definition |
|
apiRoot |
See subclause 6.1.1 |
|
ChargingDataRef |
Charging data resource reference assigned by the CHF during the Nchf_ ConvergedCharging_Create operation, |
6.1.3.3.3 Resource Standard Methods
None.
6.1.3.3.4 Resource Custom Operations
6.1.3.3.4.1 Overview
Table 6.1.3.3.4.1-1: Custom operations
|
Custom operation URI |
Mapped HTTP method |
Description |
|
{apiRoot}/ |
POST |
Update an existing Charging Data resource. |
|
{apiRoot}/ |
POST |
Update and release an existing Charging Data resource. |
6.1.3.3.4.2 Operation: update
6.1.3.3.4.2.1 Description
This operation updates an existing Charging Data resource.
6.1.3.3.4.2.2 Operation Definition
This operation shall support the request data structures specified in table 6.1.3.3.4.2.2-1 and the response data structures and response codes specified in table 6.1.3.3.4.2.2-2.
Table 6.1.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
ChargingDataRequest |
M |
1 |
Parameters to modify an existing Charging Data resource matching the ChargingDataRef according to the representation in the ChargingData. The request URI is the representation in the Location header field in the 201 response of resource creation. |
Table 6.1.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
ChargingDataResponse |
M |
1 |
200 OK |
The modification of a Charging Data resource is confirmed, and a representation of that resource is returned. The Charging Data resource which is modified and returned successfully. |
|
n/a |
307 Temporary Redirect |
Dependent on support of ES3XX (NOTE 2) |
||
|
n/a |
308 Permanent Redirect |
Dependent on support of ES3XX (NOTE 2) |
||
|
ProblemDetails |
O |
0..1 |
400 Bad Request |
Dependent on support of ES4XX (NOTE 2) |
|
ChargingDataResponse |
O |
0..1 |
400 Bad Request |
Dependent on support of ES4XX (NOTE 2) |
|
n/a |
401 Unauthorized |
(NOTE 2) |
||
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
Dependent on support of ES4XX (NOTE 2) |
|
ChargingDataResponse |
O |
0..1 |
403 Forbidden |
Dependent on support of ES4XX (NOTE 2) |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
Dependent on support of ES4XX (NOTE 2) |
|
ChargingDataResponse |
O |
0..1 |
404 Not Found |
Dependent on support of ES4XX (NOTE 2) |
|
n/a |
405 Method Not Allowed |
(NOTE 2) |
||
|
n/a |
408 Request Timeout |
(NOTE 2) |
||
|
n/a |
410 Gone |
(NOTE 2) |
||
|
n/a |
411 Length Required |
(NOTE 2) |
||
|
n/a |
413 Payload Too Large |
(NOTE 2) |
||
|
n/a |
500 Internal Server Error |
(NOTE 2) |
||
|
n/a |
503 Service Unavailable |
(NOTE 2) |
||
|
NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [299] for the POST method also apply. NOTE 2: Failure cases are described in clause 6.1.7. |
||||
Table 6.1.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative CHF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |
Table 6.1.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative CHF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |
6.1.3.3.4.3 Operation: release
6.1.3.3.4.3.1 Description
This operation update and release an existing Charging session
6.1.3.3.4.3.2 Operation Definition
This operation shall support the request data structures specified in table 6.1.3.3.4.3.2-1 and the response data structures and response codes specified in table 6.1.3.3.4.3.2-2.
Table 6.1.3.3.4.3.2-1: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
ChargingDataRequest |
M |
1 |
Parameters to modify and then release the Charging Data resource matching the ChargingDataRef according to the representation in the ChargingData. The request URI is the representation in the Location header field in the 201 response of resource creation. |
Table 6.1.3.3.4.3.2-2: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
Successful case: The Charging Data resource matching the ChargingDataRef is modified and then released. |
||
|
n/a |
401 Unauthorized |
(NOTE 2) |
||
|
n/a |
307 Temporary Redirect |
Dependent on support of ES3XX (NOTE 2) |
||
|
n/a |
308 Permanent Redirect |
Dependent on support of ES3XX (NOTE 2) |
||
|
ProblemDetails |
O |
0..1 |
404 Not Found |
Dependent on support of ES4XX (NOTE 2) |
|
ChargingDataResponse |
O |
0..1 |
404 Not Found |
Dependent on support of ES4XX (NOTE 2) |
|
n/a |
410 Gone |
(NOTE 2) |
||
|
n/a |
411 Length Required |
(NOTE 2) |
||
|
n/a |
413 Payload Too Large |
(NOTE 2) |
||
|
n/a |
500 Internal Server Error |
(NOTE 2) |
||
|
n/a |
503 Service Unavailable |
(NOTE 2) |
||
|
NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of TS 29.500 [4] also apply. NOTE 2: Failure cases are described in clause 6.1.7. |
||||
Table 6.1.3.3.4.3.2-3: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative CHF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |
Table 6.1.3.3.4.3.2-4: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative CHF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |