Available from CRM.COM R8.0.0
This method is creating Cancel Subscriptions provisioning requests in a pending life cycle state, by specifying the service and the smartcard that should be cancelled, and the subscription that the service should belong to.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||||||||
subscription_identifier (mandatory) | Subscription identifier | The subscription that the service to be cancelled belongs to. The available subscription identifier fields are the following:
| ||||||||||||
service_identifier (mandatory) | Product identifier | The service that should be cancelled. Only products classified as services can be specified. The available product identifier fields are the following:
| ||||||||||||
smartcard_identifier (mandatory) | Installed Item identifier | The smartcard that the service should be added on. Only installed items classified as smartcards through the provisioning provider can be specified. The available installed item identifier fields are the following:
| ||||||||||||
start_date (optional) | String | The date that the provisioning request will be applied. If not specified then it is set to the date that the request is submitted |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved provisioning request |
| number | String | The number of the retrieved provisioning request |
| type | String | A code that uniquely identifies the type of provisioning request that is performed. The supported options are the following:
|
| sequence_number | String | The sequence number of the retrieved provisioning request |
| scheduled_date | Date | The date that the provisioning request is scheduled to be send |
| executed_date | Date | The date that the provisioning request was actually send |
| priority | String | The priority of the provisioning request. The supported values are the following:
|
| life_cycle_state | String | The life cycle state of the retrieved provisioning request which can be PENDING, REJECTED or COMPLETED |
| request | String | The actual request that was send to Conax |
| response | String | The actual response that was received from Conax |
| reference_number | String | A reference number provided by Conax after receiving the request |
| error_code | String | The error code received by CRM.COM or Conax in case that the provisioning request was rejected |
| error_description | String | The error description received by CRM.COM or Conax in case that the provisioning request was rejected |
| process_name | String | The name of the process that submitted the provisioning request, which can be one of the following:
|
| process_id | String | The ID of the process that submitted the provisioning request |
Log Information Object | The log information related with the retrieved provisioning request | |
| parameters_set | Set of Conax Web Services Provisioning Request Item objects | The parameters which will be used to generate the Web Service Calls that will be send to Conax. That information differentiates based on the type of request |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token" : "F0F5F41B7C7648019D79914D9D83A47A",
"subscription_identifier" : { "number" : "S60712" },
"service_identifier" : { "code" : "VOD & PPV" },
"smartcard_identifier" : { "serial_number" : "smcb0000010" }
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"scheduled_date": "2015-12-02T14:21:34",
"response": null,
"error_code": null,
"priority": "REGULAR",
"error_description": null,
"sequence_number": 1,
"number": "20959",
"process_id": null,
"name": null,
"parameters_set": [
{
"sub_provisioning_distribution_id": "945FDB84E0B2458B83D1C6A9F545D920",
"id": "BEEFC478955144D0B625CECFCB69DA40"
},
{
"smartcard_ca_id": "smcb0000010",
"id": "3DE26397C1D44F128A4068FD05F0BE03"
},
{
"service_ca_id": null,
"id": "7644F0887E434645B95577EA4AD65F11"
}
],
"process_immediately": null,
"request": null,
"log_information": {
"updated_date": "2015-12-02T14:21:34",
"created_date": "2015-12-02T14:21:34",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"life_cycle_state": "PENDING",
"type": "CANCEL_SUBSCRIPTIONS",
"process_name": "MANUAL",
"id": "23C3DA789CA44E8A81DE8A8B2BEF0B9B",
"reference_number": null,
"executed_date": null
}
}