You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
Next »
GET warranty_policies/configuration/coverage_reasons/list
This method returns the available coverage reasons that are allowed to be used by warranty policies. Multiple coverage reasons are returned by each call
Resource URL
http://host_name/crmapi/rest/$version/warranty_policies/configuration/coverage_reasons/list
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
| | |
---|
id | String | The ID of the retrieved coverage reason |
name | String | The name of the retrieved coverage reason |
alternative_code | String | The alternative code of the retrieved coverage reason |
description | String | A description of the retrieved coverage reason |
Example 1
HTTP Method: GET
Request:
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": [
{
"altCode": "CR1",
"id": "0ACA0BCFAD594297AFF1E666248C4E1D",
"name": "Coverage Reason 1",
"description": "Coverage Reason 1"
},
{
"altCode": "WCR2",
"id": "D98AEF9E5B404616BEC1F8656E05619E",
"name": "Warranty Coverage Reasons 2",
"description": "Warranty Coverage Reasons 2"
},
{
"altCode": "F",
"id": "BB3F9215BDB044AF9FADEC764EE9469F",
"name": "Faulty",
"description": "Faulty"
},
{
"altCode": "ID",
"id": "3EFF24C354B24BA0B05719BF4DCDFA25",
"name": "Intentional Damage",
"description": "Intentional Damage"
},
{
"altCode": "B",
"id": "22C89A8167D8474B9DB0DDC5BFB89472",
"name": "Broken",
"description": "Broken"
},
{
"altCode": "SR",
"id": "8845A086EA8B4B9F96EF5EA6FD58E446",
"name": "Simple Replacement",
"description": "Simple Replacement"
}
]
}