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

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "entity": "ACTIVITIES",
        "number": "7",
        "recipient_email_address": "m_ioannou@crm.com",
        "subject": "Test Alert ACT000366 ",
        "log_information":
        {
            "updated_date": "2015-11-03T16:44:32",
            "created_date": "2015-11-03T16:44:21",
            "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": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "sakkascy1986@hotmail.com"
            },
            "updated_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "sakkascy1986@hotmail.com"
            }
        },
        "life_cycle_state": "SUCCESSFUL",
        "alert_definition":
        {
            "life_cycle_state": "EFFECTIVE",
            "type": "EMAIL",
            "id": "26D38E26DE6647529FDCCBFD0F2F7C48",
            "name": "Send Alert To created By User",
            "alternative_code": "CREATED_BY_USER"
        },
        "entity_id": "78F2C4952DF14A38B7F789393AC84EDC",
        "content": "  Mr Ioannou132 Marios  your  activity with number  ACT000366 was created

  with sub    location    

   with job     location    

   with lead           ",
        "recipient":
        {
            "person_name": "m_ioannou",
            "username": "m_ioannou",
            "id": "C5D6D95C71C4484F9168A5444FC928EF", 
            "email": "m_ioannou@crm.com"
        },
        "type": "EMAIL",
        "id": "D5C9543925F54A9199D1F451AB03B909",
        "workflow_rule":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "5DB96A77C25B4D19A65C4515D4E0D394",
            "name": "Workflow Rule Activity On Update",
            "alternative_code": "Upd_Act"
        }
    }
}

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

...

alert_definition_identifier

(semi-optional)

...

workflow_rule_identifier

(semi-optional)

...

entity

(semi-optional)

...

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

ACTIVITIES
SERVICEREQUESTS
JOBS
SUBSCRIPTIONS
REWARDOFFERS

Tip
REWARDOFFERS entity is available from CRM.COM R11.0.0

...

entity_id

(semi-optional)

...

recipient_email_address

(optional)

...

recipient_phone_number

(optional)

...

life_cycle_state

(optional)

...

created_date

(optional)

...

number_of_results

(optional)

...

The number of results that can be retrieved through each call

Tip
Available from CRM.COM R13.0.0

...

offset

(optional)

...

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip
Available from CRM.COM R13.0.0

...

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. 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

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "entity": "ACTIVITIES",
            "number": "4",
            "recipient_email_address": "m_ioannou@crm.com",
            "subject": "Test Alert ACT000366 ",
            "log_information":
            {
                "updated_date": "2015-11-03T12:08:04",
                "created_date": "2015-11-03T12:08:03",
                "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": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "life_cycle_state": "SUCCESSFUL",
            "alert_definition":
            {
                "life_cycle_state": "EFFECTIVE",
                "type": "EMAIL",
                "id": "26D38E26DE6647529FDCCBFD0F2F7C48",
                "name": "Send Alert To created By User",
                "alternative_code": "CREATED_BY_USER"
            },
            "entity_id": "78F2C4952DF14A38B7F789393AC84EDC",
            "content": "  Mr Ioannou132 Marios  your  activity with number  ACT000366 was created

  with sub    location    

   with job     location    

   with lead           ",
            "recipient": null,
            "type": "EMAIL",
            "id": "DDB095659F0A4354BA4DF17F1BC21232",
            "workflow_rule":
            {
                "life_cycle_state": "EFFECTIVE",
                "id": "5DB96A77C25B4D19A65C4515D4E0D394",
                "name": "Workflow Rule Activity On Update",
                "alternative_code": "Upd_Act"
            }
        },
        {
            "entity": "ACTIVITIES",
            "number": "5",
            "recipient_email_address": "sakkascy1986@hotmail.com",
            "subject": "Test Alert ACT000355 ",
            "log_information":
            {
                "updated_date": "2015-11-03T15:00:44",
                "created_date": "2015-11-03T15:00:43",
                "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": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "life_cycle_state": "SUCCESSFUL",
            "alert_definition":
            {
                "life_cycle_state": "EFFECTIVE",
                "type": "EMAIL",
                "id": "26D38E26DE6647529FDCCBFD0F2F7C48",
                "name": "Send Alert To created By User",
                "alternative_code": "CREATED_BY_USER"
            },
            "entity_id": "7FB01C80AF6D47B0A9740E0A9A10C2D0",
            "content": "  Mr Ioannou130 Marios  your  activity with number  ACT000355 was created

  with sub    location    

   with job     location    

   with lead           ",
            "recipient":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "sakkascy1986@hotmail.com"
            },
            "type": "EMAIL",
            "id": "B59339D5C4DE47569D71FD077FE26325",
            "workflow_rule":
            {
                "life_cycle_state": "EFFECTIVE",
                "id": "5DB96A77C25B4D19A65C4515D4E0D394",
                "name": "Workflow Rule Activity On Update",
                "alternative_code": "Upd_Act"
            }
        },
        {
            "entity": "ACTIVITIES",
            "number": "6",
            "recipient_email_address": "m_ioannou@crm.com",
            "subject": "Test Alert ACT000366 ",
            "log_information":
            {
                "updated_date": "2015-11-03T16:43:01",
                "created_date": "2015-11-03T16:42:31",
                "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": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "life_cycle_state": "SUCCESSFUL",
            "alert_definition":
            {
                "life_cycle_state": "EFFECTIVE",
                "type": "EMAIL",
                "id": "26D38E26DE6647529FDCCBFD0F2F7C48",
                "name": "Send Alert To created By User",
                "alternative_code": "CREATED_BY_USER"
            },
            "entity_id": "78F2C4952DF14A38B7F789393AC84EDC",
            "content": "  Mr Ioannou132 Marios  your  activity with number  ACT000366 was created

  with sub    location    

   with job     location    

   with lead           ",
            "recipient":
            {
                "person_name": "m_ioannou",
                "username": "m_ioannou",
                "id": "C5D6D95C71C4484F9168A5444FC928EF"
				"email": "m_ioannou@crm.com"
			 },
            "type": "EMAIL",
            "id": "761E70B2CF7E4E3F9DD4140A98023536",
            "workflow_rule":
            {
                "life_cycle_state": "EFFECTIVE",
                "id": "5DB96A77C25B4D19A65C4515D4E0D394",
                "name": "Workflow Rule Activity On Update",
                "alternative_code": "Upd_Act"
            }
        },
....
   ]
}

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

