Documentation Powered by Redocly

Trap.NZ API (development)

Download OpenAPI specification:Download

API for Trap.NZ

Organisations

A top-level organisation on Trap.NZ

Get organisations

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_since_uuid
string <uuid>

Only return entities changed since this UUID, if the date is equal to changed_since.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get organisation

Authorizations:
trap_auth
path Parameters
organisationUUID
required
string <uuid> (Organisation UUID)

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "summary": "string",
  • "description": "string",
  • "meta": {
    }
}

Projects

A top-level project on Trap.NZ

Get projects

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_since_uuid
string <uuid>

Only return entities changed since this UUID, if the date is equal to changed_since.

organisation
string <uuid> (Organisation UUID)

Only return entities associated with this organisation.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

my_membership_state
any (My Membership State)
Enum: "active" "pending" "blocked" null

The current users membership state

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get project

Authorizations:
trap_auth
path Parameters
projectUUID
required
string <uuid> (Project UUID)

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "location": "string",
  • "tags": [
    ],
  • "is_listed": true,
  • "share_summary_data": true,
  • "curated": true,
  • "organisations": [
    ],
  • "contact": "string",
  • "contact_organisation": "string",
  • "description": "string",
  • "websites": [
    ],
  • "enabled_features": {
    },
  • "my_access": {
    },
  • "meta": {
    }
}

Lines

A line on Trap.NZ

Get lines

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_since_uuid
string <uuid>

Only return entities changed since this UUID, if the date is equal to changed_since.

organisation
string <uuid> (Organisation UUID)

Only return entities associated with this organisation.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

Array of Project UUID (strings) or string

Only return entities associated with one or more projects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new line under a project

Authorizations:
trap_auth
Request Body schema: application/json

Line to create for a project

name
required
string (Line Name)
required
object (Project)

The project this line belongs to

required
object (Line type)
colour
string (Colour) ^#[0-9A-Fa-f]{6}$

The colour to render the line

location
string <wkt> (Location)

The location of this line

uuid
string <uuid> (Line UUID)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "project": {
    },
  • "type": {
    },
  • "colour": "string",
  • "location": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "line": {
    }
}

Get line

Authorizations:
trap_auth
path Parameters
lineUUID
required
string <uuid> (Line UUID)

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "project": {
    },
  • "type": {
    },
  • "colour": "string",
  • "location": "string",
  • "meta": {
    }
}

Update line

Authorizations:
trap_auth
path Parameters
lineUUID
required
string <uuid> (Line UUID)
Request Body schema: application/json

Line to update

name
string (Line Name)
object (Line type)
colour
string (Colour) ^#[0-9A-Fa-f]{6}$

The colour to render the line

location
string <wkt> (Location)

The location of this line

object (Project)

The project this line belongs to

uuid
string <uuid> (Line UUID)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": {
    },
  • "colour": "string",
  • "location": "string",
  • "project": {
    },
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "line": {
    }
}

Delete line

Authorizations:
trap_auth
path Parameters
lineUUID
required
string <uuid> (Line UUID)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Traps

Traps kill or catch pests

Get traps

Get traps, ordered from least recently changed to most recently changed.

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_since_uuid
string <uuid>

Only return entities changed since this UUID, if the date is equal to changed_since.

organisation
string <uuid> (Organisation UUID)

Only return entities associated with this organisation.

project
string <uuid> (Project UUID)

Only return entities associated with this project.

line
string <uuid> (Line UUID)

Only return entities associated with this line.

date_installed_before
string <date-time>

Only return entities installed before this date.

date_installed_since
string <date-time>

Only return entities installed since this date.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create trap

Create a new trap

Authorizations:
trap_auth
header Parameters
App-Version
string (App Version)

The app version to record along with a commit ID.

Request Body schema: application/json
name
required
string (Trap Number / Code)
tags
Array of strings (Tags)
date_installed
required
string <date-time> (Date Installed)

The date of installation

installed_by
string (Installed By)

The name of the installer

required
object (Device model)

The type of this trap

object (Line)

The line this trap belongs to

required
object (Project)

The project this trap belongs to

location
required
string <wkt> (Location)

The location of this trap

notes
string (Notes)
Array of objects (Images)
is_retired
required
boolean (Is retired?)
sensor
object

The sensor of this trap (TODO)

object (Contact details)
weight
integer (Weight)

The sort weight for this trap within its line

commit_id
string (commitId)
uuid
string <uuid> (Trap UUID)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "tags": [
    ],
  • "date_installed": "2019-08-24T14:15:22Z",
  • "installed_by": "string",
  • "device_model": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": "string",
  • "notes": "string",
  • "images": [
    ],
  • "is_retired": true,
  • "sensor": { },
  • "contact": {
    },
  • "weight": 0,
  • "commit_id": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "tags": [
    ],
  • "date_installed": "2019-08-24T14:15:22Z",
  • "installed_by": "string",
  • "device_model": {
    },
  • "sensor": { },
  • "line": {
    },
  • "project": {
    },
  • "location": "string",
  • "weight": 0,
  • "images": [
    ],
  • "notes": "string",
  • "is_retired": true,
  • "contact": {
    },
  • "meta": {
    }
}

Get records

Get records, ordered from least recently changed to most recently changed.

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_since_uuid
string <uuid>

Only return entities changed since this UUID, if the date is equal to changed_since.

organisation
string <uuid> (Organisation UUID)

Only return entities associated with this organisation.

project
string <uuid> (Project UUID)

Only return entities associated with this project.

line
string <uuid> (Line UUID)

Only return entities associated with this line.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

trap
string <uuid> (Trap UUID)

Only return records associated with this trap.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create trap record

Create a new trap record

Authorizations:
trap_auth
header Parameters
App-Version
string (App Version)

The app version to record along with a commit ID.

Request Body schema: application/json
date
required
string <date-time> (Date of record)
recorded_by
string (Recorded By)

The name of the recorder

required
object or object or object
required
object (Catch)

The catch, if caught

relured
required
boolean (Relured)

Whether the trap was relured

required
Array of Lure (object) or Lure (object) (Relure)

The lures added, if relured

required
Trap Status (object) or Trap Status (object) (Trap Status)
condition
required
string (Condition)
Enum: "OK" "Needs maintenance" "Repaired" "Regassed" "Relured" "Battery charge"
strikes
required
integer (Strikes) >= 0

The number of strikes

Array of objects (Images)
notes
string (Notes)
commit_id
string (commitId)
uuid
string <uuid> (Record UUID)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24T14:15:22Z",
  • "recorded_by": "string",
  • "trap": {
    },
  • "catch": {
    },
  • "relured": true,
  • "relure": [
    ],
  • "status": {
    },
  • "condition": "OK",
  • "strikes": 0,
  • "images": [
    ],
  • "notes": "string",
  • "commit_id": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "date": "2019-08-24T14:15:22Z",
  • "recorded_by": "string",
  • "trap": {
    },
  • "catch": {
    },
  • "relured": true,
  • "relure": [
    ],
  • "status": {
    },
  • "condition": "OK",
  • "strikes": 0,
  • "images": [
    ],
  • "notes": "string",
  • "meta": {
    }
}

Points of Interest

Points of interest record extra information within a project

Get points of interest

Get points of interest, ordered from least recently changed to most recently changed.

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_since_uuid
string <uuid>

Only return entities changed since this UUID, if the date is equal to changed_since.

organisation
string <uuid> (Organisation UUID)

Only return entities associated with this organisation.

project
string <uuid> (Project UUID)

Only return entities associated with this project.

line
string <uuid> (Line UUID)

Only return entities associated with this line.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

projectNid
integer (Project Node Id)
Deprecated

Only return entities associated with this project.

active_at
string <date> (Active Date)

Only return points of interest active at this date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create point of interest

Create a new point of interest

Authorizations:
trap_auth
header Parameters
App-Version
string (App Version)

