Page Comparison

...

Excerpt
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)

Number

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

uot

(mandatory)

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

Tip
From CRM.COM R17.0.0, YEARS is deprecated

contact_information_identifier

(optional)

Contact information identifier

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

Include Page

	V4:contact_information_identifier
	V4:contact_information_identifier

type_identifier

(optional)

Activity type identifier

The identifier of the type of the retrieved activity

Include Page

	V4:activity_type_identifier
	V4:activity_type_identifier

category_identifier

(optional)

Activity category identifier

The identifier of the category of the retrieved activity

Include Page

	V4:activity_category_identifier
	V4:activity_category_identifier

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip
Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip
Available from CRM.COM R13.0.0

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

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

...

Versions Compared

Old Version 4

New Version Current

Key

Resource URL

Parameters