GET warranty_policies/get_installed_item_coverage
- Former user (Deleted)
- p_demou (Deactivated)
Available from CRM.COM R9.0.0
This method checks whether installed items sold to customers are covered by warranty policies or not. The method can be used for checking installed items coverage which is required in Jobs which perform Swap Subscription Installed Item actions. Depending on the parameters, the method might return more than one installed item's warranty information.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
accounts_receivable (semi-optional) | Accounts Receivable Identifier | The accounts receivable of the customer who requests information about the sold installed items' warranty information.The allowed accounts receivable identifier fields are the following:
| ||||||||||||
| installed_item_identifier (semi-optional) | Installed Item Identifier | The identifier of the installed item whose warranty coverage is required. The allowed installed item identifier fields are the following:
| ||||||||||||
warranty_coverage_reason_identifier (optional) | Warranty Coverage Reason Identifier | The identifier of the warranty policy's coverage reason. The coverage reason represents the replacement reason so if set the installed item's warranty should support this coverage reason. The allowed warranty coverage reason 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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
| installed_item | Installed Item Object | The sold installed item for which a warranty policy was applied |
| warranty_policy | Warranty Policy Object | The warranty policy which covers the installed item |
| warehouse_issue_date | Date | The date on which the stock out warehouse transaction was issue to represent the installed item's sale |
| warranty_remaining_coverage_period | Integer | The related warranty policy's remaining coverage duration for the specified installed item calculated in days. This information is applicable only for installed items whose warranty was carried over from another installed item which was under warranty during its replacement. |
| warranty_expiration_date | Date | The date on which the sold installed item's warranty expires |
| coverage | Integer | Denotes if the installed item is finally covered by its related warranty policy. This information is available only if a coverage reason is also defined |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": [
{
"warehouse_issue_date": "2016-03-02 17:31:06.0",
"warranty_policy": {
"life_cycle_state": "EFFECTIVE",
"number": "2",
"id": "4B417948ADB44DFEAF735184B941D481",
"name": "Policy1",
"alternative_code": "p1"
},
"installed_item": {
"state": "EFFECTIVE",
"serial_number": "Smartcard2_001",
"id": "791DF73677384DC8A00D8384F5FF85FF",
"alternative_code": "Smartcard2_001",
"product": {
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": 0,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "6173FC99331504AD1ACB5D697D54DA8C",
"name": "Smartcards",
"description": "Smartcards",
"alternative_code": "SC"
},
"id": "80EEE8F6F46767AE32E6ABE68603E9F2",
"name": null,
"description": "SmartCards 2",
"code": "Smartcard 2",
"alternative_code": "SC2"
}
},
"coverage": null,
"warranty_expiration_date": "Wed Jul 20 17:31:06 EEST 2016",
"warranty_remaining_coverage_period": 140
}
]
}