The app version to record along with a commit ID.

Request Body schema: application/json
name
required
string (Name)
Array of objects (Tags)
start_date
string <date> (Start Date)
end_date
string <date> (End Date)
POI type (object) or POI type (object)
Line (object) or Line (object)
required
Project (object) or Project (object)
location
required
string <wkt> (Location)

The location of this trap

colour
string (Colour) ^#[0-9A-Fa-f]{6}$

The colour to render the point of interest

weight
integer (Weight)

The sort weight for this point of interest within its line

Array of Image (object) or Image (object) (Images)
notes
string (Notes)
commit_id
string (commitId)
uuid
string <uuid> (Point of Interest UUID)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "tags": [
    ],
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "type": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": "string",
  • "colour": "string",
  • "weight": 0,
  • "images": [
    ],
  • "notes": "string",
  • "commit_id": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "tags": [
    ],
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "type": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": "string",
  • "colour": "string",
  • "weight": 0,
  • "images": [
    ],
  • "notes": "string",
  • "meta": {
    }
}

Get point of interest

Get a single point of interest

Authorizations:
trap_auth
path Parameters
pointOfInterestUUID
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "tags": [
    ],
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "type": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": "string",
  • "colour": "string",
  • "weight": 0,
  • "images": [
    ],
  • "notes": "string",
  • "meta": {
    }
}

Update point of interest

Update a single point of interest

Authorizations:
trap_auth
path Parameters
pointOfInterestUUID
required
string <uuid>
header Parameters
App-Version
string (App Version)

The app version to record along with a commit ID.

Request Body schema: application/json
name
string (Name)
start_date
string <date> (Start Date)
end_date
string <date> (End Date)
object (POI type)
object (Line)

The line this point of interest belongs to

location
string <wkt> (Location)

The location of this trap

colour
string (Colour) ^#[0-9A-Fa-f]{6}$

The colour to render the point of interest

weight
integer (Weight)

The sort weight for this point of interest within its line

Array of Image (object) or Image (object) (Images)
notes
string (Notes)
uuid
string <uuid> (Point of Interest UUID)
Array of objects (Tags)
object (Project)

The project this point of interest belongs to

object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "type": {
    },
  • "line": {
    },
  • "location": "string",
  • "colour": "string",
  • "weight": 0,
  • "images": [
    ],
  • "notes": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "tags": [
    ],
  • "project": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "tags": [
    ],
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "type": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": "string",
  • "colour": "string",
  • "weight": 0,
  • "images": [
    ],
  • "notes": "string",
  • "meta": {
    }
}

Get point of interest Deprecated

Get a single point of interest by its node id

Authorizations:
trap_auth
path Parameters
pointOfInterestNid
required
integer

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "tags": [
    ],
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "type": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": "string",
  • "colour": "string",
  • "weight": 0,
  • "images": [
    ],
  • "notes": "string",
  • "meta": {
    }
}

Update point of interest Deprecated

Update a single point of interest by its node id

Authorizations:
trap_auth
path Parameters
pointOfInterestNid
required
integer
header Parameters
App-Version
string (App Version)

The app version to record along with a commit ID.

Request Body schema: application/json
name
string (Name)
start_date
string <date> (Start Date)
end_date
string <date> (End Date)
object (POI type)
object (Line)

The line this point of interest belongs to

location
string <wkt> (Location)

The location of this trap

colour
string (Colour) ^#[0-9A-Fa-f]{6}$

The colour to render the point of interest

weight
integer (Weight)

The sort weight for this point of interest within its line

Array of Image (object) or Image (object) (Images)
notes
string (Notes)
uuid
string <uuid> (Point of Interest UUID)
Array of objects (Tags)
object (Project)

The project this point of interest belongs to

object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "type": {
    },
  • "line": {
    },
  • "location": "string",
  • "colour": "string",
  • "weight": 0,
  • "images": [
    ],
  • "notes": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "tags": [
    ],
  • "project": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "tags": [
    ],
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "type": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": "string",
  • "colour": "string",
  • "weight": 0,
  • "images": [
    ],
  • "notes": "string",
  • "meta": {
    }
}

Get point of interest records

Get point of interest records, ordered from least recently changed to most recently changed.

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_since_uuid
string <uuid>

Only return entities changed since this UUID, if the date is equal to changed_since.

organisation
string <uuid> (Organisation UUID)

Only return entities associated with this organisation.

project
string <uuid> (Project UUID)

Only return entities associated with this project.

line
string <uuid> (Line UUID)

Only return entities associated with this line.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

pointOfInterest
string <uuid> (Point of Interest UUID)

Only return records associated with this point of interest.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a point of interest record

Create a new record at a point of interest

Authorizations:
trap_auth
header Parameters
App-Version
string (App Version)

The app version to record along with a commit ID.

Request Body schema: application/json
required
Point of Interest (object) or Point of Interest (object)
Array of objects (Tags)
ISO String (string) or ISO String (object) or Seconds since Epoch (object) (Date)
notes
string (Notes)
Array of Image (object) or Image (object) (Images)
commit_id
string (commitId)
uuid
string <uuid> (Point of Interest Record UUID)
name
string (Name)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "pointOfInterest": {
    },
  • "tags": [
    ],
  • "date": null,
  • "notes": "string",
  • "images": [
    ],
  • "commit_id": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "pointOfInterest": {
    },
  • "tags": [
    ],
  • "date": null,
  • "notes": "string",
  • "images": [
    ],
  • "meta": {
    }
}

Get point of interest record

Get a single point of interest record

Authorizations:
trap_auth
path Parameters
pointOfInterestRecordUUID
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "pointOfInterest": {
    },
  • "tags": [
    ],
  • "date": null,
  • "notes": "string",
  • "images": [
    ],
  • "meta": {
    }
}

Update point of interest record

Update a single point of interest record

Authorizations:
trap_auth
path Parameters
pointOfInterestRecordUUID
required
string <uuid>
header Parameters
App-Version
string (App Version)

The app version to record along with a commit ID.

Request Body schema: application/json
Array of objects (Tags)
ISO String (string) or ISO String (object) or Seconds since Epoch (object) (Date)
notes
string (Notes)
Array of Image (object) or Image (object) (Images)
commit_id
string (commitId)
uuid
string <uuid> (Point of Interest Record UUID)
name
string (Name)
object (Point of Interest)

The point of interest this record belongs to

object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "date": null,
  • "notes": "string",
  • "images": [
    ],
  • "commit_id": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "pointOfInterest": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "pointOfInterest": {
    },
  • "tags": [
    ],
  • "date": null,
  • "notes": "string",
  • "images": [
    ],
  • "meta": {
    }
}

Sensors

Sensors and sensor records

Get sensor records

Get sensor records, ordered from least recently changed to most recently changed.

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_since_uuid
string <uuid>

Only return entities changed since this UUID, if the date is equal to changed_since.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Post a sensor record

Authorizations:
trap_auth
Request Body schema: application/json
sensor_id
required
string (Sensor ID)

The ID of the sensor (unique per sensor provider)

required
ISO String (string) or ISO String (object) or Seconds since Epoch (object) (Date of record)

The date and time of the sensor event

event
required
string (Event)
Enum: "Sprung" "Set" "Vibration" "Heartbeat" "Baitlevel"

The type of event for this record

status
string (Status)
Enum: "Sprung" "Set" "Baitlevel"

The status of the device

network
string (Network)

The name or ID of the network the device is connected to

gateway
string (Gateway)

IP address of the network gateway the device is connected to

rssi
integer (RSSI)

Wireless network Received Signal Strength Indicator

sequence
integer (Sequence)

A total count of transmissions sent according to the device

counter
integer (Counter)

A device-specific counter such as the number of times a trigger has sprung

battery_voltage
number (Battery voltage)

The current measured battery voltage

snr
number (Signal to noise ratio)

(decibels)

