Jump to

• Request
• Response

subscriptionTermination Callback

post

{$request.body#/notifUri}/terminate

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Information about a subscription that was ended.

Show Source

• supi(required): 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.
• termCause: string
  Allowed Values: [ "REMOVED_SUBSCRIBER" ]

  The reason why the subscription was ended.

{
    "description":"Information about a subscription that was ended.",
    "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-.+|.+)$"
        },
        "termCause":{
            "$ref":"#/components/schemas/TerminationCause"
        }
    },
    "required":[
        "supi"
    ]
}

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

204 Response

The subscription was ended 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 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."
}

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