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:
| ||||||||||||
load_components (optional) | Boolean | If set to true then any physical good components related with each retrieved physical good will also 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 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
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"
}
}
]
}