Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

Key

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

...

...

...

...

...

...


Excerpt

This method completes an activity, which is already in progress

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 that will be completed. 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 completing the activity. If not specified then the default status for completing an activity of that type will be used. The allowed activity status identifiers are the following:

Include Page
V4:activity_status_identifier
V4:activity_status_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":"B70E9A718F7E436094035AACBFA66486",
	"activity_identifier"         :    { "number" : "ACT000137" },
    "status_identifier"           :    { "name" : "Closed"}
}

 


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "number": "ACT000137",
        "expected_completion_date": "2015-05-16T15:24:14",
        "performed_for":
        {
        },
        "start_date": "2015-05-14T15:24:14",
        "assign_to":
        {
            "unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1",
                "alternative_code": "MG"
            },
            "user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "sakkascy1986@hotmail.com"
            }
        },
        "contact_information":
        {
            "last_name": "Rossides",
            "life_cycle_state": "FINANCIAL",
            "first_name": "George",
            "type": "PERSON",
            "id": "08211F2D09E24989A8084FDEBBD39F17",
            "name": "George Rossides",
            "demographics":
            {
                "country_of_residence":
                {
                    "three_character_code": "USA",
                    "two_character_code": "US",
                    "id": "127",
                    "name": "UNITED STATES"
                },
                "name_day":
                {
                },
                "date_of_birth":
                {
                }
            }
        },
        "estimated_completion_time":
        {
            "time_period_value": 2,
            "time_period_uot": "DAYS"
        },
        "time_overdue":
        {
        },
        "time_to_completion":
        {
            "time_period_uot": "DAYS"
        },
        "owned_by_group":
        {
            "community_name": "Internal Community",
            "id": "84F33366CB592BAAE7E2044D93611C6A",
            "name": "Main Group",
            "description": "Main Group",
            "alternative_code": "MG1"
        },
        "log_information":
        {
            "updated_date": "2015-05-18T09:35:37",
            "created_date": "2015-05-14T15:24:14",
            "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": "COMPLETED",
            "id": "2",
            "name": "Closed",
            "description": "Closed Status",
            "alternative_code": "CL"
        },
        "actual_completed_date": "2015-05-18T09:35:37",
        "life_cycle_state": "COMPLETED",
        "type":
        {
            "id": "CB7953F4D06C4135A794623C9F1620D8",
            "name": "Onside Deliveries",
            "alternative_code": "OD"
        },
        "id": "CD8BAF55709743B0AE1F440DC4D719D3",
        "services_to_be_provided_set":
        [
            {
                "service":
                {
                    "product_type":
                    {
                        "service_type": "ONETIME",
                        "used_for_provisioning": true,
                        "classification": "SERVICES",
                        "composition_method": "FIXEDBUNDLE",
                        "id": "AD3C6C3E2D2D4C9DA7BDBC2908718AEB",
                        "name": "One Time- Fixed B",
                        "description": "One time Fixed Bundle product",
                        "alternative_code": "OT-Fixed"
                    },
                    "id": "DFEA1EC8521F416AABB8D79305CEF600",
                    "code": "Delivery Service",
                    "alternative_code": "DS"
                },
                "resource_requests_set":
                [
                ],
                "id": "73D915EFCAC54C40AFD5ED159D5C0183",
                "time_spend":
                {
                    "time_period_value": 2,
                    "time_period_uot": "HOURS"
                }
            },
            {
                "service":
                {
                    "product_type":
                    {
                        "service_type": "ONETIME",
                        "used_for_provisioning": false,
                        "classification": "SERVICES",
                        "composition_method": "FIXEDBUNDLE",
                        "id": "391D5E5E5F4F70FCA75C4D01ECAD0B6C",
                        "name": "One Time Services - Fixed",
                        "description": "One Time Services - Fixed",
                        "alternative_code": "OTS-F_1"
                    },
                    "id": "2AEC889AEC884E83B67A1FF478E34FE0",
                    "code": "Home Delivery",
                    "alternative_code": "H_D"
                },
                "resource_requests_set":
                [
                    {
                        "to_date": "2015-05-14T17:00:00",
                        "number_of_resources": 1,
                        "from_date": "2015-05-14T16:00:00",
                        "life_cycle_state": "ACCEPTED",
                        "requested_unit":
                        {
                            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                            "name": "Admin Unit",
                            "group_name": "Main Group",
                            "description": "r1",
                            "alternative_code": "MG"
                        },
                        "number": "45",
                        "id": "D3AFC27DF3FF491DB34A0BD41CCCBB3E"
                    }
                ],
                "id": "15C4959E2F7C4FC9B4D7BE421984B38B",
                "time_spend":
                {
                    "time_period_value": 20,
                    "time_period_uot": "HOURS"
                }
            }
        ]
    }
}

 

...