Available from CRM.COM R6.0.0

GET activities/configuration/types/list

This method returns the activity types that are allowed to be used in the system. Multiple activity types are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

group_identifier

(optional)

Group Identifier

The identifier of the group that will be providing the activity type. The group is filtered against the activity types' allowed organisational units. The allowed group identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

unit_identifier

(optional)

Unit Identifier

The identifier of the unit that will be providing the activity type. The unit is filtered against the activity types' allowed organisational units. The allowed unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

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

Response Data

Name	Type	Description
id	String	The ID of the retrieved activity type
name	String	The name of the retrieved activity type
alternative_code	String	The alternative code of the retrieved activity type
description	String	A description of the retrieved activity type
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
estimated_completion_time	Time Period Object	The time that is estimated to be required in order complete activities of this type, measured in MINUTES, HOURS, DAYS, WEEKS, YEARS From CRM.COM R17.0.0, YEARS is deprecated
log_information	Log Information Object	The log information of the retrieved activity type

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "log_information":
            {
                "updated_date": "2015-05-14T13:06:51",
                "created_date": "2015-04-30T10:08:04",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "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"
                }
            },
            "id": "B163FF3F08B44CBEB00F1CCD875C54DE",
            "name": "Installation",
            "estimated_completion_time":
            {
                "time_period_value": 2,
                "time_period_uot": "WEEKS"
            },
            "alternative_code": "INS"
        },
        {
            "log_information":
            {
                "updated_date": "2015-05-14T17:54:56",
                "created_date": "2015-04-15T10:06:22",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "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"
                }
            },
            "id": "09EE47872CF8414A98C2EC5655936BF5",
            "name": "Customer Training",
            "estimated_completion_time":
            {
                "time_period_value": 8,
                "time_period_uot": "HOURS"
            },
            "alternative_code": "CT"
        },
        {
            "log_information":
            {
                "updated_date": "2015-05-15T13:20:59",
                "created_date": "2015-04-15T10:07:35",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "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"
                }
            },
            "id": "CB7953F4D06C4135A794623C9F1620D8",
            "name": "Onside Deliveries",
            "estimated_completion_time":
            {
                "time_period_value": 2,
                "time_period_uot": "DAYS"
            },
            "alternative_code": "OD"
        },
        {
            "log_information":
            {
                "updated_date": "2015-04-29T14:41:51",
                "created_date": "2015-04-15T10:08:37",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "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"
                }
            },
            "id": "915B12F6D9FE4264A013AEDE1595240A",
            "name": "In house Training",
            "estimated_completion_time":
            {
                "time_period_value": 1,
                "time_period_uot": "WEEKS"
            },
            "alternative_code": "IHT"
        },
        {
            "log_information":
            {
                "updated_date": "2015-05-15T17:06:37",
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "id": "938B9B6411AAB03DC25B3F569A443C6D",
            "name": "InstallationsX",
            "description": "Test",
            "estimated_completion_time":
            {
                "time_period_value": 8,
                "time_period_uot": "HOURS"
            },
            "alternative_code": "INX"
        },
        {
            "log_information":
            {
                "updated_date": "2015-04-03T12:11:44",
                "created_date": "2014-08-25T13:17:20",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "id": "6D0C79835F7B0059D3BD1A51F2A03F41",
            "name": "Maintenance visits",
            "estimated_completion_time":
            {
                "time_period_value": 5,
                "time_period_uot": "HOURS"
            },
            "alternative_code": "MV"
        }
    ]
}

GET activities/configuration/categories/list

This method returns the activity categories that are allowed to be used by activities of specific type. Multiple activity categories are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

activity_type_identifier

(mandatory)

activity Type Identifier

The identifier of the type of the activity that will be using the categories. The categories are filtered against the allowed categories of the specified type. The allowed activity type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the activity type

name

(semi-optional)

String

The code of the activity type

alternative_code

(semi-optional)

String

The alternative code of the activity type

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

Response Data

Name	Type	Description
id	String	The id of the retrieved category
name	String	The name of the retrieved category
code	String	The code of the retrieved category
description	String	The description of the retrieved category
parent_id	String	The id of the retrieved category's parent category

Examples

Example 1

HTTP Method: GET

Request:

Response:

GET activities/configuration/services/list

This method returns the services that are allowed to be used by activities of specific type. Multiple services are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

activity_type_identifier

(mandatory)

activity Type Identifier

The identifier of the type of the activity that will be using the services. The services are filtered against the allowed services of the specified type. The allowed activity type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the activity type

name

(semi-optional)

String

The code of the activity type

alternative_code

(semi-optional)

String

The alternative code of the activity type

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

Response Data

Name	Type	Description
id	String	The ID of the retrieved activity type service
mandatory	Boolean	Determines if the activity type service is mandatory or not
time_spent_logging_method	String	Determines the time spend logging method of the retrieved activity type service. The supported values are the following: FIXED or FLEXIBLE
automatically_applied	Boolean	Determines if the activity type service will be added automatically or not
minimum_time_spent	Time Period Object	The minimum time that should be spent on the retrieved activity type service
service	Product Object	The actual product provided by the activity type service

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

Examples

Example 1

HTTP Method: GET

Request:

Response:

GET activities/configuration/statuses/list

This method returns the statuses that are allowed to be used by activities of specific type. Multiple statuses are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

activity_type_identifier

(mandatory)

activity Type Identifier

The identifier of the type of the activity that will be using the statuses. The statuses are filtered against the allowed statuses of the specified type. The allowed activity type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the activity type

name

(semi-optional)

String

The code of the activity type

alternative_code

(semi-optional)

String

The alternative code of the activity type

life_cycle_state

(optional)

Sting

The life cycle state that the status should have. If specified then only statuses related with the specified life cycle state will be retrieved

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

Response Data

Name	Type	Description
id	String	The ID of the retrieved activity type status
default	Boolean	Determines if the activity type status is the default status or not
status	Activity Status Object	The actual status provided by the activity type status

Referred Objects Response Data

activity_status object response data

Name	Type	Description
id	String	The ID of the retrieved activity status
name	String	The name of the retrieved activity status
alternative_code	String	The alternative code of the retrieved activity status
description	String	A description of the retrieved activity status
life_cycle_state	String	The life cycle state related with the retrieved activity status. The supported life cycle states are the following: PENDING, IN_PROGRESS,COMPLETED,CANCELLED

Examples

Example 1

HTTP Method: GET

Request:

Response:

GET activities/configuration/cancellation_reasons/list

This method returns the cancellation reasons that are allowed to be used by activities, as defined on the active activity definition. Multiple cancellation reasons are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

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

Response Data

Name	Type	Description
id	String	The ID of the retrieved activity cancellation reason
name	String	The name of the retrieved activity cancellation reason
alternative_code	String	The alternative code of the retrieved activity cancellation reason
description	String	A description of the retrieved activity cancellation reason

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "id": "352B746264664A96BC9FC2C16816B7F5",
            "name": "Cancel Reason 1",
            "description": "Description",
            "alternative_code": "CR1"
        },
        {
            "id": "8CE6FE0AD2CC42C0B5D8A7AF660FCEC5",
            "name": "Cancel Reason 2",
            "alternative_code": "CR2"
        },
        {
            "id": "D38A9C9649AF4EF2BF8F5BA25DCE4AF7",
            "name": "Cancel Reason 3",
            "alternative_code": "CR3"
        }
    ]
}