ChargeableParty

API for Chargeable Party management.

OpenAPI

OpenAPI Version: 3.0.0

info

Title: 3gpp-chargeable-party

Version: "1.0.0"

externalDocs

Description: 3GPP TS 29.122 V15.2.0 T8 reference point for Northbound APIs

URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'

security

- {}

- oAuth2ClientCredentials: []

servers

URL: '{apiRoot}/3gpp-chargeable-party/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.

paths

/{scsAsId}/transactions

get:

Summary: Read all chargeable party transaction resources for a given SCS/AS

Tags:

- Chargeable Party Transaction Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK (successful query of Chargeable Party resource)

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/ChargeableParty'

minItems: 0

Description: individual BDT policy subscription.

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

Method: Post

Summary: Create a new chargeable party transaction resource

Tags:

- Chargeable Party Transaction Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

Request Body:

Description: representation of the Chargeable Party resource to be Created in the SCEF

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ChargeableParty'

Callbacks:

eventNotification:

'{$request.body#/notificationDestination}':

Method: Post

Request Body: # contents of the callback message

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: 'TS29122_CommonData.yaml#/components/schemas/NotificationData'

Responses:

'200' OK (The successful acknowledgement of the notification with a body)

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

Responses:

'201' successful creation of a chargeable party resource

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ChargeableParty'

Headers:

Location:

Description: 'Contains the URI of the newly created resource'

Required/Optional: true

Schema:

Type: string

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

/{scsAsId}/transactions/{transactionId}

get:

Summary: read a chargeable party resource for a given SCS/AS and a transaction Id

Tags:

- Individual chargeable party resource Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: transactionId

In: path

Description: Identifier of transaction

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK (successful query of a chargeable party resource)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ChargeableParty'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

patch:

Summary: Updates a existing chargeable party resource for a given SCS/AS and transaction Id.

Tags:

- Individual chargeable party resource Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: transactionId

In: path

Description: Identifier of transaction

Required/Optional: true

Schema:

Type: string

Request Body:

Description: representation of the chargeable party resource to be udpated in the SCEF

Required/Optional: true

Content:

application/merge-patch+json:

Schema:

Reference: '#/components/schemas/ChargeablePartyPatch'

Responses:

'200' successful update of a chargeable party resource

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ChargeableParty'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

delete:

Summary: deletes a chargeable party resource for a given SCS/AS and a transcation Id.

Tags:

- Individual chargeable party resource Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of SCS/AS

Required/Optional: true

Schema:

Type: string

- name: transactionId

In: path

Description: Identifier of transaction

Required/Optional: true

Schema:

Type: string

Responses:

'200' successful deletion of an resouce of chargeable party

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

components

securitySchemes

oAuth2ClientCredentials

Type: oauth2

Flows:

clientCredentials:

tokenUrl: '{tokenUrl}'

scopes: {}

schemas

ChargeableParty

Type: object

Properties:

self:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'

supportedFeatures:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

notificationDestination:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'

requestTestNotification:

Type: boolean

Description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 5.2.5.3. Set to false or omitted otherwise.

websockNotifConfig:

Reference: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'

ipv4Addr:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr'

ipv6Addr :

Reference: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr'

macAddr:

Reference: 'TS29571_CommonData.yaml#/components/schemas/macAddr48'

flowInfo:

Type: array

Items:

Reference: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo'

minItems: 1

Description: Describes the application flows.

ethFlowInfo:

Type: array

Items:

Reference: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription'

minItems: 1

Description: Identifies Ethernet packet flows.

sponsorInformation:

Reference: 'TS29122_CommonData.yaml#/components/schemas/SponsorInformation'

sponsoringEnabled:

Type: boolean

Description: Indicates sponsoring status.

referenceId:

Reference: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId'

usageThreshold:

Reference: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold'

Required:

  • notificationDestination

  • sponsorInformation

  • sponsoringEnabled

ChargeablePartyPatch

Type: object

Properties:

flowInfo:

Type: array

Items:

Reference: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo'

minItems: 1

Description: Describes the application flows.

ethFlowInfo:

Type: array

Items:

Reference: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription'

minItems: 1

Description: Identifies Ethernet packet flows.

sponsoringEnabled:

Type: boolean

Description: Indicates sponsoring status.

referenceId:

Reference: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId'

usageThreshold:

Reference: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm'