Table of Contents

maxLevel	2

GET activities/show

This method returns information related with an activity. Single activity is returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

Activity identifier

The identifier of the activity that should be returned as a result. The allowed activities 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

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_string_10": null,
        "udf_float_1": null,
        "udf_string_11": null,
        "udf_float_2": null,
        "udf_string_12": null,
        "udf_float_3": null,
        "udf_string_13": null,
        "udf_float_4": null,
        "udf_string_14": null,
        "udf_float_5": null,
        "udf_string_15": null,
        "udf_string_16": null,
        "udf_float_6": null,
        "udf_string_1": null,
        "udf_string_2": null,
        "udf_float_7": null,
        "privacy_level":
        {
            "number": null,
            "hierarchy_level": 2,
            "name": "High",
            "id": "321ACE4A65A24800365B2B2236F5E171"
        },
        "contact_information":
        {
            "last_name": "Spector",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "company_profile": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Matt",
            "name": "Matt Spector",
            "id": "58F5508072753180E10322DBCA1862EE",
            "company_name": null,
            "demographics":
            {
                "gender": "MALE",
                "passport_issued_by_country": null,
                "passport_number": "JB0007689",
                "social_security_number": null,
                "country_of_residence":
                {
                    "name": "JAPAN",
                    "id": "237"
                },
                "industry_sector": null,
                "date_of_birth":
                {
                    "month": null,
                    "day": null,
                    "year": null
                },
                "name_day":
                {
                    "month": null,
                    "day": null
                },
                "id_number": null,
                "id_issued_by_country": null,
                "industry": null
            }
        },
        "udf_string_3": null,
        "udf_float_8": null,
        "udf_string_4": null,
        "udf_float_9": null,
        "udf_string_5": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "udf_string_9": null,
        "id": "D9C6BE3D7817C8DA8E16703CAAEC1A9A",
        "expected_completion_date": "2014-12-03T10:12:51",
        "time_to_completion":
        {
            "time_period_value": null,
            "time_period_uot": "DAYS"
        },
        "time_overdue":
        {
            "time_period_value": 2.5,
            "time_period_uot": "MONTHS"
        },
        "log_information":
        {
            "updated_date": "2015-02-17T12:15:56",
            "created_by_unit":
            {
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2014-12-02T10:12:51",
            "updated_by_unit":
            {
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1"
            },
            "updated_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "life_cycle_state": "PENDING",
        "estimate_completion_time":
        {
            "time_period_value": 1,
            "time_period_uot": "DAYS"
        },
        "type":
        {
            "name": "Installations",
            "id": "BF60960C7FC5B0E5B81DB7E5BCC7F140",
            "description": null,
            "alternative_code": "IN"
        },
        "services_to_be_provided_set":
        [
            {
                "service":
                {
                    "product_type":
                    {
                        "physical_good_type": null,
                        "service_type": "ONETIME",
                        "used_for_provisioning": true,
                        "composition_method": "FLAT",
                        "classification": "SERVICES",
                        "name": "One Time Services",
                        "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                        "description": "A type which is used for one time services",
                        "alternative_code": "OTS"
                    },
                    "id": "8E990D550CC2F4D2951A273E9D84F9E6",
                    "description": null,
                    "code": "Installation",
                    "alternative_code": "IN"
                },
                "resource_requests_set":
                [
                    {
                        "to_date": "2014-12-04T13:00:00",
                        "from_date": "2014-12-04T09:00:00",
                        "number_of_resources": 2,
                        "requested_unit":
                        {
                            "name": "Team 4 (Installations)",
                            "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                            "description": null,
                            "alternative_code": "T4I"
                        },
                        "life_cycle_state": "PENDING",
                        "number": "52",
                        "id": "8951B9D8EAF88401AEFAFDF40E9DA094",
                        "description": null
                    },
                    {
                        "to_date": "2014-12-04T18:00:00",
                        "from_date": "2014-12-04T14:00:00",
                        "number_of_resources": 1,
                        "requested_unit":
                        {
                            "name": "Team 4 (Installations)",
                            "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                            "description": null,
                            "alternative_code": "T4I"
                        },
                        "life_cycle_state": "PENDING",
                        "number": "62",
                        "id": "9D014701C5A4D79B3801EECCBCAC84E8",
                        "description": "Web Api Description Test"
                    },
                    {
                        "to_date": "2014-12-12T13:00:00",
                        "from_date": "2014-12-12T09:00:00",
                        "number_of_resources": 5,
                        "requested_unit":
                        {
                            "name": "Team 4 (Installations)",
                            "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                            "description": null,
                            "alternative_code": "T4I"
                        },
                        "life_cycle_state": "PENDING",
                        "number": "66",
                        "id": "F9B808574B5249252743F75D3C45F5D8",
                        "description": null
                    },
                    {
                        "to_date": "2014-12-08T18:00:00",
                        "from_date": "2014-12-08T09:00:00",
                        "number_of_resources": 2,
                        "requested_unit":
                        {
                            "name": "Team 4 (Installations)",
                            "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                            "description": null,
                            "alternative_code": "T4I"
                        },
                        "life_cycle_state": "ACCEPTED",
                        "number": "65",
                        "id": "4BCF21CCA7242A197B68630BB1D06E21",
                        "description": null
                    },
                    {
                        "to_date": "2014-12-04T18:00:00",
                        "from_date": "2014-12-04T14:00:00",
                        "number_of_resources": 1,
                        "requested_unit":
                        {
                            "name": "Team 4 (Installations)",
                            "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                            "description": null,
                            "alternative_code": "T4I"
                        },
                        "life_cycle_state": "PENDING",
                        "number": "61",
                        "id": "A9520708FABB6A3867C0D7E9BDA3F783",
                        "description": "Web Api Description Test"
                    },
                    {
                        "to_date": "2014-12-04T18:00:00",
                        "from_date": "2014-12-04T14:00:00",
                        "number_of_resources": 1,
                        "requested_unit":
                        {
                            "name": "Team 4 (Installations)",
                            "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                            "description": null,
                            "alternative_code": "T4I"
                        },
                        "life_cycle_state": "PENDING",
                        "number": "60",
                        "id": "92D30153AE02C7F15E26C3CD2F2AACD6",
                        "description": "Web Api Description Test"
                    },
                    {
                        "to_date": null,
                        "from_date": null,
                        "number_of_resources": 2,
                        "requested_unit":
                        {
                            "name": "Team 4 (Installations)",
                            "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                            "description": null,
                            "alternative_code": "T4I"
                        },
                        "life_cycle_state": "CANCELLED",
                        "number": "46",
                        "id": "FAED26D046573099BFC1E0E88C21ADEC",
                        "description": null
                    },
                    {
                        "to_date": "2014-12-05T18:00:00",
                        "from_date": "2014-12-05T09:00:00",
                        "number_of_resources": 1,
                        "requested_unit":
                        {
                            "name": "Team 4 (Installations)",
                            "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                            "description": null,
                            "alternative_code": "T4I"
                        },
                        "life_cycle_state": "PENDING",
                        "number": "63",
                        "id": "FB438EB23C4CCF3618F809DE10F61383",
                        "description": "Web Api Description Test"
                    },
                    {
                        "to_date": "2014-12-03T18:00:00",
                        "from_date": "2014-12-03T14:00:00",
                        "number_of_resources": 2,
                        "requested_unit":
                        {
                            "name": "Team 4 (Installations)",
                            "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                            "description": null,
                            "alternative_code": "T4I"
                        },
                        "life_cycle_state": "ACCEPTED",
                        "number": "44",
                        "id": "5AD8AC82FA7E0E4974DB82DF41D09EF2",
                        "description": null
                    },
                    {
                        "to_date": "2014-12-08T18:00:00",
                        "from_date": "2014-12-08T09:00:00",
                        "number_of_resources": 10,
                        "requested_unit":
                        {
                            "name": "Team 4 (Installations)",
                            "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                            "description": null,
                            "alternative_code": "T4I"
                        },
                        "life_cycle_state": "ACCEPTED",
                        "number": "64",
                        "id": "42178E5F4CFE73EBAE156EC8409DA470",
                        "description": null
                    },
                    {
                        "to_date": null,
                        "from_date": null,
                        "number_of_resources": 2,
                        "requested_unit":
                        {
                            "name": "Team 3 (Deliveries)",
                            "id": "7489680C0A5C5C8E03402D636C53FD0D",
                            "description": null,
                            "alternative_code": "T3D"
                        },
                        "life_cycle_state": "PENDING",
                        "number": "59",
                        "id": "82C9F86EF8B0B993C5D7F7414F19A130",
                        "description": null
                    },
                    {
                        "to_date": null,
                        "from_date": null,
                        "number_of_resources": 2,
                        "requested_unit":
                        {
                            "name": "Team 4 (Installations)",
                            "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                            "description": null,
                            "alternative_code": "T4I"
                        },
                        "life_cycle_state": "CANCELLED",
                        "number": "47",
                        "id": "998182B77E1048B14422D59F2888BFE0",
                        "description": null
                    }
                ],
                "id": "865FEE574CD1A24921E07FD0625AF4BD",
                "time_spend":
                {
                    "time_period_value": 2,
                    "time_period_uot": null
                }
            }
        ],
        "notes": null,
        "udf_date_10": null,
        "number": "9",
        "performed_for":
        {
            "service_request": null,
            "subscription": null,
            "job": null
        },
        "assign_to":
        {
            "unit":
            {
                "name": "U1",
                "id": "8B4009FA8BC8A612D0DB62B5F2AB135B",
                "description": null,
                "alternative_code": null
            },
            "user": null
        },
        "udf_date_1": null,
        "udf_date_2": null,
        "udf_float_10": null,
        "udf_date_3": null,
        "udf_date_4": null,
        "start_date": "2014-12-02T10:12:51",
        "udf_date_5": null,
        "udf_date_6": null,
        "udf_date_7": null,
        "udf_date_8": null,
        "udf_date_9": null,
        "owned_by_group":
        {
            "name": "Main Group",
            "id": "84F33366CB592BAAE7E2044D93611C6A",
            "description": "Main Group",
            "alternative_code": "das"
        },
        "status":
        {
            "name": "To Be approved",
            "id": "C93B05CCFC11CFFA62BA2A04F87603C8",
            "description": null,
            "alternative_code": "TBA"
        },
        "actual_completed_date": null,
        "description": "test",
        "category": null
    }
}

GET activities/list

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

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(semi-optional)

...

Activity type identifier

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

...

(semi-optional)

...

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:

...

number_of_results

(optional)

...

The number of results that can be retrieved through each call

Tip
Available from CRM.COM R13.0.0

...

offset

(optional)

...

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.

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "notes": null,
            "udf_string_10": null,
            "udf_string_11": null,
            "udf_string_12": null,
            "udf_date_10": null,
            "udf_string_13": null,
            "number": "3",
            "udf_string_14": null,
            "performed_for":
            {
                "service_request": null,
                "subscription":
                {
                    "accounts_receivable":
                    {
                        "account_owner":
                        {
                            "last_name": "Xenofontos ",
                            "life_cycle_state": "FINANCIAL",
                            "middle_name": "Iatrou",
                            "company_profile": null,
                            "title": "Mr",
                            "type": "PERSON",
                            "first_name": "Kyriacos",
                            "name": "Kyriacos Xenofontos",
                            "id": "31260911295E70BB660EBEB0C4F941AC",
                            "company_name": null,
                            "demographics":
                            {
                                "gender": "MALE",
                                "passport_issued_by_country":
                                {
                                    "name": "BAHRAIN",
                                    "id": "144"
                                },
                                "passport_number": "3463463",
                                "social_security_number": "73473567",
                                "country_of_residence":
                                {
                                    "name": "UNITED KINGDOM",
                                    "id": "126"
                                },
                                "industry_sector": null,
                                "date_of_birth":
                                {
                                    "month": 5,
                                    "day": 6,
                                    "year": 1988
                                },
                                "name_day":
                                {
                                    "month": 5,
                                    "day": 3
                                },
                                "id_number": "87878000",
                                "id_issued_by_country":
                                {
                                    "name": "AZERBAIJAN",
                                    "id": "142"
                                },
                                "industry": null
                            }
                        },
                        "life_cycle_state": "ACTIVE",
                        "number": "195",
                        "name": "Xenofontos",
                        "id": "5B51429862A7BCBAD60CC81982BBD45B"
                    },
                    "life_cycle_state": "EFFECTIVE",
                    "number": "S60142",
                    "type":
                    {
                        "name": "United Kingdom",
                        "id": "1C81FBB1E5D90040F440ECE98D6A368D",
                        "description": "For subscribers residing in United Kingdom",
                        "alternative_code": "UK"
                    },
                    "id": "253A818FECCA1D1B212703FEE056C8EA"
                },
                "job": null
            },
            "udf_string_15": null,
            "assign_to":
            {
                "unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Marketing Unit",
                    "id": "83922FE923563679768A94F58CAB5569",
                    "description": "r1c1",
                    "alternative_code": null
                },
                "user":
                {
                    "person_name": "eleniTemplate",
                    "username": "eleniTemplate",
                    "id": "771CD3A923E7BEED3055E109E4F676DC",
                    "email": null
                }
            },
            "udf_string_1": null,
            "udf_string_16": null,
            "udf_string_2": null,
            "privacy_level":
            {
                "number": "000004",
                "hierarchy_level": 1,
                "name": "To be deleted 3",
                "id": "106A9C633A7851071709513CD15B491B"
            },
            "contact_information":
            {
                "last_name": "Xenofontos ",
                "life_cycle_state": "FINANCIAL",
                "middle_name": "Iatrou",
                "company_profile": null,
                "title": "Mr",
                "type": "PERSON",
                "first_name": "Kyriacos",
                "name": "Kyriacos Xenofontos",
                "id": "31260911295E70BB660EBEB0C4F941AC",
                "company_name": null,
                "demographics":
                {
                    "gender": "MALE",
                    "passport_issued_by_country":
                    {
                        "name": "BAHRAIN",
                        "id": "144"
                    },
                    "passport_number": "3463463",
                    "social_security_number": "73473567",
                    "country_of_residence":
                    {
                        "name": "UNITED KINGDOM",
                        "id": "126"
                    },
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": 5,
                        "day": 6,
                        "year": 1988
                    },
                    "name_day":
                    {
                        "month": 5,
                        "day": 3
                    },
                    "id_number": "87878000",
                    "id_issued_by_country":
                    {
                        "name": "AZERBAIJAN",
                        "id": "142"
                    },
                    "industry": null
                }
            },
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "udf_string_9": null,
            "id": "B3409C01A4E13BF3DA8BF809678138FA",
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "expected_completion_date": "2014-07-29T00:00:00",
            "udf_date_4": null,
            "start_date": "2014-07-15T00:00:00",
            "udf_date_5": null,
            "udf_date_6": null,
            "udf_date_7": null,
            "time_to_completion":
            {
                "time_period_value": null,
                "time_period_uot": "WEEKS"
            },
            "time_overdue":
            {
                "time_period_value": null,
                "time_period_uot": null
            },
            "udf_date_8": null,
            "udf_date_9": null,
            "owned_by_group":
            {
                "community_name": "Main Community",
                "name": "Main Group",
                "id": "84F33366CB592BAAE7E2044D93611C6A",
                "description": "Main Group",
                "alternative_code": "das"
            },
            "log_information":
            {
                "updated_date": "2014-07-15T11:59:25",
                "created_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-07-15T09:38:51",
                "updated_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                }
            },
            "status":
            {
                "name": "Closed",
                "id": "2",
                "description": "Completed",
                "alternative_code": "CL"
            },
            "actual_completed_date": "2014-07-15T11:45:50",
            "life_cycle_state": "COMPLETED",
            "estimate_completion_time":
            {
                "time_period_value": 2,
                "time_period_uot": "WEEKS"
            },
            "type":
            {
                "name": "ActivityType1",
                "id": "0EAC36C3C860ED01C2A18E82661570F0",
                "description": null,
                "alternative_code": "asdasaSA"
            },
            "description": null,
            "category":
            {
                "name": "name 1",
                "id": "E037ECCED154220494E1466B9C792A99",
                "description": "desc 1",
                "code": "code 1"
            },
            "services_to_be_provided_set":
            [
                {
                    "service":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "ONETIME",
                            "used_for_provisioning": false,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "One-off fee",
                            "id": "EBD643D9FE1401217E7D3328F85FBB20",
                            "description": "One-off fee",
                            "alternative_code": "OOF"
                        },
                        "id": "7705DF97FBB8A7639A97BBD918A09D85",
                        "description": "FEE10",
                        "code": "FEE10",
                        "alternative_code": null
                    },
                    "id": "06DCFE8041C971C793C58607C36CA4C7",
                    "time_spend":
                    {
                        "time_period_value": 5,
                        "time_period_uot": "HOURS"
                    }
                },
                {
                    "service":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "ONETIME",
                            "used_for_provisioning": false,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "One-off fee",
                            "id": "EBD643D9FE1401217E7D3328F85FBB20",
                            "description": "One-off fee",
                            "alternative_code": "OOF"
                        },
                        "id": "3E0AE236D75C3C5EFCCF56A4BE9322BB",
                        "description": "FEE2",
                        "code": "FEE2",
                        "alternative_code": "FEE2"
                    },
                    "id": "C231537428878CB0E6AF93C8A94F01C1",
                    "time_spend":
                    {
                        "time_period_value": 100,
                        "time_period_uot": "HOURS"
                    }
                },
                {
                    "service":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "ONETIME",
                            "used_for_provisioning": false,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "One-off fee",
                            "id": "EBD643D9FE1401217E7D3328F85FBB20",
                            "description": "One-off fee",
                            "alternative_code": "OOF"
                        },
                        "id": "A000839A81878B6B9B8FC475F1F44199",
                        "description": "FEE1",
                        "code": "FEE1",
                        "alternative_code": "FEE1"
                    },
                    "id": "CE8BFB8843FFF83F61D78BCF7F60351E",
                    "time_spend":
                    {
                        "time_period_value": 2,
                        "time_period_uot": "DAYS"
                    }
                }
            ]
        },
        {
            "notes": null,
            "udf_string_10": null,
            "udf_string_11": null,
            "udf_string_12": null,
            "udf_date_10": null,
            "udf_string_13": null,
            "number": "5",
            "udf_string_14": null,
            "performed_for":
            {
                "service_request": null,
                "subscription": null,
                "job": null
            },
            "udf_string_15": null,
            "assign_to":
            {
                "unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "test555",
                    "id": "94016E390E900729C45ECD564E309181",
                    "description": null,
                    "alternative_code": "4444"
                },
                "user": null
            },
            "udf_string_1": null,
            "udf_string_16": null,
            "udf_string_2": null,
            "privacy_level": null,
            "contact_information":
            {
                "last_name": "Xenofontos ",
                "life_cycle_state": "FINANCIAL",
                "middle_name": "Iatrou",
                "company_profile": null,
                "title": "Mr",
                "type": "PERSON",
                "first_name": "Kyriacos",
                "name": "Kyriacos Xenofontos",
                "id": "31260911295E70BB660EBEB0C4F941AC",
                "company_name": null,
                "demographics":
                {
                    "gender": "MALE",
                    "passport_issued_by_country":
                    {
                        "name": "BAHRAIN",
                        "id": "144"
                    },
                    "passport_number": "3463463",
                    "social_security_number": "73473567",
                    "country_of_residence":
                    {
                        "name": "UNITED KINGDOM",
                        "id": "126"
                    },
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": 5,
                        "day": 6,
                        "year": 1988
                    },
                    "name_day":
                    {
                        "month": 5,
                        "day": 3
                    },
                    "id_number": "87878000",
                    "id_issued_by_country":
                    {
                        "name": "AZERBAIJAN",
                        "id": "142"
                    },
                    "industry": null
                }
            },
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "udf_string_9": null,
            "id": "11C8884D199519F1EE6AD42F44C713E4",
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "expected_completion_date": "2014-07-15T15:16:00",
            "udf_date_4": null,
            "start_date": "2014-07-15T15:13:57",
            "udf_date_5": null,
            "udf_date_6": null,
            "udf_date_7": null,
            "time_to_completion":
            {
                "time_period_value": null,
                "time_period_uot": "SECONDS"
            },
            "time_overdue":
            {
                "time_period_value": null,
                "time_period_uot": null
            },
            "udf_date_8": null,
            "udf_date_9": null,
            "owned_by_group":
            {
                "community_name": "Main Community",
                "name": "Main Group",
                "id": "84F33366CB592BAAE7E2044D93611C6A",
                "description": "Main Group",
                "alternative_code": "das"
            },
            "log_information":
            {
                "updated_date": "2014-07-15T15:22:04",
                "created_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-07-15T15:13:57",
                "updated_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                }
            },
            "status":
            {
                "name": "Closed",
                "id": "2",
                "description": "Completed",
                "alternative_code": "CL"
            },
            "actual_completed_date": "2014-07-15T15:22:00",
            "life_cycle_state": "COMPLETED",
            "estimate_completion_time":
            {
                "time_period_value": 123,
                "time_period_uot": "SECONDS"
            },
            "type":
            {
                "name": "Activity Type 1",
                "id": "AF4D27993257C5242E7CAD6F35566222",
                "description": "testyoiniokjuiiju",
                "alternative_code": "ACT11"
            },
            "description": null,
            "category":
            {
                "name": "name 2",
                "id": "73EE48F5950613300C48B806FCCCFB2E",
                "description": "desc 2",
                "code": "code 2"
            },
            "services_to_be_provided_set":
            [
            ]
        },......
}

GET activities/get_close_to_estimated_completion_time

This method returns information related with activities which are close to their estimated completion time. Multiple activities are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

period

(mandatory)

...

(mandatory)

...

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

...

contact_information_identifier

(optional)

...

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

...

type_identifier

(optional)

...

The identifier of the type of the retrieved activity

...

category_identifier

(optional)

...

The identifier of the category of the retrieved activity

...

number_of_results

(optional)

...

The number of results that can be retrieved through each call

Tip
Available from CRM.COM R13.0.0

...

offset

(optional)

