Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Tip

Available from CRM.COM R7.0.0 and up to CRM.COM R11

Available from CRM.COM R17.3.0


Excerpt

This method is creating Set pin code to default value 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

semi-optional)

Subscription identifier

The subscription that the smartcard to be reset belongs to. The available subscription identifier fields are the following:

Include Page
V4:subscription_identifier
V4:subscription_identifier

smartcard_identifier

(mandatory)

String

The smartcard CA ID that should be reset.

Include Page
V4:installed_item_identifier
V4:installed_item_identifier

Tip
Deprecated in CRM.COM R17.3.0


installed_item_identifier

(semi-optional)

String

The installed item CA ID that should be reset.

Include Page
V4:installed_item_identifier
V4:installed_item_identifier

Tip
Available from CRM.COM R17.3.0


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

Tip
Deprecated in CRM.COM R17.3.0


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

Tip
Deprecated in CRM.COM R17.3.0


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

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
	"token"	: "56C91A25B081415495861A60F631E763",
	"subscription_identifier" : { "number" : "S60507" },
	"smartcard_identifier" : { "serial_number" : "smrt20000054"}
}  


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
    {
       "status":
       {
           "message": "",
           "description": "",
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2015-09-07T17:46:45",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": null,
           "number": "18576",
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "sub_provisioning_distribution_id": "296D64F4D3A543B6AC4F4820F13FDC41",
                   "id": "A8BD38B9BA2542308618882D20D454EA"
               },
               {
                   "id": "8C006115BCB94007A85EB60C608568B3"
               },
               {
                   "id": "24EB6D1131004AEC8EFE15C033E41225"
               },
               {
                   "smartcard_ca_id": "smrt200000",
                   "id": "C5FF9B1247A2414D8D121FD1879A35FE"
               }
           ],
           "process_immediately": 0,
           "request": null,
           "log_information":
           {
               "updated_date": "2015-09-07T17:46:45",
               "created_date": "2015-09-07T17:46:45",
               "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": "UPDATE_CA_PIN_TO_DEFAULT_VALUE",
           "process_name": "RESET_PIN_CODE_UTILITY",
           "id": "C61B04EE7E3443E1B57B5454513A58AA",
           "reference_number": null,
           "executed_date": null
       }
    } 


...