Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Joseph Ioannou

Saved on

Key

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

...

...

...

...

...

...

...

...


Excerpt

This method cancels an activity, which is not already completed or cancelled. 

Tip

Available from CRM.COM R6.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

activity_identifier

(mandatory)

Activity Identifier

The identifier of the activity to be cancelled. The allowed activity identifier fields are the following:

Include Page
V4:activity_identifier
V4:activity_identifier

status_identifier

(optional)

Activity Status Identifier

The status that will be set on the activity, after the cancellation. If not specified then the default status for cancelling activities of that type will be used. The allowed activity status identifiers are the following:

Include Page
V4:activity_status_identifier
V4:activity_status_identifier

cancellation_reason_identifier

(mandatory)

Activity Cancellation Reason Identifier

The reason for cancelling the activity. The allowed activity cancellation reason identifiers are the following:

Include Page
V4:activity_cancellation_reason_identifier
V4:activity_cancellation_reason_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.

...

Expand
titleExample 1

HTTP Method: POST

 


Request:

Body:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
	"token":"336784FFE8734D9F919A6EA6891316F4",
	"activity_identifier"         :    { "number" : "ACT000133" },
    "status_identifier"           :    { "name" : "Cancelled"},
    "cancellation_reason_identifier"           :    { "name" : "Cancel Reason 1"}
}  


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": "ACT000133",
        "expected_completion_date": "2015-05-13T19:47:55",
        "performed_for":
        {
            "job":
            {
                "life_cycle_state": "IN_PROGRESS",
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Ioannou6",
                        "life_cycle_state": "FINANCIAL",
                        "first_name": "Marios",
                        "type": "PERSON",
                        "id": "5397EE07B58752ABE0975E9027BB2A72",
                        "demographics":
                        {
                            "name_day":
                            {
                            },
                            "date_of_birth":
                            {
                            },
                            "id_number": "8788889"
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "ACR000281",
                    "id": "74CABB55D73734E89E7B9BA2471B739C",
                    "name": "mar6"
                },
                "number": "J000110",
                "id": "4A9A19740C5A484984B43454057B327D"
            }
        },
        "start_date": "2015-05-13T14:47:55",
        "assign_to":
        {
            "user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "sakkascy1986@hotmail.com"
            }
        },
        "estimated_completion_time":
        {
            "time_period_value": 5,
            "time_period_uot": "HOURS"
        },
        "contact_information":
        {
            "last_name": "Ioannou6",
            "life_cycle_state": "FINANCIAL",
            "first_name": "Marios",
            "type": "PERSON",
            "id": "5397EE07B58752ABE0975E9027BB2A72",
            "name": "Marios Ioannou6",
            "demographics":
            {
                "country_of_residence":
                {
                    "three_character_code": "USA",
                    "two_character_code": "US",
                    "id": "127",
                    "name": "UNITED STATES"
                },
                "name_day":
                {
                },
                "date_of_birth":
                {
                },
                "id_number": "8788889"
            }
        },
        "time_overdue":
        {
            "time_period_value": 5,
            "time_period_uot": "DAYS"
        },
        "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-05-18T08:58:21",
            "created_date": "2015-05-13T14:47:55",
            "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": "sakkascy1986@hotmail.com"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "status":
        {
            "life_cycle_state": "CANCELLED",
            "id": "9BF9F6E1C1F54081A67BBD72CADE3BC9",
            "name": "Cancelled",
            "alternative_code": "C"
        },
        "life_cycle_state": "CANCELLED",
        "type":
        {
            "id": "6D0C79835F7B0059D3BD1A51F2A03F41",
            "name": "Maintenance visits",
            "alternative_code": "MV"
        },
        "id": "2B601372C1924F699C7EB187B7C3A6CF",
        "services_to_be_provided_set":
        [
            {
                "service":
                {
                    "product_type":
                    {
                        "service_type": "ONETIME",
                        "used_for_provisioning": false,
                        "classification": "SERVICES",
                        "composition_method": "FLAT",
                        "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                        "name": "One Time Services - Flat",
                        "description": "A type which is used for one time services",
                        "alternative_code": "OTS-F"
                    },
                    "id": "8F7A45F44BBEB320718F309F58CCE097",
                    "description": "Installation",
                    "code": "Installation Fee",
                    "alternative_code": "Ins"
                },
                "resource_requests_set":
                [
                ],
                "id": "041E4585AE3345199E183B33C453386F",
                "time_spend":
                {
                    "time_period_value": 5,
                    "time_period_uot": "SECONDS"
                }
            },
            {
                "service":
                {
                    "product_type":
                    {
                        "service_type": "ONETIME",
                        "used_for_provisioning": false,
                        "classification": "SERVICES",
                        "composition_method": "FLAT",
                        "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                        "name": "One Time Services - Flat",
                        "description": "A type which is used for one time services",
                        "alternative_code": "OTS-F"
                    },
                    "id": "998E9B16CD3936A6D31AC9FC8ABEE0B8",
                    "code": "Upgrades",
                    "alternative_code": "UP"
                },
                "resource_requests_set":
                [
                ],
                "id": "78394C7EF72A4C46B6F7DBE7BC688F54",
                "time_spend":
                {
                    "time_period_value": 15,
                    "time_period_uot": "SECONDS"
                }
            },
            {
                "service":
                {
                    "product_type":
                    {
                        "service_type": "ONETIME",
                        "used_for_provisioning": false,
                        "classification": "SERVICES",
                        "composition_method": "FLAT",
                        "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                        "name": "One Time Services - Flat",
                        "description": "A type which is used for one time services",
                        "alternative_code": "OTS-F"
                    },
                    "id": "8B58C14194D51E560F0E49B0292EA56F",
                    "code": "Maintenance Fee",
                    "alternative_code": "MC"
                },
                "resource_requests_set":
                [
                ],
                "id": "D49CAF9DAEE84BCEB5E7A78BB96DCA84",
                "time_spend":
                {
                    "time_period_value": 15,
                    "time_period_uot": "HOURS"
                }
            }
        ]
    }
}


...