Nchf_SpendingLimitControl (1.3.0)

Download OpenAPI specification:

Nchf Spending Limit Control Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

/subscriptions

Authorizations:
NoneoAuth2ClientCredentials
Request Body schema: application/json
required
supi
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows

  • for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI.
  • for a network specific identifier "nai-, where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.
  • for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003.
  • for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501.
gpsi
string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$

String identifying a Gpsi shall contain either an External Id or an MSISDN. It shall be formatted as follows -External Identifier= "extid-'extid', where 'extid' shall be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an External Identifier.

policyCounterIds
Array of strings (PolicyCounterId) non-empty

This is a list of policy counter identifier(s), which identifies policy counters maintained per subscriber within the CHF.

notifUri
string (Uri)

String providing an URI formatted according to RFC 3986.

expiry
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

notifId
string

Responses

Callbacks

Request samples

Content type
application/json
{
  • "supi": "string",
  • "gpsi": "string",
  • "policyCounterIds": [
    ],
  • "notifUri": "string",
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string",
  • "notifId": "string"
}

Response samples

Content type
application/json
{
  • "supi": "string",
  • "notifId": "string",
  • "statusInfos": {
    },
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string"
}

Callback payload samples

Callback
Content type
application/json
{
  • "supi": "string",
  • "notifId": "string",
  • "statusInfos": {
    },
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string"
}

/subscriptions/{subscriptionId}

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subscriptionId
required
string

Identifies an individual spending limit retrieval subscription.

Request Body schema: application/json
required
supi
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows

  • for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI.
  • for a network specific identifier "nai-, where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.
  • for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003.
  • for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501.
gpsi
string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$

String identifying a Gpsi shall contain either an External Id or an MSISDN. It shall be formatted as follows -External Identifier= "extid-'extid', where 'extid' shall be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an External Identifier.

policyCounterIds
Array of strings (PolicyCounterId) non-empty

This is a list of policy counter identifier(s), which identifies policy counters maintained per subscriber within the CHF.

notifUri
string (Uri)

String providing an URI formatted according to RFC 3986.

expiry
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

notifId
string

Responses

Request samples

Content type
application/json
{
  • "supi": "string",
  • "gpsi": "string",
  • "policyCounterIds": [
    ],
  • "notifUri": "string",
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string",
  • "notifId": "string"
}

Response samples

Content type
application/json
{
  • "supi": "string",
  • "notifId": "string",
  • "statusInfos": {
    },
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string"
}

/subscriptions/{subscriptionId}

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subscriptionId
required
string

Identifies an individual spending limit retrieval subscription.

Responses

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}