...

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.

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "notes": null,
            "udf_string_10": null,
            "udf_string_11": null,
            "udf_string_12": null,
            "udf_date_10": null,
            "udf_string_13": null,
            "number": "A012168",
            "udf_string_14": null,
            "performed_for":
            {
                "service_request": null,
                "subscription": null,
                "job": null
            },
            "udf_string_15": null,
            "assign_to":
            {
                "unit":
                {
                    "community_name": null,
                    "group_name": "Developers Group",
                    "name": "Developers Unit",
                    "id": "C4370788B2630BC8A99E8C7397406C09",
                    "description": null,
                    "alternative_code": null
                },
                "user":
                {
                    "person_name": "hannibal",
                    "username": "hannibal",
                    "id": "2C008EB82E0DBC7722E93F207E2091CE",
                    "email": null
                }
            },
            "udf_string_1": null,
            "udf_string_16": null,
            "udf_string_2": null,
            "privacy_level": null,
            "contact_information":
            {
                "last_name": "Ventura",
                "life_cycle_state": "MARKETING",
                "middle_name": null,
                "company_profile": null,
                "title": "Mr.",
                "type": "PERSON",
                "first_name": "Ace",
                "name": "Ace Ventura",
                "id": "2F8AD333DBB899A10DCC10FB505058BB",
                "company_name": null,
                "demographics":
                {
                    "gender": null,
                    "passport_issued_by_country":
                    {
                        "name": "ARUBA",
                        "id": "139"
                    },
                    "passport_number": "567547854784",
                    "social_security_number": "67367546745",
                    "country_of_residence":
                    {
                        "name": "ARGENTINA",
                        "id": "137"
                    },
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": 5,
                        "day": 4,
                        "year": 1973
                    },
                    "name_day":
                    {
                        "month": 8,
                        "day": 7
                    },
                    "id_number": "5463463463",
                    "id_issued_by_country":
                    {
                        "name": "ARUBA",
                        "id": "139"
                    },
                    "industry": null
                }
            },
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "udf_string_9": null,
            "id": "4459CEFA62E069BBF7B6589B32C9AB3F",
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "expected_completion_date": "2015-01-30T16:29:01",
            "udf_date_4": null,
            "start_date": "2014-10-22T16:29:01",
            "udf_date_5": null,
            "udf_date_6": null,
            "udf_date_7": null,
            "time_to_completion":
            {
                "time_period_value": 1,
                "time_period_uot": "DAYS"
            },
            "time_overdue":
            {
                "time_period_value": null,
                "time_period_uot": null
            },
            "udf_date_8": null,
            "udf_date_9": null,
            "owned_by_group":
            {
                "community_name": null,
                "name": "Developers Group",
                "id": "8BD400EC50DB9678F9C3573401399924",
                "description": "test2",
                "alternative_code": null
            },
            "log_information":
            {
                "updated_date": "2014-10-22T16:35:59",
                "created_date": "2013-08-26T11:24:34",
                "updated_by_unit":
                {
                    "group_name": null,
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "status":
            {
                "name": "To Be approved",
                "id": "C93B05CCFC11CFFA62BA2A04F87603C8",
                "description": null,
                "alternative_code": "TBA"
            },
            "actual_completed_date": null,
            "life_cycle_state": "PENDING",
            "estimate_completion_time":
            {
                "time_period_value": 100,
                "time_period_uot": "DAYS"
            },
            "type":
            {
                "name": "Dealer Unknown",
                "id": "06DD24BFBADC5E4B801CC30566E833DE",
                "description": null,
                "alternative_code": "Dealer Unknown"
            },
            "description": null,
            "category": null,
            "services_to_be_provided_set":
            [
                {
                    "service":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "ONETIME",
                            "used_for_provisioning": false,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "One-off fee",
                            "id": "EBD643D9FE1401217E7D3328F85FBB20",
                            "description": "One-off fee",
                            "alternative_code": "OOF"
                        },
                        "id": "786E9F5C40EA7DC8F80DCB6121530778",
                        "description": "Reminder fee",
                        "code": "Reminder fee",
                        "alternative_code": null
                    },
                    "id": "53FB9C62B4F024ABDB7706BC613C589A",
                    "time_spend":
                    {
                        "time_period_value": 2,
                        "time_period_uot": "HOURS"
                    }
                },
                {
                    "service":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "ONETIME",
                            "used_for_provisioning": true,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "One Time Services",
                            "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                            "description": "A type which is used for one time services",
                            "alternative_code": "OTS"
                        },
                        "id": "23B0335123C123F75B890C0380625BDE",
                        "description": "Package Change Service",
                        "code": "Package Change Service",
                        "alternative_code": null
                    },
                    "id": "180B60ACD12B10B24506BCEBA5FF4B2A",
                    "time_spend":
                    {
                        "time_period_value": 5,
                        "time_period_uot": "DAYS"
                    }
                },
                {
                    "service":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "ONETIME",
                            "used_for_provisioning": false,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "One-off fee",
                            "id": "EBD643D9FE1401217E7D3328F85FBB20",
                            "description": "One-off fee",
                            "alternative_code": "OOF"
                        },
                        "id": "543CC9EB5C97A9152B58DC447827CD1A",
                        "description": "Penalty for damaged Hardware",
                        "code": "Penalty for damaged Hardware",
                        "alternative_code": null
                    },
                    "id": "B5F90E8C6BFD2F78CFDA4916E5C08A34",
                    "time_spend":
                    {
                        "time_period_value": 1,
                        "time_period_uot": "DAYS"
                    }
                },
                {
                    "service":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "ONETIME",
                            "used_for_provisioning": true,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "One Time Services",
                            "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                            "description": "A type which is used for one time services",
                            "alternative_code": "OTS"
                        },
                        "id": "8BE02F31611850040232AF4225D7B6A0",
                        "description": "Decoder Installation Service",
                        "code": "Decoder Installation Service",
                        "alternative_code": null
                    },
                    "id": "7E9C7987793D21B4B7D70D9603BB9229",
                    "time_spend":
                    {
                        "time_period_value": 5,
                        "time_period_uot": "DAYS"
                    }
                }
            ]
        }
    ]
}

GET activities/get_overdue

This method returns information related with the activities which are overdue. 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)

...

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

...

type_identifier

(optional)

...

The identifier of the type of the retrieved activity

...

category_identifier

(optional)

...

The identifier of the category of the retrieved activity

...

number_of_results

(optional)

...

The number of results that can be retrieved through each call

Tip
Available from CRM.COM R13.0.0

...

offset

(optional)

...

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.

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       [
           {
               "udf_string_10": null,
               "udf_float_1": null,
               "udf_string_11": null,
               "udf_float_2": null,
               "udf_string_12": null,
               "udf_float_3": null,
               "udf_string_13": null,
               "udf_float_4": null,
               "udf_string_14": null,
               "udf_float_5": null,
               "udf_string_15": null,
               "udf_string_16": null,
               "udf_float_6": null,
               "udf_string_1": null,
               "udf_string_2": null,
               "udf_float_7": null,
               "privacy_level": null,
               "contact_information":
               {
                   "last_name": "Clark",
                   "life_cycle_state": "FINANCIAL",
                   "middle_name": "S.",
                   "company_profile": null,
                   "title": "Mrs",
                   "type": "PERSON",
                   "first_name": "Kathy",
                   "name": "Kathy Clark",
                   "id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": "FEMALE",
                       "passport_issued_by_country": null,
                       "passport_number": "4564455",
                       "social_security_number": "88996633",
                       "country_of_residence":
                       {
                           "name": "UNITED STATES",
                           "id": "127"
                       },
                       "industry_sector": null,
                       "date_of_birth":
                       {
                           "month": 1,
                           "day": 1,
                           "year": 1980
                       },
                       "name_day":
                       {
                           "month": 1,
                           "day": 1
                       },
                       "id_number": "87878000",
                       "id_issued_by_country": null,
                       "industry": null
                   }
               },
               "udf_string_3": null,
               "udf_float_8": null,
               "udf_string_4": null,
               "udf_float_9": null,
               "udf_string_5": null,
               "udf_string_6": null,
               "udf_string_7": null,
               "udf_string_8": null,
               "udf_string_9": null,
               "id": "A5108C3667ECC469BFC51BD485777C32",
               "expected_completion_date": "2014-10-22T19:38:46",
               "time_to_completion":
               {
                   "time_period_value": null,
                   "time_period_uot": "HOURS"
               },
               "time_overdue":
               {
                   "time_period_value": 6.64516129032258,
                   "time_period_uot": "MONTHS"
               },
               "log_information":
               {
                   "updated_date": "2014-10-22T14:39:09",
                   "created_by_unit":
                   {
                       "community_name": "Internal Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_date": "2014-10-22T14:38:46",
                   "updated_by_unit":
                   {
                       "community_name": "Internal Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   },
                   "updated_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   }
               },
               "life_cycle_state": "PENDING",
               "estimate_completion_time":
               {
                   "time_period_value": 5,
                   "time_period_uot": "HOURS"
               },
               "type":
               {
                   "name": "Maintenance visits",
                   "id": "6D0C79835F7B0059D3BD1A51F2A03F41",
                   "description": null,
                   "alternative_code": "MV"
               },
               "services_to_be_provided_set":
               [
                   {
                       "service":
                       {
                           "product_type":
                           {
                               "physical_good_type": null,
                               "service_type": "ONETIME",
                               "used_for_provisioning": false,
                               "composition_method": "FLAT",
                               "classification": "SERVICES",
                               "name": "One Time Services - Flat",
                               "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                               "description": "A type which is used for one time services",
                               "alternative_code": "OTS-F"
                           },
                           "id": "8B58C14194D51E560F0E49B0292EA56F",
                           "description": null,
                           "code": "Maintenance Fee",
                           "alternative_code": "MC"
                       },
                       "resource_requests_set":
                       [
                       ],
                       "id": "C5EC087D0B66CE9A03E120CE72B3165F",
                       "time_spend":
                       {
                           "time_period_value": null,
                           "time_period_uot": null
                       }
                   }
               ],
               "notes": null,
               "udf_date_10": null,
               "number": "29",
               "performed_for":
               {
                   "service_request": null,
                   "lead": null,
                   "subscription": null,
                   "job": null
               },
               "assign_to":
               {
                   "unit":
                   {
                       "name": "Operators SB1",
                       "id": "4677F5B24AC600DF7476F003DA185FAE",
                       "description": null,
                       "alternative_code": "OSB1"
                   },
                   "user": null
               },
               "udf_date_1": null,
               "udf_date_2": null,
               "udf_float_10": null,
               "udf_date_3": null,
               "udf_date_4": null,
               "start_date": "2014-10-22T14:38:46",
               "udf_date_5": null,
               "udf_date_6": null,
               "udf_date_7": null,
               "udf_date_8": null,
               "udf_date_9": null,
               "owned_by_group":
               {
                   "community_name": "Internal Community",
                   "name": "Main Group",
                   "id": "84F33366CB592BAAE7E2044D93611C6A",
                   "description": "Main Group",
                   "alternative_code": "MG1"
               },
               "status":
               {
                   "name": "Assigned",
                   "id": "63ADCD4D9DE09258EE5FA24B8ACF40BF",
                   "description": null,
                   "alternative_code": "AS"
               },
               "actual_completed_date": null,
               "description": "fdgdfg",
               "category":
               {
                   "name": "Maintenance",
                   "id": "68CD2AC7ACC4913C9695DBE776128236",
                   "description": "Maintenance",
                   "code": "MA"
               }
           }
       ]
    }

GET activities/get_pending

This method returns information related with activities which are in pending life cycle state

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

contact_information_identifier

(optional)

...

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

...

type_identifier

(optional)

...

The identifier of the type of the retrieved activity

...

category_identifier

(optional)

...

The identifier of the category of the retrieved activity

...

number_of_results

(optional)

...

The number of results that can be retrieved through each call

Tip
Available from CRM.COM R13.0.0

...

offset

(optional)

...

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.

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       [
           {
               "udf_string_10": null,
               "udf_float_1": null,
               "udf_string_11": null,
               "udf_float_2": null,
               "udf_string_12": null,
               "udf_float_3": null,
               "udf_string_13": null,
               "udf_float_4": null,
               "udf_string_14": null,
               "udf_float_5": null,
               "udf_string_15": null,
               "udf_string_16": null,
               "udf_float_6": null,
               "udf_string_1": null,
               "udf_string_2": null,
               "udf_float_7": null,
               "privacy_level": null,
               "contact_information":
               {
                   "last_name": "Clark",
                   "life_cycle_state": "FINANCIAL",
                   "middle_name": "S.",
                   "company_profile": null,
                   "title": "Mrs",
                   "type": "PERSON",
                   "first_name": "Kathy",
                   "name": "Kathy Clark",
                   "id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": "FEMALE",
                       "passport_issued_by_country": null,
                       "passport_number": "4564455",
                       "social_security_number": "88996633",
                       "country_of_residence":
                       {
                           "name": "UNITED STATES",
                           "id": "127"
                       },
                       "industry_sector": null,
                       "date_of_birth":
                       {
                           "month": 1,
                           "day": 1,
                           "year": 1980
                       },
                       "name_day":
                       {
                           "month": 1,
                           "day": 1
                       },
                       "id_number": "87878000",
                       "id_issued_by_country": null,
                       "industry": null
                   }
               },
               "udf_string_3": null,
               "udf_float_8": null,
               "udf_string_4": null,
               "udf_float_9": null,
               "udf_string_5": null,
               "udf_string_6": null,
               "udf_string_7": null,
               "udf_string_8": null,
               "udf_string_9": null,
               "id": "A5108C3667ECC469BFC51BD485777C32",
               "expected_completion_date": "2014-10-22T19:38:46",
               "time_to_completion":
               {
                   "time_period_value": null,
                   "time_period_uot": "HOURS"
               },
               "time_overdue":
               {
                   "time_period_value": 6.64516129032258,
                   "time_period_uot": "MONTHS"
               },
               "log_information":
               {
                   "updated_date": "2014-10-22T14:39:09",
                   "created_by_unit":
                   {
                       "community_name": "Internal Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_date": "2014-10-22T14:38:46",
                   "updated_by_unit":
                   {
                       "community_name": "Internal Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   },
                   "updated_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   }
               },
               "life_cycle_state": "PENDING",
               "estimate_completion_time":
               {
                   "time_period_value": 5,
                   "time_period_uot": "HOURS"
               },
               "type":
               {
                   "name": "Maintenance visits",
                   "id": "6D0C79835F7B0059D3BD1A51F2A03F41",
                   "description": null,
                   "alternative_code": "MV"
               },
               "services_to_be_provided_set":
               [
                   {
                       "service":
                       {
                           "product_type":
                           {
                               "physical_good_type": null,
                               "service_type": "ONETIME",
                               "used_for_provisioning": false,
                               "composition_method": "FLAT",
                               "classification": "SERVICES",
                               "name": "One Time Services - Flat",
                               "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                               "description": "A type which is used for one time services",
                               "alternative_code": "OTS-F"
                           },
                           "id": "8B58C14194D51E560F0E49B0292EA56F",
                           "description": null,
                           "code": "Maintenance Fee",
                           "alternative_code": "MC"
                       },
                       "resource_requests_set":
                       [
                       ],
                       "id": "C5EC087D0B66CE9A03E120CE72B3165F",
                       "time_spend":
                       {
                           "time_period_value": null,
                           "time_period_uot": null
                       }
                   }
               ],
               "notes": null,
               "udf_date_10": null,
               "number": "29",
               "performed_for":
               {
                   "service_request": null,
                   "lead": null,
                   "subscription": null,
                   "job": null
               },
               "assign_to":
               {
                   "unit":
                   {
                       "name": "Operators SB1",
                       "id": "4677F5B24AC600DF7476F003DA185FAE",
                       "description": null,
                       "alternative_code": "OSB1"
                   },
                   "user": null
               },
               "udf_date_1": null,
               "udf_date_2": null,
               "udf_float_10": null,
               "udf_date_3": null,
               "udf_date_4": null,
               "start_date": "2014-10-22T14:38:46",
               "udf_date_5": null,
               "udf_date_6": null,
               "udf_date_7": null,
               "udf_date_8": null,
               "udf_date_9": null,
               "owned_by_group":
               {
                   "community_name": "Internal Community",
                   "name": "Main Group",
                   "id": "84F33366CB592BAAE7E2044D93611C6A",
                   "description": "Main Group",
                   "alternative_code": "MG1"
               },
               "status":
               {
                   "name": "Assigned",
                   "id": "63ADCD4D9DE09258EE5FA24B8ACF40BF",
                   "description": null,
                   "alternative_code": "AS"
               },
               "actual_completed_date": null,
               "description": "fdgdfg",
               "category":
               {
                   "name": "Maintenance",
                   "id": "68CD2AC7ACC4913C9695DBE776128236",
                   "description": "Maintenance",
                   "code": "MA"
               }
           }
       ]
    }

