2.4 Close Unit
Updated at: 7/21/2022 2:11:33 AM
Url
/api/v2/{fleet_token}/contractors/{contractor_id}/units/close/{id}
Method
Post
Body
``` json
{
"EffectiveDate": "<date:Date>",
"IgnoreFailures": true | false
}
```
Parameters
- `EffectiveDate`. Required, will close all coverages underneath on the given date.
- `IgnoreFailures` Optional. If there are some coverages that cannot be closed on the given effective date, the request would be be rejected. It will still proceed and close those coverages that can be closed and ignore the failures.
Response
```JSON
{
"Success": "<true|false>",
"Message": "<message>",
"Data":
{
"ID": "",
"UnitNumber": "",
"Year": "",
"Make": "",
"Vin": "",
"StatedValue": "",
"EquipmentType": "",
"Model": "",
"RegistrationState": "<state>",
"Ownership": "<ownership>",
"InactivationDate":"<date:yyyy-MM-dd>"
}
}
```
Returns
- The closed unit is returned in the response.
Notes
- The request would fail if the specified unit is already closed.
- The request would fail if there is any individual coverage associated with the unit. You might need to close the individuals first.
- Will try to close all vehicle coverages underneath the unit. If `IgnoreFailures` is set to true, then those coverages that cannot be closed on the given date would be skipped.
- Those drivers which are actively associated with the request unit will be unlinked.
In this article