1.5.2 Close Coverage
Updated at: 2/1/2023 8:43:53 PM
Url
/api/{fleet_token}/contractors/{contractor_id}/coverages/close/{id}
Method
Post
Body
```json
{
"EffectiveDate": "<date:Date>"
}
```
Parameters
- `EffectiveDate`. Required.
Response
```json
{
"Success": "<true|false>",
"Message": "<message>",
"Data":
{
"ID": "",
"Description": "",
"ProductToken": ""
"InceptionDate": "",
"InactivationDate": "",
"Contractor":
{
"ID": "<contractor_id>",
"Number": "<contractor_number>",
"Name": "",
"FirstName": "<first_name>",
"MiddleName": "<middle_name>",
"LastName": "<last_name>",
"Dob": "<dob:Date>",
"Email": "<email>",
"PhoneNumber" :"<phone_number>",
"CellNumber": "<cell_number>",
"Address": "<address>",
"Address2":"<address2>",
"City":"<city>",
"State":"<state>",
"Zip":"<zip>",
"License": "<license>",
"LicenseState": "<license_state>"
}
}
}
```
Returns
- The closed coverage will be returned in the response.
Notes
- The request would fail if the given coverage is already closed in CBA.
- The request would fail if it fails to locate the motor carrier by `fleet_token`.
In this article