OpenAPI
OpenAPI Version: 3.0.0
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
OpenAPI Version: 3.0.0
Description: Spending Limit Control Service API Callbacks
Version: "1.0.0"
Title: Nchf_SpendingLimitControl Callbacks
Description: 3GPP TS 29.594 V15.2.0; 5G System; Spending Limit Control Service.
URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.594/'
- {}
- oAuth2ClientCredentials:
- nchf-spendinglimitcontrol
URL: 'http://{apiRoot}/'
Variables:
API Root:
Default: https://example.com
Description: apiRoot as defined in subclause subclause 4.4 of 3GPP TS 29.501
Method: Post
Parameters:
- in: path
name: subscriptionId
Description: Identifies an individual spending limit retrieval subscription.
Required/Optional: true
Schema:
Type: string
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: './TS29594_Nchf_SpendingLimitControl.yaml#/components/schemas/SpendingLimitStatus'
Responses:
'204' No Content, Notification was succesfull
'400': Reference './TS29571_CommonData.yaml#/components/responses/400'
'401': Reference './TS29571_CommonData.yaml#/components/responses/401'
'403': Reference './TS29571_CommonData.yaml#/components/responses/403'
'404': Reference './TS29571_CommonData.yaml#/components/responses/404'
'411': Reference './TS29571_CommonData.yaml#/components/responses/411'
'413': Reference './TS29571_CommonData.yaml#/components/responses/413'
'415': Reference './TS29571_CommonData.yaml#/components/responses/415'
'429': Reference './TS29571_CommonData.yaml#/components/responses/429'
'500': Reference './TS29571_CommonData.yaml#/components/responses/500'
'503': Reference './TS29571_CommonData.yaml#/components/responses/503'
default: Reference './TS29571_CommonData.yaml#/components/responses/default'
Method: Post
Parameters:
- in: path
name: subscriptionId
Description: Identifies an individual spending limit retrieval subscription.
Required/Optional: true
Schema:
Type: string
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: './TS29594_Nchf_SpendingLimitControl.yaml#/components/schemas/SubscriptionTerminationInfo'
Responses:
'204' No Content, Notification was succesfull
'400': Reference './TS29571_CommonData.yaml#/components/responses/400'
'401': Reference './TS29571_CommonData.yaml#/components/responses/401'
'403': Reference './TS29571_CommonData.yaml#/components/responses/403'
'404': Reference './TS29571_CommonData.yaml#/components/responses/404'
'411': Reference './TS29571_CommonData.yaml#/components/responses/411'
'413': Reference './TS29571_CommonData.yaml#/components/responses/413'
'415': Reference './TS29571_CommonData.yaml#/components/responses/415'
'429': Reference './TS29571_CommonData.yaml#/components/responses/429'
'500': Reference './TS29571_CommonData.yaml#/components/responses/500'
'503': Reference './TS29571_CommonData.yaml#/components/responses/503'
default: Reference './TS29571_CommonData.yaml#/components/responses/default'
Type: oauth2
Flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nchf-spendinglimitcontrol: Access to the Nchf_SpendingLimitControl API