REST API for Elastic Charging Engine

Converged Charging Notification

post

{apiRoot}/nchf-convergedcharging/v2/{$request.body#/notifyUri}

Notifies the NF that one of the following is required:

Reauthorization
Ending the authorization

Request

Path Parameters

$request.body#/notifyUri(required): string

The notification URI (notifyUri field) provided in the Create a Converged Charging Session request body.

Supported Media Types

application/json

A notification request.

Root Schema : schema

Type: object

A notification request.

Show Source

notificationType(required): string
Allowed Values: [ "REAUTHORIZATION", "ABORT_CHARGING" ]
The reason for the notification:
- REAUTHORIZATION: Reauthorization is required
- ABORT_CHARGING: Ending authorization is required
reauthorizationDetails: array reauthorizationDetails

Minimum Number of Items: 0

Reauthorization data that specifies the quota or usage reporting to update.

{
    "type":"object",
    "description":"A notification request.",
    "properties":{
        "notificationType":{
            "$ref":"#/components/schemas/NotificationType"
        },
        "reauthorizationDetails":{
            "description":"Reauthorization data that specifies the quota or usage reporting to update.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReauthorizationDetails"
            },
            "minItems":0
        }
    },
    "required":[
        "notificationType"
    ]
}

Nested Schema : reauthorizationDetails

Type: array

Minimum Number of Items: 0

Reauthorization data that specifies the quota or usage reporting to update.

Show Source

Array of: object ReauthorizationDetails

Reauthorization data that specifies the quota or usage reporting to update.

{
    "description":"Reauthorization data that specifies the quota or usage reporting to update.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReauthorizationDetails"
    },
    "minItems":0
}

Nested Schema : ReauthorizationDetails

Type: object

Reauthorization data that specifies the quota or usage reporting to update.

Show Source

quotaManagementIndicator: string

Allowed Values: [ "ONLINE_CHARGING", "OFFLINE_CHARGING", "QUOTA_MANAGEMENT_SUSPENDED" ]

Indicates the charging type for the usage request: (ONLINE_CHARGING) for online charging, (OFFLINE_CHARGING) for offline-only charging, or (QUOTA_MANAGEMENT_SUSPENDED) for suspended charging.
ratingGroup: integer (int32)

Minimum Value: 0

The ID of the rating group.
serviceId: integer (int32)

Minimum Value: 0

The ID of the service.

{
    "description":"Reauthorization data that specifies the quota or usage reporting to update.",
    "type":"object",
    "properties":{
        "serviceId":{
            "$ref":"#/components/schemas/ServiceId"
        },
        "ratingGroup":{
            "$ref":"#/components/schemas/RatingGroup"
        },
        "quotaManagementIndicator":{
            "$ref":"#/components/schemas/QuotaManagementIndicator"
        }
    }
}

Response

Supported Media Types

application/problem+json

204 Response

The charging notification was created successfully.

400 Response

The request isn't valid.

Root Schema : ProblemDetails

Type: object

Information about an error.

Show Source

cause: string

The reason for the failure.
detail: string

Details about the error.
instance: string

The instance.
invalidParams: array invalidParams

Minimum Number of Items: 1

A list of invalid parameters.
status: integer

The status code.
supportedFeatures: string

Pattern: ^[A-Fa-f0-9]*$

The list of supported features.
title: string

The problem's title.
type: string

The type of problem.

{
    "description":"Information about an error.",
    "type":"object",
    "properties":{
        "type":{
            "description":"The type of problem.",
            "type":"string"
        },
        "title":{
            "description":"The problem's title.",
            "type":"string"
        },
        "status":{
            "description":"The status code.",
            "type":"integer"
        },
        "detail":{
            "description":"Details about the error.",
            "type":"string"
        },
        "instance":{
            "type":"string",
            "description":"The instance."
        },
        "cause":{
            "description":"The reason for the failure.",
            "type":"string"
        },
        "invalidParams":{
            "type":"array",
            "description":"A list of invalid parameters.",
            "items":{
                "$ref":"#/components/schemas/InvalidParam"
            },
            "minItems":1
        },
        "supportedFeatures":{
            "$ref":"#/components/schemas/SupportedFeatures"
        }
    }
}

Nested Schema : invalidParams

Type: array

Minimum Number of Items: 1

A list of invalid parameters.

Show Source

Array of: object InvalidParam

An invalid parameter.

{
    "type":"array",
    "description":"A list of invalid parameters.",
    "items":{
        "$ref":"#/components/schemas/InvalidParam"
    },
    "minItems":1
}

Nested Schema : InvalidParam

Type: object

An invalid parameter.

Show Source

param(required): string

The name of the parameter.
reason: string

The reason why the parameter didn't pass validation.

{
    "type":"object",
    "description":"An invalid parameter.",
    "properties":{
        "param":{
            "type":"string",
            "description":"The name of the parameter."
        },
        "reason":{
            "type":"string",
            "description":"The reason why the parameter didn't pass validation."
        }
    },
    "required":[
        "param"
    ]
}

Default Response

Generic Error