GET activities/get_in_progress

This method returns information related with activities which are in the in progress life cycle state. 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)

...

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

...

type_identifier

(optional)

...

The identifier of the type of the retrieved activity

...

category_identifier

(optional)

...

The identifier of the category of the retrieved activity

...

number_of_results

(optional)

...

The number of results that can be retrieved through each call

Tip
Available from CRM.COM R13.0.0

...

offset

(optional)

...

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.

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 
    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       [
           {
               "udf_string_10": null,
               "udf_float_1": null,
               "udf_string_11": null,
               "udf_float_2": null,
               "udf_string_12": null,
               "udf_float_3": null,
               "udf_string_13": null,
               "udf_float_4": null,
               "udf_string_14": null,
               "udf_float_5": null,
               "udf_string_15": null,
               "udf_string_16": null,
               "udf_float_6": null,
               "udf_string_1": null,
               "udf_string_2": null,
               "udf_float_7": null,
               "privacy_level": null,
               "contact_information":
               {
                   "last_name": "Mercer",
                   "life_cycle_state": "FINANCIAL",
                   "middle_name": "111111111",
                   "company_profile": null,
                   "title": null,
                   "type": "PERSON",
                   "first_name": "Ben",
                   "name": "Ben Mercer",
                   "id": "475904FB959FE8D3DDAEB22FBFEC5FFB",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": null,
                       "passport_issued_by_country":
                       {
                           "name": "ANDORRA",
                           "id": "132"
                       },
                       "passport_number": null,
                       "social_security_number": null,
                       "country_of_residence":
                       {
                           "name": "UNITED STATES",
                           "id": "127"
                       },
                       "industry_sector": null,
                       "date_of_birth":
                       {
                           "month": null,
                           "day": null,
                           "year": null
                       },
                       "name_day":
                       {
                           "month": null,
                           "day": null
                       },
                       "id_number": "1212125",
                       "id_issued_by_country":
                       {
                           "name": "ALGERIA",
                           "id": "130"
                       },
                       "industry":
                       {
                           "name": "Marketing",
                           "id": "31BC2070C79EAE5455BFAD41599C5190",
                           "code": "MK"
                       }
                   }
               },
               "udf_string_3": null,
               "udf_float_8": null,
               "udf_string_4": null,
               "udf_float_9": null,
               "udf_string_5": null,
               "udf_string_6": null,
               "udf_string_7": null,
               "udf_string_8": null,
               "udf_string_9": null,
               "id": "D7CB4509E8DE43B2A3A3AB95CE1DBFD8",
               "expected_completion_date": "2015-03-20T23:33:14",
               "time_to_completion":
               {
                   "time_period_value": null,
                   "time_period_uot": "HOURS"
               },
               "time_overdue":
               {
                   "time_period_value": 1.7096774193548387,
                   "time_period_uot": "MONTHS"
               },
               "log_information":
               {
                   "updated_date": "2015-03-20T15:33:36",
                   "created_by_unit":
                   {
                       "community_name": "Internal Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_date": "2015-03-20T15:33:14",
                   "updated_by_unit":
                   {
                       "community_name": "Internal Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   },
                   "updated_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   }
               },
               "life_cycle_state": "IN_PROGRESS",
               "estimate_completion_time":
               {
                   "time_period_value": 8,
                   "time_period_uot": "HOURS"
               },
               "type":
               {
                   "name": "InstallationsX",
                   "id": "938B9B6411AAB03DC25B3F569A443C6D",
                   "description": "Test",
                   "alternative_code": "INX"
               },
               "services_to_be_provided_set":
               [
               ],
               "notes": null,
               "udf_date_10": null,
               "number": "ACT000050",
               "performed_for":
               {
                   "service_request": null,
                   "lead": null,
                   "subscription": null,
                   "job": null
               },
               "assign_to":
               {
                   "unit":
                   {
                       "name": "Operators SB1",
                       "id": "4677F5B24AC600DF7476F003DA185FAE",
                       "description": null,
                       "alternative_code": "OSB1"
                   },
                   "user": null
               },
               "udf_date_1": null,
               "udf_date_2": null,
               "udf_float_10": null,
               "udf_date_3": null,
               "udf_date_4": null,
               "start_date": "2015-03-20T15:33:14",
               "udf_date_5": null,
               "udf_date_6": null,
               "udf_date_7": null,
               "udf_date_8": null,
               "udf_date_9": null,
               "owned_by_group":
               {
                   "community_name": "Internal Community",
                   "name": "Main Group",
                   "id": "84F33366CB592BAAE7E2044D93611C6A",
                   "description": "Main Group",
                   "alternative_code": "MG1"
               },
               "status":
               {
                   "name": "In Progress",
                   "id": "F6420AC12C68BBC6C9B7600E0E1BA6DF",
                   "description": "In Progress Status",
                   "alternative_code": "IP"
               },
               "actual_completed_date": null,
               "description": null,
               "category": null
           },
           {
               "udf_string_10": null,
               "udf_float_1": null,
               "udf_string_11": null,
               "udf_float_2": null,
               "udf_string_12": null,
               "udf_float_3": null,
               "udf_string_13": null,
               "udf_float_4": null,
               "udf_string_14": null,
               "udf_float_5": null,
               "udf_string_15": null,
               "udf_string_16": null,
               "udf_float_6": null,
               "udf_string_1": null,
               "udf_string_2": null,
               "udf_float_7": null,
               "privacy_level": null,
               "contact_information":
               {
                   "last_name": "Mercer",
                   "life_cycle_state": "FINANCIAL",
                   "middle_name": "111111111",
                   "company_profile": null,
                   "title": null,
                   "type": "PERSON",
                   "first_name": "Ben",
                   "name": "Ben Mercer",
                   "id": "475904FB959FE8D3DDAEB22FBFEC5FFB",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": null,
                       "passport_issued_by_country":
                       {
                           "name": "ANDORRA",
                           "id": "132"
                       },
                       "passport_number": null,
                       "social_security_number": null,
                       "country_of_residence":
                       {
                           "name": "UNITED STATES",
                           "id": "127"
                       },
                       "industry_sector": null,
                       "date_of_birth":
                       {
                           "month": null,
                           "day": null,
                           "year": null
                       },
                       "name_day":
                       {
                           "month": null,
                           "day": null
                       },
                       "id_number": "1212125",
                       "id_issued_by_country":
                       {
                           "name": "ALGERIA",
                           "id": "130"
                       },
                       "industry":
                       {
                           "name": "Marketing",
                           "id": "31BC2070C79EAE5455BFAD41599C5190",
                           "code": "MK"
                       }
                   }
               },
               "udf_string_3": null,
               "udf_float_8": null,
               "udf_string_4": null,
               "udf_float_9": null,
               "udf_string_5": null,
               "udf_string_6": null,
               "udf_string_7": null,
               "udf_string_8": null,
               "udf_string_9": null,
               "id": "E2CDA0BE51954C729B690B1E03589F45",
               "expected_completion_date": "2015-05-13T12:13:09",
               "time_to_completion":
               {
                   "time_period_value": 2,
                   "time_period_uot": "WEEKS"
               },
               "time_overdue":
               {
                   "time_period_value": null,
                   "time_period_uot": null
               },
               "log_information":
               {
                   "updated_date": "2015-04-29T12:13:35",
                   "created_by_unit":
                   {
                       "community_name": "Internal Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_date": "2015-04-29T12:13:09",
                   "updated_by_unit":
                   {
                       "community_name": "Internal Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   },
                   "updated_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   }
               },
               "life_cycle_state": "IN_PROGRESS",
               "estimate_completion_time":
               {
                   "time_period_value": 2,
                   "time_period_uot": "WEEKS"
               },
               "type":
               {
                   "name": "Installation",
                   "id": "B163FF3F08B44CBEB00F1CCD875C54DE",
                   "description": null,
                   "alternative_code": "INS"
               },
               "services_to_be_provided_set":
               [
                   {
                       "service":
                       {
                           "product_type":
                           {
                               "physical_good_type": null,
                               "service_type": "ONETIME",
                               "used_for_provisioning": true,
                               "composition_method": "FIXEDBUNDLE",
                               "classification": "SERVICES",
                               "name": "One Time- Fixed B",
                               "id": "AD3C6C3E2D2D4C9DA7BDBC2908718AEB",
                               "description": "One time Fixed Bundle product",
                               "alternative_code": "OT-Fixed"
                           },
                           "id": "DFEA1EC8521F416AABB8D79305CEF600",
                           "description": null,
                           "code": "Delivery Service",
                           "alternative_code": "DS"
                       },
                       "resource_requests_set":
                       [
                       ],
                       "id": "AFD8B463704E420986F6B3537B89FA90",
                       "time_spend":
                       {
                           "time_period_value": 10,
                           "time_period_uot": "HOURS"
                       }
                   },
                   {
                       "service":
                       {
                           "product_type":
                           {
                               "physical_good_type": null,
                               "service_type": "ONETIME",
                               "used_for_provisioning": false,
                               "composition_method": "FIXEDBUNDLE",
                               "classification": "SERVICES",
                               "name": "One Time Services - Fixed",
                               "id": "391D5E5E5F4F70FCA75C4D01ECAD0B6C",
                               "description": "One Time Services - Fixed",
                               "alternative_code": "OTS-F_1"
                           },
                           "id": "690A6B1932D34421A1EE254425F2CB12",
                           "description": null,
                           "code": "Installation Service",
                           "alternative_code": "IS"
                       },
                       "resource_requests_set":
                       [
                       ],
                       "id": "C78AAE0CEA4C43EEA7DD77D500C2BC78",
                       "time_spend":
                       {
                           "time_period_value": 20,
                           "time_period_uot": "HOURS"
                       }
                   }
               ],
               "notes": null,
               "udf_date_10": null,
               "number": "ACT000104",
               "performed_for":
               {
                   "service_request": null,
                   "lead": null,
                   "subscription": null,
                   "job": null
               },
               "assign_to":
               {
                   "unit":
                   {
                       "name": "Operators SB1",
                       "id": "4677F5B24AC600DF7476F003DA185FAE",
                       "description": null,
                       "alternative_code": "OSB1"
                   },
                   "user": null
               },
               "udf_date_1": null,
               "udf_date_2": null,
               "udf_float_10": null,
               "udf_date_3": null,
               "udf_date_4": null,
               "start_date": "2015-04-29T12:13:09",
               "udf_date_5": null,
               "udf_date_6": null,
               "udf_date_7": null,
               "udf_date_8": null,
               "udf_date_9": null,
               "owned_by_group":
               {
                   "community_name": "Internal Community",
                   "name": "Main Group",
                   "id": "84F33366CB592BAAE7E2044D93611C6A",
                   "description": "Main Group",
                   "alternative_code": "MG1"
               },
               "status":
               {
                   "name": "In Progress",
                   "id": "F6420AC12C68BBC6C9B7600E0E1BA6DF",
                   "description": "In Progress Status",
                   "alternative_code": "IP"
               },
               "actual_completed_date": null,
               "description": null,
               "category": null
           }
       ]
    }

GET activities/get_completed

This method returns information related with completed 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)

