1.4 Close Contractor
Updated at: 2/1/2023 8:43:01 PM
Url
/api/v2/{fleet_token}/contractors/close/{id}
Method
Post
Body
``` json
{
"EffectiveDate": "<date:Date>"
}
```
Parameters
- `EffectiveDate`. Required.
Response
```JSON
{
"Success": "<true|false>",
"Message": "<message>",
"Data": {
"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>",
"InactivationDate": "<date:Date>"
}
}
```
Returns
- The information of the closed contractor would be returned. The closed date is indicated by the field `inactivation_date`.
Notes
- If there are any active objects, such as units, drivers, and coverages, the API would fail.
In this article