Tip
Available from CRM.COM R9.0.0

Table of Contents

maxLevel	2

GET alerts/show

This method returns information related with an alert. A single alert is returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

Alert Identifier

The identifier of the alert that should be returned as a result. The allowed alert 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

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	js
linenumbers	true

GET buy_in_advance_requests/list

This method returns information related with buy in advance requests that were submitted against a specific subscription. Multiple buy in advance requests are returned by each call.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

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

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	js
linenumbers	true

POST buy_in_advance_requests/create

This method creates a buy in advance request. A single buy in advance request can be created by each call.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

duration

(mandatory)

...

unit_of_time

(mandatory)

...

description

(optional)

...

billing_effective_date

(optional)

...

udf_string_1
(optional)

...

User Defined Field of type String

...

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

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
 "token": "E79D2DDBA8F5499D801F1724EDDBD207",
 "subscription_identifier":{"id":"A60B45D48F24CE3C1099FEB5D4FCEC2E"}, 
 "duration":"3",
 "unit_of_time":"MONTHS",
 "description":"test desc"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "status": {
    "message": null,
    "description": null,
    "code": "OK"
  },
  "data": {
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_float_3": null,
    "number": "14",
    "udf_float_4": null,
    "billing_effective_date": "2015-03-12T15:23:13",
    "udf_string_1": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "billing_state": "NOT_RATED",
    "udf_string_4": null,
    "udf_string_5": null,
    "udf_string_6": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "duration": 3,
    "id": "326A0E7F3BD7479B9D9FB115DDB2627B",
    "subscription": {
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Vrikkis",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "company_profile": null,
          "title": "Mr",
          "type": "PERSON",
          "first_name": "Nikos",
          "name": "Nikos Vrikkis",
          "id": "E129EFE1236D24644350B8A263ECC23D",
          "company_name": null,
          "demographics": {
            "gender": "MALE",
            "passport_issued_by_country": null,
            "passport_number": "54673457543",
            "social_security_number": "5467357",
            "country_of_residence": {
              "name": "JAPAN",
              "id": "237"
            },
            "industry_sector": null,
            "date_of_birth": {
              "month": null,
              "day": null,
              "year": null
            },
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "835667",
            "id_issued_by_country": null,
            "industry": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "79",
        "name": "Nikos Vrikkis",
        "id": "A59E791DCF07FC9D96CD4BA4DAFAE381"
      },
      "life_cycle_state": "EFFECTIVE",
      "number": "S60055",
      "type": {
        "name": "Normal Subscription",
        "id": "6BB2B984CC9309775D06650C7493A836",
        "description": null,
        "alternative_code": "ST"
      },
      "id": "A60B45D48F24CE3C1099FEB5D4FCEC2E"
    },
    "udf_date_1": null,
    "udf_date_2": null,
    "udf_date_3": null,
    "udf_date_4": null,
    "log_information": {
      "updated_date": "2015-03-12T15:23:48",
      "created_by_unit": {
        "community_name": "Main Community",
        "group_name": "Main Group",
        "name": "Admin Unit",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "description": "r1",
        "alternative_code": "MG"
      },
      "created_date": "2015-03-12T15:23:10",
      "updated_by_unit": {
        "community_name": "Main Community",
        "group_name": "Main Group",
        "name": "Admin Unit",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "description": "r1",
        "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": "EFFECTIVE",
    "unit_of_time": "MONTHS",
    "description": "test desc"
  }
}

POST buy_in_advance_requests/update

This method updates an existing buy in advance request. This method can be used only if the specified buy in advance request is effective and not rated. A single buy in advance request can be update by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

Buy in Advance Request identifier

The identifier of the buy in advance request that should be updated. The allowed buy in advance request identifier fields are the following:

...

duration

(optional)

...

unit_of_time

(optional)

...

description

(optional)

...

billing_effective_date

(optional)

...

udf_string_1
(optional)

...

User Defined Field of type String

...

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

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
 "token": "C586BC3AC28048BE9FCC2A79B197F33B",
 "buy_in_advance_request_identifier":{"id":"90A52D7CF4B147F3A4D1740003B9B0D4"}, 
 "duration":"87",
 "unit_of_time":"DAYS",
 "description":"test desc 2"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "status": {
    "message": null,
    "description": null,
    "code": "OK"
  },
  "data": {
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_float_3": null,
    "number": "14",
    "udf_float_4": null,
    "billing_effective_date": "2015-03-12T15:25:00",
    "udf_string_1": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "billing_state": "NOT_RATED",
    "udf_string_4": null,
    "udf_string_5": null,
    "udf_string_6": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "duration": 87,
    "id": "326A0E7F3BD7479B9D9FB115DDB2627B",
    "subscription": {
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Vrikkis",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "company_profile": null,
          "title": "Mr",
          "type": "PERSON",
          "first_name": "Nikos",
          "name": "Nikos Vrikkis",
          "id": "E129EFE1236D24644350B8A263ECC23D",
          "company_name": null,
          "demographics": {
            "gender": "MALE",
            "passport_issued_by_country": null,
            "passport_number": "54673457543",
            "social_security_number": "5467357",
            "country_of_residence": {
              "name": "JAPAN",
              "id": "237"
            },
            "industry_sector": null,
            "date_of_birth": {
              "month": null,
              "day": null,
              "year": null
            },
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "835667",
            "id_issued_by_country": null,
            "industry": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "79",
        "name": "Nikos Vrikkis",
        "id": "A59E791DCF07FC9D96CD4BA4DAFAE381"
      },
      "life_cycle_state": "EFFECTIVE",
      "number": "S60055",
      "type": {
        "name": "Normal Subscription",
        "id": "6BB2B984CC9309775D06650C7493A836",
        "description": null,
        "alternative_code": "ST"
      },
      "id": "A60B45D48F24CE3C1099FEB5D4FCEC2E"
    },
    "udf_date_1": null,
    "udf_date_2": null,
    "udf_date_3": null,
    "udf_date_4": null,
    "log_information": {
      "updated_date": "2015-03-12T15:25:00",
      "created_by_unit": {
        "community_name": "Main Community",
        "group_name": "Main Group",
        "name": "Admin Unit",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "description": "r1",
        "alternative_code": "MG"
      },
      "created_date": "2015-03-12T15:23:10",
      "updated_by_unit": {
        "community_name": "Main Community",
        "group_name": "Main Group",
        "name": "Admin Unit",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "description": "r1",
        "alternative_code": "MG"
      },
      "created_by_user": {
        "person_name": "mpadministrator",
        "username": "mpadministrator",
        "id": "1",
        "email": "mp@ministrator.com"
      },
      "updated_by_user": {
        "person_name": "Marios Lannister",
        "username": "mpadministrator",
        "id": "1"
      }
    },
    "life_cycle_state": "EFFECTIVE",
    "unit_of_time": "DAYS",
    "description": "test desc 2"
  }
}