...

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

...

type_identifier

(optional)

...

The identifier of the type of the retrieved activity

...

category_identifier

(optional)

...

The identifier of the category of the retrieved activity

...

number_of_results

(optional)

...

The number of results that can be retrieved through each call

Tip
Available from CRM.COM R13.0.0

...

offset

(optional)

...

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.

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
   "status":
   {
       "message": null,
       "description": null,
       "code": "OK"
   },
   "data":
   [
       {
           "udf_string_10": null,
           "udf_float_1": null,
           "udf_string_11": null,
           "udf_float_2": null,
           "udf_string_12": null,
           "udf_float_3": null,
           "udf_string_13": null,
           "udf_float_4": null,
           "udf_string_14": null,
           "udf_float_5": null,
           "udf_string_15": null,
           "udf_string_16": null,
           "udf_float_6": null,
           "udf_string_1": null,
           "udf_string_2": null,
           "udf_float_7": null,
           "privacy_level": null,
           "contact_information":
           {
               "last_name": "Clark",
               "life_cycle_state": "FINANCIAL",
               "middle_name": "S.",
               "company_profile": null,
               "title": "Mrs",
               "type": "PERSON",
               "first_name": "Kathy",
               "name": "Kathy Clark",
               "id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
               "company_name": null,
               "demographics":
               {
                   "gender": "FEMALE",
                   "passport_issued_by_country": null,
                   "passport_number": "4564455",
                   "social_security_number": "88996633",
                   "country_of_residence":
                   {
                       "name": "UNITED STATES",
                       "id": "127"
                   },
                   "industry_sector": null,
                   "date_of_birth":
                   {
                       "month": 1,
                       "day": 1,
                       "year": 1980
                   },
                   "name_day":
                   {
                       "month": 1,
                       "day": 1
                   },
                   "id_number": "87878000",
                   "id_issued_by_country": null,
                   "industry": null
               }
           },
           "udf_string_3": null,
           "udf_float_8": null,
           "udf_string_4": null,
           "udf_float_9": null,
           "udf_string_5": null,
           "udf_string_6": null,
           "udf_string_7": null,
           "udf_string_8": null,
           "udf_string_9": null,
           "id": "13596AD2CE14EB5B6E83AB032B70822A",
           "expected_completion_date": "2014-08-08T18:33:40",
           "time_to_completion":
           {
               "time_period_value": null,
               "time_period_uot": "HOURS"
           },
           "time_overdue":
           {
               "time_period_value": null,
               "time_period_uot": null
           },
           "log_information":
           {
               "updated_date": "2014-08-08T15:35:46",
               "created_by_unit":
               {
                   "community_name": "Internal Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-08-08T15:33:40",
               "updated_by_unit":
               {
                   "community_name": "Internal Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "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": "emichailidou",
                   "username": "emichailidou",
                   "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
                   "email": "e_michailidou@crm.com"
               }
           },
           "life_cycle_state": "COMPLETED",
           "estimate_completion_time":
           {
               "time_period_value": 3,
               "time_period_uot": "HOURS"
           },
           "type":
           {
               "name": "InstallationsX",
               "id": "938B9B6411AAB03DC25B3F569A443C6D",
               "description": "Test",
               "alternative_code": "INX"
           },
           "services_to_be_provided_set":
           [
               {
                   "service":
                   {
                       "product_type":
                       {
                           "physical_good_type": null,
                           "service_type": "ONETIME",
                           "used_for_provisioning": false,
                           "composition_method": "FLAT",
                           "classification": "SERVICES",
                           "name": "One Time Services - Flat",
                           "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                           "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": "F5DD7DFDDBF4CD257D74142FCB20F198",
                   "time_spend":
                   {
                       "time_period_value": 3,
                       "time_period_uot": "HOURS"
                   }
               },
               {
                   "service":
                   {
                       "product_type":
                       {
                           "physical_good_type": null,
                           "service_type": "ONETIME",
                           "used_for_provisioning": false,
                           "composition_method": "FLAT",
                           "classification": "SERVICES",
                           "name": "One Time Services - Flat",
                           "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                           "description": "A type which is used for one time services",
                           "alternative_code": "OTS-F"
                       },
                       "id": "2E1C3761B6701C1DC4652D5E1D826AD6",
                       "description": null,
                       "code": "Support",
                       "alternative_code": "Support"
                   },
                   "resource_requests_set":
                   [
                   ],
                   "id": "C66593B5C2F9F0B48DB1B474031793C5",
                   "time_spend":
                   {
                       "time_period_value": 1,
                       "time_period_uot": "HOURS"
                   }
               }
           ],
           "notes": null,
           "udf_date_10": null,
           "number": "6",
           "performed_for":
           {
               "service_request": null,
               "lead": null,
               "subscription": null,
               "job":
               {
                   "accounts_receivable":
                   {
                       "account_owner":
                       {
                           "last_name": "Clark",
                           "life_cycle_state": "FINANCIAL",
                           "middle_name": "S.",
                           "company_profile": null,
                           "title": "Mrs",
                           "type": "PERSON",
                           "first_name": "Kathy",
                           "name": "Kathy Clark",
                           "id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
                           "company_name": null,
                           "demographics":
                           {
                               "gender": "FEMALE",
                               "passport_issued_by_country": null,
                               "passport_number": "4564455",
                               "social_security_number": "88996633",
                               "country_of_residence":
                               {
                                   "name": "UNITED STATES",
                                   "id": "127"
                               },
                               "industry_sector": null,
                               "date_of_birth":
                               {
                                   "month": 1,
                                   "day": 1,
                                   "year": 1980
                               },
                               "name_day":
                               {
                                   "month": 1,
                                   "day": 1
                               },
                               "id_number": "87878000",
                               "id_issued_by_country": null,
                               "industry": null
                           }
                       },
                       "life_cycle_state": "ACTIVE",
                       "number": "191",
                       "name": "Kat's Main TV Account",
                       "id": "D64410DDAC580029C9664EAB74ACAC9C"
                   },
                   "life_cycle_state": "COMPLETED",
                   "number": "5",
                   "id": "FB4C8B22E5829C78EC812921D5C7C426",
                   "description": null
               }
           },
           "assign_to":
           {
               "unit":
               {
                   "name": "Vehicle Operators SB2",
                   "id": "6F5406E9B7ED04E9A37320C0BF1CF858",
                   "description": null,
                   "alternative_code": "VOSB2"
               },
               "user": null
           },
           "udf_date_1": null,
           "udf_date_2": null,
           "udf_float_10": null,
           "udf_date_3": null,
           "udf_date_4": null,
           "start_date": "2014-08-08T15:33:40",
           "udf_date_5": null,
           "udf_date_6": null,
           "udf_date_7": null,
           "udf_date_8": null,
           "udf_date_9": null,
           "owned_by_group":
           {
               "community_name": "Internal Community",
               "name": "Main Group",
               "id": "84F33366CB592BAAE7E2044D93611C6A",
               "description": "Main Group",
               "alternative_code": "MG1"
           },
           "status":
           {
               "name": "Closed",
               "id": "2",
               "description": "Closed Status",
               "alternative_code": "CL"
           },
           "actual_completed_date": "2014-08-08T15:35:45",
           "description": null,
           "category": null
       },
       {
           "udf_string_10": null,
           "udf_float_1": null,
           "udf_string_11": null,
           "udf_float_2": null,
           "udf_string_12": null,
           "udf_float_3": null,
           "udf_string_13": null,
           "udf_float_4": null,
           "udf_string_14": null,
           "udf_float_5": null,
           "udf_string_15": null,
           "udf_string_16": null,
           "udf_float_6": null,
           "udf_string_1": null,
           "udf_string_2": null,
           "udf_float_7": null,
           "privacy_level": null,
           "contact_information":
           {
               "last_name": "Clark",
               "life_cycle_state": "FINANCIAL",
               "middle_name": "S.",
               "company_profile": null,
               "title": "Mrs",
               "type": "PERSON",
               "first_name": "Kathy",
               "name": "Kathy Clark",
               "id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
               "company_name": null,
               "demographics":
               {
                   "gender": "FEMALE",
                   "passport_issued_by_country": null,
                   "passport_number": "4564455",
                   "social_security_number": "88996633",
                   "country_of_residence":
                   {
                       "name": "UNITED STATES",
                       "id": "127"
                   },
                   "industry_sector": null,
                   "date_of_birth":
                   {
                       "month": 1,
                       "day": 1,
                       "year": 1980
                   },
                   "name_day":
                   {
                       "month": 1,
                       "day": 1
                   },
                   "id_number": "87878000",
                   "id_issued_by_country": null,
                   "industry": null
               }
           },
           "udf_string_3": null,
           "udf_float_8": null,
           "udf_string_4": null,
           "udf_float_9": null,
           "udf_string_5": null,
           "udf_string_6": null,
           "udf_string_7": null,
           "udf_string_8": null,
           "udf_string_9": null,
           "id": "74730C487E0DD9F1477DE8A7CF519416",
           "expected_completion_date": "2014-08-07T03:00:00",
           "time_to_completion":
           {
               "time_period_value": null,
               "time_period_uot": "HOURS"
           },
           "time_overdue":
           {
               "time_period_value": null,
               "time_period_uot": null
           },
           "log_information":
           {
               "updated_date": "2014-08-08T15:36:17",
               "created_by_unit":
               {
                   "community_name": "Internal Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-08-08T15:35:49",
               "updated_by_unit":
               {
                   "community_name": "Internal Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "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": "emichailidou",
                   "username": "emichailidou",
                   "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
                   "email": "e_michailidou@crm.com"
               }
           },
           "life_cycle_state": "COMPLETED",
           "estimate_completion_time":
           {
               "time_period_value": 3,
               "time_period_uot": "HOURS"
           },
           "type":
           {
               "name": "InstallationsX",
               "id": "938B9B6411AAB03DC25B3F569A443C6D",
               "description": "Test",
               "alternative_code": "INX"
           },
           "services_to_be_provided_set":
           [
               {
                   "service":
                   {
                       "product_type":
                       {
                           "physical_good_type": null,
                           "service_type": "ONETIME",
                           "used_for_provisioning": false,
                           "composition_method": "FLAT",
                           "classification": "SERVICES",
                           "name": "One Time Services - Flat",
                           "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                           "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": "F04A371468A4F82C3481718A7E6AAB49",
                   "time_spend":
                   {
                       "time_period_value": 3,
                       "time_period_uot": "HOURS"
                   }
               }
           ],
           "notes": null,
           "udf_date_10": null,
           "number": "7",
           "performed_for":
           {
               "service_request": null,
               "lead": null,
               "subscription": null,
               "job":
               {
                   "accounts_receivable":
                   {
                       "account_owner":
                       {
                           "last_name": "Clark",
                           "life_cycle_state": "FINANCIAL",
                           "middle_name": "S.",
                           "company_profile": null,
                           "title": "Mrs",
                           "type": "PERSON",
                           "first_name": "Kathy",
                           "name": "Kathy Clark",
                           "id": "460BB0DB7A4EB61D9D6E3DFEE8566C08",
                           "company_name": null,
                           "demographics":
                           {
                               "gender": "FEMALE",
                               "passport_issued_by_country": null,
                               "passport_number": "4564455",
                               "social_security_number": "88996633",
                               "country_of_residence":
                               {
                                   "name": "UNITED STATES",
                                   "id": "127"
                               },
                               "industry_sector": null,
                               "date_of_birth":
                               {
                                   "month": 1,
                                   "day": 1,
                                   "year": 1980
                               },
                               "name_day":
                               {
                                   "month": 1,
                                   "day": 1
                               },
                               "id_number": "87878000",
                               "id_issued_by_country": null,
                               "industry": null
                           }
                       },
                       "life_cycle_state": "ACTIVE",
                       "number": "191",
                       "name": "Kat's Main TV Account",
                       "id": "D64410DDAC580029C9664EAB74ACAC9C"
                   },
                   "life_cycle_state": "COMPLETED",
                   "number": "5",
                   "id": "FB4C8B22E5829C78EC812921D5C7C426",
                   "description": null
               }
           },
           "assign_to":
           {
               "unit":
               {
                   "name": "Vehicle Operators SB2",
                   "id": "6F5406E9B7ED04E9A37320C0BF1CF858",
                   "description": null,
                   "alternative_code": "VOSB2"
               },
               "user": null
           },
           "udf_date_1": null,
           "udf_date_2": null,
           "udf_float_10": null,
           "udf_date_3": null,
           "udf_date_4": null,
           "start_date": "2014-08-07T00:00:00",
           "udf_date_5": null,
           "udf_date_6": null,
           "udf_date_7": null,
           "udf_date_8": null,
           "udf_date_9": null,
           "owned_by_group":
           {
               "community_name": "Internal Community",
               "name": "Main Group",
               "id": "84F33366CB592BAAE7E2044D93611C6A",
               "description": "Main Group",
               "alternative_code": "MG1"
           },
           "status":
           {
               "name": "Closed",
               "id": "2",
               "description": "Closed Status",
               "alternative_code": "CL"
           },
           "actual_completed_date": "2014-08-08T15:35:53",
           "description": null,
           "category": null
       },....
}

GET activities/get_cancelled

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)

...

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

...

type_identifier

(optional)

...

The identifier of the type of the retrieved activity

...

category_identifier

(optional)

...

The identifier of the category of the retrieved activity

...

number_of_results

(optional)

...

The number of results that can be retrieved through each call

Tip
Available from CRM.COM R13.0.0

...

offset

(optional)

...

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.

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

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

POST activities/create

This method creates an activity. Single activities can be created by each call. Only customer activities can be created through this method.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

type_identifier

(mandatory)

...

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

...

contact_information_identifier

(mandatory)

...

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

...

category_identifier

(optional)

...

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

...

status_identifier

(optional)

...

The status of the activity. If not specified then the default status will be set automatically.The allowed activity status identifiers are the following:

...

description

(optional)

...

notes

(optional)

...

start_date

(optional)

...

owned_by_group_identifier

(mandatory)

...

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

...

privacy_level_identifier

(optional)

...

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

...

udf_string_1

(optional)

...

User Defined Field of type String

...

udf_string_2

(optional)

...

User Defined Field of type String

...

udf_string_3

(optional)

...

User Defined Field of type String

...

udf_string_4

(optional)

...

User Defined Field of type String

...

udf_string_5

(optional)

...

User Defined Field of type String

...

udf_string_6

(optional)

...

User Defined Field of type String

...

udf_string_7

(optional)

...

User Defined Field of type String

...

udf_string_8

(optional)

...

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)

...

estimated_completion_time

(semi-optional)

...

assign_to

(optional)

...

The assignment information of the activity

...

performed_for

(optional)

...

The entities which are related with the activity

...

services_to_be_provided_set

(optional)

...

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

...

fields_set

(optional)

...

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

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "token" :   "010255E946388E6C1A033037DD21E040",
    "type_identifier" :   { "name" : "Activity Type 2" },
    "contact_information_identifier": { "id" : "31260911295E70BB660EBEB0C4F941AC" },
    "status_identifier" :   { "name" : "To Be approved"},
    "description" :   "Description For Activity",
    "start_date" :   "2014-08-01T09:00:00",
    "estimate_completion_time" :   {
                                        "time_period_value" : 5,
                                        "time_period_uot" : "DAYS"
                                    },
    "assign_to" : {
                      "unit_identifier" : { "name" : "Admin Unit"}
                  },
    "performed_for" : {
                          "subscription_identifier" : { "number" : "S60142"}
                      },
    "services_to_be_provided_set":    [
                                        {
                                            "product_identifier" : { "code" : "OTP001"},
                                            "time_spend" : {
                                                                "time_period_value" : 10,
                                                                "time_period_uot" : "WEEKS"
                                                            }
                                        },
                                        {
                                            "product_identifier" : { "code" : "OTP002" },
                                            "time_spend" : {
                                                                "time_period_value" : 10,
                                                                "time_period_uot" : "DAYS"
                                                            }
 
                                        },
                                        {
                                            "product_identifier" : { "code" : "OTP003" },
                                            "time_spend" : {
                                                                "time_period_value" : 2.5,
                                                                "time_period_uot" : "DAYS"
                                                            }
                                        }
                                    ],
       "udf_float_1": 10,
       "udf_float_2": 12,
       "udf_float_3": 13,
       "udf_float_4": 14,
       "udf_string_1": "userfield1",
       "udf_string_2": "userfield2",
       "udf_string_3": "userfield3",
       "udf_date_1" :   "2014-08-01T09:00:00",
       "udf_date_2" :   "2014-08-01T09:00:00",
       "udf_date_3" :   "2014-08-01T09:00:00",
       "udf_string_4": "userfield4",
       "udf_date_4" :   "2014-08-01T09:00:00",
       "udf_string_5": "userfield5",
       "udf_string_6": "userfield6",
       "udf_string_7": "userfield7",
       "udf_string_8": "userfield8",
       "privacy_level_identifier":
       {
           "id": "0BA1A4672D1A071351BB1297A99F2915"
       },
       "owned_by_group_identifier":
		{
           "name": "Nicosia Office",
           "id": "68D54DA033606669621E3D2E4B355DA0"
       },
    "notes": "ACTIVITY"
 }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "notes": "ACTIVITY",
        "udf_string_10": null,
        "udf_string_11": null,
        "udf_string_12": null,
        "udf_date_10": null,
        "udf_string_13": null,
        "number": "306",
        "udf_string_14": null,
        "performed_for":
        {
            "subscription":
            {
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Xenofontos ",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": "Iatrou",
                        "company_profile": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Kyriakos",
                        "name": "Kyriakos Xenofontos",
                        "id": "31260911295E70BB660EBEB0C4F941AC",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": "MALE",
                            "passport_issued_by_country": null,
                            "passport_number": null,
                            "social_security_number": null,
                            "country_of_residence":
                            {
                                "name": "UNITED KINGDOM",
                                "id": "126"
                            },
                            "industry_sector": null,
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "id_number": "87878000",
                            "id_issued_by_country": null,
                            "industry": null
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "195",
                    "name": "Xenofontos",
                    "id": "5B51429862A7BCBAD60CC81982BBD45B"
                },
                "life_cycle_state": "EFFECTIVE",
                "number": "S60142",
                "type":
                {
                    "name": "United Kingdom",
                    "id": "1C81FBB1E5D90040F440ECE98D6A368D",
                    "description": "For subscribers residing in United Kingdom",
                    "alternative_code": "UK"
                },
                "id": "253A818FECCA1D1B212703FEE056C8EA"
            },
            "job": null
        },
        "udf_string_15": null,
        "assign_to":
        {
            "unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "user": null
        },
        "udf_string_1": "userfield1",
        "udf_string_16": null,
        "udf_string_2": "userfield2",
        "privacy_level":
        {
            "number": null,
            "hierarchy_level": 1,
            "name": "3",
            "id": "0BA1A4672D1A071351BB1297A99F2915"
        },
        "contact_information":
        {
            "last_name": "Xenofontos ",
            "life_cycle_state": "FINANCIAL",
            "middle_name": "Iatrou",
            "company_profile": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Kyriakos",
            "name": "Kyriakos Xenofontos",
            "id": "31260911295E70BB660EBEB0C4F941AC",
            "company_name": null,
            "demographics":
            {
                "gender": "MALE",
                "passport_issued_by_country": null,
                "passport_number": null,
                "social_security_number": null,
                "country_of_residence":
                {
                    "name": "UNITED KINGDOM",
                    "id": "126"
                },
                "industry_sector": null,
                "date_of_birth":
                {
                    "month": null,
                    "day": null,
                    "year": null
                },
                "name_day":
                {
                    "month": null,
                    "day": null
                },
                "id_number": "87878000",
                "id_issued_by_country": null,
                "industry": null
            }
        },
        "udf_string_3": "userfield3",
        "udf_string_4": "userfield4",
        "udf_string_5": "userfield5",
        "udf_string_6": "userfield6",
        "udf_string_7": "userfield7",
        "udf_string_8": "userfield8",
        "udf_string_9": null,
        "id": "7D8C99BB3F3BBB154105AB0FDA36750C",
        "udf_date_1": "2014-08-01T09:00:00",
        "udf_date_2": "2014-08-01T09:00:00",
        "udf_date_3": "2014-08-01T09:00:00",
        "expected_completion_date": "2014-08-06T09:00:00",
        "udf_date_4": "2014-08-01T09:00:00",
        "start_date": "2014-08-01T09:00:00",
        "udf_date_5": null,
        "udf_date_6": null,
        "udf_date_7": null,
        "time_to_completion":
        {
            "time_period_value": null,
            "time_period_uot": "DAYS"
        },
        "time_overdue":
        {
            "time_period_value": 2.6774193548387095,
            "time_period_uot": "MONTHS"
        },
        "udf_date_8": null,
        "udf_date_9": null,
        "owned_by_group":
        {
            "community_name": "Main Community",
            "name": "Nicosia Office",
            "id": "68D54DA033606669621E3D2E4B355DA0",
            "description": null,
            "alternative_code": "NO"
        },
        "log_information":
        {
            "updated_date": "2014-10-27T09:45:10",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2014-10-27T09:45:09",
            "updated_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            }
        },
        "status":
        {
            "name": "To Be approved",
            "id": "C93B05CCFC11CFFA62BA2A04F87603C8",
            "description": null,
            "alternative_code": "TBA"
        },
        "actual_completed_date": null,
        "life_cycle_state": "PENDING",
        "estimate_completion_time":
        {
            "time_period_value": 5,
            "time_period_uot": "DAYS"
        },
        "type":
        {
            "name": "Activity Type 2",
            "id": "DC21155B4A625F4B6230BF1B63C393FF",
            "description": "ACTTYPE",
            "alternative_code": "AT2"
        },
        "description": "Description For Activity",
        "category": null,
        "services_to_be_provided_set":
        [
            {
                "service":
                {
                    "product_type":
                    {
                        "physical_good_type": null,
                        "service_type": "ONETIME",
                        "used_for_provisioning": true,
                        "composition_method": "FLAT",
                        "classification": "SERVICES",
                        "name": "One Time Services",
                        "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                        "description": "A type which is used for one time services",
                        "alternative_code": "OTS"
                    },
                    "id": "891E24F7F1C8C79A1E179B670680E611",
                    "description": null,
                    "code": "OTP001",
                    "alternative_code": "OTP001"
                },
                "id": "1002C0CB43E2844D3484213DF583C675",
                "time_spend":
                {
                    "time_period_value": 10,
                    "time_period_uot": "WEEKS"
                }
            },
            {
                "service":
                {
                    "product_type":
                    {
                        "physical_good_type": null,
                        "service_type": "ONETIME",
                        "used_for_provisioning": true,
                        "composition_method": "FLAT",
                        "classification": "SERVICES",
                        "name": "One Time Services",
                        "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                        "description": "A type which is used for one time services",
                        "alternative_code": "OTS"
                    },
                    "id": "0576A176E6C792A1BAF5986B4A3B6E87",
                    "description": null,
                    "code": "OTP003",
                    "alternative_code": "OTP003"
                },
                "id": "E8B588AE000564407B46769F8CC47C1F",
                "time_spend":
                {
                    "time_period_value": 2.5,
                    "time_period_uot": "DAYS"
                }
            },
            {
                "service":
                {
                    "product_type":
                    {
                        "physical_good_type": null,
                        "service_type": "ONETIME",
                        "used_for_provisioning": true,
                        "composition_method": "FLAT",
                        "classification": "SERVICES",
                        "name": "One Time Services",
                        "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                        "description": "A type which is used for one time services",
                        "alternative_code": "OTS"
                    },
                    "id": "9485FC0F5C75279E4E8E1FF3B7B247AE",
                    "description": null,
                    "code": "OTP002",
                    "alternative_code": "OTP002"
                },
                "id": "6BF2E43266367D991AA594C911A43227",
                "time_spend":
                {
                    "time_period_value": 10,
                    "time_period_uot": "DAYS"
                }
            }
        ]
    }
}

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "token" :   "2F734D18F7024990B91204ED5BC5CEFF",
    "type_identifier" :   { "name" : "Activity Type 2" },
    "contact_information_identifier": { "id" : "31260911295E70BB660EBEB0C4F941AC" },
    "status_identifier" :   { "name" : "To Be approved"},
    "description" :   "Description For Activity",
    "start_date" :   "2015-02-23T09:00:00",
    "estimate_completion_time" :   {
                                        "time_period_value" : 5,
                                        "time_period_uot" : "DAYS"
                                    },
    "assign_to" : {
                      "unit_identifier" : { "name" : "Admin Unit"}
                  },
    "performed_for" : {
                          "subscription_identifier" : { "number" : "S60142"}
                      },
    "services_to_be_provided_set":    [
                                        {
                                             "product_identifier" : { "code" : "Installation"},
                                            "time_spend" : {
                                                                "time_period_value" : 10,
                                                                "time_period_uot"    : "WEEKS"
                                                            },
                                           "resource_request":{
                                                            "requested_by_group_identifier" : {"name" : "Developers Group"},
                                                            "planned_date" : "2015-02-25T00:00:00",
                                                            "from_time" : "12:00",
                                                            "to_time" : "18:00",
                                                            "requested_by_unit_identifier" : {"name" : "U1"},
                                                            "requested_by_user_identifier" : {"username" : "MPAdministrator"},
                                                            "requested_resource_plan_entry_identifier" : { "number" : "1827"},
                                                            "requested_one_time_service_identifier":{"code" : "Installation"},
                                                            "number_of_resources":1
                                           }
                                        }
                                    ],
       "udf_float_1": 10,
       "udf_float_2": 12,
       "udf_float_3": 13,
       "udf_float_4": 14,
       "udf_string_1": "userfield1",
       "udf_string_2": "userfield2",
       "udf_string_3": "userfield3",
       "udf_date_1" :   "2014-08-01T09:00:00",
       "udf_date_2" :   "2014-08-01T09:00:00",
       "udf_date_3" :   "2014-08-01T09:00:00",
       "udf_string_4": "userfield4",
       "udf_date_4" :   "2014-08-01T09:00:00",
       "udf_string_5": "userfield5",
       "udf_string_6": "userfield6",
       "udf_string_7": "userfield7",
       "udf_string_8": "userfield8",
       "privacy_level_identifier":
       {
           "id": "0BA1A4672D1A071351BB1297A99F2915"
       },
       "owned_by_group_identifier":
        {
           "name": "Nicosia Office",
           "id": "68D54DA033606669621E3D2E4B355DA0"
       },
    "notes": "ACTIVITY"
 }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_string_10": null,
        "udf_float_1": 10,
        "udf_string_11": null,
        "udf_float_2": 12,
        "udf_string_12": null,
        "udf_float_3": 13,
        "udf_string_13": null,
        "udf_float_4": 14,
        "udf_string_14": null,
        "udf_float_5": null,
        "udf_string_15": null,
        "udf_string_16": null,
        "udf_float_6": null,
        "udf_string_1": "userfield1",
        "udf_string_2": "userfield2",
        "udf_float_7": null,
        "privacy_level":
        {
            "number": null,
            "hierarchy_level": 1,
            "name": "3",
            "id": "0BA1A4672D1A071351BB1297A99F2915"
        },
        "contact_information":
        {
            "last_name": "Xenofontos ",
            "life_cycle_state": "FINANCIAL",
            "middle_name": "Iatrou",
            "company_profile": null,
            "title": "Mr",
            "type": "PERSON",
            "first_name": "Kyriacos",
            "name": "Kyriacos Xenofontos",
            "id": "31260911295E70BB660EBEB0C4F941AC",
            "company_name": null,
            "demographics":
            {
                "gender": "MALE",
                "passport_issued_by_country":
                {
                    "name": "UNITED KINGDOM",
                    "id": "126"
                },
                "passport_number": "3463463",
                "social_security_number": "73473567",
                "country_of_residence":
                {
                    "name": "UNITED KINGDOM",
                    "id": "126"
                },
                "industry_sector": null,
                "date_of_birth":
                {
                    "month": 5,
                    "day": 6,
                    "year": 1988
                },
                "name_day":
                {
                    "month": 5,
                    "day": 3
                },
                "id_number": "87878000",
                "id_issued_by_country":
                {
                    "name": "UNITED KINGDOM",
                    "id": "126"
                },
                "industry": null
            }
        },
        "udf_string_3": "userfield3",
        "udf_float_8": null,
        "udf_string_4": "userfield4",
        "udf_float_9": null,
        "udf_string_5": "userfield5",
        "udf_string_6": "userfield6",
        "udf_string_7": "userfield7",
        "udf_string_8": "userfield8",
        "udf_string_9": null,
        "id": "975C62DEB1B54E5BB212B2ADFB52BE6F",
        "expected_completion_date": "2015-02-28T09:00:00",
        "time_to_completion":
        {
            "time_period_value": 4,
            "time_period_uot": "DAYS"
        },
        "time_overdue":
        {
            "time_period_value": null,
            "time_period_uot": null
        },
        "log_information":
        {
            "updated_date": "2015-02-24T13:19:32",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2015-02-24T13:19:30",
            "updated_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "life_cycle_state": "PENDING",
        "estimate_completion_time":
        {
            "time_period_value": 5,
            "time_period_uot": "DAYS"
        },
        "type":
        {
            "name": "Activity Type 2",
            "id": "DC21155B4A625F4B6230BF1B63C393FF",
            "description": "ACTTYPE",
            "alternative_code": "AT2"
        },
        "services_to_be_provided_set":
        [
            {
                "service":
                {
                    "product_type":
                    {
                        "physical_good_type": null,
                        "service_type": "ONETIME",
                        "used_for_provisioning": true,
                        "composition_method": "FLAT",
                        "classification": "SERVICES",
                        "name": "One Time Services",
                        "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                        "description": "A type which is used for one time services",
                        "alternative_code": "OTS"
                    },
                    "id": "8E990D550CC2F4D2951A273E9D84F9E6",
                    "description": null,
                    "code": "Installation",
                    "alternative_code": "IN"
                },
                "resource_requests_set":
                [
                    {
                        "to_date": "2015-02-25T18:00:00",
                        "from_date": "2015-02-25T12:00:00",
                        "number_of_resources": 1,
                        "requested_unit": null,
                        "life_cycle_state": "PENDING",
                        "number": "82",
                        "id": "6896A4B4FB80478AA6E119B64EC1DD4E",
                        "description": null
                    }
                ],
                "id": "870F53BEA9AC4C4A9DFF0E66924BB7A1",
                "time_spend":
                {
                    "time_period_value": 10,
                    "time_period_uot": "WEEKS"
                }
            }
        ],
        "notes": "Marios Lannister	24/2/2015 13:19:30	ACTIVITY",
        "udf_date_10": null,
        "number": "31",
        "performed_for":
        {
            "service_request": null,
            "lead": null,
            "subscription":
            {
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Xenofontos ",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": "Iatrou",
                        "company_profile": null,
                        "title": "Mr",
                        "type": "PERSON",
                        "first_name": "Kyriacos",
                        "name": "Kyriacos Xenofontos",
                        "id": "31260911295E70BB660EBEB0C4F941AC",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": "MALE",
                            "passport_issued_by_country":
                            {
                                "name": "UNITED KINGDOM",
                                "id": "126"
                            },
                            "passport_number": "3463463",
                            "social_security_number": "73473567",
                            "country_of_residence":
                            {
                                "name": "UNITED KINGDOM",
                                "id": "126"
                            },
                            "industry_sector": null,
                            "date_of_birth":
                            {
                                "month": 5,
                                "day": 6,
                                "year": 1988
                            },
                            "name_day":
                            {
                                "month": 5,
                                "day": 3
                            },
                            "id_number": "87878000",
                            "id_issued_by_country":
                            {
                                "name": "UNITED KINGDOM",
                                "id": "126"
                            },
                            "industry": null
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "195",
                    "name": "Xenofontos",
                    "id": "5B51429862A7BCBAD60CC81982BBD45B"
                },
                "life_cycle_state": "EFFECTIVE",
                "number": "S60142",
                "type":
                {
                    "name": "United Kingdom",
                    "id": "1C81FBB1E5D90040F440ECE98D6A368D",
                    "description": "For subscribers residing in United Kingdom",
                    "alternative_code": "UK"
                },
                "id": "253A818FECCA1D1B212703FEE056C8EA"
            },
            "job": null
        },
        "assign_to":
        {
            "unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "user": null
        },
        "udf_date_1": "2014-08-01T09:00:00",
        "udf_date_2": "2014-08-01T09:00:00",
        "udf_float_10": null,
        "udf_date_3": "2014-08-01T09:00:00",
        "udf_date_4": "2014-08-01T09:00:00",
        "start_date": "2015-02-23T09:00:00",
        "udf_date_5": null,
        "udf_date_6": null,
        "udf_date_7": null,
        "udf_date_8": null,
        "udf_date_9": null,
        "owned_by_group":
        {
            "community_name": "Main Community",
            "name": "Nicosia Office",
            "id": "68D54DA033606669621E3D2E4B355DA0",
            "description": null,
            "alternative_code": "NO"
        },
        "status":
        {
            "name": "To Be approved",
            "id": "C93B05CCFC11CFFA62BA2A04F87603C8",
            "description": null,
            "alternative_code": "TBA"
        },
        "actual_completed_date": null,
        "description": "Description For Activity",
        "category": null
    }
}

