API docs by Redocly

External API (1.0)

Download OpenAPI specification:Download

Get permalink for a specific enquiry.

Retrieve a permalink associated with an enquiry.

Authorizations:
JwtAccessToken
path Parameters
jobid
required
string
Example: 12402445

The ID of the enquiry for which the permalink is being requested.

Responses

Download PDF or ZIP file for a specific enquiry.

Allows downloading either a PDF or ZIP file associated with an enquiry. The file type is determined by the f query parameter.

Authorizations:
JwtAccessToken
path Parameters
jobid
required
string
Example: 12402445

The ID of the enquiry for which the file is being requested.

query Parameters
f
required
string
Enum: "pdf" "zip"
Example: f=pdf

Specify the file format to download. Supported values are: - pdf: For downloading PDF files. - zip: For downloading ZIP files.

Responses

Create enquiry.

Create a new enquiry for a project.

Authorizations:
JwtAccessToken
Request Body schema: application/json
required
project_name
required
string
user_reference
required
string

A user-supplied reference for this enquiry.

dig_start_at
required
string <date>

Start date for enquiry activity. Must be no earlier than today.

dig_end_at
required
string <date>

End date for enquiry activity. Must be no earlier than start date.

required
object
required
object
notes
string <= 500 characters

User supplied notes regarding the enquiry activity. Useful for communicating additional details about the activity with DBYD members.

is_dry_run
boolean

When true, the enquiry will not saved in the system.

Responses

Request samples

Content type
application/json
{
  • "project_name": "My Locate Project",
  • "user_reference": "LLJ.178.A",
  • "dig_start_at": "2020-08-08",
  • "dig_end_at": "2020-08-15",
  • "address": {
    },
  • "shape": {
    },
  • "notes": "Upgrading infrastructure.",
  • "is_dry_run": true
}

Response samples

Content type
application/json
{}