Page Comparison

...

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

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

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...

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

...

Versions Compared

Old Version 3

New Version Current

Key

Resource URL

Parameters

Restrictions