POST activities/update

This method updates activities. Single activities can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

activity_identifier

(mandatory)

...

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

...

category_identifier

(optional)

...

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

...

status_identifier

(optional)

...

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

...

description

(optional)

...

notes

(optional)

...

start_date

(optional)

...

owned_by_group_identifier

(optional)

...

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

...

privacy_level_identifier

(optional)

...

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

...

udf_string_1

(optional)

...

User Defined Field of type String

...

udf_string_2

(optional)

...

User Defined Field of type String

...

udf_string_3

(optional)

...

User Defined Field of type String

...

udf_string_4

(optional)

...

User Defined Field of type String

...

udf_string_5

(optional)

...

User Defined Field of type String

...

udf_string_6

(optional)

...

User Defined Field of type String

...

udf_string_7

(optional)

...

User Defined Field of type String

...

udf_string_8

(optional)

...

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)

...

estimated_completion_time

(optional)

...

assign_to

(mandatory on conditions)

...

The assignment information of the activity. Assign to information is mandatory to be specified, unless if it is set automatically through ACR rules.

...

performed_for

(optional)

...

The entities which are related with the activity

...

services_to_be_provided_set

(optional)

...

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

...

fields_set

(optional)

...

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

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "token" :   "1B4D09A2C62B477791544314C3847FE5",
    "activity_identifier"         :    { "number" : "9" },
    "status_identifier"           :    { "name" : "Assigned"},
    "description"                  :    "Description For Activity",
    "start_date"                  :    "2014-08-01T09:00:00",
	"udf_string_1": "userfield1",
    "udf_string_2": "userfield2",
    "udf_string_3": "userfield3",
    "udf_string_4": "userfield4",
    "udf_string_5": "userfield5",
    "udf_string_6": "userfield6",
    "udf_string_7": "userfield7",
    "udf_string_8": "userfield8",
    "udf_string_9": "userfield9",
    "udf_string_10": "userfield10",
    "udf_string_11": "userfield11",
    "udf_string_12": "userfield12",
    "udf_string_13": "userfield13",
    "udf_string_14": "userfield14",
    "udf_string_15": "userfield15",
    "udf_string_16": "userfield16",
    "udf_float_1":1,
    "udf_float_2":2,
	"udf_float_3":3,
	"udf_float_4":4,
	"udf_float_5":5,
	"udf_float_6":6,
	"udf_float_7":7,
	"udf_float_8":8,
	"udf_float_9":9,
	"udf_float_10":10,
    "udf_date_1": "2011-08-01T09:00:00",
    "udf_date_2": "2012-08-01T09:00:00",
    "udf_date_3": "2013-08-01T09:00:00",
    "udf_date_4": "2014-08-01T09:00:00",
    "udf_date_5": "2015-08-01T09:00:00",
    "udf_date_6": "2016-08-01T09:00:00",
    "udf_date_7": "2017-08-01T09:00:00",
    "udf_date_8": "2018-08-01T09:00:00",
    "udf_date_9": "2019-08-01T09:00:00",
    "udf_date_10": "2020-08-01T09:00:00"
	"performed_for"              :   {
                "lead_identifier" : { "number" : "61"}
                    },
    "estimate_completion_time"     :    {
                                        "time_period_value" : 5,
                                        "time_period_uot" : "DAYS"
                                    },
   "services_to_be_provided_set":    [
                                        {
                                            "action": "add",
                                            "product_identifier" : { "code" : "Installation"},
                                            "time_spend" : {
                                                                "time_period_value" : 10,
                                                                "time_period_uot"    : "WEEKS"
                                                            },
                                           "resource_request":{
                                                            "requested_by_group_identifier" : {"name" : "Developers Group"},
                                                            "planned_date" : "2015-02-18T00:00:00",
                                                            "from_time" : "12:00",
                                                            "to_time" : "18:00",
                                                            "requested_by_unit_identifier" : {"name" : "U1"},
                                                            "requested_by_user_identifier" : {"username" : "MPAdministrator"},
                                                            "requested_resource_plan_entry_identifier" : { "number" : "1827"},
                                                            "requested_one_time_service_identifier":{"code" : "Installation"},
                                                            "number_of_resources":1
                                           }
                                        }
              ]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "notes": null,
           "udf_string_10": "userfield10",
           "udf_float_1": 1,
           "udf_string_11": "userfield11",
           "udf_float_2": 2,
           "udf_string_12": "userfield12",
           "udf_float_3": 3,
           "udf_string_13": "userfield13",
           "udf_float_4": 4,
           "udf_string_14": "userfield14",
           "udf_float_5": 5,
           "udf_string_15": "userfield15",
           "udf_string_16": "userfield16",
           "udf_float_6": 6,
           "udf_string_1": "userfield1",
           "udf_string_2": "userfield2",
       	   "udf_float_7": 7,

           "performed_for":
           {
               "service_request": null,
               "lead":
               {
                   "life_cycle_state": "PENDING",
                   "number": "61",
                   "id": "FB7E2F2337BAC04BA21DAEA5B2380A7E",
                   "description": null,
                   "contact_information":
                   {
                       "last_name": "Spector",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": null,
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Matt",
                       "name": null,
                       "id": "58F5508072753180E10322DBCA1862EE",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "passport_issued_by_country": null,
                           "passport_number": "JB0007689",
                           "social_security_number": null,
                           "industry_sector": null,
                           "date_of_birth":
                           {
                               "month": null,
                               "day": null,
                               "year": null
                           },
                           "name_day":
                           {
                               "month": null,
                               "day": null
                           },
                           "id_number": null,
                           "id_issued_by_country": null,
                           "industry": null
                       }
                   }
               },
               "subscription": null,
               "job": null
           },
           "assign_to":
           {
               "unit":
               {
                   "group_name": null,
                   "name": "U1",
                   "id": "8B4009FA8BC8A612D0DB62B5F2AB135B",
                   "description": null,
                   "alternative_code": null
               },
               "user": null
           },
           "privacy_level":
           {
               "number": null,
               "hierarchy_level": 2,
               "name": "High",
               "id": "321ACE4A65A24800365B2B2236F5E171"
           },
           "contact_information":
           {
               "last_name": "Spector",
               "life_cycle_state": "FINANCIAL",
               "middle_name": null,
               "company_profile": null,
               "title": null,
               "type": "PERSON",
               "first_name": "Matt",
               "name": "Matt Spector",
               "id": "58F5508072753180E10322DBCA1862EE",
               "company_name": null,
               "demographics":
               {
                   "gender": "MALE",
                   "passport_issued_by_country": null,
                   "passport_number": "JB0007689",
                   "social_security_number": null,
                   "country_of_residence":
                   {
                       "name": "JAPAN",
                       "id": "237"
                   },
                   "industry_sector": null,
                   "date_of_birth":
                   {
                       "month": null,
                       "day": null,
                       "year": null
                   },
                   "name_day":
                   {
                       "month": null,
                       "day": null
                   },
                   "id_number": null,
                   "id_issued_by_country": null,
                   "industry": null
               }
           },
           "udf_string_3": "userfield3",
           "udf_float_8": 8,
           "udf_string_4": "userfield4",
           "udf_float_9": 9,
           "udf_string_5": "userfield5",
           "udf_string_6": "userfield6",
           "udf_string_7": "userfield7",
           "udf_string_8": "userfield8",
           "udf_string_9": "userfield9",
           "id": "D9C6BE3D7817C8DA8E16703CAAEC1A9A",
           "expected_completion_date": "2014-12-03T10:12:51",
           "start_date": "2014-12-02T10:12:51",
           "time_to_completion":
           {
               "time_period_value": null,
               "time_period_uot": "DAYS"
           },
           "time_overdue":
           {
               "time_period_value": 2.571428571428571,
               "time_period_uot": "MONTHS"
           },
           "owned_by_group":
           {
               "community_name": "Main Community",
               "name": "Developers Group",
               "id": "8BD400EC50DB9678F9C3573401399924",
               "description": "test2",
               "alternative_code": null
           },
           "log_information":
           {
               "updated_date": "2015-02-19T13:00:50",
               "created_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-12-02T10:12:51",
               "updated_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": "mp@ministrator.com"
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "udf_date_10": "2020-08-01T09:00:00",
           "status":
           {
               "name": "To Be approved",
               "id": "C93B05CCFC11CFFA62BA2A04F87603C8",
               "description": null,
               "alternative_code": "TBA"
           },
           "udf_date_1": "2011-08-01T09:00:00",
           "udf_date_2": "2012-08-01T09:00:00",
           "udf_float_10": 10,
           "udf_date_3": "2013-08-01T09:00:00",
           "udf_date_4": "2014-08-01T09:00:00",
           "udf_date_5": "2015-08-01T09:00:00",
           "udf_date_6": "2016-08-01T09:00:00",
           "udf_date_7": "2017-08-01T09:00:00",
           "udf_date_8": "2018-08-01T09:00:00",
           "udf_date_9": "2019-08-01T09:00:00",
           "actual_completed_date": null,
           "life_cycle_state": "PENDING",
           "estimate_completion_time":
           {
               "time_period_value": 1,
               "time_period_uot": "DAYS"
           },
           "type":
           {
               "name": "Installations",
               "id": "BF60960C7FC5B0E5B81DB7E5BCC7F140",
               "description": null,
               "alternative_code": "IN"
           },
           "description": "test",
           "category": null,
           "services_to_be_provided_set":
           [
               {
                   "service":
                   {
                       "product_type":
                       {
                           "physical_good_type": null,
                           "service_type": "ONETIME",
                           "used_for_provisioning": true,
                           "composition_method": "FLAT",
                           "classification": "SERVICES",
                           "name": "One Time Services",
                           "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                           "description": "A type which is used for one time services",
                           "alternative_code": "OTS"
                       },
                       "id": "009F001976DA6F8F4DFD0BB5F704C0D7",
                       "description": null,
                       "code": "material delivery",
                       "alternative_code": "MD"
                   },
                   "id": "F05890872A35462D93C9B74BEA9AD931",
                   "time_spend":
                   {
                       "time_period_value": 10,
                       "time_period_uot": "WEEKS"
                   }
               },
               {
                   "service":
                   {
                       "product_type":
                       {
                           "physical_good_type": null,
                           "service_type": "ONETIME",
                           "used_for_provisioning": true,
                           "composition_method": "FLAT",
                           "classification": "SERVICES",
                           "name": "One Time Services",
                           "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                           "description": "A type which is used for one time services",
                           "alternative_code": "OTS"
                       },
                       "id": "8E990D550CC2F4D2951A273E9D84F9E6",
                       "description": null,
                       "code": "Installation",
                       "alternative_code": "IN"
                   },
                   "id": "255F82E21CCE44CAA72678687261C86D",
                   "time_spend":
                   {
                       "time_period_value": 10,
                       "time_period_uot": "WEEKS"
                   }
               }
           ]
       }
}

