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

GET conax_web_services/provisioning_requests/show

This method returns information related with a conax web services provisioning request. A single conax web services provisioning requests is returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(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:

...

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

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: GET

 

Request:

Response:

Code Block
themeConfluence
languagejs
linenumberstrue
 

GET conax_web_services/provisioning_requests/list

This method returns information related with notifications. Multiple notifications are returned by each call.

Resource URL

Parameters

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

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: GET

 

Request:

Response:

Code Block
themeConfluence
languagejs
linenumberstrue
 

POST conax_web_services/provisioning_request/add_subscriptions

This method creates an activity.  Single activities can be created by each call. Only customer activities can be created through this method. 

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

priority

(optional)

...

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

  • REGULAR
  • EXPRESS

...

subscription_identifier

(mandatory)

...

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

...

service_identifier

(mandatory)

...

smartcard_identifier

(mandatory)

...

 udf_string_3 

(optional)

...

udf_string_3 

(optional)

...

User Defined Field of type String

...

udf_string_3 

(optional)

...

User Defined Field of type String

...

udf_string_4 

(optional)

...

User Defined Field of type String

...

udf_string_5

(optional)

...

User Defined Field of type String

...

udf_string_6 

(optional)

...

User Defined Field of type String

...

udf_string_7

(optional)

...

User Defined Field of type String

...

udf_string_8

(optional)

...

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

 

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
themeConfluence
languagejavascript
linenumberstrue
 

 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

POST conax_web_services/provisioning_request/cancel_subscriptions

POST conax_web_services/provisioning_request/create_pairing

POST conax_web_services/provisioning_request/add_to_existing_pairing

POST conax_web_services/provisioning_request/reset_pin_to_default_value

POST conax_web_services/provisioning_request/reset_pin_to_given_value

...

Panel
nameblue

Child pages (Children Display)
alltrue
excerpttrue