timeout
integer (Timeout)

Heartbeat interval (seconds). Alternatively -1 (no timeout) or 0: (expired)

bait_level
number (Bait level)

The measured level of the remaining bait

temperature
number (Temperature)

Degrees Celsius

humidity
number (Humidity)

Relative humidity (%)

tilt_angle
number (Tilt angle)

Single-axis gyroscopic tilt (degrees)

bump
boolean (Bump detection)

Bump, shock or rapid accelerometer detection

pir_count
integer (PIR count)

Count of infrared motion detections (since last record)

extra
string (Extra info) <= 255 characters

Extra data, info or debugging not captured by the official fields

uuid
string <uuid> (Sensor record UUID)
user_uuid
string <uuid> (User UUID)

Reference to the trap.nz user ID of the authenticated account

provider
string (Sensor provider)

The ID of the sensor provider associated with the authenticated account

submissionDate
any (Date of submission)

Date at which the record was submitted to Trap.NZ

Responses

Request samples

Content type
application/json
{
  • "sensor_id": "string",
  • "date": null,
  • "event": "Sprung",
  • "status": "Sprung",
  • "network": "string",
  • "gateway": "string",
  • "rssi": 0,
  • "sequence": 0,
  • "counter": 0,
  • "battery_voltage": 0,
  • "snr": 0,
  • "timeout": 0,
  • "bait_level": 0,
  • "temperature": 0,
  • "humidity": 0,
  • "tilt_angle": 0,
  • "bump": true,
  • "pir_count": 0,
  • "extra": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f",
  • "provider": "string",
  • "submissionDate": null
}

Response samples

Content type
application/json
"string"

Get sensor record

Get a single sensor record

Authorizations:
trap_auth
path Parameters
sensorRecordUUID
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f",
  • "provider": "string",
  • "sensor_id": "string",
  • "date": null,
  • "submissionDate": null,
  • "event": "Sprung",
  • "status": "Sprung",
  • "network": "string",
  • "gateway": "string",
  • "rssi": 0,
  • "sequence": 0,
  • "counter": 0,
  • "battery_voltage": 0,
  • "snr": 0,
  • "timeout": 0,
  • "bait_level": 0,
  • "temperature": 0,
  • "humidity": 0,
  • "tilt_angle": 0,
  • "bump": true,
  • "pir_count": 0,
  • "extra": "string",
  • "meta": null
}

Get sensors

Authorizations:
trap_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get sensor

Authorizations:
trap_auth
path Parameters
sensorProvider
required
string
sensorID
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "provider": "string",
  • "installation": {
    },
  • "meta": { }
}

Auth

Endpoints related to auth

Request access token

Authorizations:
Request Body schema: application/json
One of
grant_type
required
string
Value: "password"
scope
string
Value: "default"
username
required
string
password
required
string <password>
client_id
required
string
client_secret
string <password>

Responses

Request samples

Content type
application/json
Example
{
  • "grant_type": "password",
  • "scope": "default",
  • "username": "string",
  • "password": "pa$$word",
  • "client_id": "string",
  • "client_secret": "pa$$word"
}

Response samples

Content type
application/json
{
  • "access_token": "pa$$word",
  • "refresh_token": "pa$$word",
  • "token_type": "Bearer",
  • "scope": "default",
  • "expires_in": "string"
}

Users

Endpoints related to users

Get current user

Authorizations:
trap_auth

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "username": "string",
  • "common_name": "string",
  • "email": "[email protected]",
  • "meta": {
    }
}

Deployment Markers

Endpoints related to deployment markers

Get deployment markers by project

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_since_uuid
string <uuid>

Only return entities changed since this UUID, if the date is equal to changed_since.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

project
required
string <uuid> (Project UUID)

Only return entities associated with this project.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new deployment marker under a project

Authorizations:
trap_auth
Request Body schema: application/json

Deployment to create for a project

name
string (Deployment Marker Name)
planned_installation_type
required
string (Planned Installation Type)
Enum: "trap" "bait_station" "monitoring_station"
planned_install_term_uuid
required
string <uuid> (Planned install term)

The term that describes the planned install detail or subtype (e.g. trap type or monitoring station type).

deployment_state
string (Deployment State)
Enum: "planned" "in_progress" "approved" "installed" "declined"
project_uuid
required
string <uuid> (Project)

The project which this deployment belongs to

line_uuid
string <uuid> (Line)

The line this deployment is associated with

location
required
string <wkt> (WKT Polygon)
notes
string (Notes)

General notes about this deployment marker

photos
Array of strings <uuid> (Photos)
uuid
string <uuid> (Deployment Marker UUID)
object (Metadata)
line
string (Line)

The name of the line this deployment is associated with

installation_uuid
string <uuid> (Installation)

Reference ID of the actual installed item

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "planned_installation_type": "trap",
  • "planned_install_term_uuid": "eacf8cd1-316c-42f2-84cf-8a3c396f6928",
  • "deployment_state": "planned",
  • "project_uuid": "1de37675-f868-4726-bb1d-b08d89f463f9",
  • "line_uuid": "9e7574fe-bdba-45e4-a7ea-861287f5a8c6",
  • "location": "string",
  • "notes": "string",
  • "photos": [
    ],
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "meta": {
    },
  • "line": "string",
  • "installation_uuid": "ae0baaae-4d83-4a10-88b5-16662b772857"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "deployment_marker": {
    }
}

Create multiple deployment markers

Authorizations:
trap_auth
Request Body schema: application/json

Deployments to create

Array
name
string (Deployment Marker Name)
planned_installation_type
required
string (Planned Installation Type)
Enum: "trap" "bait_station" "monitoring_station"
planned_install_term_uuid
required
string <uuid> (Planned install term)

The term that describes the planned install detail or subtype (e.g. trap type or monitoring station type).

deployment_state
string (Deployment State)
Enum: "planned" "in_progress" "approved" "installed" "declined"
project_uuid
required
string <uuid> (Project)

The project which this deployment belongs to

line_uuid
string <uuid> (Line)

The line this deployment is associated with

location
required
string <wkt> (WKT Polygon)
notes
string (Notes)

General notes about this deployment marker

uuid
string <uuid> (Deployment Marker UUID)
object (Metadata)
line
string (Line)

The name of the line this deployment is associated with

installation_uuid
string <uuid> (Installation)

Reference ID of the actual installed item

photos
Array of strings <uuid> (Photos)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "deployment_markers": [
    ]
}

Update multiple deployment markers

Authorizations:
trap_auth
Request Body schema: application/json

Deployments to update

Array
name
string (Deployment Marker Name)
planned_installation_type
string (Planned Installation Type)
Enum: "trap" "bait_station" "monitoring_station"
planned_install_term_uuid
string <uuid> (Planned install term)

The term that describes the planned install detail or subtype (e.g. trap type or monitoring station type).

deployment_state
string (Deployment State)
Enum: "planned" "in_progress" "approved" "installed" "declined"
line_uuid
string <uuid> (Line)

The line this deployment is associated with

installation_uuid
string <uuid> (Installation)

Reference ID of the actual installed item

location
string <wkt> (WKT Polygon)
uuid
required
string <uuid> (Deployment Marker UUID)
notes
string (Notes)

General notes about this deployment marker

photos
Array of strings <uuid> (Photos)
object (Metadata)
project_uuid
string <uuid> (Project)

The project which this deployment belongs to

line
string (Line)

The name of the line this deployment is associated with

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "deployment_markers": [
    ]
}

Delete multiple deployment markers

Authorizations:
trap_auth
Request Body schema: application/json

Deployments to delete

Array
string <uuid>

Responses

Request samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "deployment_markers": [
    ]
}

Get deployment