POST activities/cancel

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)

...

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

...

status_identifier

(optional)

...

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:

...

cancellation_reason_identifier

(mandatory)

...

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

...

fields_set

(optional)

...

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

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
	"token":"336784FFE8734D9F919A6EA6891316F4",
	"activity_identifier"         :    { "number" : "ACT000133" },
    "status_identifier"           :    { "name" : "Cancelled"},
    "cancellation_reason_identifier"           :    { "name" : "Cancel Reason 1"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

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

POST activities/start_progress

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)

...

The identifier of the activity that will be started. The allowed activity identifier fields are the following:

...

status_identifier

(optional)

...

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

...

fields_set

(optional)

...

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

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
	"token" :   "187A269CB5B14AD9870BBE61A699BDA2",
    "activity_identifier"         :    { "number" : "ACT000138" },
	"status_identifier" :   { "name" : "In Progress" }
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "number": "ACT000138",
        "expected_completion_date": "2015-05-28T17:39:49",
        "performed_for":
        {
        },
        "start_date": "2015-05-14T17:39:49",
        "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": "Mika",
            "life_cycle_state": "FINANCIAL",
            "title": "Mr",
            "first_name": "Darko",
            "type": "PERSON",
            "id": "531C8308457947EFAFA91776AA4F4B4E",
            "name": "Darko Mika",
            "demographics":
            {
                "gender": "MALE",
                "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": "WEEKS"
        },
        "time_overdue":
        {
        },
        "time_to_completion":
        {
            "time_period_value": 2,
            "time_period_uot": "WEEKS"
        },
        "owned_by_group":
        {
            "community_name": "Internal Community",
            "id": "84F33366CB592BAAE7E2044D93611C6A",
            "name": "Main Group",
            "description": "Main Group",
            "alternative_code": "MG1"
        },
        "log_information":
        {
            "updated_date": "2015-05-14T17:55:58",
            "created_date": "2015-05-14T17:39:50",
            "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": "IN_PROGRESS",
            "id": "F6420AC12C68BBC6C9B7600E0E1BA6DF",
            "name": "In Progress",
            "description": "In Progress Status",
            "alternative_code": "IP"
        },
        "life_cycle_state": "IN_PROGRESS",
        "type":
        {
            "id": "6D0C79835F7B0059D3BD1A51F2A03F41",
            "name": "Maintenance visits",
            "alternative_code": "MV"
        },
        "id": "C2B77FB0F7C24625817D491837B0F893",
        "services_to_be_provided_set":
        [
            {
                "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": "690A6B1932D34421A1EE254425F2CB12",
                    "code": "Installation Service",
                    "alternative_code": "IS"
                },
                "resource_requests_set":
                [
                ],
                "id": "E5889ACD1844430B98C433CDEB49263A",
                "time_spend":
                {
                    "time_period_value": 1,
                    "time_period_uot": "DAYS"
                }
            }
        ]
    }
}

