Available from CRM.COM R7.0.0 and up to CRM.COM R11
This method is creating Clear pin code provisioning requests in a pending life cycle state, by specifying the smartcard that should be reset, and the subscription that the smartcard 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 smartcard to be reset belongs to. The available subscription identifier fields are the following:
| ||||||||||||
smartcard_identifier (mandatory) | String | The smartcard CA ID that should be reset.
| ||||||||||||
process_immediately (optional) | boolean | Defines if the provisioning request will be processed immediately after its creation. If enabled then the provisioning request will be sent through Web API during its creation. If not enabled then the provisioning request will be created and processed later on by the active provisioning request processing run. If not specified then the provisioning request will not be processed immediately | ||||||||||||
scheduled_date (optional) | date | The date that the provisioning request is scheduled to be processed. If not specified and process_immediatelly is also set to false, then the provisioning request will be processed immediately |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token" : "A7AD3752AC7B48099A80E62C8F0BE565",
"subscription_identifier" : { "number" : "S60507" },
"smartcard_identifier" : { "serial_number" : "smrt20000054"}
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"scheduled_date": "2015-09-07T17:56:11",
"response": null,
"error_code": null,
"priority": "REGULAR",
"error_description": null,
"sequence_number": null,
"number": "18579",
"process_id": null,
"name": null,
"parameters_set":
[
{
"id": "F858F07C2AFB4020988F40E5E36D308B"
},
{
"smartcard_ca_id": "smrt200000",
"id": "8D90C87F9EBF4DB0B54C44DFB4DD2E6E"
},
{
"id": "79D362BC51724DC99A62A597A15939B5"
},
{
"sub_provisioning_distribution_id": "296D64F4D3A543B6AC4F4820F13FDC41",
"id": "FD9A9DC80EAA4A8F810F214592F3D5DD"
}
],
"process_immediately": 0,
"request": null,
"log_information":
{
"updated_date": "2015-09-07T17:56:11",
"created_date": "2015-09-07T17:56:11",
"created_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"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": "CLEAR_CA_PIN",
"process_name": "RESET_PIN_CODE_UTILITY",
"id": "D62E639909C64F648AF480C66BF59FF9",
"reference_number": null,
"executed_date": null
}
}