...

(mandatory)

...

Alert Identifier

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

...

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

...

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
          "token":"438BA44BD33B44EEBC77746030A92629",
          "alert_identifier":{"number":"11"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "recipient_phone_number": "357232256789",
        "entity": "ACTIVITIES",
        "error_code": "SendingSMSFailException",
        "error_description": "Error:Sending sms failed.  Error: ERROR No Account Found for the Given Credentials. - Description:Sending sms failed.",
        "number": "11",
        "log_information":
        {
            "updated_date": "2016-01-19T11:28:22",
            "created_date": "2016-01-07T13:33:22",
            "created_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1",
                "alternative_code": "MG"
            },
            "updated_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "crm.com.tst@gmail.com"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "life_cycle_state": "REJECTED",
        "alert_definition":
        {
            "life_cycle_state": "EFFECTIVE",
            "type": "SMS",
            "id": "3901B04101C843C4BA80EC6698FA8331",
            "name": "Installation alert SMS",
            "alternative_code": "IAS"
        },
        "entity_id": "FB351B991DFB46FFAD49BDB19B653ED3",
        "content": "New Installation activity ACT000256 assigned to your unit Admin Unit ",
        "recipient":
        {
            "person_name": "m_clerides",
            "username": "m_clerides",
            "id": "D502772234A6A5F3DEBF0D77D06D9703",
            "email": "crm.com.tst@gmail.com"
        },
        "type": "SMS",
        "id": "02F9E6D58FC14B4CB5740451067FDB64",
        "workflow_rule":
        {
            "life_cycle_state": "NOT_EFFECTIVE",
            "id": "70701D9EAD034C52A729BD4EC89C7230",
            "name": "Installations",
            "alternative_code": "I"
        }
    }
}

POST alerts/delete

This method is used to delete successful or rejected alerts. A single alert can be deleted through this method

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 deleted. The allowed alert Identifier fields are the following:

...

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":"7A5D6BFA7366434EB60EC189D6474836",
    "alert_identifier":{"number":"7"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{ "status": { "message": "", "description": "", "code": "OK" }, "data": { "entity": "ACTIVITIES", "number": "7", "recipient_email_address": "m_ioannou@crm.com", "subject": "Test Alert ACT000366 ", "log_information": { "updated_date": "2015-11-06T08:12:28", "created_date": "2015-11-03T16:44:21", "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": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" }, "updated_by_user": { "person_name": "Marios Lannister", "username": "MPAdministrator", "id": "1" } }, "life_cycle_state": "SUCCESSFUL", "alert_definition": { "life_cycle_state": "EFFECTIVE", "type": "EMAIL", "id": "26D38E26DE6647529FDCCBFD0F2F7C48", "name": "Send Alert To created By User", "alternative_code": "CREATED_BY_USER" }, "entity_id": "78F2C4952DF14A38B7F789393AC84EDC", "content": " Mr Ioannou132 Marios your activity with number ACT000366 was created with sub location with job location with lead ", "recipient": { "person_name": "m_ioannou", "username": "m_ioannou", "id": "C5D6D95C71C4484F9168A5444FC928EF" "email":"m_ioannou@crm.com" }, "type": "EMAIL", "id": "D5C9543925F54A9199D1F451AB03B909", "workflow_rule": { "life_cycle_state": "EFFECTIVE", "id": "5DB96A77C25B4D19A65C4515D4E0D394", "name": "Workflow Rule Activity On Update", "alternative_code": "Upd_Act" } } } Panel

name	blue

Child pages (Children Display)

excerpt	true

Versions Compared

Old Version 14

New Version 15

Key

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

POST alerts/delete

Resource URL

Parameters

Restrictions

Response Data

Examples

Page Comparison

Versions Compared

Old Version 14

New Version 15

Key

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

POST alerts/delete

Resource URL

Parameters

Restrictions

Response Data

Examples