POST activities/complete

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)

...

The identifier of the activity that will be completed. The allowed activity identifier fields are the following:

...

status_identifier

(optional)

...

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:

...

fields_set

(optional)

...

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

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

...

Panel

name	blue

Child pages (Children Display)

excerpt	true

Page Comparison

Versions Compared

Old Version 88

New Version 89

Key

GET activities/show

Resource URL

Parameters

Restrictions

Response Data

Examples

GET activities/list

Resource URL

Parameters

Restrictions

Response Data

Examples

GET activities/get_close_to_estimated_completion_time

Resource URL

Parameters

Restrictions

Response Data

Examples

GET activities/get_overdue

Resource URL

Parameters

Restrictions

Response Data

Examples

GET activities/get_pending

Resource URL

Parameters

Restrictions

Response Data

Examples

GET activities/get_in_progress

Resource URL

Parameters

Restrictions

Response Data

Examples

GET activities/get_completed

Resource URL

Parameters

Restrictions

Response Data

Examples

GET activities/get_cancelled

Resource URL

Parameters

Restrictions

Response Data

Examples

POST activities/create

Resource URL

Parameters

Restrictions

Response Data

Examples

POST activities/update

Resource URL

Parameters

Restrictions

Response Data

Examples

POST activities/cancel

Resource URL

Parameters

Restrictions

Response Data

Examples

POST activities/start_progress

Resource URL

Parameters

Restrictions

Response Data

Examples

POST activities/complete

Resource URL

Parameters