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

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "entity": "ACTIVITIES",
        "error_code": "Error code 44",
        "error_description": "bad gateway",
        "number": "7",
        "recipient_email_address": "m_michael@crm.com",
        "subject": "#activity.number   Dear #activity.contact_information.name",
        "log_information":
        {
            "updated_date": "2015-10-23T17:31:13",
            "created_by_unit": null,
            "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": null,
            "updated_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "sakkascy1986@hotmail.com"
            }
        },
        "life_cycle_state": "REJECTED",
        "alert_definition":
        {
            "life_cycle_state": "NOT_EFFECTIVE",
            "type": "EMAIL",
            "id": "966D8110D1B54F1C9B037744DEC9848C",
            "name": "Alert Definition",
            "alternative_code": "AD"
        },
        "content": "#activity.number   Dear #activity.contact_information.name   We would like to inform you that the following activities have been completed successfully. #activity.type   Regards AluxSat Co. #activity.subscription.location.type and #activity.subscription.location.country",
        "recipient":
        {
            "person_name": "m_michael_user",
            "username": "m_michael_user",
            "id": "970A84FDE9784FCF807597FEA26FA0F1"
        },
        "type": "EMAIL",
        "id": "71DE190EFBE1FF070F9AD07911F18A6E",
        "entityID": "2CDD6FD79C7A49019448E60D37C8A520"
    }
} 

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

...

entity_id

(semi-optional)

...

recipient_email_address

(optional)

...

recipient_phone_number

(optional)

...

life_cycle_state

(optional)

...

created_date

(optional)

...

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

...

Examples

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

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:

Response: