Jump to

• Request
• Response

statusNotification Callback

post

{$request.body#/notifUri}/notify

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

The status of the spending limit control subscription.

Show Source

• expiry: string (date-time)
  The date and time the spending limit subscription expires.
• statusInfos: object statusInfos
  Minimum Number of Properties: 1

  Additional Properties Allowed: PolicyCounterInfo

  The status of the requested policy counters. The key of the map is the policyCounterId attribute.
• supi: string
  Pattern: ^(imsi-[0-9]{5,15}|nai-.+|.+)$

  The unique 5G Subscription Permanent Identifier (SUPI). A SUPI is usually a string of 15 decimal digits.
• supportedFeatures: string
  Pattern: ^[A-Fa-f0-9]*$

  The list of supported features.

{
    "description":"The status of the spending limit control subscription.",
    "type":"object",
    "properties":{
        "supi":{
            "description":"The unique 5G Subscription Permanent Identifier (SUPI). A SUPI is usually a string of 15 decimal digits.",
            "type":"string",
            "pattern":"^(imsi-[0-9]{5,15}|nai-.+|.+)$"
        },
        "statusInfos":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/PolicyCounterInfo"
            },
            "minProperties":1,
            "description":"The status of the requested policy counters. The key of the map is the policyCounterId attribute."
        },
        "expiry":{
            "description":"The date and time the spending limit subscription expires.",
            "format":"date-time",
            "type":"string"
        },
        "supportedFeatures":{
            "description":"The list of supported features.",
            "type":"string",
            "pattern":"^[A-Fa-f0-9]*$"
        }
    }
}

Nested Schema : statusInfos

Type: object

Minimum Number of Properties: 1

Additional Properties Allowed

Show Source

• object PolicyCounterInfo
  Information about a policy counter.

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/PolicyCounterInfo"
    },
    "minProperties":1,
    "description":"The status of the requested policy counters. The key of the map is the policyCounterId attribute."
}

The status of the requested policy counters. The key of the map is the policyCounterId attribute.

Nested Schema : PolicyCounterInfo

Type: object

Information about a policy counter.

Show Source

• currentStatus(required): string
  The current status of the policy counter. The values such as valid or invalid are not specified.
• penPolCounterStatuses: array penPolCounterStatuses
  Minimum Number of Items: 1

  The status of the pending policy counter.
• policyCounterId(required): string
  The ID of the requested policy counter.

{
    "description":"Information about a policy counter.",
    "type":"object",
    "properties":{
        "policyCounterId":{
            "$ref":"#/components/schemas/PolicyCounterId"
        },
        "currentStatus":{
            "type":"string",
            "description":"The current status of the policy counter. The values such as valid or invalid are not specified."
        },
        "penPolCounterStatuses":{
            "description":"The status of the pending policy counter.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PendingPolicyCounterStatus"
            },
            "minItems":1
        }
    },
    "required":[
        "policyCounterId",
        "currentStatus"
    ]
}

Nested Schema : penPolCounterStatuses

Type: array

Minimum Number of Items: 1

The status of the pending policy counter.

Show Source

• Array of: object PendingPolicyCounterStatus
  The status of the pending policy counter.

{
    "description":"The status of the pending policy counter.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PendingPolicyCounterStatus"
    },
    "minItems":1
}

Nested Schema : PendingPolicyCounterStatus

Type: object

The status of the pending policy counter.

Show Source

• activationTime(required): string (date-time)
  The activation times per required policy counter.
• policyCounterStatus(required): string
  The status of the policy counter. The values, such as valid, invalid, or any other status, are not specified.

{
    "description":"The status of the pending policy counter.",
    "type":"object",
    "properties":{
        "policyCounterStatus":{
            "type":"string",
            "description":"The status of the policy counter. The values, such as valid, invalid, or any other status, are not specified."
        },
        "activationTime":{
            "description":"The activation times per required policy counter.",
            "format":"date-time",
            "type":"string"
        }
    },
    "required":[
        "policyCounterStatus",
        "activationTime"
    ]
}

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

204 Response

The notification was created succesfully.

400 Response

The request isn't valid.

Body ()

Root Schema : Error

Type: object

An error.

Show Source

• @baseType: string
  When sub-classing, this defines the super class.
• @schemaLocation: string (uri)
  The URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  The error code, which contains application-relevant detail.
• message: string
  Additional details about the error as well as possible corrective actions.
• reason(required): string
  The reason for the error that can be shown to a client user.
• referenceError: string (uri)
  The URI to the documentation describing the error.
• status: string
  The HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code, which contains application-relevant detail."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Additional details about the error as well as possible corrective actions."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI to the documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"An error."
}

401 Response

The client doesn't have the correct privileges.

Body ()

Root Schema : Error

Type: object

An error.

Show Source

• @baseType: string
  When sub-classing, this defines the super class.
• @schemaLocation: string (uri)
  The URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  The error code, which contains application-relevant detail.
• message: string
  Additional details about the error as well as possible corrective actions.
• reason(required): string
  The reason for the error that can be shown to a client user.
