POST provisioning/subscriptions/reset

This method resets CRM.COM subscriptions that are out of sync with the information kept in the specified provisioning system. A single subscription can be updated by each call

Available from CRM.COM R11.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

provisioning_provider_identifier

(mandatory)

Provisioning Provider Identifier

The provisioning provider related with the subscription that will be reset. The allowed provisioning provider identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the provisioning provider

name

(semi-optional)

String

The name of the provisioning provider

alternative_code

(semi-optional)

String

The alternative code of the provisioning provider

subscription_identifier

(mandatory)

Subscription Identifier

The identifier of the subscription that will be reset. Only subscriptions which are provisioned by the specified provisioning provider n can be specified. The allowed subscription identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Not Applicable.

Examples

Example 1

HTTP Method: POST

Request:

Body:

{
    "token":"952E00410AF743DE951398945D28F71F",
    "provisioning_provider_identifier":{"id":"8E57FA9E894241E491A3335EAB0DA5D9"},
    "subscription_identifier":{"number":"S0000000309"}
}

Response:

    {
        "data":
        {
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }