Versions Compared

Old Version 1

changes.mady.by.user George Rossides (Unlicensed)

Saved on

compared with

New Version 2

changes.mady.by.user George Rossides (Unlicensed)

Saved on

Key

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

Available from CRM.COM R4.0.0

 

Table of Contents
maxLevel2

...

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

Resource URL

...

communication_identifier

Name

Type

Description

token

String

The token retrieved from the login method

notificationsprovisioning_request_identifier

(semi-optional)

Notification Provisioning Request identifier

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

Include Page
V4:notificationprovisioning_request_identifier
V4:notificationprovisioning_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

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:conax_web_services_provisioning_request_complete
V4:conax_web_services_provisioning_request_complete

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

V4:communication_identifier
  • 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

Name

Type

Description

token

String

The token retrieved from the login method

type
(semi-optional)

Communication identifier

String

The identifier type of the communication that was created for the notification that should be returned as a result. The allowed communication identifier fields provisioning request to be retrieved. The supported types are the following:
Include Page
V4:communication_identifier

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

Include Page
V4:notificationconax_web_services_provisioning_request_complete
V4:notificationconax_web_services_provisioning_request_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejs
linenumberstrue
 

...

POST conax_web_services/provisioning_

...

request/

...

add_subscriptions

This method returns information related with notifications. Multiple notifications are returned 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

type_identifier

(semi-optionalmandatory)

Notification type identifier		Activity Type Identifier

The identifier of the notification type related with the notification that should be returned as a result. The allowed notification type identifier fields type of the activity. The allowed activity type identifiers are the following:

Include Page
V4:activity_type_identifier
V4:activity_type_identifier

contact_information_identifier

(mandatory)

Contact Information Identifier

The contact information related with the activity. The allowed contact information identifiers are the following:

Include Page
V4:notificationcontact_typeinformation_identifier
V4:notificationcontact_typeinformation_identifier

notificationcategory_run_identifier

(semi-optional)

Notification run identifier		Category Identifier

The identifier category of the notification run that created the notifications that should be returned as a resultactivity. The allowed notification run identifier fields activity category identifiers are the following:

Include Page
V4:notificationactivity_runcategory_identifier
V4:notification_run_identifier

contact_information_identifier

(optional)

Contact Information identifier

activity_category_identifier

status_identifier

(mandatory)

Activity Status Identifier

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

Include Page
V4:activity_status_identifier
V4:activity_status_identifier

description

(optional)

StringThe description of the retrieved activity

notes

(optional)

StringThe notes of the retrieved activity

start_date

(optional)

DateThe date that the activity will start

owned_by_group_identifier

(mandatory)

The identifier of the contact information notified by the notifications that should be returned as a resultowned by group information

The owned by group information of the activity. The allowed contact information group identifier fields are the following:

Include Page
V4:contactgroup_information_identifier
V4:contact_informationgroup_identifier

accountsprivacy_receivablelevel_identifier

(optional)

Accounts receivable identifier		The identifier of the privacy level

The identifier privacy level of the accounts receivable notified by the notifications that should be returned as a resultactivity. The allowed contact information privacy level identifier fields are the following:

Include Page
V4:accountsprivacy_receivablelevel_identifier
V4:accountsprivacy_receivablelevel_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

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)

DateThe 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

 

Anchor
activities_create referred objects parameters
activities_create referred objects parameters
Referred Parameters Objects Data

Include Page
V4:time_period_parameters
V4:time_period_parameters

Include Page
V4:activity_assign_to_parameter
V4:activity_assign_to_parameter

Include Page
V4:activity_performed_for_parameter
V4:activity_performed_for_parameter

Include Page
V4:activity_services_to_be_provided_parameter
V4: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:notificationactivities_complete
V4:notificationactivities_complete

Examples

Expand
titleExample 1

HTTP Method: GETPOST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

 

 

Response:

Code Block
themeConfluence
languagejsjavascript
linenumberstrue
 

...


POST conax_web_services/provisioning_request/cancel_subscriptions
...