Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Excerpt

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

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

contact_information_identifier

(optional)

Contact information identifier

The identifier of the contact information (person or company) for which the retrieved activity is planned for

Include Page
V4:contact_information_identifier
V4:contact_information_identifier

type_identifier

(optional)

Activity type identifier

The identifier of the type of the retrieved activity

Include Page
V4:activity_type_identifier
V4:activity_type_identifier

category_identifier

(optional)

Activity category identifier

The identifier of the category of the retrieved activity

Include Page
V4:activity_category_identifier
V4:activity_category_identifier

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip

Available from CRM.COM R13.0.0


offset

(optional)

Number

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 one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...

Expand
titleExample 1

HTTP Method: GET 


Request:

Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "cancellation_reason":
            {
                "id": "352B746264664A96BC9FC2C16816B7F5",
                "name": "Cancel Reason 1",
                "description": "Description",
                "alternative_code": "CR1"
            },
            "number": "ACT000040",
            "expected_completion_date": "2015-03-10T12:11:03",
            "performed_for":
            {
                "lead":
                {
                    "life_cycle_state": "PENDING",
                    "number": "LD000006",
                    "id": "111D913CBD0A428ABD5E38ACD44CCFC8",
                    "contact_information":
                    {
                        "life_cycle_state": "MARKETING",
                        "company_profile":
                        {
                        },
                        "title": "Mr",
                        "first_name": "Black",
                        "type": "COMPANY",
                        "id": "8C7519D6CDAB451AA50418BA586F9432",
                        "company_name": "Black Box TV"
                    }
                }
            },
            "start_date": "2015-03-10T10:11:03",
            "assign_to":
            {
                "unit":
                {
                    "id": "1A73F4569FFA76E1C657C73C41D1FDB0",
                    "name": "Call Operators SB1",
                    "alternative_code": "COSB1"
                }
            },
            "estimated_completion_time":
            {
                "time_period_value": 2,
                "time_period_uot": "HOURS"
            },
            "contact_information":
            {
                "life_cycle_state": "MARKETING",
                "company_profile":
                {
                },
                "title": "Mr",
                "first_name": "Black",
                "type": "COMPANY",
                "id": "8C7519D6CDAB451AA50418BA586F9432",
                "name": "Black Box TV",
                "company_name": "Black Box TV"
            },
            "time_overdue":
            {
                "time_period_value": 2.129032258064516,
                "time_period_uot": "MONTHS"
            },
            "time_to_completion":
            {
                "time_period_uot": "HOURS"
            },
            "owned_by_group":
            {
                "community_name": "Internal Community",
                "id": "84F33366CB592BAAE7E2044D93611C6A",
                "name": "Main Group",
                "description": "Main Group",
                "alternative_code": "MG1"
            },
            "log_information":
            {
                "updated_date": "2015-04-07T12:12:24",
                "created_date": "2015-03-10T10:11:03",
                "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": "emichailidou",
                    "username": "emichailidou",
                    "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
                    "email": "e_michailidou@crm.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "status":
            {
                "id": "9BF9F6E1C1F54081A67BBD72CADE3BC9",
                "name": "Cancelled",
                "alternative_code": "C"
            },
            "life_cycle_state": "CANCELLED",
            "type":
            {
                "id": "6DFD8FD0D5024AC48750368FC39D13A8",
                "name": "Demonstration",
                "alternative_code": "D"
            },
            "id": "E2679ED3AA2E4A2F8F86019576F2BBEB",
            "description": "CRM.COM Billing App Demonstration",
            "services_to_be_provided_set":
            [
            ]
        }
    ]
}


...