POST buy_in_advance_requests/cancel

This method cancels an existing buy in advance request. This method can be used only if the specified buy in advance request is effective and not rated. A single buy in advance request can be cancelled by each call.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

Buy in Advance Request identifier

The identifier of the buy in advance request that should be cancelled. The allowed buy in advance request identifier fields are the following:

...

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

HTTP Method: POST

Request:

Body:

Expand

title	Example 1

Code Block

theme	Confluence
language	js
linenumbers	true

{
 "token": "C586BC3AC28048BE9FCC2A79B197F33B",
 "buy_in_advance_request_identifier":{"id":"90A52D7CF4B147F3A4D1740003B9B0D4"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{ "status": { "message": null, "description": null, "code": "OK" }, "data": { "udf_float_1": null, "udf_float_2": null, "udf_float_3": null, "number": "14", "udf_float_4": null, "billing_effective_date": "2015-03-12T15:25:00", "udf_string_1": null, "udf_string_2": null, "udf_string_3": null, "billing_state": "NOT_RATED", "udf_string_4": null, "udf_string_5": null, "udf_string_6": null, "udf_string_7": null, "udf_string_8": null, "duration": 87, "id": "326A0E7F3BD7479B9D9FB115DDB2627B", "subscription": { "accounts_receivable": { "account_owner": { "last_name": "Vrikkis", "life_cycle_state": "FINANCIAL", "middle_name": null, "company_profile": null, "title": "Mr", "type": "PERSON", "first_name": "Nikos", "name": "Nikos Vrikkis", "id": "E129EFE1236D24644350B8A263ECC23D", "company_name": null, "demographics": { "gender": "MALE", "passport_issued_by_country": null, "passport_number": "54673457543", "social_security_number": "5467357", "country_of_residence": { "name": "JAPAN", "id": "237" }, "industry_sector": null, "date_of_birth": { "month": null, "day": null, "year": null }, "name_day": { "month": null, "day": null }, "id_number": "835667", "id_issued_by_country": null, "industry": null } }, "life_cycle_state": "ACTIVE", "number": "79", "name": "Nikos Vrikkis", "id": "A59E791DCF07FC9D96CD4BA4DAFAE381" }, "life_cycle_state": "EFFECTIVE", "number": "S60055", "type": { "name": "Normal Subscription", "id": "6BB2B984CC9309775D06650C7493A836", "description": null, "alternative_code": "ST" }, "id": "A60B45D48F24CE3C1099FEB5D4FCEC2E" }, "udf_date_1": null, "udf_date_2": null, "udf_date_3": null, "udf_date_4": null, "log_information": { "updated_date": "2015-03-12T15:25:48", "created_by_unit": { "community_name": "Main Community", "group_name": "Main Group", "name": "Admin Unit", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "description": "r1", "alternative_code": "MG" }, "created_date": "2015-03-12T15:23:10", "updated_by_unit": { "community_name": "Main Community", "group_name": "Main Group", "name": "Admin Unit", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "description": "r1", "alternative_code": "MG" }, "created_by_user": { "person_name": "mpadministrator", "username": "mpadministrator", "id": "1", "email": "mp@ministrator.com" }, "updated_by_user": { "person_name": "Marios Lannister", "username": "mpadministrator", "id": "1" } }, "life_cycle_state": "EFFECTIVE", "unit_of_time": "DAYS", "description": "test desc 2" } } Tip

Available from CRM.COM R9.0.0

Table of Contents

maxLevel	2

GET alerts/show

This method returns information related with an alert. A single alert is returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

alert_identifier

(mandatory)

Alert Identifier

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

Include Page

	V4:alert_identifier
	V4:alert_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:alert_complete
	V4:alert_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	js
linenumbers	true

GET alerts/list

This method returns information related with alerts having specific attributes. Multiple alerts are returned by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

recipient_identifier
(semi-optional)

Recipient Identifier

The identifier of the recipient related with the alerts that should be returned as a result. The allowed recipient identifier fields are the following:

Include Page

	V4:user_identifier
	V4:user_identifier

alert_definition_identifier

(semi-optional)

Alert Definition Identifier

The identifier of the alert definition related with the alerts that should be returned as a result. The allowed alert definition identifier fields are the following:

Include Page

	V4:alert_definition_identifier
	V4:alert_definition_identifier

entity

(semi-optional)

String

The name of the entity related with the alerts that should be returned as a result. The supported entities are the following:

ACTIVITIES

entity_id

(semi-optional)

String

The ID of the entity related with the alerts that should be returned as a result

recipient_email_address

(optional)

String

The email address of the recipient related with the alerts that should be returned as a result

recipient_phone_number

(optional)

String

The phone number of the recipient related with the alerts that should be returned as a result

life_cycle_state

(optional)

String

The life cycle state of the alerts that should be returned as a result. The supported options are EFFECTIVE or NOT_EFFECTIVE

created_date

(optional)

Date

The created date of the alerts that should be returned as a result.

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 at least one of the semi-optional parameters. Multiple of those parameters are allowed to be specified.

Response Data

Include Page

	V4:alert_complete
	V4:alert_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	js
linenumbers	true

POST alerts/resend

This method is used to re-send rejected alerts. This method is applicable only on rejected alerts. A single alert can be re-send through this method

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

alert_identifier

(mandatory)

Alert Identifier

The identifier of the alert that should be send again. The allowed alert Identifier fields are the following:

Include Page

	V4:alert_identifier
	V4:alert_identifier

Note that only rejected alerts can be specified in this method.

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

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Version	Old Version 1	New Version 2
Changes made by	George Rossides (Unlicensed)	George Rossides (Unlicensed)
Saved on	Oct 14, 2015	Oct 14, 2015

Page Comparison

Versions Compared

Key

GET alerts/show

Resource URL

Parameters

Restrictions

Response Data

Examples

GET buy_in_advance_requests/list

Resource URL

Parameters

Restrictions

Response Data

Examples

POST buy_in_advance_requests/create

Resource URL

Parameters

Restrictions

Response Data

Examples

POST buy_in_advance_requests/update

Resource URL

Parameters

Restrictions

Response Data

Examples

POST buy_in_advance_requests/cancel

Resource URL

Parameters

Restrictions

Response Data

Examples

GET alerts/show

Resource URL

Parameters

Restrictions

Response Data

Examples

GET alerts/list

Resource URL

Parameters

Restrictions

Response Data

Examples

POST alerts/resend

Resource URL

Parameters

Restrictions

Response Data

Examples