Authorizations:
trap_auth
path Parameters
deploymentMarkerUUID
required
string <uuid> (Deployment Marker UUID)

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "planned_installation_type": "trap",
  • "planned_install_term_uuid": "eacf8cd1-316c-42f2-84cf-8a3c396f6928",
  • "deployment_state": "planned",
  • "project_uuid": "1de37675-f868-4726-bb1d-b08d89f463f9",
  • "line_uuid": "9e7574fe-bdba-45e4-a7ea-861287f5a8c6",
  • "line": "string",
  • "installation_uuid": "ae0baaae-4d83-4a10-88b5-16662b772857",
  • "location": "string",
  • "notes": "string",
  • "photos": [
    ],
  • "meta": {
    }
}

Update deployment

Authorizations:
trap_auth
path Parameters
deploymentMarkerUUID
required
string <uuid> (Deployment Marker UUID)
Request Body schema: application/json

Deployment marker to update

name
string (Deployment Marker Name)
planned_installation_type
string (Planned Installation Type)
Enum: "trap" "bait_station" "monitoring_station"
planned_install_term_uuid
string <uuid> (Planned install term)

The term that describes the planned install detail or subtype (e.g. trap type or monitoring station type).

deployment_state
string (Deployment State)
Enum: "planned" "in_progress" "approved" "installed" "declined"
line_uuid
string <uuid> (Line)

The line this deployment is associated with

installation_uuid
string <uuid> (Installation)

Reference ID of the actual installed item

location
string <wkt> (WKT Polygon)
notes
string (Notes)

General notes about this deployment marker

photos
Array of strings <uuid> (Photos)
uuid
string <uuid> (Deployment Marker UUID)
object (Metadata)
project_uuid
string <uuid> (Project)

The project which this deployment belongs to

line
string (Line)

The name of the line this deployment is associated with

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "planned_installation_type": "trap",
  • "planned_install_term_uuid": "eacf8cd1-316c-42f2-84cf-8a3c396f6928",
  • "deployment_state": "planned",
  • "line_uuid": "9e7574fe-bdba-45e4-a7ea-861287f5a8c6",
  • "installation_uuid": "ae0baaae-4d83-4a10-88b5-16662b772857",
  • "location": "string",
  • "notes": "string",
  • "photos": [
    ],
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "meta": {
    },
  • "project_uuid": "1de37675-f868-4726-bb1d-b08d89f463f9",
  • "line": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "deployment_marker": {
    }
}

Delete deployment

Authorizations:
trap_auth
path Parameters
deploymentMarkerUUID
required
string <uuid> (Deployment Marker UUID)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Bait Stations

Get bait stations

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_since_uuid
string <uuid>

Only return entities changed since this UUID, if the date is equal to changed_since.

organisation
string <uuid> (Organisation UUID)

Only return entities associated with this organisation.

is_retired
boolean (Retired state)

The entities retired state

date_installed_before
string <date-time>

Only return entities installed before this date.

date_installed_since
string <date-time>

Only return entities installed since this date.

Array of Project UUID (strings) or string

Only return entities associated with one or more projects.

Array of Line UUID (strings) or string

Only return entities associated with one or more lines.

projectNid
integer (Project Node Id)
Deprecated

Only return entities associated with this project.

has_sensor
boolean

Only return entities if they have (true) or don't have (false) a sensor configured.

can_edit
boolean

Only return entities if the requesting user can (true) or can't (false) edit them. To "edit" includes the action of creating an associated record.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create bait station

Create a new bait station

Authorizations:
trap_auth
header Parameters
App-Version
string (App Version)

The app version to record along with a commit ID.

Request Body schema: application/json
name
required
string (Name)
Array of objects (Tags)
date_installed
required
string <date-time> (Date Installed)

The date of installation

installed_by
string (Installed By)

The name of the installer

required
Device model (object) or Device model (object)
object (Line)

The line this bait station belongs to

required
object (Project)

The project this bait station belongs to

required
object (Location)

The location of this bait station, as GeoJSON

notes
string (Notes)
Array of Image (object) or Image (object) (Images)
is_retired
required
boolean (Is retired?)
object (Sensor)
object (Contact details)
weight
integer (Weight)

The sort weight for this bait station within its line

commit_id
string (commitId)
uuid
string <uuid> (Bait Station UUID)
object (Last Record)

A bait station record

object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "tags": [
    ],
  • "date_installed": "2019-08-24T14:15:22Z",
  • "installed_by": "string",
  • "device_model": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": {
    },
  • "notes": "string",
  • "images": [
    ],
  • "is_retired": true,
  • "sensor": {
    },
  • "contact": {
    },
  • "weight": 0,
  • "commit_id": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "last_record": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "tags": [
    ],
  • "date_installed": "2019-08-24T14:15:22Z",
  • "installed_by": "string",
  • "device_model": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": {
    },
  • "notes": "string",
  • "images": [
    ],
  • "is_retired": true,
  • "sensor": {
    },
  • "contact": {
    },
  • "weight": 0,
  • "last_record": {
    },
  • "meta": {
    }
}

Get bait station

Get a single bait station

Authorizations:
trap_auth
path Parameters
baitStationUUID
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "tags": [
    ],
  • "date_installed": "2019-08-24T14:15:22Z",
  • "installed_by": "string",
  • "device_model": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": {
    },
  • "notes": "string",
  • "images": [
    ],
  • "is_retired": true,
  • "sensor": {
    },
  • "contact": {
    },
  • "weight": 0,
  • "last_record": {
    },
  • "meta": {
    }
}

Update bait station

Update a single bait station

Authorizations:
trap_auth
path Parameters
baitStationUUID
required
string <uuid>
header Parameters
App-Version
string (App Version)

The app version to record along with a commit ID.

Request Body schema: application/json
name
string (Name)
date_installed
string <date-time> (Date Installed)

The date of installation

installed_by
string (Installed By)

The name of the installer

Device model (object) or Device model (object)
object (Line)

The line this bait station belongs to

object (Location)

The location of this bait station, as GeoJSON

notes
string (Notes)
Array of Image (object) or Image (object) (Images)
is_retired
boolean (Is retired?)
object (Sensor)
object (Contact details)
weight
integer (Weight)

The sort weight for this bait station within its line

uuid
string <uuid> (Bait Station UUID)
Array of objects (Tags)
object (Project)

The project this bait station belongs to

object (Last Record)

A bait station record

object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "date_installed": "2019-08-24T14:15:22Z",
  • "installed_by": "string",
  • "device_model": {
    },
  • "line": {
    },
  • "location": {
    },
  • "notes": "string",
  • "images": [
    ],
  • "is_retired": true,
  • "sensor": {
    },
  • "contact": {
    },
  • "weight": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "tags": [
    ],
  • "project": {
    },
  • "last_record": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "tags": [
    ],
  • "date_installed": "2019-08-24T14:15:22Z",
  • "installed_by": "string",
  • "device_model": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": {
    },
  • "notes": "string",
  • "images": [
    ],
  • "is_retired": true,
  • "sensor": {
    },
  • "contact": {
    },
  • "weight": 0,
  • "last_record": {
    },
  • "meta": {
    }
}

Get bait station records

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_before
string <date-time>

Only return entities changed before this date.

changed_since_uuid
string <uuid>

Only return entities changed since this UUID, if the date is equal to changed_since.

organisation
string <uuid> (Organisation UUID)

Only return entities associated with this organisation.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

offset
integer >= 0
Default: 0

Offset the page returned by this many records

sort_order
string
Default: "asc"
Enum: "asc" "desc"

provide a sort order / direction

is_retired
boolean (Retired state)

The entities retired state

Array of Project UUID (strings) or Project UUID (string) (Project UUID)

Only return entities associated with one or more projects.

Array of Line UUID (strings) or Line UUID (string) (Line UUID)

Only return entities associated with one or more lines.

Array of Species detected (strings) or string

Only return entities associated with one or more species detected.

Array of Active Ingredients (strings) or string

Only return entities associated with one or more active_ingredients.

Array of Target species (strings) or string

Only return entities associated with one or more target species.

Array of Formulations (strings) or string

Only return entities associated with one or more formulations.

sort_column
string
Default: "changed"
Enum: "nid" "uuid" "created" "changed" "bait_station_name" "bait_station_nid" "bait_station_uuid" "date" "recorded_by" "active_ingredient" "target_species" "species_detected" "formulation" "concentration" "bait_remaining" "bait_removed" "bait_added" "notes" "images"

provide a field to sort by

bait_station
string <uuid> (Bait Station UUID)

Only return records associated with this bait station.

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "items": [
    ]
}

Create bait station record

Create a new bait station record

Authorizations:
trap_auth
header Parameters
App-Version
string (App Version)

The app version to record along with a commit ID.

Request Body schema: application/json
required
object (Bait Station)

The bait station this record belongs to

date
required
string <date-time> (Date of record)
recorded_by
string (Recorded By)

The name of the recorder

active_ingredient
required
string (Active Ingredient)
target_species
required
string (Target Species)
Array of Species (object) or Species (object)
formulation
required
string (Formulation)
concentration
required
number (Concentration)
bait_remaining
required
number (Bait Remaining (kg))
bait_removed
number (Bait Removed (kg))
bait_added
number (Bait Added (kg))
notes
string (Notes)
Array of objects (Images)
commit_id
string (commitId)
uuid
string <uuid> (Bait Station Record UUID)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "bait_station": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "recorded_by": "string",
  • "active_ingredient": "string",
  • "target_species": "string",
  • "species_detected": [
    ],
  • "formulation": "string",
  • "concentration": 0,
  • "bait_remaining": 0,
  • "bait_removed": 0,
  • "bait_added": 0,
  • "notes": "string",
  • "images": [
    ],
  • "commit_id": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "bait_station": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "recorded_by": "string",
  • "active_ingredient": "string",
  • "target_species": "string",
  • "species_detected": [
    ],
  • "formulation": "string",
  • "concentration": 0,
  • "bait_remaining": 0,
  • "bait_removed": 0,
  • "bait_added": 0,
  • "notes": "string",
  • "images": [
    ],
  • "meta": {
    }
}

Get bait station record

Get a single bait station record

Authorizations:
trap_auth
path Parameters
baitStationRecordUUID
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "bait_station": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "recorded_by": "string",
  • "active_ingredient": "string",
  • "target_species": "string",
  • "species_detected": [
    ],
  • "formulation": "string",
  • "concentration": 0,
  • "bait_remaining": 0,
  • "bait_removed": 0,
  • "bait_added": 0,
  • "notes": "string",
  • "images": [
    ],
  • "meta": {
    }
}

Update bait station record

Update a single bait station record

Authorizations:
trap_auth
path Parameters
baitStationRecordUUID
required
string <uuid>
header Parameters
App-Version
string (App Version)

The app version to record along with a commit ID.

Request Body schema: application/json
date
required
string <date-time> (Date of record)
recorded_by
string (Recorded By)

The name of the recorder

active_ingredient
required
string (Active Ingredient)
target_species
required
string (Target Species)
Array of Species (object) or Species (object)
formulation
required
string (Formulation)
concentration
required
number (Concentration)
bait_remaining
required
number (Bait Remaining (kg))
bait_removed
number (Bait Removed (kg))
bait_added
number (Bait Added (kg))
notes
string (Notes)
Array of objects (Images)
uuid
string <uuid> (Bait Station Record UUID)
object (Bait Station)

The bait station this record belongs to

object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24T14:15:22Z",
  • "recorded_by": "string",
  • "active_ingredient": "string",
  • "target_species": "string",
  • "species_detected": [
    ],
  • "formulation": "string",
  • "concentration": 0,
  • "bait_remaining": 0,
  • "bait_removed": 0,
  • "bait_added": 0,
  • "notes": "string",
  • "images": [
    ],
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "bait_station": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "bait_station": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "recorded_by": "string",
  • "active_ingredient": "string",
  • "target_species": "string",
  • "species_detected": [
    ],
  • "formulation": "string",
  • "concentration": 0,
  • "bait_remaining": 0,
  • "bait_removed": 0,
  • "bait_added": 0,
  • "notes": "string",
  • "images": [
    ],
  • "meta": {
    }
}

Bait Stations Species Detected

Get bait station records species detected

Authorizations:
trap_auth
query Parameters
Array of Project UUID (strings) or Project UUID (string) (Project UUID)

Only return entities associated with one or more projects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bait Stations Formulations

Get bait station records formulations

Authorizations:
trap_auth
query Parameters
Array of Project UUID (strings) or Project UUID (string) (Project UUID)

Only return entities associated with one or more projects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bait Stations Active Ingredients

Get bait station records active ingredients

Authorizations:
trap_auth
query Parameters
Array of Project UUID (strings) or Project UUID (string) (Project UUID)

Only return entities associated with one or more projects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bait Stations Target Species

Get bait station records target species

Authorizations:
trap_auth
query Parameters
Array of Project UUID (strings) or Project UUID (string) (Project UUID)

Only return entities associated with one or more projects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Monitoring Stations

Get monitoring stations

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_since_uuid
string <uuid>

Only return entities changed since this UUID, if the date is equal to changed_since.

organisation
string <uuid> (Organisation UUID)

Only return entities associated with this organisation.

project
string <uuid> (Project UUID)

Only return entities associated with this project.

date_installed_before
string <date-time>

Only return entities installed before this date.

date_installed_since
string <date-time>

Only return entities installed since this date.

projectNid
integer (Project Node Id)
Deprecated

Only return entities associated with this project.

line
string <uuid> (Line UUID)

Only return entities associated with this line.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create monitoring station

Create a new monitoring station

Authorizations:
trap_auth
header Parameters
App-Version
string (App Version)

The app version to record along with a commit ID.

Request Body schema: application/json
name
required
string (Name)
Array of objects (Tags)
date_installed
required
string <date-time> (Date Installed)

The date of installation

installed_by
string (Installed By)

The name of the installer

required
Device model (object) or Device model (object)
object (Line)

The line this monitoring station belongs to

required
object (Project)

The project this monitoring station belongs to

required
object (Location)

The location of this monitoring station, as GeoJSON

notes
string (Notes)
Array of objects (Images)
is_retired
required
boolean (Is retired?)
object (Contact details)
weight
integer (Weight)

The sort weight for this monitoring station within its line

commit_id
string (commitId)
uuid
string <uuid> (Monitoring Station UUID)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "tags": [
    ],
  • "date_installed": "2019-08-24T14:15:22Z",
  • "installed_by": "string",
  • "device_model": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": {
    },
  • "notes": "string",
  • "images": [
    ],
  • "is_retired": true,
  • "contact": {
    },
  • "weight": 0,
  • "commit_id": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "tags": [
    ],
  • "date_installed": "2019-08-24T14:15:22Z",
  • "installed_by": "string",
  • "device_model": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": {
    },
  • "notes": "string",
  • "images": [
    ],
  • "is_retired": true,
  • "contact": {
    },
  • "weight": 0,
  • "last_record": null,
  • "meta": {
    }
}

Get monitoring station

Get a single monitoring station

Authorizations:
trap_auth
path Parameters
monitoringStationUUID
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "tags": [
    ],
  • "date_installed": "2019-08-24T14:15:22Z",
  • "installed_by": "string",
  • "device_model": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": {
    },
  • "notes": "string",
  • "images": [
    ],
  • "is_retired": true,
  • "contact": {
    },
  • "weight": 0,
  • "last_record": null,
  • "meta": {
    }
}

Update monitoring station

Update a single monitoring station

Authorizations:
trap_auth
path Parameters
monitoringStationUUID
required
string <uuid>
header Parameters
App-Version
string (App Version)

The app version to record along with a commit ID.

Request Body schema: application/json
name
string (Name)
date_installed
string <date-time> (Date Installed)

The date of installation

installed_by
string (Installed By)

The name of the installer

Device model (object) or Device model (object)
object (Line)

The line this monitoring station belongs to

object (Location)

The location of this monitoring station, as GeoJSON

notes
string (Notes)
Array of objects (Images)
is_retired
boolean (Is retired?)
object (Contact details)
weight
integer (Weight)

The sort weight for this monitoring station within its line

uuid
string <uuid> (Monitoring Station UUID)
Array of objects (Tags)
object (Project)

The project this monitoring station belongs to

object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "date_installed": "2019-08-24T14:15:22Z",
  • "installed_by": "string",
  • "device_model": {
    },
  • "line": {
    },
  • "location": {
    },
  • "notes": "string",
  • "images": [
    ],
  • "is_retired": true,
  • "contact": {
    },
  • "weight": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "tags": [
    ],
  • "project": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "tags": [
    ],
  • "date_installed": "2019-08-24T14:15:22Z",
  • "installed_by": "string",
  • "device_model": {
    },
  • "line": {
    },
  • "project": {
    },
  • "location": {
    },
  • "notes": "string",
  • "images": [
    ],
  • "is_retired": true,
  • "contact": {
    },
  • "weight": 0,
  • "last_record": null,
  • "meta": {
    }
}

Terms

Get global term values for a given vocab machine name

Authorizations:
trap_auth
query Parameters
vocabulary
string (vocabulary machine name)
Enum: "bait_active_ingredient" "bait_formulation" "bait_station_type" "bait_target_species" "bird_species" "line_type" "region" "regional_districts" "trap_species_caught" "trap_sensor_provider" "trap_status" "trap_type"

Only return terms associated with a given vocabulary machine name. Logic for this list is these are the only vocabularies that are likely to be used in the UI and reporting.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get terms for a given projectUUID and vocab machine name

Authorizations:
trap_auth
path Parameters
projectUUID
required
string <uuid> (Project UUID)
query Parameters
vocabulary
string (vocabulary machine name)
Enum: "bait_station_species_detected" "monitoring_bait" "monitoring_protocol" "monitoring_species" "monitoring_survey_event" "monitoring_type" "poi_type" "project_record_type" "trap_bait_type"

Only return terms associated with a given vocabulary machine name.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Areas

Get work areas by project

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_since_uuid
string <uuid>

Only return entities changed since this UUID, if the date is equal to changed_since.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

Array of Project UUID (strings) or Project UUID (string) (Project UUID)

Only return entities associated with one or more projects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new area under a project

Authorizations:
trap_auth
Request Body schema: application/json

Work Area to create for a project

name
string (Work Area Name)
project_uuid
required
string <uuid> (Project)

The project which this area belongs to

boundary
required
string <wkt> (WKT Polygon)
review_date
string <date-time> (Work Area review date)
notes
string (Work Area notes)
object (Metadata)
uuid
string <uuid> (Work Area UUID)
approval_state
string (Approval status)
Enum: "approved" "declined" "pending" "in_progress"

One of the possible approval states (approved, declined, pending - no approval record exists , in_progress - approval record exists but is not yet approved or declined)

approved
boolean (Work Area approved status)
approval_uuid
string <uuid> (Work Area approval UUID)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "project_uuid": "1de37675-f868-4726-bb1d-b08d89f463f9",
  • "boundary": "string",
  • "review_date": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "meta": {
    },
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "approval_state": "approved",
  • "approved": true,
  • "approval_uuid": "d657dcda-a61d-431e-b8b3-61cdd09ef609"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "area": {
    }
}

Get area

Authorizations:
trap_auth
path Parameters
areaUUID
required
string <uuid> (Work Area UUID)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "project_uuid": "1de37675-f868-4726-bb1d-b08d89f463f9",
  • "boundary": "string",
  • "approved": true,
  • "approval_uuid": "d657dcda-a61d-431e-b8b3-61cdd09ef609",
  • "approval_state": "approved",
  • "review_date": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "meta": {
    }
}

Update area

Authorizations:
trap_auth
path Parameters
areaUUID
required
string <uuid> (Work Area UUID)
Request Body schema: application/json

Work Area to update

name
string (Work Area Name)
boundary
string <wkt> (WKT Polygon)
review_date
string <date-time> (Work Area review date)
notes
string (Work Area notes)
uuid
string <uuid> (Work Area UUID)
project_uuid
string <uuid> (Project)

The project which this area belongs to

approval_state
string (Approval status)
Enum: "approved" "declined" "pending" "in_progress"

One of the possible approval states (approved, declined, pending - no approval record exists , in_progress - approval record exists but is not yet approved or declined)

approved
boolean (Work Area approved status)
approval_uuid
string <uuid> (Work Area approval UUID)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "boundary": "string",
  • "review_date": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "project_uuid": "1de37675-f868-4726-bb1d-b08d89f463f9",
  • "approval_state": "approved",
  • "approved": true,
  • "approval_uuid": "d657dcda-a61d-431e-b8b3-61cdd09ef609",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "area": {
    }
}

Delete area

Authorizations:
trap_auth
path Parameters
areaUUID
required
string <uuid> (Work Area UUID)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Approvals

Get approvals by project

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_since_uuid
string <uuid>

Only return entities changed since this UUID, if the date is equal to changed_since.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

Array of Project UUID (strings) or Project UUID (string) (Project UUID)

Only return entities associated with one or more projects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new approval under a project

Authorizations:
trap_auth
Request Body schema: application/json

Approval to create for a project

area_uuid
required
string <uuid> (Area)

The area which this approval belongs to

project_uuid
required
string <uuid> (Project)

The project which this approval belongs to

owner_trap_servicing
boolean (Owner trap/install servicing)

Owner will take care of trap/installation servicing

owner_app_usage
boolean (Owner app usage)

Owner will use mobile app

owner_website_usage
boolean (Owner website usage)

Owner will use website

allow_mechanical_traps
boolean (Allow mechanical traps)

Permission to use mechanical traps

allow_camera_traps
boolean (Allow camera traps)

Permission to use camera traps

allow_toxins
boolean (Allow toxins)

Permission to use toxins

allow_radio_transmission
boolean (Allow radio transmissions)

Permission to use trap sensors/transmitters on installations

object (Owner contact phone) non-empty
household_bait_allergy_present
boolean (Bait allergy present in household)

Bait allergy present in household, e.g. use of nut butters in lure/bait is not accepted.

household_bait_allergy_description
string (Bait allergy site description/notes)

Bait allergy site description/notes, type of bait, reaction likelihood etc

dog_onsite
any
dog_onsite_description
any
please_knock_on_door
boolean (Please knock on the door)

On each site visit, does the owner want us to knock on the door to announce our arrival?

heard_of_project_beforehand
any
approval_date
string <date-time> (Approval date)

Date of approval

owner_contact_email
string <email> (Owner contact email)

Owners contact email address

owner_first_names
required
string (Owner first names)

Owners first names

owner_surname
required
string (Owner surname)

Owners surname

potential_hazards
string (Potential Hazards)

Potential hazards onsite

access_security_details
string (Access security details)

Security details for access onsite

street_address
required
string (Street Address)

Address for accessing site

signed_approval
string <byte> (Signed approval)

byte (which is the standard format for a base64 encoded string) array - enforce file size below below 1000KB

approved
boolean (Approved status)

Has the owner explicitly approved this

owner_comms_preference
string (Owner communication preference)

Owner communication preference (email, phone, other?)

notes
string (Notes)

Other notes relating to site and approval (caveats etc)

uuid
string <uuid> (Approval UUID)
object (Metadata)
dog_on_site
boolean (Dog on site)

Dog on site

dog_on_site_description
string (Dog on site description/notes)

Dog on site description/notes, type of dog, whereabouts, how aggressive etc.

heard_of_project_before_hand
boolean (heard of project before this engagement)

Has the owner heard of this project before

Responses

Request samples

Content type
application/json
{
  • "area_uuid": "23f67669-918a-4ed0-bb44-b0229619d79c",
  • "project_uuid": "1de37675-f868-4726-bb1d-b08d89f463f9",
  • "owner_trap_servicing": true,
  • "owner_app_usage": true,
  • "owner_website_usage": true,
  • "allow_mechanical_traps": true,
  • "allow_camera_traps": true,
  • "allow_toxins": true,
  • "allow_radio_transmission": true,
  • "owner_contact_phone": {
    },
  • "household_bait_allergy_present": true,
  • "household_bait_allergy_description": "string",
  • "dog_onsite": null,
  • "dog_onsite_description": null,
  • "please_knock_on_door": true,
  • "heard_of_project_beforehand": null,
  • "approval_date": "2019-08-24T14:15:22Z",
  • "owner_contact_email": "[email protected]",
  • "owner_first_names": "string",
  • "owner_surname": "string",
  • "potential_hazards": "string",
  • "access_security_details": "string",
  • "street_address": "string",
  • "signed_approval": "string",
  • "approved": true,
  • "owner_comms_preference": "string",
  • "notes": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "meta": {
    },
  • "dog_on_site": true,
  • "dog_on_site_description": "string",
  • "heard_of_project_before_hand": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "approval": {
    }
}

Get approval

Authorizations:
trap_auth
path Parameters
approvalUUID
required
string <uuid> (Approval UUID)

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "area_uuid": "23f67669-918a-4ed0-bb44-b0229619d79c",
  • "project_uuid": "1de37675-f868-4726-bb1d-b08d89f463f9",
  • "owner_trap_servicing": true,
  • "owner_app_usage": true,
  • "owner_website_usage": true,
  • "allow_mechanical_traps": true,
  • "allow_camera_traps": true,
  • "allow_toxins": true,
  • "allow_radio_transmission": true,
  • "owner_contact_phone": {
    },
  • "household_bait_allergy_present": true,
  • "household_bait_allergy_description": "string",
  • "dog_onsite": null,
  • "dog_onsite_description": null,
  • "please_knock_on_door": true,
  • "heard_of_project_beforehand": null,
  • "approval_date": "2019-08-24T14:15:22Z",
  • "owner_contact_email": "[email protected]",
  • "owner_first_names": "string",
  • "owner_surname": "string",
  • "potential_hazards": "string",
  • "access_security_details": "string",
  • "street_address": "string",
  • "signed_approval": "string",
  • "approved": true,
  • "owner_comms_preference": "string",
  • "notes": "string",
  • "meta": {
    },
  • "dog_on_site": true,
  • "dog_on_site_description": "string",
  • "heard_of_project_before_hand": true
}

Update approval

Authorizations:
trap_auth
path Parameters
approvalUUID
required
string <uuid> (Approval UUID)
Request Body schema: application/json

Approval to update

area_uuid
string <uuid> (Area)

The area which this approval belongs to

project_uuid
string <uuid> (Project)

The project which this approval belongs to

owner_trap_servicing
boolean (Owner trap/install servicing)

Owner will take care of trap/installation servicing

owner_app_usage
boolean (Owner app usage)

Owner will use mobile app

owner_website_usage
boolean (Owner website usage)

Owner will use website

allow_mechanical_traps
boolean (Allow mechanical traps)

Permission to use mechanical traps

allow_camera_traps
boolean (Allow camera traps)

Permission to use camera traps

allow_toxins
boolean (Allow toxins)

Permission to use toxins

allow_radio_transmission
boolean (Allow radio transmissions)

Permission to use trap sensors/transmitters on installations

object (Owner contact phone) non-empty
household_bait_allergy_present
boolean (Bait allergy present in household)

Bait allergy present in household, e.g. use of nut butters in lure/bait is not accepted.

household_bait_allergy_description
string (Bait allergy site description/notes)

Bait allergy site description/notes, type of bait, reaction likelihood etc

dog_onsite
any
dog_onsite_description
any
please_knock_on_door
boolean (Please knock on the door)

On each site visit, does the owner want us to knock on the door to announce our arrival?

heard_of_project_beforehand
any
approval_date
string <date-time> (Approval date)

Date of approval

owner_contact_email
string <email> (Owner contact email)

Owners contact email address

owner_first_names
string (Owner first names)

Owners first names

owner_surname
string (Owner surname)

Owners surname

potential_hazards
string (Potential Hazards)

Potential hazards onsite

access_security_details
string (Access security details)

Security details for access onsite

street_address
string (Street Address)

Address for accessing site

signed_approval
string <byte> (Signed approval)

byte (which is the standard format for a base64 encoded string) array - enforce file size below below 1000KB

approved
boolean (Approved status)

Has the owner explicitly approved this

owner_comms_preference
string (Owner communication preference)

Owner communication preference (email, phone, other?)

notes
string (Notes)

Other notes relating to site and approval (caveats etc)

uuid
string <uuid> (Approval UUID)
object (Metadata)
dog_on_site
boolean (Dog on site)

Dog on site

dog_on_site_description
string (Dog on site description/notes)

Dog on site description/notes, type of dog, whereabouts, how aggressive etc.

heard_of_project_before_hand
boolean (heard of project before this engagement)

Has the owner heard of this project before

Responses

Request samples

Content type
application/json
{
  • "area_uuid": "23f67669-918a-4ed0-bb44-b0229619d79c",
  • "project_uuid": "1de37675-f868-4726-bb1d-b08d89f463f9",
  • "owner_trap_servicing": true,
  • "owner_app_usage": true,
  • "owner_website_usage": true,
  • "allow_mechanical_traps": true,
  • "allow_camera_traps": true,
  • "allow_toxins": true,
  • "allow_radio_transmission": true,
  • "owner_contact_phone": {
    },
  • "household_bait_allergy_present": true,
  • "household_bait_allergy_description": "string",
  • "dog_onsite": null,
  • "dog_onsite_description": null,
  • "please_knock_on_door": true,
  • "heard_of_project_beforehand": null,
  • "approval_date": "2019-08-24T14:15:22Z",
  • "owner_contact_email": "[email protected]",
  • "owner_first_names": "string",
  • "owner_surname": "string",
  • "potential_hazards": "string",
  • "access_security_details": "string",
  • "street_address": "string",
  • "signed_approval": "string",
  • "approved": true,
  • "owner_comms_preference": "string",
  • "notes": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "meta": {
    },
  • "dog_on_site": true,
  • "dog_on_site_description": "string",
  • "heard_of_project_before_hand": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "approval": {
    }
}

Delete approval

Authorizations:
trap_auth
path Parameters
approvalUUID
required
string <uuid> (Approval UUID)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Parcels

Get parcels by project

Authorizations:
trap_auth
query Parameters
limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

project
required
string <uuid> (Project UUID)

Only return entities associated with this project.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "attribution": "string"
}

Reachable?

Does nothing and returns No Content

query Parameters
_
any

Optional parameter for avoiding caching

Responses

Work Effort Report

Get Work Effort Report

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_before
string <date-time>

Only return entities changed before this date.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

offset
integer >= 0
Default: 0

Offset the page returned by this many records

sort_order
string
Default: "asc"
Enum: "asc" "desc"

provide a sort order / direction

Array of Project UUID (strings) or Project UUID (string) (Project UUID)

Only return entities associated with one or more projects.

Array of Record type (strings) or string

Only return entities associated with one or more record types

sort_column
string
Default: "username"
Enum: "project" "username" "installs_serviced" "records" "service_time_mins"

provide a field to sort by

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "total_installs_serviced": 0,
  • "total_records": 0,
  • "total_service_time_mins": 0,
  • "items": [
    ]
}

Install Service Report

Get Install Service Report

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_before
string <date-time>

Only return entities changed before this date.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

offset
integer >= 0
Default: 0

Offset the page returned by this many records

sort_order
string
Default: "asc"
Enum: "asc" "desc"

provide a sort order / direction

Array of Project UUID (strings) or Project UUID (string) (Project UUID)

Only return entities associated with one or more projects.

Array of Record type (strings) or string

Only return entities associated with one or more installation types

sort_column
string
Default: "line"
Enum: "project" "line" "active" "installed" "retired" "installs_serviced" "avg_service_time_mins"

provide a field to sort by

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "total_active": 0,
  • "total_installed": 0,
  • "total_retired": 0,
  • "total_installs_serviced": 0,
  • "agg_avg_service_time_mins": 0,
  • "items": [
    ]
}

Trapping Summary Report

Get Trapping Summary Report

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_before
string <date-time>

Only return entities changed before this date.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

offset
integer >= 0
Default: 0

Offset the page returned by this many records

sort_order
string
Default: "asc"
Enum: "asc" "desc"

provide a sort order / direction

Array of Project UUID (strings) or Project UUID (string) (Project UUID)

Only return entities associated with one or more projects.

Array of Line UUID (strings) or Line UUID (string) (Line UUID)

Only return entities associated with one or more lines.

sort_column
string
Default: "line"
Enum: "project" "line" "active" "trap_nights" "installs_serviced" "avg_service_time_mins" "total_service_time_mins" "catches"

provide a field to sort by

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "total_active": 0,
  • "total_installs_serviced": 0,
  • "total_trap_nights": 0,
  • "agg_avg_service_time_mins": 0,
  • "total_total_service_time_mins": 0,
  • "total_catches": 0,
  • "items": [
    ]
}

Trapping Summary Traptype Report

Get Trapping Summary by Trap type Report (Note WIP/experimental)

Authorizations:
trap_auth
query Parameters
changed_since
string <date-time>

Only return entities changed since this date.

changed_before
string <date-time>

Only return entities changed before this date.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

offset
integer >= 0
Default: 0

Offset the page returned by this many records

sort_order
string
Default: "asc"
Enum: "asc" "desc"

provide a sort order / direction

project_tags
Array of strings (Project tags)

list of free-text tags applied to projects

Array of Project UUID (strings) or Project UUID (string) (Project UUID)

Only return entities associated with one or more projects.

sort_column
string
Default: "trap_type"
Enum: "project" "project_tags" "install_tags" "trap_type" "date_installed" "species_caught" "active" "installed" "retired" "trap_nights" "installs_serviced" "avg_service_time_mins" "total_service_time_mins" "catches"

provide a field to sort by

install_tags
Array of strings (Install tags)

list of free-text tags applied to installations

trap_type
Array of strings (Trap type)

Only return entities associated with one or more trap types.

species_caught
Array of strings (Species caught)

Only return entities associated with one or more species caught.

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "total_active": 0,
  • "total_installed": 0,
  • "total_retired": 0,
  • "total_installs_serviced": 0,
  • "total_trap_nights": 0,
  • "agg_avg_service_time_mins": 0,
  • "total_total_service_time_mins": 0,
  • "total_catches": 0,
  • "project_tags_options": [
    ],
  • "install_tags_options": [
    ],
  • "species_caught_options": [
    ],
  • "trap_type_options": [
    ],
  • "items": [
    ]
}

Catch Rate Report

Get Catch Rate Report

Authorizations:
trap_auth
query Parameters
limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

offset
integer >= 0
Default: 0

Offset the page returned by this many records

sort_order
string
Default: "asc"
Enum: "asc" "desc"

provide a sort order / direction

Array of Project UUID (strings) or Project UUID (string) (Project UUID)

Only return entities associated with one or more projects.

Array of Line UUID (strings) or Line UUID (string) (Line UUID)

Only return entities associated with one or more lines.

changedFromYear
integer (changed from year) [ 1997 .. 2100 ]

only return entities changed from this year inclusive

changedToYear
integer (changed to year) [ 1997 .. 2100 ]

only return entities changed before this year inclusive

sort_column
string
Default: "line"
Enum: "project" "line" "catch_year" "trap_nights" "installs_serviced" "catches" "catches_per_100_nights"

provide a field to sort by

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "total_trap_nights": 0,
  • "total_catches": 0,
  • "agg_avg_catches_per_100_nights": 0,
  • "items": [
    ]
}

Deployment Marker Status Report

Get Deployment Marker Status

Authorizations:
trap_auth
query Parameters
created_since
string <date-time>

Only return entities created after or since this date.

created_before
string <date-time>

Only return entities created before this date.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

offset
integer >= 0
Default: 0

Offset the page returned by this many records

sort_order
string
Default: "asc"
Enum: "asc" "desc"

provide a sort order / direction

project_tags
Array of strings (Project tags)

list of free-text tags applied to projects

Array of Record type (strings) or string

Only return entities associated with one or more installation types

Array of Project UUID (strings) or Project UUID (string) (Project UUID)

Only return entities associated with one or more projects.

Array of Line UUID (strings) or Line UUID (string) (Line UUID)

Only return entities associated with one or more lines.

Array of Area UUID (strings) or Area UUID (string) (Area UUID)

Only return entities associated with one or more areas.

sort_column
string
Default: "deployment_name"
Enum: "project" "line" "project_tags" "name" "deployment_state" "deployment_id" "planned_installation_type" "install_model_name" "created" "area"

provide a field to sort by

Array of Deployment State (strings) or string

Only return entities associated with one or more deployment states

Array of Install model UUID (strings) or Install model UUID (string) (Install model UUID)

only return records associated with one or more Installation device brands and/or models

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "project_tags_options": [
    ],
  • "install_model_options": [
    ],
  • "items": [
    ]
}

Area Approval Report

Get Area Approval Report

Authorizations:
trap_auth
query Parameters
created_since
string <date-time>

Only return entities created after or since this date.

created_before
string <date-time>

Only return entities created before this date.

limit
integer [ 1 .. 100000 ]
Default: 1000

Only return up to this many entities. Tentatively limited to 100,000.

offset
integer >= 0
Default: 0

Offset the page returned by this many records

sort_order
string
Default: "asc"
Enum: "asc" "desc"

provide a sort order / direction

project_tags
Array of strings (Project tags)

list of free-text tags applied to projects

Array of Project UUID (strings) or Project UUID (string) (Project UUID)

Only return entities associated with one or more projects.

Array of Area UUID (strings) or Area UUID (string) (Area UUID)

Only return entities associated with one or more areas.

sort_column
string
Default: "deployment_name"
Enum: "project" "project_tags" "area" "area_created" "approval_created" "owner_first_names" "owner_surname" "owner_contact_email" "owner_contact_phone_home" "owner_contact_phone_mobile" "owner_comms_preference" "owner_trap_servicing" "owner_app_usage" "owner_website_usage" "allow_mechanical_traps" "allow_camera_traps" "allow_toxins" "allow_radio_transmission" "household_bait_allergy_present" "dog_onsite" "please_knock_on_door" "heard_of_project_beforehand" "potential_hazards" "access_security_details" "street_address" "approval_date" "approved" "notes" "approval_state" "parcel_ids" "is_from_linz_parcel"

provide a field to sort by

Array of Approval State (strings) or string

Only return entities associated with one or more approval states

is_from_linz_parcel
boolean (is from LINZ parcel)

only return records with the specified value for is_from_linz_parcel

address_search_term
string (filter by address search term)

only return entities that contain the search term in the street address

owner_first_names_search_term
string (filter by owners first names)

only return entities that contain the search term in the owners first names

owner_surname_search_term
string (filter by owners surname)

only return entities that contain the search term in the owners surname

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "project_tags_options": [
    ],
  • "approval_state_options": [
    ],
  • "total_approved": 0,
  • "total_declined": 0,
  • "total_pending": 0,
  • "total_in_progress": 0,
  • "items": [
    ]
}