Versions Compared

Key

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

Available from CRM.COM R4.0.0

 

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

provisioning_request_identifier

(semi-optional)

Provisioning Request identifier

The identifier of the provisioning request that should be returned as a result. The allowed provisioning request identifier fields are the following:

Include Page
V4:provisioning_request_identifier
V4:provisioning_request_identifier

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

type
(semi-optional)

String

The type of the provisioning request to be retrieved. The supported types are the following:
  • ADD_SUBSCRIPTIONS
  • CANCEL_SUBSCRIPTIONS
  • GET_ACTIVE_SUBSCRIPTIONS
  • CREATE_PAIRING
  • ADD_TO_EXISTING_PAIRING
  • GET_PAIRING_STATUS_FOR_CARD
  • GET_PAIRING_STATUS_FOR_PAIRING_MODULE
  • DISPLAY_FINGERPRINT
  • UPDATE_CA_PIN_TO_DEFAULT_VALUE
  • UPDATE_CA_PIN_TO_GIVEN_VALUE
  • SEND_MAIL_MESSAGE_TO_CLIENT
  • SEND_BARK_MESSAGE_TO_CLIENT
  • SEND_REPEATING_BARK_MESSAGE_TO_CLIENT

life_cycle_state

(semi-optional)

String

The life cycle state of the retrieved provisioning request which can be PENDING, REJECTED or COMPLETED

reference_number

(semi-optional)

String

The reference number of the provisioning request as provided by Conax after receiving the request

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login methodtype

 DateThe date that the provisioning request is scheduled to be send

priority

(optional)

String

The priority of the provisioning request. The supported values are the following:

  • REGULAR
  • EXPRESS

subscription_identifier

(mandatory)

Activity Type Identifier

Subscription identifier 

The type of the activity. The allowed activity type identifiers are the following:

Include Page
V4:activity_type_identifier
V4:activity_type_identifier

Scheduled DateDateThe date that the provisioning request is scheduled to be send
 

service_identifier

(mandatory)

Service identifier 

smartcard_identifier

(mandatory)

Smartcard identifier 
   
   
   
   
   

 

   
   

udf_string_3 

(optional)

 String User Defined Field of type String

udf_string_3 

(optional)

String

User Defined Field of type String

udf_string_3 

(optional)

String

User Defined Field of type String

udf_string_4 

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6 

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1 

(optional)

Date

User Defined Field of type Date

udf_date_2 

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

expected_completion_date

(semi-optional)

Date

The date that the activity is expected to be completed

estimate_completion_time

(semi-optional)

Time Period ObjectThe time that is estimated to complete the activity, measured in minutes, hours, days, weeks, years

assign_to

(mandatory)

Assign To Object

The assignment information of the activity

performed_for

(optional)

Performed for Object

The entities which are related with the activity

services_to_be_provided_set

(optional)

Set of Services to be Provided Object

The information related to the services to be provided with the activity

  Anchoractivities_create referred objects parametersactivities_create referred objects parametersReferred Parameters Objects Data Include PageV4:time_period_parametersV4:time_period_parameters Include PageV4:activity_assign_to_parameterV4:activity_assign_to_parameter Include PageV4:activity_performed_for_parameterV4:activity_performed_for_parameter Include PageV4:activity_services_to_be_provided_parameterV4:activity_services_to_be_provided_parameter

Restrictions

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

Response Data

Include Page
V4:activitiesconax_web_services_provisioning_request_complete
V4:activitiesconax_web_services_provisioning_request_complete

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

...