• referenceError: string (uri)
  The URI to the documentation describing the error.
• status: string
  The HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code, which contains application-relevant detail."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Additional details about the error as well as possible corrective actions."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI to the documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"An error."
}

403 Response

The request wasn't authorized.

Body ()

Root Schema : Error

Type: object

An error.

Show Source

• @baseType: string
  When sub-classing, this defines the super class.
• @schemaLocation: string (uri)
  The URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  The error code, which contains application-relevant detail.
• message: string
  Additional details about the error as well as possible corrective actions.
• reason(required): string
  The reason for the error that can be shown to a client user.
• referenceError: string (uri)
  The URI to the documentation describing the error.
• status: string
  The HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code, which contains application-relevant detail."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Additional details about the error as well as possible corrective actions."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI to the documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"An error."
}

404 Response

The requested resource wasn't found.

Body ()

Root Schema : Error

Type: object

An error.

Show Source

• @baseType: string
  When sub-classing, this defines the super class.
• @schemaLocation: string (uri)
  The URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  The error code, which contains application-relevant detail.
• message: string
  Additional details about the error as well as possible corrective actions.
• reason(required): string
  The reason for the error that can be shown to a client user.
• referenceError: string (uri)
  The URI to the documentation describing the error.
• status: string
  The HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code, which contains application-relevant detail."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Additional details about the error as well as possible corrective actions."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI to the documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"An error."
}

411 Response

The content's length is missing from the request.

Body ()

Root Schema : Error

Type: object

An error.

Show Source

• @baseType: string
  When sub-classing, this defines the super class.
• @schemaLocation: string (uri)
  The URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  The error code, which contains application-relevant detail.
• message: string
  Additional details about the error as well as possible corrective actions.
• reason(required): string
  The reason for the error that can be shown to a client user.
• referenceError: string (uri)
  The URI to the documentation describing the error.
• status: string
  The HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code, which contains application-relevant detail."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Additional details about the error as well as possible corrective actions."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI to the documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"An error."
}

413 Response

The request is too large for the server to process.

Body ()

Root Schema : Error

Type: object

An error.

Show Source

• @baseType: string
  When sub-classing, this defines the super class.
• @schemaLocation: string (uri)
  The URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  The error code, which contains application-relevant detail.
• message: string
  Additional details about the error as well as possible corrective actions.
• reason(required): string
  The reason for the error that can be shown to a client user.
• referenceError: string (uri)
  The URI to the documentation describing the error.
• status: string
  The HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code, which contains application-relevant detail."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Additional details about the error as well as possible corrective actions."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI to the documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"An error."
}

415 Response

The media type isn't supported.

Body ()

Root Schema : Error

Type: object

An error.

Show Source

• @baseType: string
  When sub-classing, this defines the super class.
• @schemaLocation: string (uri)
  The URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  The error code, which contains application-relevant detail.
• message: string
  Additional details about the error as well as possible corrective actions.
• reason(required): string
  The reason for the error that can be shown to a client user.
• referenceError: string (uri)
  The URI to the documentation describing the error.
• status: string
  The HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code, which contains application-relevant detail."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Additional details about the error as well as possible corrective actions."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI to the documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"An error."
}

429 Response

The client has sent too many requests at once.

Body ()

Root Schema : Error

Type: object

An error.

Show Source

• @baseType: string
  When sub-classing, this defines the super class.
• @schemaLocation: string (uri)
  The URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  The error code, which contains application-relevant detail.
• message: string
  Additional details about the error as well as possible corrective actions.
• reason(required): string
  The reason for the error that can be shown to a client user.
• referenceError: string (uri)
  The URI to the documentation describing the error.
• status: string
  The HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code, which contains application-relevant detail."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Additional details about the error as well as possible corrective actions."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI to the documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"An error."
}

500 Response

An internal server error occurred.

Body ()

Root Schema : Error

Type: object

An error.

Show Source

• @baseType: string
  When sub-classing, this defines the super class.
• @schemaLocation: string (uri)
  The URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  The error code, which contains application-relevant detail.
• message: string
  Additional details about the error as well as possible corrective actions.
• reason(required): string
  The reason for the error that can be shown to a client user.
• referenceError: string (uri)
  The URI to the documentation describing the error.
• status: string
  The HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code, which contains application-relevant detail."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Additional details about the error as well as possible corrective actions."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI to the documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"An error."
}

503 Response

The server is overloaded or down for maintenance.

Body ()

Root Schema : Error

Type: object

An error.

Show Source

• @baseType: string
  When sub-classing, this defines the super class.
• @schemaLocation: string (uri)
  The URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  The error code, which contains application-relevant detail.
• message: string
  Additional details about the error as well as possible corrective actions.
• reason(required): string
  The reason for the error that can be shown to a client user.
• referenceError: string (uri)
  The URI to the documentation describing the error.
• status: string
  The HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code, which contains application-relevant detail."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Additional details about the error as well as possible corrective actions."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI to the documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"An error."
}

Back to Top