You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
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 |
| 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 |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
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:
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 job type physical good |
| mandatory | Boolean | Determines if the job type physical good is mandatory or not |
product | Product Object | The product which can be provided through a job of the specified type. In cases in which a physical good type is included in the job type, then all physical goods of the specified type are returned. |
Referred Objects Response Data
product object response data
| | |
|---|
| 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 |
| product_type | Product type object | The type of the product |
| product_family | Product family object | The family of the product |
| product_brand | Product brand object | The brand of the product
|
| product_components_set | Set of product objects | A list of all the products that can be added as components on the specific product. This is applicable only if the product is classified as a bundle 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 |
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 |
product_family object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product family |
| name | String | The Name of the retrieved product family |
| code | String | The code of the retrieved product family |
| description | String | The Description of the retrieved product family |
product_brand object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product brand |
| name | String | The Name of the retrieved product brand |
| alternative_code | String | The Alternative Code of the retrieved product brand |
| description | String | The Description of the retrieved product brand |
product object response data
| | |
|---|
| 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 |
| global_rate | Global Rate Object | The global rate of the retrieved product |
| 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 |
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
|
| 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 |
| 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 job type status |
| default | Boolean | Determines if the job type status is the default status or not |
| status | Job Status Object | The actual status provided by the job type status |
Referred Objects Response Data
job_status object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved job status |
name | String | The name of the retrieved job status |
alternative_code | String | The alternative code of the retrieved job status |
| description | String | A description of the retrieved job status |
| life_cycle_state | String | The life cycle state related with the retrieved job status The supported life cycle states are the following: DRAFT, 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: