Locate Resource
Locates Module
| Endpoints | URI | Access Control | Description |
|---|---|---|---|
| delete | POST /api/Locate/delete |
Admin or Module WRITE | |
| save | POST /api/Locate/save |
Admin or Module WRITE | Also accepts 'ticket_num' when creating a new Locate, which creates or binds to a locateticket |
| zip-package | GET /api/Locate/zip-package |
Endpoint level permissions | compiles a zip package of all locates that match the get results |
| save-batch | POST /api/Locate/save-batch |
Admin or Module WRITE | |
| get | GET /api/Locate/get |
Allowed with an active employment connection | |
| find | GET /api/Locate/find |
Allowed with an active employment connection | |
| get-estimated-drive-time | GET /api/Locate/get-estimated-drive-time |
Endpoint level permissions | |
| notify-customer-eta | GET /api/Locate/notify-customer-eta |
Endpoint level permissions |
| Property | Type | Description |
|---|---|---|
id |
number | |
slug |
string | |
work_begin_date |
date | |
utility |
string | |
date_pulled |
date | |
expiry_date |
date | |
refresh_date |
date | |
job_id |
number | |
service_id |
number | |
file_id |
number | |
ticket_num |
string | |
ticket_id |
number | |
address |
string | |
status |
string | |
archived |
boolean | |
created_at |
datetime | |
updated_at |
datetime | |
updated_by |
number |
| Setting | |
|---|---|
Pagination Limit (when page parameter is set) |
None |
| Default Sort Order |
refresh_date DESC |
| Related Resource | Key | Relationship to Locate | Property |
|---|---|---|---|
| LocateTicket | ticket_id |
Belongs To | LocateTicket |
| UploadFile | file_id |
Belongs To | UploadFile |
| User | updated_by |
Belongs To | User |