Jump to

• Request
• Response
• Examples

End a Spending Limit Control Subscription

delete

{apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId}

Ends an existing spending limit control subscription for a specified subscriber.

Request

Path Parameters

• subscriptionId(required): string
  Identifies an individual spending limit retrieval subscription.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

204 Response

The spending limit control 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 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."
}

429 Response

The client has sent too many requests.

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

Examples

The following example shows how to end a specified spending limit subscription by submitting a DELETE request on the REST resource using cURL. For more information about cURL, see "Use cURL".

curl -X DELETE 'apiRoot/nchf-spendinglimitcontrol/v1/subscriptions/imsi-6500000427" -H "accept: */*"

where apiRoot is for accessing the HTTP Gateway server at either http://hostname:httpPort or https://hostname:httpsPort.

Example of the Response Body

If successful, the response code 204 is returned along with a header. For example:

connection: keep-alive
date: Tue, 12 Jul 2022 08:28:22 +0530

Back to Top