Page Comparison

Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

activity_identifier

(mandatory)

Activity identifier

The identifier of the activity that should be returned as a result. The allowed activities identifier fields are the following:

Include Page

	V4:activity_identifier
	V4:activity_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

...

Name

Type

Description

token

String

The token retrieved from the login method

activity_type_identifier

(semi-optional)

Activity type identifier

The identifier of the activity type. The allowed activity type identifier fields are the following:

Include Page

	V4:activity_type_identifier
	V4:activity_type_identifier

contact_information_identifier

(semi-optional)

Contact information identifier

The identifier of the contact information related with the account that will be returned as results. The allowed contact information identifier fields are the following:

Include Page

	V4:contact_information_identifier
	V4:contact_information_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

...

Name

Type

Description

token

String

The token retrieved from the login method

period

(mandatory)

Number

The length of time for which an activity is close to estimated completion

uot

(mandatory)

String

The unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

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

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

...

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

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

...

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

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

...

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

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

...

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

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

...

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

Tip
Available from CRM.COM R6.0.0

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

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

...

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier

(mandatory)

Activity Type Identifier

The type of the activity. The allowed activity type identifiers are the following:

Include Page

	V4:activity_type_identifier
	V4:activity_type_identifier

contact_information_identifier

(mandatory)

Contact Information Identifier

The contact information related with the activity. The allowed contact information identifiers are the following:

Include Page

	V4:contact_information_identifier
	V4:contact_information_identifier

category_identifier

(optional)

Category Identifier

The category of the activity. The allowed activity category identifiers are the following:

Include Page

	V4:activity_category_identifier
	V4:activity_category_identifier

status_identifier

(mandatory)

Activity Status Identifier

The status of the activity. The allowed activity status identifiers are the following:

Include Page

	V4:activity_status_identifier
	V4:activity_status_identifier

description

(optional)

String

The description of the retrieved activity

notes

(optional)

String

The notes of the retrieved activity

start_date

(optional)

Date

The date that the activity will start

owned_by_group_identifier

(mandatory)

The identifier of the owned by group information

The owned by group information of the activity. The allowed group identifier fields are the following:

Include Page

	V4:group_identifier
	V4:group_identifier

privacy_level_identifier

(optional)

The identifier of the privacy level

The privacy level of the activity. The allowed privacy level identifier fields are the following:

Include Page

	V4:privacy_level_identifier
	V4:privacy_level_identifier

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

expected_completion_date

(semi-optional)

Date

The date that the activity is expected to be completed

estimated_completion_time

(semi-optional)

Time Period Object

The time that is estimated to complete the activity, measured in minutes, hours, days, weeks, years

assign_to

(mandatory)

Assign To Object

The assignment information of the activity

performed_for

(optional)

Performed for Object

The entities which are related with the activity

services_to_be_provided_set

(optional)

Set of Services to be Provided Object

The information related to the services to be provided with the activity

...

Name

Type

Description

token

String

The token retrieved from the login method

activity_identifier

(mandatory)

Activity Identifier

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

Include Page

	V4:activity_identifier
	V4:activity_identifier

category_identifier

(optional)

Category Identifier

The category of the activity. The allowed activity category identifiers are the following:

Include Page

	V4:activity_category_identifier
	V4:activity_category_identifier

status_identifier

(optional)

Activity Status Identifier

The status of the activity. The allowed activity status identifiers are the following:

Include Page

	V4:activity_status_identifier
	V4:activity_status_identifier

description

(optional)

String

The description of the retrieved activity

notes

(optional)

String

The notes of the retrieved activity

start_date

(optional)

Date

The date that the activity will start

owned_by_group_identifier

(optional)

The identifier of the owned by group information

The owned by group information of the activity. The allowed group identifier fields are the following:

Include Page

	V4:group_identifier
	V4:group_identifier

privacy_level_identifier

(optional)

The identifier of the privacy level

The privacy level of the activity. The allowed privacy level identifier fields are the following:

Include Page

	V4:privacy_level_identifier
	V4:privacy_level_identifier

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

expected_completion_date

(optional)

Date

The date that the activity is expected to be completed

estimated_completion_time

(optional)

Time Period Object

The time that is estimated to complete the activity, measured in minutes, hours, days, weeks, years

assign_to

(optional)

Assign To Object

The assignment information of the activity

performed_for

(optional)

Performed for Object

The entities which are related with the activity

services_to_be_provided_set

(optional)

Set of Services to be Provided Object

The information related to the services to be provided with the activity

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

...

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

(mandatory)

Activity Status Identifier

The status that will be set on the activity, after the cancellation. 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

...

This method sets an activity in progress. This method can be applied only on pending activities

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 started. The allowed activity identifier fields are the following:

Include Page

	V4:activity_identifier
	V4:activity_identifier

status_identifier

(mandatory)

Activity Status Identifier

The status that will be set on the activity, after starting the progress. The allowed activity status identifiers are the following:

Include Page

	V4:activity_status_identifier
	V4:activity_status_identifier

...

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

(mandatory)

Activity Status Identifier

The status that will be set on completing the activity. The allowed activity status identifiers are the following:

Include Page

	V4:activity_status_identifier
	V4:activity_status_identifier

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
	"token":"B70E9A718F7E436094035AACBFA66486",
	"activity_identifier"         :    { "number" : "ACT000137" },
    "status_identifier"           :    { "name" : "Closed"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "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"
                }
            }
        ]
    }
}

Versions Compared

Old Version 82

New Version 83

Key

Resource URL

Parameters

Resource URL

Parameters

Resource URL

Parameters

Resource URL

Parameters