- Created by Former user, last modified by p_demou (Deactivated) on Jul 07, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 2 Next »
Available from CRM.COM R6.0.0
This method returns the physical goods that are allowed to be used by jobs of specific type. Multiple physical goods are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
job_type_identifier (mandatory) | Job Type Identifier | The identifier of the type of the job that will be using the physical goods. The physical goods are filtered against the allowed physical goods of the specified type. The allowed job type 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 |
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 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
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 |
product_type | Product type object | The type of the product |
product_family | Product family object | The family of the product Available from CRM.COM R12.3.0 |
product_brand | Product brand object | The brand of the product Available from CRM.COM R12.3.0 |
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 Available from CRM.COM R12.3.0 |
Referred Objects Response Data
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
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
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 |
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
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 |
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 |
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 |
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
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
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
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 |
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
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 |
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:
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
|
uot | String | The 'UOT' applicable for the rate
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
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
HTTP Method: GET
Request:
Response:
{ "status": { "message": "", "description": "", "code": "OK" }, "data": [ { "mandatory": false, "id": "F22C38126B9DEA50A421881EC44A68A5", "product": { "product_type": { "service_type": null, "physical_good_type": "TRACEABLE", "used_for_provisioning": true, "classification": "PHYSICALGOODS", "composition_method": "FLAT", "id": "B4A1396AE3D1384B304A0FEB22F7BA50", "name": "Decoders", "description": "Decoders", "alternative_code": "D" }, "id": "E8672BB71A9B1BD25E30705AC34D7D61", "description": "Decoders 1", "code": "Decoders 1", "alternative_code": "D1" } }, { "mandatory": false, "id": "E4DBFBB3AA84DC6F0C6C0CBF25E0D237", "product": { "product_type": { "service_type": null, "physical_good_type": "TRACEABLE", "used_for_provisioning": true, "classification": "PHYSICALGOODS", "composition_method": "FLAT", "id": "FA802647636A11B7B74B582A688B968D", "name": "Cameras", "description": "Cameras", "alternative_code": "CA" }, "id": "13C42638B34C902F16D4EB516F775E0F", "description": "HD Camera Version 1", "code": "HD Camera V1", "alternative_code": "HDCV1" } }, { "mandatory": false, "id": "71A8B5FE335040EB836610616896AD18", "product": { "product_type": { "service_type": null, "physical_good_type": "TRACEABLE", "used_for_provisioning": false, "classification": "PHYSICALGOODS", "composition_method": "FLAT", "id": "6173FC99331504AD1ACB5D697D54DA8C", "name": "Smartcards", "description": "Smartcards", "alternative_code": "SC" }, "id": "80EEE8F6F46767AE32E6ABE68603E9F2", "description": "SmartCards 2", "code": "Smartcard 2", "alternative_code": "SC2" } }, { "mandatory": true, "id": "BA6B612DF860C72EA9BB225EEDADC7D3", "product": { "product_type": { "service_type": null, "physical_good_type": "NONTRACEABLE", "used_for_provisioning": false, "classification": "PHYSICALGOODS", "composition_method": "FLAT", "id": "0F94B51F175F06A475EB2948B4030074", "name": "Accessories", "description": "A type which is used for accessories physical goods", "alternative_code": "005" }, "id": "70FFDF2B2A74466DD7D0D5246ED1DD2D", "description": "Antenna v1", "code": "Antenna 1", "alternative_code": "ANT1" } }, { "mandatory": false, "id": "9CF1AB2762394D59821376412FF84513", "product": { "product_type": { "service_type": null, "physical_good_type": "TRACEABLE", "used_for_provisioning": false, "classification": "PHYSICALGOODS", "composition_method": "FLAT", "id": "6173FC99331504AD1ACB5D697D54DA8C", "name": "Smartcards", "description": "Smartcards", "alternative_code": "SC" }, "id": "EAC7A30429364176616CFEF5DF709941", "description": "Smartcard 1", "code": "Smartcard 1", "alternative_code": "SC1" } }, { "mandatory": false, "id": "21034AD6B00999DA3F01BE1F1D671CB3", "product": { "product_type": { "service_type": null, "physical_good_type": "NONTRACEABLE", "used_for_provisioning": false, "classification": "PHYSICALGOODS", "composition_method": "FLAT", "id": "0F94B51F175F06A475EB2948B4030074", "name": "Accessories", "description": "A type which is used for accessories physical goods", "alternative_code": "005" }, "id": "3F01BB0B40264DF7311660F63CB2180D", "description": "Remote Control", "code": "Remote Control", "alternative_code": "REM" } } ] }
- No labels