FisheriesApp API Reference

Introduction

The FisheriesApp API which is available at https://fisheriesapp.com/api/v1 is built upon restful principles using common HTTP verbs GET, POST, PUT, and DELETE which are supported on almost all API endpoints.

All requests and responses to and from the API will be provided as JSON and do not require request headers such as CONTENT-TYPE to be set.

Authentication

Authentication with the FisheriesApp API is handled using a standard bearer token that can be used as a querystring parameter or in the request header.

An authentication token can be made available to you upon request by contacting Vericatch support at support@vericatch.com. Please be sure to store the token in a secure place and ensure that it does not get checked into github projects, client side code, etc.

As an example, retrieving a list of areas could be called using either one of the following two methods.

With the token is used as a querystring parameter: $ curl https://fisheriesapp.com/api/v1/areas?token=d82499c1-2095-4ae3-90a9-7d7a54b53069

With the token is used as bearer type authorization set in the header: $ curl https://fisheriesapp.com/api/v1/areas -H "Authorization: Bearer d82499c1-2095-4ae3-90a9-7d7a54b53069"

Filtering and Pagination

Filtering

Changes on or after a specific date/time

All API endpoints accept a modified_on_or_after querystring parameter which will result results whose updated date and time occur on or after the supplied date. When using this parameter it should be supplied as a valid ISO8601 string.

Fishery or Fishery Period

Core form API endpoints (Fisherman Sets, Monitor Sets, Electronic Monitored Sets, Landings, Biology Samples) and Trips optionally accept a fishery_ids and fishery_period_ids querystring parameters which allow comma separated list of ids to be supplied which will filter the results for only those fisheries or period in question.

Pagination

When using GET with any list based endpoint 10 entries will be returned by default. This can be overridden to return anywhere from 1 and 100 entries using the per_page querystring parameter.

Paginating the results can be performed by specifying the page querystring parameter. Results returned for any entity will be sorted by created_date_time with the most recently created entries at the top of the list.

Errors

In the event that errors are raised during create or update operations they will be returned in an “errors” key as in the following example.

{ "errors": { "fisherman_id": "can't be blank", "vessel_id": "can't be blank" } }

Versioning

The FisheriesApp API is versioned in order to provide backwards support for breaking changes. The current version of the API is v1. Details will be communicated out to the community as new versions of the API are introduced, including any breaking or backwards incompatible changes.

Additional Notes

The following items are a miscellaneous collection of tips and tricks to assist with using the FisheriesApp API.

  • All dates and times should be communicated in ISO 8601 format similar to the following YYYY-MM-DDTHH:MM:SSZ; dates returned from the API will always be in the UTC timezone

Areas

Create a new Area

Endpoint

POST /api/v1/areas

Parameters

Name Description Type
name Name String
code Code String
active Status Boolean
economic_zone Economic Zone String
fao_fishing_area_code FAO fishing area code Integer
comments Comments String
metadata Metadata JSON

Request

Route

POST /api/v1/areas

Headers

Authorization: Bearer ffb4cb59bcbc7549afba7e5e1eb160b54eaa6bdc
Content-Type: application/json

Body

{
  "name": "Grosse Point",
  "code": "GP01",
  "active": true,
  "economic_zone": "SAIEZ",
  "fao_fishing_area_code": 21,
  "comments": "Just off northwest coast"
}

cURL

curl "https://fisheriesapp.com/api/v1/areas" -d '{"name":"Grosse Point","code":"GP01","active":true,"economic_zone":"SAIEZ","fao_fishing_area_code":21,"comments":"Just off northwest coast"}' -X POST \
	-H "Authorization: Bearer ffb4cb59bcbc7549afba7e5e1eb160b54eaa6bdc"

Response

Simulated Response

Response Fields

Name Description Type
html_url Management URL String
name Name String
code Code String
active Status Boolean
economic_zone Economic zone String
fao_fishing_area_code FAO fishing area code Integer
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 3fa4d0e9-f557-4418-9683-c5e68c2f8c40

Body

{
  "data": {
    "id": "3a906f8c-987d-4e8a-b4e8-3993b495c04f",
    "html_url": "/management/account/areas/1182f0ad4e9d",
    "name": "Grosse Point",
    "code": "GP01",
    "active": true,
    "economic_zone": "SAIEZ",
    "fao_fishing_area_code": 21,
    "comments": "Just off northwest coast",
    "metadata": {
    },
    "created_date_time": "2020-06-22T19:38:19Z",
    "created_by_name": "Daysi Goyette",
    "updated_date_time": "2020-06-22T19:38:19Z",
    "updated_by_name": "Daysi Goyette"
  }
}

Delete an existing Area

Endpoint

DELETE /api/v1/areas/:id

Request

Route

DELETE /api/v1/areas/3584f403-9a7a-4e7e-85ef-4377d012af41

Headers

Authorization: Bearer ffb4cb59bcbc7549afba7e5e1eb160b54eaa6bdc
Content-Type: application/json

cURL

curl "https://fisheriesapp.com/api/v1/areas/3584f403-9a7a-4e7e-85ef-4377d012af41" -d '' -X DELETE \
	-H "Authorization: Bearer ffb4cb59bcbc7549afba7e5e1eb160b54eaa6bdc"

Response

Simulated Response

Status

204

Headers

X-Request-Id: fd8850a2-800f-4e47-bb66-065ae2dada8a

Return a list of Areas

Endpoint

GET /api/v1/areas

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/areas

Headers

Authorization: Bearer ffb4cb59bcbc7549afba7e5e1eb160b54eaa6bdc
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/areas" -X GET \
	-H "Authorization: Bearer ffb4cb59bcbc7549afba7e5e1eb160b54eaa6bdc"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
code Code String
active Status Boolean
economic_zone Economic zone String
fao_fishing_area_code FAO fishing area code Integer
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 68260e6c-d9a5-4540-be12-3a7800a92c30

Body

{
  "data": [
    {
      "id": "532904cc-b389-4eab-841f-c814000af753",
      "html_url": "/management/account/areas/8626374a45fa",
      "name": "Lampung A1",
      "code": "A1",
      "active": true,
      "economic_zone": "XIN",
      "fao_fishing_area_code": 21,
      "comments": "4.5586 S, 105.4068 E",
      "metadata": {
        "color": "red",
        "countries": [
          "CA",
          "BR",
          "IT"
        ],
        "temperature": 1.3
      },
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Daysi Goyette",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Daysi Goyette"
    },
    {
      "id": "eb7f3a1b-de63-49e3-bfaf-4bfa279f0fec",
      "html_url": "/management/account/areas/53e0da107864",
      "name": "Cedar Lake Inlet",
      "code": "CLake",
      "active": true,
      "economic_zone": "RVI",
      "fao_fishing_area_code": 71,
      "comments": "Across bay from floating dock",
      "metadata": {
      },
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Daysi Goyette",
      "updated_date_time": "2020-06-22T19:38:19Z",
      "updated_by_name": "Daysi Goyette"
    },
    {
      "id": "3584f403-9a7a-4e7e-85ef-4377d012af41",
      "html_url": "/management/account/areas/c6aed0d8e062",
      "name": "Madura A3",
      "code": "A3",
      "active": true,
      "economic_zone": "FTZ",
      "fao_fishing_area_code": 71,
      "comments": "7.0777 S, 113.2871 E",
      "metadata": {
      },
      "created_date_time": "2018-07-01T00:00:00Z",
      "created_by_name": "Daysi Goyette",
      "updated_date_time": "2018-07-02T00:00:00Z",
      "updated_by_name": "Daysi Goyette"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single Area

Endpoint

GET /api/v1/areas/:id

Request

Route

GET /api/v1/areas/532904cc-b389-4eab-841f-c814000af753

Headers

Authorization: Bearer ffb4cb59bcbc7549afba7e5e1eb160b54eaa6bdc
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/areas/532904cc-b389-4eab-841f-c814000af753" -X GET \
	-H "Authorization: Bearer ffb4cb59bcbc7549afba7e5e1eb160b54eaa6bdc"

Response

Simulated Response

Response Fields

Name Description Type
html_url Management URL String
name Name String
code Code String
active Status Boolean
economic_zone Economic zone String
fao_fishing_area_code FAO fishing area code Integer
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: b9889d8c-9a34-4c3f-b4d4-e5a5708e6ff1

Body

{
  "data": {
    "id": "532904cc-b389-4eab-841f-c814000af753",
    "html_url": "/management/account/areas/8626374a45fa",
    "name": "Lampung A1",
    "code": "A1",
    "active": true,
    "economic_zone": "XIN",
    "fao_fishing_area_code": 21,
    "comments": "4.5586 S, 105.4068 E",
    "metadata": {
      "color": "red",
      "countries": [
        "CA",
        "BR",
        "IT"
      ],
      "temperature": 1.3
    },
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Daysi Goyette",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Daysi Goyette"
  }
}

Update an existing Area

Endpoint

PUT /api/v1/areas/:id

Parameters

Name Description Type
name Name String
code Code String
active Status Boolean
economic_zone Economic Zone String
fao_fishing_area_code FAO fishing area code Integer
comments Comments String
metadata Metadata JSON

Request

Route

PUT /api/v1/areas/eb7f3a1b-de63-49e3-bfaf-4bfa279f0fec

Headers

Authorization: Bearer ffb4cb59bcbc7549afba7e5e1eb160b54eaa6bdc
Content-Type: application/json

Body

{
  "name": "Cedar Lake Inlet",
  "code": "CLake",
  "active": true,
  "economic_zone": "RVI",
  "fao_fishing_area_code": 71,
  "comments": "Across bay from floating dock"
}

cURL

curl "https://fisheriesapp.com/api/v1/areas/eb7f3a1b-de63-49e3-bfaf-4bfa279f0fec" -d '{"name":"Cedar Lake Inlet","code":"CLake","active":true,"economic_zone":"RVI","fao_fishing_area_code":71,"comments":"Across bay from floating dock"}' -X PUT \
	-H "Authorization: Bearer ffb4cb59bcbc7549afba7e5e1eb160b54eaa6bdc"

Response

Simulated Response

Response Fields

Name Description Type
html_url Management URL String
name Name String
code Code String
active Status Boolean
economic_zone Economic zone String
fao_fishing_area_code FAO fishing area code Integer
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 9342ce4e-9a1c-4401-a241-63c31ac89241

Body

{
  "data": {
    "id": "eb7f3a1b-de63-49e3-bfaf-4bfa279f0fec",
    "html_url": "/management/account/areas/53e0da107864",
    "name": "Cedar Lake Inlet",
    "code": "CLake",
    "active": true,
    "economic_zone": "RVI",
    "fao_fishing_area_code": 71,
    "comments": "Across bay from floating dock",
    "metadata": {
    },
    "created_date_time": "2018-08-01T00:00:00Z",
    "created_by_name": "Daysi Goyette",
    "updated_date_time": "2020-06-22T19:38:19Z",
    "updated_by_name": "Daysi Goyette"
  }
}

Biology Samples

Create a new Biology Sample

Endpoint

POST /api/v1/biology-samples

Parameters

Name Description Type
fishery_id required ID of fishery UUID
fishery_period_id required ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
sampled_date_time Sampled date/time ISO8601 date/time
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
location_id ID of location UUID
first_receiver_id ID of first receiver UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Size of gear mesh Integer
fishery_species_id ID of species UUID
comments Comments String
metadata Metadata JSON

Request

Route

POST /api/v1/biology-samples

Headers

Authorization: Bearer 83bf5e8fe4d86bc28eef863147740e848dd00120
Content-Type: application/json

Body

{
  "fishery_id": "cb754474-671c-4488-9698-4f78d225583a",
  "fishery_period_id": "e3f7b942-5aa7-42dc-9dff-e667268aa292",
  "sampled_date_time": "2018-09-02T12:19:12",
  "fisherman_id": "11b95c80-3c3b-4873-ae8a-cb75e3da7669",
  "monitor_id": "d445d1f1-0184-4921-8b5e-2e8e6e70daa4",
  "vessel_id": "fb33c8c2-de14-4801-9104-2a8c6dc09fc6",
  "location_id": "fd0c1725-9a30-456e-ac20-46f9f316e492",
  "first_receiver_id": "431a16ac-e9bb-4a6d-a932-b7fc31e36043",
  "fishery_gear_id": "c3892e5d-eb93-4121-9a0c-8f7ee7e2c0d2",
  "gear_mesh_size": 3.4,
  "fishery_species_id": "a212f0e5-5e86-4534-968f-f799f317b7c2",
  "comments": "Summarized data for biology sample"
}

cURL

curl "https://fisheriesapp.com/api/v1/biology-samples" -d '{"fishery_id":"cb754474-671c-4488-9698-4f78d225583a","fishery_period_id":"e3f7b942-5aa7-42dc-9dff-e667268aa292","sampled_date_time":"2018-09-02T12:19:12","fisherman_id":"11b95c80-3c3b-4873-ae8a-cb75e3da7669","monitor_id":"d445d1f1-0184-4921-8b5e-2e8e6e70daa4","vessel_id":"fb33c8c2-de14-4801-9104-2a8c6dc09fc6","location_id":"fd0c1725-9a30-456e-ac20-46f9f316e492","first_receiver_id":"431a16ac-e9bb-4a6d-a932-b7fc31e36043","fishery_gear_id":"c3892e5d-eb93-4121-9a0c-8f7ee7e2c0d2","gear_mesh_size":3.4,"fishery_species_id":"a212f0e5-5e86-4534-968f-f799f317b7c2","comments":"Summarized data for biology sample"}' -X POST \
	-H "Authorization: Bearer 83bf5e8fe4d86bc28eef863147740e848dd00120"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
sampled_date_time Sampled date/time ISO8601 date/time
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
location_id ID of location UUID
first_receiver_id ID of first receiver UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Size of gear mesh Integer
fishery_species_id ID of species UUID
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name ID of creating user UUID
updated_date_time Updated date/time ISO8601 date/time
updated_by_name ID of updating user UUID
submitted_date_time Submitted date/time ISO8601 date/time
validated_date_time Validated date/time ISO8601 date/time
validated_by_name ID of validating user UUID
validation_comments Validation comments String
measurements Measurement entries Array
- id ID UUID

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 50ab3b08-b99b-4879-818d-f52c9910d294

Body

{
  "data": {
    "id": "eddd5a98-a87a-4491-9bad-d8fe7e6c0cec",
    "html_url": "/management/fisheries/407d842c225f/biology-samples/d8e468dd15c1",
    "fishery_id": "cb754474-671c-4488-9698-4f78d225583a",
    "fishery_period_id": "e3f7b942-5aa7-42dc-9dff-e667268aa292",
    "trip_id": null,
    "hail_id": null,
    "sampled_date_time": "2018-09-02T12:19:12Z",
    "fisherman_id": "11b95c80-3c3b-4873-ae8a-cb75e3da7669",
    "monitor_id": "d445d1f1-0184-4921-8b5e-2e8e6e70daa4",
    "vessel_id": "fb33c8c2-de14-4801-9104-2a8c6dc09fc6",
    "location_id": "fd0c1725-9a30-456e-ac20-46f9f316e492",
    "first_receiver_id": "431a16ac-e9bb-4a6d-a932-b7fc31e36043",
    "fishery_gear_id": "c3892e5d-eb93-4121-9a0c-8f7ee7e2c0d2",
    "gear_mesh_size": null,
    "fishery_species_id": "a212f0e5-5e86-4534-968f-f799f317b7c2",
    "comments": "Summarized data for biology sample",
    "metadata": {
    },
    "created_date_time": "2020-06-22T19:38:18Z",
    "created_by_name": "Camellia Bogan",
    "updated_date_time": "2020-06-22T19:38:18Z",
    "updated_by_name": "Camellia Bogan",
    "submitted_date_time": null,
    "validated_date_time": null,
    "validated_by_name": null,
    "validation_comments": null
  }
}

Delete an existing Biology Sample

Endpoint

DELETE /api/v1/biology-samples/:id

Request

Route

DELETE /api/v1/biology-samples/ddf3a12a-c036-4cb9-91d0-25af8d8b74eb

Headers

Authorization: Bearer 83bf5e8fe4d86bc28eef863147740e848dd00120
Content-Type: application/json

cURL

curl "https://fisheriesapp.com/api/v1/biology-samples/ddf3a12a-c036-4cb9-91d0-25af8d8b74eb" -d '' -X DELETE \
	-H "Authorization: Bearer 83bf5e8fe4d86bc28eef863147740e848dd00120"

Response

Simulated Response

Status

204

Headers

X-Request-Id: 6b2abeba-301b-418d-92e7-6a73ba14669b

Return a list of Biology Samples

Endpoint

GET /api/v1/biology-samples

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time
fishery_id Optionally specify one or more fisheries as a comma separated list of IDs String
fishery_period_id Optionally specify one or more periods as a comma separated list of IDs; leaving blank defaults to returning data from any fisheries current period String

Request

Route

GET /api/v1/biology-samples

Headers

Authorization: Bearer 83bf5e8fe4d86bc28eef863147740e848dd00120
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/biology-samples" -X GET \
	-H "Authorization: Bearer 83bf5e8fe4d86bc28eef863147740e848dd00120"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
sampled_date_time Sampled date/time ISO8601 date/time
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
location_id ID of location UUID
first_receiver_id ID of first receiver UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Size of gear mesh Integer
fishery_species_id ID of species UUID
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name ID of creating user UUID
updated_date_time Updated date/time ISO8601 date/time
updated_by_name ID of updating user UUID
submitted_date_time Submitted date/time ISO8601 date/time
validated_date_time Validated date/time ISO8601 date/time
validated_by_name ID of validating user UUID
validation_comments Validation comments String
measurements Measurement entries Array
- id ID UUID

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 4908a38a-b877-4caa-bf85-6b8b3b5c4ed2

Body

{
  "data": [
    {
      "id": "84651226-52f2-4e20-8ea5-f83dbf2931ed",
      "html_url": "/management/fisheries/407d842c225f/biology-samples/ee01baaccbb7",
      "fishery_id": "cb754474-671c-4488-9698-4f78d225583a",
      "fishery_period_id": "e3f7b942-5aa7-42dc-9dff-e667268aa292",
      "trip_id": "ab98a8cf-2366-491a-a8f1-494a1834f503",
      "hail_id": null,
      "sampled_date_time": "2020-06-20T19:33:17Z",
      "fisherman_id": "11b95c80-3c3b-4873-ae8a-cb75e3da7669",
      "monitor_id": "d445d1f1-0184-4921-8b5e-2e8e6e70daa4",
      "vessel_id": "fb33c8c2-de14-4801-9104-2a8c6dc09fc6",
      "location_id": "fd0c1725-9a30-456e-ac20-46f9f316e492",
      "first_receiver_id": "431a16ac-e9bb-4a6d-a932-b7fc31e36043",
      "fishery_gear_id": "c3892e5d-eb93-4121-9a0c-8f7ee7e2c0d2",
      "gear_mesh_size": 2,
      "fishery_species_id": "a212f0e5-5e86-4534-968f-f799f317b7c2",
      "comments": "",
      "metadata": {
        "color": "orange"
      },
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Camellia Bogan",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Camellia Bogan",
      "submitted_date_time": null,
      "validated_date_time": null,
      "validated_by_name": null,
      "validation_comments": null
    },
    {
      "id": "f24ff380-37a0-4c45-8f77-8e90ab36a7af",
      "html_url": "/management/fisheries/407d842c225f/biology-samples/8e72f63f3b9c",
      "fishery_id": "cb754474-671c-4488-9698-4f78d225583a",
      "fishery_period_id": "e3f7b942-5aa7-42dc-9dff-e667268aa292",
      "trip_id": null,
      "hail_id": null,
      "sampled_date_time": "2020-05-11T19:00:17Z",
      "fisherman_id": "e0283227-0da9-44f1-8194-d160aa6ef550",
      "monitor_id": "9162a513-c5ca-42cc-9cd7-1f1c677cdb7d",
      "vessel_id": "74ebea0b-abf8-467d-8c42-77425160d0f0",
      "location_id": "29ec4ee1-01f3-40de-bb58-e9a1de957a14",
      "first_receiver_id": "4ff0aaa7-e56d-489e-a4b4-721b287f9ce9",
      "fishery_gear_id": "9f5b44cd-3c61-4842-b821-e7493aa189d0",
      "gear_mesh_size": 2,
      "fishery_species_id": "230613ef-c5fa-45e7-8b93-6bb627d9ad87",
      "comments": "",
      "metadata": {
      },
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Camellia Bogan",
      "updated_date_time": "2018-08-02T00:00:00Z",
      "updated_by_name": "Camellia Bogan",
      "submitted_date_time": null,
      "validated_date_time": null,
      "validated_by_name": null,
      "validation_comments": null
    }
  ],
  "objects": 2,
  "pages": 1
}

Return a single Biology Sample

Endpoint

GET /api/v1/biology-samples/:id

Request

Route

GET /api/v1/biology-samples/84651226-52f2-4e20-8ea5-f83dbf2931ed

Headers

Authorization: Bearer 83bf5e8fe4d86bc28eef863147740e848dd00120
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/biology-samples/84651226-52f2-4e20-8ea5-f83dbf2931ed" -X GET \
	-H "Authorization: Bearer 83bf5e8fe4d86bc28eef863147740e848dd00120"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
sampled_date_time Sampled date/time ISO8601 date/time
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
location_id ID of location UUID
first_receiver_id ID of first receiver UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Size of gear mesh Integer
fishery_species_id ID of species UUID
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name ID of creating user UUID
updated_date_time Updated date/time ISO8601 date/time
updated_by_name ID of updating user UUID
submitted_date_time Submitted date/time ISO8601 date/time
validated_date_time Validated date/time ISO8601 date/time
validated_by_name ID of validating user UUID
validation_comments Validation comments String
measurements Measurement entries Array
- id ID UUID

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 1b8406a3-1ed7-4863-942c-5da11d1b2c6c

Body

{
  "data": {
    "id": "84651226-52f2-4e20-8ea5-f83dbf2931ed",
    "html_url": "/management/fisheries/407d842c225f/biology-samples/ee01baaccbb7",
    "fishery_id": "cb754474-671c-4488-9698-4f78d225583a",
    "fishery_period_id": "e3f7b942-5aa7-42dc-9dff-e667268aa292",
    "trip_id": "ab98a8cf-2366-491a-a8f1-494a1834f503",
    "hail_id": null,
    "sampled_date_time": "2020-06-20T19:33:17Z",
    "fisherman_id": "11b95c80-3c3b-4873-ae8a-cb75e3da7669",
    "monitor_id": "d445d1f1-0184-4921-8b5e-2e8e6e70daa4",
    "vessel_id": "fb33c8c2-de14-4801-9104-2a8c6dc09fc6",
    "location_id": "fd0c1725-9a30-456e-ac20-46f9f316e492",
    "first_receiver_id": "431a16ac-e9bb-4a6d-a932-b7fc31e36043",
    "fishery_gear_id": "c3892e5d-eb93-4121-9a0c-8f7ee7e2c0d2",
    "gear_mesh_size": 2,
    "fishery_species_id": "a212f0e5-5e86-4534-968f-f799f317b7c2",
    "comments": "",
    "metadata": {
      "color": "orange"
    },
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Camellia Bogan",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Camellia Bogan",
    "submitted_date_time": null,
    "validated_date_time": null,
    "validated_by_name": null,
    "validation_comments": null
  }
}

Update an existing Biology Sample

Endpoint

PUT /api/v1/biology-samples/:id

Parameters

Name Description Type
sampled_date_time Sampled date/time ISO8601 date/time
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
location_id ID of location UUID
first_receiver_id ID of first receiver UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Size of gear mesh Integer
fishery_species_id ID of species UUID
comments Comments String
metadata Metadata JSON

Request

Route

PUT /api/v1/biology-samples/f24ff380-37a0-4c45-8f77-8e90ab36a7af

Headers

Authorization: Bearer 83bf5e8fe4d86bc28eef863147740e848dd00120
Content-Type: application/json

Body

{
  "fishery_id": "cb754474-671c-4488-9698-4f78d225583a",
  "fishery_period_id": "e3f7b942-5aa7-42dc-9dff-e667268aa292",
  "sampled_date_time": "2018-09-02T12:19:12",
  "fisherman_id": "11b95c80-3c3b-4873-ae8a-cb75e3da7669",
  "monitor_id": "d445d1f1-0184-4921-8b5e-2e8e6e70daa4",
  "vessel_id": "fb33c8c2-de14-4801-9104-2a8c6dc09fc6",
  "location_id": "fd0c1725-9a30-456e-ac20-46f9f316e492",
  "first_receiver_id": "431a16ac-e9bb-4a6d-a932-b7fc31e36043",
  "fishery_gear_id": "c3892e5d-eb93-4121-9a0c-8f7ee7e2c0d2",
  "gear_mesh_size": 2.1,
  "fishery_species_id": "a212f0e5-5e86-4534-968f-f799f317b7c2",
  "comments": "Summarized data for biology sample"
}

cURL

curl "https://fisheriesapp.com/api/v1/biology-samples/f24ff380-37a0-4c45-8f77-8e90ab36a7af" -d '{"fishery_id":"cb754474-671c-4488-9698-4f78d225583a","fishery_period_id":"e3f7b942-5aa7-42dc-9dff-e667268aa292","sampled_date_time":"2018-09-02T12:19:12","fisherman_id":"11b95c80-3c3b-4873-ae8a-cb75e3da7669","monitor_id":"d445d1f1-0184-4921-8b5e-2e8e6e70daa4","vessel_id":"fb33c8c2-de14-4801-9104-2a8c6dc09fc6","location_id":"fd0c1725-9a30-456e-ac20-46f9f316e492","first_receiver_id":"431a16ac-e9bb-4a6d-a932-b7fc31e36043","fishery_gear_id":"c3892e5d-eb93-4121-9a0c-8f7ee7e2c0d2","gear_mesh_size":2.1,"fishery_species_id":"a212f0e5-5e86-4534-968f-f799f317b7c2","comments":"Summarized data for biology sample"}' -X PUT \
	-H "Authorization: Bearer 83bf5e8fe4d86bc28eef863147740e848dd00120"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
sampled_date_time Sampled date/time ISO8601 date/time
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
location_id ID of location UUID
first_receiver_id ID of first receiver UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Size of gear mesh Integer
fishery_species_id ID of species UUID
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name ID of creating user UUID
updated_date_time Updated date/time ISO8601 date/time
updated_by_name ID of updating user UUID
submitted_date_time Submitted date/time ISO8601 date/time
validated_date_time Validated date/time ISO8601 date/time
validated_by_name ID of validating user UUID
validation_comments Validation comments String
measurements Measurement entries Array
- id ID UUID

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: f0c64d42-35b4-40e6-bc31-ad963796626c

Body

{
  "data": {
    "id": "f24ff380-37a0-4c45-8f77-8e90ab36a7af",
    "html_url": "/management/fisheries/407d842c225f/biology-samples/8e72f63f3b9c",
    "fishery_id": "cb754474-671c-4488-9698-4f78d225583a",
    "fishery_period_id": "e3f7b942-5aa7-42dc-9dff-e667268aa292",
    "trip_id": null,
    "hail_id": null,
    "sampled_date_time": "2018-09-02T12:19:12Z",
    "fisherman_id": "11b95c80-3c3b-4873-ae8a-cb75e3da7669",
    "monitor_id": "d445d1f1-0184-4921-8b5e-2e8e6e70daa4",
    "vessel_id": "fb33c8c2-de14-4801-9104-2a8c6dc09fc6",
    "location_id": "fd0c1725-9a30-456e-ac20-46f9f316e492",
    "first_receiver_id": "431a16ac-e9bb-4a6d-a932-b7fc31e36043",
    "fishery_gear_id": "c3892e5d-eb93-4121-9a0c-8f7ee7e2c0d2",
    "gear_mesh_size": 2,
    "fishery_species_id": "a212f0e5-5e86-4534-968f-f799f317b7c2",
    "comments": "Summarized data for biology sample",
    "metadata": {
    },
    "created_date_time": "2018-08-01T00:00:00Z",
    "created_by_name": "Camellia Bogan",
    "updated_date_time": "2020-06-22T19:38:18Z",
    "updated_by_name": "Camellia Bogan",
    "submitted_date_time": null,
    "validated_date_time": null,
    "validated_by_name": null,
    "validation_comments": null
  }
}

Brand/Variants

Create a new Brand/Variant

Endpoint

POST /api/v1/brand-variants

Parameters

Name Description Type
name Name String
description Description String
code Code String
active Status Boolean
comments Comments String
metadata Metadata JSON

Request

Route

POST /api/v1/brand-variants

Headers

Authorization: Bearer e27c701e826e698a0889f39f1bd605b8828ce21e
Content-Type: application/json

Body

{
  "name": "Extra Large",
  "code": "XL001",
  "active": true,
  "comments": "Extra large cup size"
}

cURL

curl "https://fisheriesapp.com/api/v1/brand-variants" -d '{"name":"Extra Large","code":"XL001","active":true,"comments":"Extra large cup size"}' -X POST \
	-H "Authorization: Bearer e27c701e826e698a0889f39f1bd605b8828ce21e"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
description Description String
code Code String
active Status Boolean
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 4e3cb099-c3af-43c4-b97e-8af14601775a

Body

{
  "data": {
    "id": "2bb537c9-cb9f-47c8-8004-9a2d3ce48a2b",
    "html_url": "/management/account/brand-variants/596a39e57ace",
    "name": "Extra Large",
    "description": null,
    "code": "XL001",
    "active": true,
    "comments": "Extra large cup size",
    "metadata": {
    },
    "created_date_time": "2020-06-22T19:38:27Z",
    "created_by_name": "Alphonso DuBuque",
    "updated_date_time": "2020-06-22T19:38:27Z",
    "updated_by_name": "Alphonso DuBuque"
  }
}

Delete an existing Brand/Variant

Endpoint

DELETE /api/v1/brand-variants/:id

Request

Route

DELETE /api/v1/brand-variants/5903f347-1566-410d-b69b-13acd87ae2f8

Headers

Authorization: Bearer e27c701e826e698a0889f39f1bd605b8828ce21e
Content-Type: application/json

cURL

curl "https://fisheriesapp.com/api/v1/brand-variants/5903f347-1566-410d-b69b-13acd87ae2f8" -d '' -X DELETE \
	-H "Authorization: Bearer e27c701e826e698a0889f39f1bd605b8828ce21e"

Response

Simulated Response

Status

204

Headers

X-Request-Id: 4cf0d76d-d5ea-4fd2-83dc-63b1aa363135

Return a list of Brand/Variants

Endpoint

GET /api/v1/brand-variants

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/brand-variants

Headers

Authorization: Bearer e27c701e826e698a0889f39f1bd605b8828ce21e
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/brand-variants" -X GET \
	-H "Authorization: Bearer e27c701e826e698a0889f39f1bd605b8828ce21e"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
description Description String
code Code String
active Status Boolean
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: ae4e0963-c944-4cb2-aca8-55be6e4ee156

Body

{
  "data": [
    {
      "id": "5903f347-1566-410d-b69b-13acd87ae2f8",
      "html_url": "/management/account/brand-variants/28b08cfded77",
      "name": "Deep-Cupped",
      "description": "Delicious deep shelled oysters.",
      "code": "F019",
      "active": true,
      "comments": "Off-bottom culture",
      "metadata": {
      },
      "created_date_time": "2020-06-22T19:38:27Z",
      "created_by_name": "Alphonso DuBuque",
      "updated_date_time": "2020-06-22T19:38:27Z",
      "updated_by_name": "Alphonso DuBuque"
    },
    {
      "id": "bcc8bf77-7b6b-418d-9556-91d5cc087158",
      "html_url": "/management/account/brand-variants/d5b86531ebd4",
      "name": "Small",
      "description": "Light taste, excellent finish on the palate.",
      "code": "SM001",
      "active": true,
      "comments": "Small cup size",
      "metadata": {
      },
      "created_date_time": "2020-06-22T19:38:27Z",
      "created_by_name": "Alphonso DuBuque",
      "updated_date_time": "2020-06-22T19:38:27Z",
      "updated_by_name": "Alphonso DuBuque"
    },
    {
      "id": "e7b0e554-16eb-45e3-95ad-6bc788097991",
      "html_url": "/management/account/brand-variants/f4048ec11119",
      "name": "Large",
      "description": "Full bodied, extra texture.",
      "code": "K182",
      "active": true,
      "comments": "Tumbled during final process",
      "metadata": {
        "color": "red"
      },
      "created_date_time": "2020-06-22T19:38:27Z",
      "created_by_name": "Alphonso DuBuque",
      "updated_date_time": "2020-06-22T19:38:27Z",
      "updated_by_name": "Alphonso DuBuque"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single Brand/Variant

Endpoint

GET /api/v1/brand-variants/:id

Request

Route

GET /api/v1/brand-variants/e7b0e554-16eb-45e3-95ad-6bc788097991

Headers

Authorization: Bearer e27c701e826e698a0889f39f1bd605b8828ce21e
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/brand-variants/e7b0e554-16eb-45e3-95ad-6bc788097991" -X GET \
	-H "Authorization: Bearer e27c701e826e698a0889f39f1bd605b8828ce21e"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
description Description String
code Code String
active Status Boolean
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 2f757ae5-e7a3-4578-93d9-ff4061d4a700

Body

{
  "data": {
    "id": "e7b0e554-16eb-45e3-95ad-6bc788097991",
    "html_url": "/management/account/brand-variants/f4048ec11119",
    "name": "Large",
    "description": "Full bodied, extra texture.",
    "code": "K182",
    "active": true,
    "comments": "Tumbled during final process",
    "metadata": {
      "color": "red"
    },
    "created_date_time": "2020-06-22T19:38:27Z",
    "created_by_name": "Alphonso DuBuque",
    "updated_date_time": "2020-06-22T19:38:27Z",
    "updated_by_name": "Alphonso DuBuque"
  }
}

Update an existing Brand/Variant

Endpoint

PUT /api/v1/brand-variants/:id

Parameters

Name Description Type
name Name String
code Code String
active Status Boolean
comments Comments String
metadata Metadata JSON

Request

Route

PUT /api/v1/brand-variants/bcc8bf77-7b6b-418d-9556-91d5cc087158

Headers

Authorization: Bearer e27c701e826e698a0889f39f1bd605b8828ce21e
Content-Type: application/json

Body

{
  "name": "Small",
  "code": "SM001",
  "active": true,
  "comments": "Small cup size"
}

cURL

curl "https://fisheriesapp.com/api/v1/brand-variants/bcc8bf77-7b6b-418d-9556-91d5cc087158" -d '{"name":"Small","code":"SM001","active":true,"comments":"Small cup size"}' -X PUT \
	-H "Authorization: Bearer e27c701e826e698a0889f39f1bd605b8828ce21e"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
description Description String
code Code String
active Status Boolean
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 2b5e767f-7835-4ec0-ab18-ec155db6148b

Body

{
  "data": {
    "id": "bcc8bf77-7b6b-418d-9556-91d5cc087158",
    "html_url": "/management/account/brand-variants/d5b86531ebd4",
    "name": "Small",
    "description": "Light taste, excellent finish on the palate.",
    "code": "SM001",
    "active": true,
    "comments": "Small cup size",
    "metadata": {
    },
    "created_date_time": "2020-06-22T19:38:27Z",
    "created_by_name": "Alphonso DuBuque",
    "updated_date_time": "2020-06-22T19:38:27Z",
    "updated_by_name": "Alphonso DuBuque"
  }
}

Categories

Return a list of Categories

Endpoint

GET /api/v1/categories

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/categories

Headers

Authorization: Bearer cf1aa3794d3c014098c6cfd319fbc461e1f98b25
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/categories" -X GET \
	-H "Authorization: Bearer cf1aa3794d3c014098c6cfd319fbc461e1f98b25"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
type Type String
names Names Hash of ISO 639-1 language codes
target Target Boolean
order Forced order of category String
code Code String
active Status Boolean
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 28b65886-eceb-4657-a8c3-97b55ee50908

Body

{
  "data": [
    {
      "id": "4a90cd42-1f77-4c56-9fe6-38158072da71",
      "fishery_id": "543ac1c0-9e09-419d-af26-051be02cd714",
      "type": "landing_catch",
      "names": {
        "en": "Marketable",
        "es": "ES Marketable",
        "fr": "FR Marketable",
        "id": "Yang Dijual"
      },
      "target": true,
      "order": 1,
      "code": null,
      "active": true,
      "created_date_time": "2020-06-22T19:38:27Z",
      "created_by_name": "Cameron Erdman",
      "updated_date_time": "2020-06-22T19:38:27Z",
      "updated_by_name": "Cameron Erdman"
    },
    {
      "id": "16b85529-4671-46a1-8086-2e61b5d38857",
      "fishery_id": "543ac1c0-9e09-419d-af26-051be02cd714",
      "type": "monitor_set_catch",
      "names": {
        "en": "Marketable",
        "es": "ES Marketable",
        "fr": "FR Marketable",
        "id": "Yang Dijual"
      },
      "target": true,
      "order": 1,
      "code": null,
      "active": true,
      "created_date_time": "2020-06-22T19:38:27Z",
      "created_by_name": "Cameron Erdman",
      "updated_date_time": "2020-06-22T19:38:27Z",
      "updated_by_name": "Cameron Erdman"
    },
    {
      "id": "1e131456-33a0-49cc-9dc5-4a230b94864a",
      "fishery_id": "db1cf764-6b9b-4904-8513-8f58831ffb2d",
      "type": "fisherman_set_catch",
      "names": {
        "en": "Marketable",
        "es": "ES Marketable",
        "fr": "FR Marketable",
        "id": "Yang Dijual"
      },
      "target": true,
      "order": 1,
      "code": null,
      "active": true,
      "created_date_time": "2020-06-22T19:38:27Z",
      "created_by_name": "Cameron Erdman",
      "updated_date_time": "2020-06-22T19:38:27Z",
      "updated_by_name": "Cameron Erdman"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single Category

Endpoint

GET /api/v1/categories/:id

Request

Route

GET /api/v1/categories/1e131456-33a0-49cc-9dc5-4a230b94864a

Headers

Authorization: Bearer cf1aa3794d3c014098c6cfd319fbc461e1f98b25
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/categories/1e131456-33a0-49cc-9dc5-4a230b94864a" -X GET \
	-H "Authorization: Bearer cf1aa3794d3c014098c6cfd319fbc461e1f98b25"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
type Type String
names Names Hash of ISO 639-1 language codes
target Target Boolean
order Forced order of category String
code Code String
active Status Boolean
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 73332fa8-570a-436a-8a03-f19edc827fd2

Body

{
  "data": {
    "id": "1e131456-33a0-49cc-9dc5-4a230b94864a",
    "fishery_id": "db1cf764-6b9b-4904-8513-8f58831ffb2d",
    "type": "fisherman_set_catch",
    "names": {
      "en": "Marketable",
      "es": "ES Marketable",
      "fr": "FR Marketable",
      "id": "Yang Dijual"
    },
    "target": true,
    "order": 1,
    "code": null,
    "active": true,
    "created_date_time": "2020-06-22T19:38:27Z",
    "created_by_name": "Cameron Erdman",
    "updated_date_time": "2020-06-22T19:38:27Z",
    "updated_by_name": "Cameron Erdman"
  }
}

Electronic Monitored Sets

Create a new Electronic Monitored Set

Endpoint

POST /api/v1/electronic-monitored-sets

Parameters

Name Description Type
fishery_id required ID of fishery UUID
fishery_period_id required ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time required Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
set_number Set number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Gear mesh size (cm) Integer
gear_length Length of an individual panel, pot, etc (m) Decimal
gear_count Count of panels, pots, etc Integer
depth_min Minimum depth (m) Integer
depth_max Maximum depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
catch Catch details Array
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Request

Route

POST /api/v1/electronic-monitored-sets

Headers

Authorization: Bearer 15e29550b30e40b1de9e3c3f7515ce8ca5a426d0
Content-Type: application/json

Body

{
  "fishery_id": "4f87cf24-f3d5-4a1c-a26c-d363b3ee2bb4",
  "fishery_period_id": "234d0cb0-0f2d-4a65-86d9-82f7f475a052",
  "trip_id": "9ef29833-bae3-489e-b81b-605c017277ba",
  "hail_id": "9febdd39-898f-42d6-a9ff-3472a99e6795",
  "started_date_time": "2018-09-02T12:19:12",
  "ended_date_time": "2018-09-04T05:22:02",
  "set_number": 4,
  "fisherman_id": "e647407f-f0ad-4f81-bef2-619d2726cc98",
  "monitor_id": "891900f3-2080-4e21-b576-9502e3cafebe",
  "vessel_id": "98400c3a-24f6-4739-b6c3-b25e567942eb",
  "area_id": "b12da7fb-bf49-4f3b-bd3c-2796561fb80e",
  "fishery_gear_": "48d1894a-bfd6-4e0c-bf15-2adf0f5f021c",
  "gear_mesh_size": 2,
  "gear_length": 5.5,
  "gear_count": 45,
  "depth_min": 7,
  "depth_max": 8,
  "start_geo_point": {
    "lat": {
      "dd": {
        "degrees": 50.123
      }
    },
    "long": {
      "dd": {
        "degrees": -127.123
      }
    }
  },
  "mid_geo_point": {
    "lat": {
      "dd": {
        "degrees": 51.123
      }
    },
    "long": {
      "dd": {
        "degrees": -128.123
      }
    }
  },
  "end_geo_point": {
    "lat": {
      "dd": {
        "degrees": 52.123
      }
    },
    "long": {
      "dd": {
        "degrees": -129.123
      }
    }
  },
  "comments": "Summarized data for tow 4"
}

cURL

curl "https://fisheriesapp.com/api/v1/electronic-monitored-sets" -d '{"fishery_id":"4f87cf24-f3d5-4a1c-a26c-d363b3ee2bb4","fishery_period_id":"234d0cb0-0f2d-4a65-86d9-82f7f475a052","trip_id":"9ef29833-bae3-489e-b81b-605c017277ba","hail_id":"9febdd39-898f-42d6-a9ff-3472a99e6795","started_date_time":"2018-09-02T12:19:12","ended_date_time":"2018-09-04T05:22:02","set_number":4,"fisherman_id":"e647407f-f0ad-4f81-bef2-619d2726cc98","monitor_id":"891900f3-2080-4e21-b576-9502e3cafebe","vessel_id":"98400c3a-24f6-4739-b6c3-b25e567942eb","area_id":"b12da7fb-bf49-4f3b-bd3c-2796561fb80e","fishery_gear_":"48d1894a-bfd6-4e0c-bf15-2adf0f5f021c","gear_mesh_size":2,"gear_length":5.5,"gear_count":45,"depth_min":7,"depth_max":8,"start_geo_point":{"lat":{"dd":{"degrees":50.123}},"long":{"dd":{"degrees":-127.123}}},"mid_geo_point":{"lat":{"dd":{"degrees":51.123}},"long":{"dd":{"degrees":-128.123}}},"end_geo_point":{"lat":{"dd":{"degrees":52.123}},"long":{"dd":{"degrees":-129.123}}},"comments":"Summarized data for tow 4"}' -X POST \
	-H "Authorization: Bearer 15e29550b30e40b1de9e3c3f7515ce8ca5a426d0"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
set_number Set number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Mesh size of gear (cm) Integer
gear_length Length of an individual panel, pot, etc (m) Decimal
gear_count Count of panels, pots, etc Integer
depth_min Minimum gear depth (m) Integer
depth_max Maximum gear depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 8187b7c3-b61d-4a4a-b6e4-0d6601d7ce49

Body

{
  "data": {
    "id": "d5ea3f00-07dd-4a77-a9b3-ad9c514909e1",
    "html_url": "/management/fisheries/49eef8429c84/electronic-monitored-sets/5025766ee3fa",
    "fishery_id": "4f87cf24-f3d5-4a1c-a26c-d363b3ee2bb4",
    "fishery_period_id": "234d0cb0-0f2d-4a65-86d9-82f7f475a052",
    "trip_id": "9ef29833-bae3-489e-b81b-605c017277ba",
    "hail_id": "9febdd39-898f-42d6-a9ff-3472a99e6795",
    "started_date_time": "2018-09-02T12:19:12Z",
    "ended_date_time": "2018-09-04T05:22:02Z",
    "set_number": 4,
    "fisherman_id": "e647407f-f0ad-4f81-bef2-619d2726cc98",
    "monitor_id": "891900f3-2080-4e21-b576-9502e3cafebe",
    "vessel_id": "98400c3a-24f6-4739-b6c3-b25e567942eb",
    "area_id": "b12da7fb-bf49-4f3b-bd3c-2796561fb80e",
    "fishery_gear_id": null,
    "gear_mesh_size": 2.0,
    "gear_length": 5.5,
    "gear_count": 45,
    "depth_min": 7,
    "depth_max": 8,
    "start_geo_point": {
      "lat": {
        "dd": {
          "degrees": 50.123
        },
        "ddm": {
          "degrees": 50,
          "minutes": 7.38
        },
        "dms": {
          "degrees": 50,
          "minutes": 7,
          "seconds": 22.8
        }
      },
      "long": {
        "dd": {
          "degrees": -127.123
        },
        "ddm": {
          "degrees": -127,
          "minutes": 7.38
        },
        "dms": {
          "degrees": -127,
          "minutes": 7,
          "seconds": 22.8
        }
      }
    },
    "mid_geo_point": {
      "lat": {
        "dd": {
          "degrees": 51.123
        },
        "ddm": {
          "degrees": 51,
          "minutes": 7.38
        },
        "dms": {
          "degrees": 51,
          "minutes": 7,
          "seconds": 22.8
        }
      },
      "long": {
        "dd": {
          "degrees": -128.123
        },
        "ddm": {
          "degrees": -128,
          "minutes": 7.38
        },
        "dms": {
          "degrees": -128,
          "minutes": 7,
          "seconds": 22.8
        }
      }
    },
    "end_geo_point": {
      "lat": {
        "dd": {
          "degrees": 52.123
        },
        "ddm": {
          "degrees": 52,
          "minutes": 7.38
        },
        "dms": {
          "degrees": 52,
          "minutes": 7,
          "seconds": 22.8
        }
      },
      "long": {
        "dd": {
          "degrees": -129.123
        },
        "ddm": {
          "degrees": -129,
          "minutes": 7.38
        },
        "dms": {
          "degrees": -129,
          "minutes": 7,
          "seconds": 22.8
        }
      }
    },
    "comments": "Summarized data for tow 4",
    "metadata": {
    },
    "created_date_time": "2020-06-22T19:38:22Z",
    "created_by_name": "Hallie Raynor",
    "updated_date_time": "2020-06-22T19:38:22Z",
    "updated_by_name": "Hallie Raynor",
    "catch": [

    ]
  }
}

Delete an existing Electronic Monitored Set

Endpoint

DELETE /api/v1/electronic-monitored-sets/:id

Request

Route

DELETE /api/v1/electronic-monitored-sets/c7b83d25-c5e9-481e-9d38-1e587b1d4988

Headers

Authorization: Bearer 15e29550b30e40b1de9e3c3f7515ce8ca5a426d0
Content-Type: application/json

cURL

curl "https://fisheriesapp.com/api/v1/electronic-monitored-sets/c7b83d25-c5e9-481e-9d38-1e587b1d4988" -d '' -X DELETE \
	-H "Authorization: Bearer 15e29550b30e40b1de9e3c3f7515ce8ca5a426d0"

Response

Simulated Response

Status

204

Headers

X-Request-Id: 0c3d3cbd-033c-4dcd-9d02-d9d1688fd1c9

Return a list of Electronic Monitored Sets

Endpoint

GET /api/v1/electronic-monitored-sets

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time
fishery_id Optionally specify one or more fisheries as a comma separated list of IDs String
fishery_period_id Optionally specify one or more periods as a comma separated list of IDs; leaving blank defaults to returning data from any fisheries current period String

Request

Route

GET /api/v1/electronic-monitored-sets

Headers

Authorization: Bearer 15e29550b30e40b1de9e3c3f7515ce8ca5a426d0
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/electronic-monitored-sets" -X GET \
	-H "Authorization: Bearer 15e29550b30e40b1de9e3c3f7515ce8ca5a426d0"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
set_number Set number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Mesh size of gear (cm) Integer
gear_length Length of an individual panel, pot, etc (m) Decimal
gear_count Count of panels, pots, etc Integer
depth_min Minimum gear depth (m) Integer
depth_max Maximum gear depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 65f8ae85-129a-4c18-ae00-7baa37c1e418

Body

{
  "data": [
    {
      "id": "d5ea3f00-07dd-4a77-a9b3-ad9c514909e1",
      "html_url": "/management/fisheries/49eef8429c84/electronic-monitored-sets/5025766ee3fa",
      "fishery_id": "4f87cf24-f3d5-4a1c-a26c-d363b3ee2bb4",
      "fishery_period_id": "234d0cb0-0f2d-4a65-86d9-82f7f475a052",
      "trip_id": "9ef29833-bae3-489e-b81b-605c017277ba",
      "hail_id": "9febdd39-898f-42d6-a9ff-3472a99e6795",
      "started_date_time": "2018-09-02T12:19:12Z",
      "ended_date_time": "2018-09-04T05:22:02Z",
      "set_number": 4,
      "fisherman_id": "e647407f-f0ad-4f81-bef2-619d2726cc98",
      "monitor_id": "891900f3-2080-4e21-b576-9502e3cafebe",
      "vessel_id": "98400c3a-24f6-4739-b6c3-b25e567942eb",
      "area_id": "b12da7fb-bf49-4f3b-bd3c-2796561fb80e",
      "fishery_gear_id": null,
      "gear_mesh_size": 2.0,
      "gear_length": 5.5,
      "gear_count": 45,
      "depth_min": 7,
      "depth_max": 8,
      "start_geo_point": {
        "lat": {
          "dd": {
            "degrees": 50.123
          },
          "ddm": {
            "degrees": 50,
            "minutes": 7.38
          },
          "dms": {
            "degrees": 50,
            "minutes": 7,
            "seconds": 22.8
          }
        },
        "long": {
          "dd": {
            "degrees": -127.123
          },
          "ddm": {
            "degrees": -127,
            "minutes": 7.38
          },
          "dms": {
            "degrees": -127,
            "minutes": 7,
            "seconds": 22.8
          }
        }
      },
      "mid_geo_point": {
        "lat": {
          "dd": {
            "degrees": 51.123
          },
          "ddm": {
            "degrees": 51,
            "minutes": 7.38
          },
          "dms": {
            "degrees": 51,
            "minutes": 7,
            "seconds": 22.8
          }
        },
        "long": {
          "dd": {
            "degrees": -128.123
          },
          "ddm": {
            "degrees": -128,
            "minutes": 7.38
          },
          "dms": {
            "degrees": -128,
            "minutes": 7,
            "seconds": 22.8
          }
        }
      },
      "end_geo_point": {
        "lat": {
          "dd": {
            "degrees": 52.123
          },
          "ddm": {
            "degrees": 52,
            "minutes": 7.38
          },
          "dms": {
            "degrees": 52,
            "minutes": 7,
            "seconds": 22.8
          }
        },
        "long": {
          "dd": {
            "degrees": -129.123
          },
          "ddm": {
            "degrees": -129,
            "minutes": 7.38
          },
          "dms": {
            "degrees": -129,
            "minutes": 7,
            "seconds": 22.8
          }
        }
      },
      "comments": "Summarized data for tow 4",
      "metadata": {
      },
      "created_date_time": "2020-06-22T19:38:22Z",
      "created_by_name": "Hallie Raynor",
      "updated_date_time": "2020-06-22T19:38:22Z",
      "updated_by_name": "Hallie Raynor",
      "catch": [

      ]
    },
    {
      "id": "c6897371-6cca-4e0d-933b-f71384fc1b1b",
      "html_url": "/management/fisheries/49eef8429c84/electronic-monitored-sets/0f7396496448",
      "fishery_id": "4f87cf24-f3d5-4a1c-a26c-d363b3ee2bb4",
      "fishery_period_id": "234d0cb0-0f2d-4a65-86d9-82f7f475a052",
      "trip_id": "9ef29833-bae3-489e-b81b-605c017277ba",
      "hail_id": null,
      "started_date_time": "2020-06-22T20:16:22Z",
      "ended_date_time": "2020-06-22T22:16:22Z",
      "set_number": 1,
      "fisherman_id": "e647407f-f0ad-4f81-bef2-619d2726cc98",
      "monitor_id": "891900f3-2080-4e21-b576-9502e3cafebe",
      "vessel_id": "98400c3a-24f6-4739-b6c3-b25e567942eb",
      "area_id": "b12da7fb-bf49-4f3b-bd3c-2796561fb80e",
      "fishery_gear_id": "48d1894a-bfd6-4e0c-bf15-2adf0f5f021c",
      "gear_mesh_size": 10.0,
      "gear_length": 70.5,
      "gear_count": 60,
      "depth_min": 10,
      "depth_max": 15,
      "start_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.686453
          },
          "ddm": {
            "degrees": 49,
            "minutes": 41.1872
          },
          "dms": {
            "degrees": 49,
            "minutes": 41,
            "seconds": 11.2308
          }
        },
        "long": {
          "dd": {
            "degrees": -124.280624
          },
          "ddm": {
            "degrees": -124,
            "minutes": 16.8374
          },
          "dms": {
            "degrees": -124,
            "minutes": 16,
            "seconds": 50.2464
          }
        }
      },
      "mid_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.498926
          },
          "ddm": {
            "degrees": 49,
            "minutes": 29.9356
          },
          "dms": {
            "degrees": 49,
            "minutes": 29,
            "seconds": 56.1336
          }
        },
        "long": {
          "dd": {
            "degrees": -124.041773
          },
          "ddm": {
            "degrees": -124,
            "minutes": 2.5064
          },
          "dms": {
            "degrees": -124,
            "minutes": 2,
            "seconds": 30.3828
          }
        }
      },
      "end_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.45798
          },
          "ddm": {
            "degrees": 49,
            "minutes": 27.4788
          },
          "dms": {
            "degrees": 49,
            "minutes": 27,
            "seconds": 28.728
          }
        },
        "long": {
          "dd": {
            "degrees": -123.978817
          },
          "ddm": {
            "degrees": -123,
            "minutes": 58.729
          },
          "dms": {
            "degrees": -123,
            "minutes": 58,
            "seconds": 43.7412
          }
        }
      },
      "comments": "",
      "metadata": {
        "color": "orange"
      },
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Hallie Raynor",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Hallie Raynor",
      "catch": [
        {
          "id": "2622aa7a-f2d4-4be5-b48e-1552d78f9db7",
          "fishery_species_id": null,
          "area_id": null,
          "catch_category_id": "524de7a4-a23a-4bf0-abb2-747c5cfb778c",
          "retained_weight": 360.0,
          "released_weight": 18.3,
          "retained_pieces": 2352,
          "released_pieces": 241,
          "comments": "Released catch too small for market.",
          "metadata": {
            "integration_id": 4890
          }
        },
        {
          "id": "e98fc53a-f8bd-40dd-8baa-87e052d3aa4f",
          "fishery_species_id": null,
          "area_id": null,
          "catch_category_id": "fbe64ec7-0b84-4aee-af68-a981efadfdcd",
          "retained_weight": 81.5,
          "released_weight": null,
          "retained_pieces": 7,
          "released_pieces": null,
          "comments": "",
          "metadata": {
          }
        }
      ]
    },
    {
      "id": "a118c8ba-4d92-40e0-8820-18defc018056",
      "html_url": "/management/fisheries/49eef8429c84/electronic-monitored-sets/4deea0c9ae1a",
      "fishery_id": "4f87cf24-f3d5-4a1c-a26c-d363b3ee2bb4",
      "fishery_period_id": "234d0cb0-0f2d-4a65-86d9-82f7f475a052",
      "trip_id": null,
      "hail_id": null,
      "started_date_time": "2020-06-22T20:00:22Z",
      "ended_date_time": "2020-06-22T22:00:22Z",
      "set_number": 2,
      "fisherman_id": "1856a124-2119-4298-acb0-487b95f82d5c",
      "monitor_id": "6393af4c-c6de-46b4-845c-a252ce5af899",
      "vessel_id": "9fb91021-0912-4390-8b28-973aee0f21f5",
      "area_id": "a17c7a0e-b8de-45b5-942a-b546e83f07c3",
      "fishery_gear_id": "d05e84ad-9549-4f17-9e89-b63e9a03afe6",
      "gear_mesh_size": 1.0,
      "gear_length": 46.25,
      "gear_count": 160,
      "depth_min": 4,
      "depth_max": 6,
      "start_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.686453
          },
          "ddm": {
            "degrees": 49,
            "minutes": 41.1872
          },
          "dms": {
            "degrees": 49,
            "minutes": 41,
            "seconds": 11.2308
          }
        },
        "long": {
          "dd": {
            "degrees": -124.280624
          },
          "ddm": {
            "degrees": -124,
            "minutes": 16.8374
          },
          "dms": {
            "degrees": -124,
            "minutes": 16,
            "seconds": 50.2464
          }
        }
      },
      "mid_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.498926
          },
          "ddm": {
            "degrees": 49,
            "minutes": 29.9356
          },
          "dms": {
            "degrees": 49,
            "minutes": 29,
            "seconds": 56.1336
          }
        },
        "long": {
          "dd": {
            "degrees": -124.041773
          },
          "ddm": {
            "degrees": -124,
            "minutes": 2.5064
          },
          "dms": {
            "degrees": -124,
            "minutes": 2,
            "seconds": 30.3828
          }
        }
      },
      "end_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.45798
          },
          "ddm": {
            "degrees": 49,
            "minutes": 27.4788
          },
          "dms": {
            "degrees": 49,
            "minutes": 27,
            "seconds": 28.728
          }
        },
        "long": {
          "dd": {
            "degrees": -123.978817
          },
          "ddm": {
            "degrees": -123,
            "minutes": 58.729
          },
          "dms": {
            "degrees": -123,
            "minutes": 58,
            "seconds": 43.7412
          }
        }
      },
      "comments": "",
      "metadata": {
      },
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Hallie Raynor",
      "updated_date_time": "2018-08-02T00:00:00Z",
      "updated_by_name": "Hallie Raynor",
      "catch": [
        {
          "id": "077f4306-708e-4880-abd6-f3e74fe5945c",
          "fishery_species_id": null,
          "area_id": null,
          "catch_category_id": "524de7a4-a23a-4bf0-abb2-747c5cfb778c",
          "retained_weight": 11.2,
          "released_weight": null,
          "retained_pieces": 8,
          "released_pieces": null,
          "comments": "Unknown fish species.",
          "metadata": {
            "integration_id": 842
          }
        },
        {
          "id": "06a49335-457e-45eb-83c3-a4e130ec6159",
          "fishery_species_id": null,
          "area_id": null,
          "catch_category_id": "fbe64ec7-0b84-4aee-af68-a981efadfdcd",
          "retained_weight": 81.5,
          "released_weight": null,
          "retained_pieces": 332,
          "released_pieces": null,
          "comments": "",
          "metadata": {
          }
        }
      ]
    },
    {
      "id": "c7b83d25-c5e9-481e-9d38-1e587b1d4988",
      "html_url": "/management/fisheries/49eef8429c84/electronic-monitored-sets/9e55e72452bd",
      "fishery_id": "4f87cf24-f3d5-4a1c-a26c-d363b3ee2bb4",
      "fishery_period_id": "234d0cb0-0f2d-4a65-86d9-82f7f475a052",
      "trip_id": null,
      "hail_id": null,
      "started_date_time": "2020-06-22T20:26:22Z",
      "ended_date_time": "2020-06-22T22:26:22Z",
      "set_number": 3,
      "fisherman_id": "68e3f901-1735-43fe-a409-7607d854d5a3",
      "monitor_id": "ec304ef5-88e9-48de-bc4c-458835b51dcc",
      "vessel_id": "599242e4-a620-49e7-96ec-ef285bf571e4",
      "area_id": "6521517a-832c-44de-bcd8-c2c14ca7a17d",
      "fishery_gear_id": "1de270b8-b34b-4d73-8735-e0b291f31d8e",
      "gear_mesh_size": 1.0,
      "gear_length": 46.25,
      "gear_count": 160,
      "depth_min": 4,
      "depth_max": 6,
      "start_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.686453
          },
          "ddm": {
            "degrees": 49,
            "minutes": 41.1872
          },
          "dms": {
            "degrees": 49,
            "minutes": 41,
            "seconds": 11.2308
          }
        },
        "long": {
          "dd": {
            "degrees": -124.290624
          },
          "ddm": {
            "degrees": -124,
            "minutes": 17.4374
          },
          "dms": {
            "degrees": -124,
            "minutes": 17,
            "seconds": 26.2464
          }
        }
      },
      "mid_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.498926
          },
          "ddm": {
            "degrees": 49,
            "minutes": 29.9356
          },
          "dms": {
            "degrees": 49,
            "minutes": 29,
            "seconds": 56.1336
          }
        },
        "long": {
          "dd": {
            "degrees": -124.051773
          },
          "ddm": {
            "degrees": -124,
            "minutes": 3.1064
          },
          "dms": {
            "degrees": -124,
            "minutes": 3,
            "seconds": 6.3828
          }
        }
      },
      "end_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.45798
          },
          "ddm": {
            "degrees": 49,
            "minutes": 27.4788
          },
          "dms": {
            "degrees": 49,
            "minutes": 27,
            "seconds": 28.728
          }
        },
        "long": {
          "dd": {
            "degrees": -123.988817
          },
          "ddm": {
            "degrees": -123,
            "minutes": 59.329
          },
          "dms": {
            "degrees": -123,
            "minutes": 59,
            "seconds": 19.7412
          }
        }
      },
      "comments": "",
      "metadata": {
      },
      "created_date_time": "2018-07-01T00:00:00Z",
      "created_by_name": "Hallie Raynor",
      "updated_date_time": "2018-07-02T00:00:00Z",
      "updated_by_name": "Hallie Raynor",
      "catch": [

      ]
    }
  ],
  "objects": 4,
  "pages": 1
}

Return a single Electronic Monitored Set

Endpoint

GET /api/v1/electronic-monitored-sets/:id

Request

Route

GET /api/v1/electronic-monitored-sets/c6897371-6cca-4e0d-933b-f71384fc1b1b

Headers

Authorization: Bearer 15e29550b30e40b1de9e3c3f7515ce8ca5a426d0
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/electronic-monitored-sets/c6897371-6cca-4e0d-933b-f71384fc1b1b" -X GET \
	-H "Authorization: Bearer 15e29550b30e40b1de9e3c3f7515ce8ca5a426d0"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
set_number Set number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Mesh size of gear (cm) Integer
gear_length Length of an individual panel, pot, etc (m) Decimal
gear_count Count of panels, pots, etc Integer
depth_min Minimum gear depth (m) Integer
depth_max Maximum gear depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: c5275412-4797-4d3f-9f1d-b6e346ff43cf

Body

{
  "data": {
    "id": "c6897371-6cca-4e0d-933b-f71384fc1b1b",
    "html_url": "/management/fisheries/49eef8429c84/electronic-monitored-sets/0f7396496448",
    "fishery_id": "4f87cf24-f3d5-4a1c-a26c-d363b3ee2bb4",
    "fishery_period_id": "234d0cb0-0f2d-4a65-86d9-82f7f475a052",
    "trip_id": "9ef29833-bae3-489e-b81b-605c017277ba",
    "hail_id": null,
    "started_date_time": "2020-06-22T20:16:22Z",
    "ended_date_time": "2020-06-22T22:16:22Z",
    "set_number": 1,
    "fisherman_id": "e647407f-f0ad-4f81-bef2-619d2726cc98",
    "monitor_id": "891900f3-2080-4e21-b576-9502e3cafebe",
    "vessel_id": "98400c3a-24f6-4739-b6c3-b25e567942eb",
    "area_id": "b12da7fb-bf49-4f3b-bd3c-2796561fb80e",
    "fishery_gear_id": "48d1894a-bfd6-4e0c-bf15-2adf0f5f021c",
    "gear_mesh_size": 10.0,
    "gear_length": 70.5,
    "gear_count": 60,
    "depth_min": 10,
    "depth_max": 15,
    "start_geo_point": {
      "lat": {
        "dd": {
          "degrees": 49.686453
        },
        "ddm": {
          "degrees": 49,
          "minutes": 41.1872
        },
        "dms": {
          "degrees": 49,
          "minutes": 41,
          "seconds": 11.2308
        }
      },
      "long": {
        "dd": {
          "degrees": -124.280624
        },
        "ddm": {
          "degrees": -124,
          "minutes": 16.8374
        },
        "dms": {
          "degrees": -124,
          "minutes": 16,
          "seconds": 50.2464
        }
      }
    },
    "mid_geo_point": {
      "lat": {
        "dd": {
          "degrees": 49.498926
        },
        "ddm": {
          "degrees": 49,
          "minutes": 29.9356
        },
        "dms": {
          "degrees": 49,
          "minutes": 29,
          "seconds": 56.1336
        }
      },
      "long": {
        "dd": {
          "degrees": -124.041773
        },
        "ddm": {
          "degrees": -124,
          "minutes": 2.5064
        },
        "dms": {
          "degrees": -124,
          "minutes": 2,
          "seconds": 30.3828
        }
      }
    },
    "end_geo_point": {
      "lat": {
        "dd": {
          "degrees": 49.45798
        },
        "ddm": {
          "degrees": 49,
          "minutes": 27.4788
        },
        "dms": {
          "degrees": 49,
          "minutes": 27,
          "seconds": 28.728
        }
      },
      "long": {
        "dd": {
          "degrees": -123.978817
        },
        "ddm": {
          "degrees": -123,
          "minutes": 58.729
        },
        "dms": {
          "degrees": -123,
          "minutes": 58,
          "seconds": 43.7412
        }
      }
    },
    "comments": "",
    "metadata": {
      "color": "orange"
    },
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Hallie Raynor",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Hallie Raynor",
    "catch": [
      {
        "id": "2622aa7a-f2d4-4be5-b48e-1552d78f9db7",
        "fishery_species_id": null,
        "area_id": null,
        "catch_category_id": "524de7a4-a23a-4bf0-abb2-747c5cfb778c",
        "retained_weight": 360.0,
        "released_weight": 18.3,
        "retained_pieces": 2352,
        "released_pieces": 241,
        "comments": "Released catch too small for market.",
        "metadata": {
          "integration_id": 4890
        }
      },
      {
        "id": "e98fc53a-f8bd-40dd-8baa-87e052d3aa4f",
        "fishery_species_id": null,
        "area_id": null,
        "catch_category_id": "fbe64ec7-0b84-4aee-af68-a981efadfdcd",
        "retained_weight": 81.5,
        "released_weight": null,
        "retained_pieces": 7,
        "released_pieces": null,
        "comments": "",
        "metadata": {
        }
      }
    ]
  }
}

Update an existing Electronic Monitored Set

Endpoint

PUT /api/v1/electronic-monitored-sets/:id

Parameters

Name Description Type
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
set_number Set number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Gear mesh size (cm) Integer
gear_length Length of an individual panel, pot, etc (m) Decimal
gear_count Count of panels, pots, etc Integer
depth_min Minimum depth (m) Integer
depth_max Maximum depth (m) Integer
comments Comments String
metadata Metadata JSON
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Request

Route

PUT /api/v1/electronic-monitored-sets/a118c8ba-4d92-40e0-8820-18defc018056

Headers

Authorization: Bearer 15e29550b30e40b1de9e3c3f7515ce8ca5a426d0
Content-Type: application/json

Body

{
  "trip_id": "9ef29833-bae3-489e-b81b-605c017277ba",
  "hail_id": "9febdd39-898f-42d6-a9ff-3472a99e6795",
  "started_date_time": "2018-08-03T11:12Z",
  "ended_date_time": "2018-08-03T18:01Z",
  "set_number": 12,
  "fisherman_id": "1856a124-2119-4298-acb0-487b95f82d5c",
  "monitor_id": "6393af4c-c6de-46b4-845c-a252ce5af899",
  "vessel_id": "9fb91021-0912-4390-8b28-973aee0f21f5",
  "area_id": "a17c7a0e-b8de-45b5-942a-b546e83f07c3",
  "gear_id": "d05e84ad-9549-4f17-9e89-b63e9a03afe6",
  "gear_mesh_size": 1,
  "gear_length": 5.75,
  "gear_count": 40,
  "depth_min": 6,
  "depth_max": 7,
  "start_geo_point": {
    "lat": {
      "ddm": {
        "degrees": 50,
        "minutes": 1.11
      }
    },
    "long": {
      "ddm": {
        "degrees": -127,
        "minutes": 1.11
      }
    }
  },
  "mid_geo_point": {
    "lat": {
      "ddm": {
        "degrees": 51,
        "minutes": 1.21
      }
    },
    "long": {
      "ddm": {
        "degrees": -128,
        "minutes": 1.21
      }
    }
  },
  "end_geo_point": {
    "lat": {
      "ddm": {
        "degrees": 52,
        "minutes": 1.31
      }
    },
    "long": {
      "ddm": {
        "degrees": -129,
        "minutes": 1.31
      }
    }
  },
  "comments": "2 cm gear mesh pots also used."
}

cURL

curl "https://fisheriesapp.com/api/v1/electronic-monitored-sets/a118c8ba-4d92-40e0-8820-18defc018056" -d '{"trip_id":"9ef29833-bae3-489e-b81b-605c017277ba","hail_id":"9febdd39-898f-42d6-a9ff-3472a99e6795","started_date_time":"2018-08-03T11:12Z","ended_date_time":"2018-08-03T18:01Z","set_number":12,"fisherman_id":"1856a124-2119-4298-acb0-487b95f82d5c","monitor_id":"6393af4c-c6de-46b4-845c-a252ce5af899","vessel_id":"9fb91021-0912-4390-8b28-973aee0f21f5","area_id":"a17c7a0e-b8de-45b5-942a-b546e83f07c3","gear_id":"d05e84ad-9549-4f17-9e89-b63e9a03afe6","gear_mesh_size":1,"gear_length":5.75,"gear_count":40,"depth_min":6,"depth_max":7,"start_geo_point":{"lat":{"ddm":{"degrees":50,"minutes":1.11}},"long":{"ddm":{"degrees":-127,"minutes":1.11}}},"mid_geo_point":{"lat":{"ddm":{"degrees":51,"minutes":1.21}},"long":{"ddm":{"degrees":-128,"minutes":1.21}}},"end_geo_point":{"lat":{"ddm":{"degrees":52,"minutes":1.31}},"long":{"ddm":{"degrees":-129,"minutes":1.31}}},"comments":"2 cm gear mesh pots also used."}' -X PUT \
	-H "Authorization: Bearer 15e29550b30e40b1de9e3c3f7515ce8ca5a426d0"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
set_number Set number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Mesh size of gear (cm) Integer
gear_length Length of an individual panel, pot, etc (m) Decimal
gear_count Count of panels, pots, etc Integer
depth_min Minimum gear depth (m) Integer
depth_max Maximum gear depth (m) Integer
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 650bb782-3105-418d-a0c4-9c467d660161

Body

{
  "data": {
    "id": "a118c8ba-4d92-40e0-8820-18defc018056",
    "html_url": "/management/fisheries/49eef8429c84/electronic-monitored-sets/4deea0c9ae1a",
    "fishery_id": "4f87cf24-f3d5-4a1c-a26c-d363b3ee2bb4",
    "fishery_period_id": "234d0cb0-0f2d-4a65-86d9-82f7f475a052",
    "trip_id": "9ef29833-bae3-489e-b81b-605c017277ba",
    "hail_id": "9febdd39-898f-42d6-a9ff-3472a99e6795",
    "started_date_time": "2018-08-03T11:12:00Z",
    "ended_date_time": "2018-08-03T18:01:00Z",
    "set_number": 12,
    "fisherman_id": "1856a124-2119-4298-acb0-487b95f82d5c",
    "monitor_id": "6393af4c-c6de-46b4-845c-a252ce5af899",
    "vessel_id": "9fb91021-0912-4390-8b28-973aee0f21f5",
    "area_id": "a17c7a0e-b8de-45b5-942a-b546e83f07c3",
    "fishery_gear_id": "d05e84ad-9549-4f17-9e89-b63e9a03afe6",
    "gear_mesh_size": 1.0,
    "gear_length": 5.75,
    "gear_count": 40,
    "depth_min": 6,
    "depth_max": 7,
    "start_geo_point": {
      "lat": {
        "dd": {
          "degrees": 50.0185
        },
        "ddm": {
          "degrees": 50,
          "minutes": 1.11
        },
        "dms": {
          "degrees": 50,
          "minutes": 1,
          "seconds": 6.6
        }
      },
      "long": {
        "dd": {
          "degrees": -127.0185
        },
        "ddm": {
          "degrees": -127,
          "minutes": 1.11
        },
        "dms": {
          "degrees": -127,
          "minutes": 1,
          "seconds": 6.6
        }
      }
    },
    "mid_geo_point": {
      "lat": {
        "dd": {
          "degrees": 51.020167
        },
        "ddm": {
          "degrees": 51,
          "minutes": 1.21
        },
        "dms": {
          "degrees": 51,
          "minutes": 1,
          "seconds": 12.6
        }
      },
      "long": {
        "dd": {
          "degrees": -128.020167
        },
        "ddm": {
          "degrees": -128,
          "minutes": 1.21
        },
        "dms": {
          "degrees": -128,
          "minutes": 1,
          "seconds": 12.6
        }
      }
    },
    "end_geo_point": {
      "lat": {
        "dd": {
          "degrees": 52.021833
        },
        "ddm": {
          "degrees": 52,
          "minutes": 1.31
        },
        "dms": {
          "degrees": 52,
          "minutes": 1,
          "seconds": 18.6
        }
      },
      "long": {
        "dd": {
          "degrees": -129.021833
        },
        "ddm": {
          "degrees": -129,
          "minutes": 1.31
        },
        "dms": {
          "degrees": -129,
          "minutes": 1,
          "seconds": 18.6
        }
      }
    },
    "comments": "2 cm gear mesh pots also used.",
    "metadata": {
    },
    "created_date_time": "2018-08-01T00:00:00Z",
    "created_by_name": "Hallie Raynor",
    "updated_date_time": "2020-06-22T19:38:22Z",
    "updated_by_name": "Hallie Raynor",
    "catch": [
      {
        "id": "077f4306-708e-4880-abd6-f3e74fe5945c",
        "fishery_species_id": null,
        "area_id": null,
        "catch_category_id": "524de7a4-a23a-4bf0-abb2-747c5cfb778c",
        "retained_weight": 11.2,
        "released_weight": null,
        "retained_pieces": 8,
        "released_pieces": null,
        "comments": "Unknown fish species.",
        "metadata": {
          "integration_id": 842
        }
      },
      {
        "id": "06a49335-457e-45eb-83c3-a4e130ec6159",
        "fishery_species_id": null,
        "area_id": null,
        "catch_category_id": "fbe64ec7-0b84-4aee-af68-a981efadfdcd",
        "retained_weight": 81.5,
        "released_weight": null,
        "retained_pieces": 332,
        "released_pieces": null,
        "comments": "",
        "metadata": {
        }
      }
    ]
  }
}

Fisheries

Return a list of Fisheries

Endpoint

GET /api/v1/fisheries

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/fisheries

Headers

Authorization: Bearer d5254dd2490f4c061537aa60fc4eaac2bb1e3ce4
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fisheries" -X GET \
	-H "Authorization: Bearer d5254dd2490f4c061537aa60fc4eaac2bb1e3ce4"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
name Name String
active Status Boolean
comments Comments String
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 4ea72402-5777-4993-aa22-6c40c6d50997

Body

{
  "data": [
    {
      "id": "e7f7e256-b613-48ff-8f57-209f989a5bf0",
      "name": "Blue Swimming Crab",
      "active": true,
      "comments": "Located in Lampung, Indonesia",
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Abraham Ziemann",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Abraham Ziemann"
    },
    {
      "id": "3f93e7f8-b6c8-41eb-ad57-77c39e7f34c8",
      "name": "Coho Salmon",
      "active": true,
      "comments": "",
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Abraham Ziemann",
      "updated_date_time": "2018-08-02T00:00:00Z",
      "updated_by_name": "Abraham Ziemann"
    },
    {
      "id": "b5deb5a9-8afb-4d19-b00d-50b8481de8f2",
      "name": "Grounfish Trawl",
      "active": true,
      "comments": "",
      "created_date_time": "2018-07-01T00:00:00Z",
      "created_by_name": "Abraham Ziemann",
      "updated_date_time": "2018-07-02T00:00:00Z",
      "updated_by_name": "Abraham Ziemann"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single Fishery

Endpoint

GET /api/v1/fisheries/:id

Request

Route

GET /api/v1/fisheries/48469255f380

Headers

Authorization: Bearer d5254dd2490f4c061537aa60fc4eaac2bb1e3ce4
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fisheries/48469255f380" -X GET \
	-H "Authorization: Bearer d5254dd2490f4c061537aa60fc4eaac2bb1e3ce4"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
name Name String
active Status Boolean
comments Comments String
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 33de6fa3-25c4-4707-97d4-d611dfc3864d

Body

{
  "data": {
    "id": "e7f7e256-b613-48ff-8f57-209f989a5bf0",
    "name": "Blue Swimming Crab",
    "active": true,
    "comments": "Located in Lampung, Indonesia",
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Abraham Ziemann",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Abraham Ziemann"
  }
}

Fisherman Sets

Create a new Fisherman Set

Endpoint

POST /api/v1/fisherman-sets

Parameters

Name Description Type
fishery_id required ID of fishery UUID
fishery_period_id required ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time required Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
soak_time Soak time Decimal
set_number Set number Integer
fisherman_id ID of fisherman UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Gear mesh size (cm) Integer
gear_length Length of an individual panel, pot, etc (m) Decimal
gear_count Count of panels, pots, etc Integer
target_species_priority_1_id ID of priority 1 target species UUID
target_species_priority_2_id ID of priority 2 target species UUID
target_species_priority_3_id ID of priority 3 target species UUID
depth_target Target gear depth (m) Integer
depth_min Minimum depth (m) Integer
depth_max Maximum depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
catch Catch details Array
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Request

Route

POST /api/v1/fisherman-sets

Headers

Authorization: Bearer 70a0b86d1c5547cd0c5e3a01627bf03a9ae924e0
Content-Type: application/json

Body

{
  "fishery_id": "6ee21aaf-59e6-468b-8600-d0324044a674",
  "fishery_period_id": "3af92f4c-2d01-4629-a297-956ccc4e161e",
  "trip_id": "dbdf45d0-b677-4c10-b0f3-29c89e5e6a12",
  "hail_id": "a8c031a4-be5d-491d-96de-2fb252bc05b2",
  "started_date_time": "2018-09-02T12:19:12",
  "ended_date_time": "2018-09-04T05:22:02",
  "soak_time": 2,
  "set_number": 4,
  "fisherman_id": "96d485a3-f37c-4586-9c78-537de44f7e99",
  "vessel_id": "cdbd784c-d9b2-49be-beed-b27ca4699adc",
  "area_id": "5a5c54cf-e4b1-41ae-af1a-30b54bb1b5b3",
  "fishery_gear_id": "f8019bab-ad6a-4d8c-9db6-fa6c5fcc6e67",
  "gear_mesh_size": 2,
  "gear_length": 5.5,
  "gear_count": 45,
  "target_species_priority_1_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
  "target_species_priority_2_id": "d9daeff1-ba65-4766-aa06-478dd5e8cf41",
  "target_species_priority_3_id": null,
  "depth_target": 9,
  "depth_min": 7,
  "depth_max": 8,
  "start_geo_point": {
    "lat": {
      "dd": {
        "degrees": 50.123
      }
    },
    "long": {
      "dd": {
        "degrees": -127.123
      }
    }
  },
  "mid_geo_point": {
    "lat": {
      "dd": {
        "degrees": 51.123
      }
    },
    "long": {
      "dd": {
        "degrees": -128.123
      }
    }
  },
  "end_geo_point": {
    "lat": {
      "dd": {
        "degrees": 52.123
      }
    },
    "long": {
      "dd": {
        "degrees": -129.123
      }
    }
  },
  "comments": "Summarized data for tow 4",
  "metadata": {
    "color": "grey"
  },
  "catch": [
    {
      "fishery_species_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
      "area_id": "5a5c54cf-e4b1-41ae-af1a-30b54bb1b5b3",
      "catch_category_id": null,
      "retained_weight": 102.1,
      "released_weight": 12.4,
      "retained_pieces": 67,
      "released_pieces": 5
    },
    {
      "fishery_species_id": "d9daeff1-ba65-4766-aa06-478dd5e8cf41",
      "area_id": "e99f7bf7-1f39-4919-8f42-1803a3aa8d73",
      "catch_category_id": null,
      "retained_weight": null,
      "released_weight": 34.2,
      "retained_pieces": null,
      "released_pieces": 6,
      "comments": "comment on catch"
    }
  ]
}

cURL

curl "https://fisheriesapp.com/api/v1/fisherman-sets" -d '{"fishery_id":"6ee21aaf-59e6-468b-8600-d0324044a674","fishery_period_id":"3af92f4c-2d01-4629-a297-956ccc4e161e","trip_id":"dbdf45d0-b677-4c10-b0f3-29c89e5e6a12","hail_id":"a8c031a4-be5d-491d-96de-2fb252bc05b2","started_date_time":"2018-09-02T12:19:12","ended_date_time":"2018-09-04T05:22:02","soak_time":2,"set_number":4,"fisherman_id":"96d485a3-f37c-4586-9c78-537de44f7e99","vessel_id":"cdbd784c-d9b2-49be-beed-b27ca4699adc","area_id":"5a5c54cf-e4b1-41ae-af1a-30b54bb1b5b3","fishery_gear_id":"f8019bab-ad6a-4d8c-9db6-fa6c5fcc6e67","gear_mesh_size":2,"gear_length":5.5,"gear_count":45,"target_species_priority_1_id":"9920543e-10a8-4f75-99cd-ed64ecf06515","target_species_priority_2_id":"d9daeff1-ba65-4766-aa06-478dd5e8cf41","target_species_priority_3_id":null,"depth_target":9,"depth_min":7,"depth_max":8,"start_geo_point":{"lat":{"dd":{"degrees":50.123}},"long":{"dd":{"degrees":-127.123}}},"mid_geo_point":{"lat":{"dd":{"degrees":51.123}},"long":{"dd":{"degrees":-128.123}}},"end_geo_point":{"lat":{"dd":{"degrees":52.123}},"long":{"dd":{"degrees":-129.123}}},"comments":"Summarized data for tow 4","metadata":{"color":"grey"},"catch":[{"fishery_species_id":"9920543e-10a8-4f75-99cd-ed64ecf06515","area_id":"5a5c54cf-e4b1-41ae-af1a-30b54bb1b5b3","catch_category_id":null,"retained_weight":102.1,"released_weight":12.4,"retained_pieces":67,"released_pieces":5},{"fishery_species_id":"d9daeff1-ba65-4766-aa06-478dd5e8cf41","area_id":"e99f7bf7-1f39-4919-8f42-1803a3aa8d73","catch_category_id":null,"retained_weight":null,"released_weight":34.2,"retained_pieces":null,"released_pieces":6,"comments":"comment on catch"}]}' -X POST \
	-H "Authorization: Bearer 70a0b86d1c5547cd0c5e3a01627bf03a9ae924e0"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
soak_time Soak time Decimal
set_number Set number Integer
fisherman_id ID of fisherman UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Mesh size of gear (cm) Decimal
gear_length Length of gear (m) Decimal
gear_count Count of gear (panels, pots, etc) Integer
target_species_priority_1_id ID of priority 1 target species UUID
target_species_priority_2_id ID of priority 2 target species UUID
target_species_priority_3_id ID of priority 3 target species UUID
depth_target Target gear depth (m) Integer
depth_min Minimum gear depth (m) Integer
depth_max Maximum gear depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
submitted_date_time Submitted date/time ISO8601 date/time
validated_date_time Validated date/time ISO8601 date/time
validated_by_name Name of validating user String
validation_comments Validation comments String
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 30cfa1f9-6561-4926-b6c3-269c1d0638ec

Body

{
  "data": {
    "id": "36fd633a-85b3-4199-8b73-061652a7fa8d",
    "html_url": "/management/fisheries/8b34de0b1ada/fisherman-sets/247582afb297",
    "fishery_id": "6ee21aaf-59e6-468b-8600-d0324044a674",
    "fishery_period_id": "3af92f4c-2d01-4629-a297-956ccc4e161e",
    "trip_id": "dbdf45d0-b677-4c10-b0f3-29c89e5e6a12",
    "hail_id": "a8c031a4-be5d-491d-96de-2fb252bc05b2",
    "started_date_time": "2018-09-02T12:19:12Z",
    "ended_date_time": "2018-09-04T05:22:02Z",
    "soak_time": 2.0,
    "set_number": 4,
    "fisherman_id": "96d485a3-f37c-4586-9c78-537de44f7e99",
    "vessel_id": "cdbd784c-d9b2-49be-beed-b27ca4699adc",
    "area_id": "5a5c54cf-e4b1-41ae-af1a-30b54bb1b5b3",
    "fishery_gear_id": "f8019bab-ad6a-4d8c-9db6-fa6c5fcc6e67",
    "gear_mesh_size": 2.0,
    "gear_length": 5.5,
    "gear_count": 45,
    "target_species_priority_1_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
    "target_species_priority_2_id": "d9daeff1-ba65-4766-aa06-478dd5e8cf41",
    "target_species_priority_3_id": null,
    "depth_target": 9,
    "depth_min": 7,
    "depth_max": 8,
    "start_geo_point": {
      "lat": {
        "dd": {
          "degrees": 50.123
        },
        "ddm": {
          "degrees": 50,
          "minutes": 7.38
        },
        "dms": {
          "degrees": 50,
          "minutes": 7,
          "seconds": 22.8
        }
      },
      "long": {
        "dd": {
          "degrees": -127.123
        },
        "ddm": {
          "degrees": -127,
          "minutes": 7.38
        },
        "dms": {
          "degrees": -127,
          "minutes": 7,
          "seconds": 22.8
        }
      }
    },
    "mid_geo_point": {
      "lat": {
        "dd": {
          "degrees": 51.123
        },
        "ddm": {
          "degrees": 51,
          "minutes": 7.38
        },
        "dms": {
          "degrees": 51,
          "minutes": 7,
          "seconds": 22.8
        }
      },
      "long": {
        "dd": {
          "degrees": -128.123
        },
        "ddm": {
          "degrees": -128,
          "minutes": 7.38
        },
        "dms": {
          "degrees": -128,
          "minutes": 7,
          "seconds": 22.8
        }
      }
    },
    "end_geo_point": {
      "lat": {
        "dd": {
          "degrees": 52.123
        },
        "ddm": {
          "degrees": 52,
          "minutes": 7.38
        },
        "dms": {
          "degrees": 52,
          "minutes": 7,
          "seconds": 22.8
        }
      },
      "long": {
        "dd": {
          "degrees": -129.123
        },
        "ddm": {
          "degrees": -129,
          "minutes": 7.38
        },
        "dms": {
          "degrees": -129,
          "minutes": 7,
          "seconds": 22.8
        }
      }
    },
    "comments": "Summarized data for tow 4",
    "metadata": {
      "color": "grey"
    },
    "created_date_time": "2020-06-22T19:38:21Z",
    "created_by_name": "Isis Walsh",
    "updated_date_time": "2020-06-22T19:38:21Z",
    "updated_by_name": "Isis Walsh",
    "submitted_date_time": null,
    "validated_date_time": null,
    "validated_by_name": null,
    "validation_comments": null,
    "catch": [
      {
        "id": "2fd46675-c37a-43e1-a84d-433d28deb78a",
        "fishery_species_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
        "area_id": "5a5c54cf-e4b1-41ae-af1a-30b54bb1b5b3",
        "catch_category_id": null,
        "retained_weight": 102.1,
        "released_weight": 12.4,
        "retained_pieces": null,
        "released_pieces": null,
        "comments": null,
        "metadata": {
        }
      },
      {
        "id": "34eee455-4a6a-45a4-8b47-6c871f0daff2",
        "fishery_species_id": "d9daeff1-ba65-4766-aa06-478dd5e8cf41",
        "area_id": "e99f7bf7-1f39-4919-8f42-1803a3aa8d73",
        "catch_category_id": null,
        "retained_weight": null,
        "released_weight": 34.2,
        "retained_pieces": null,
        "released_pieces": null,
        "comments": "comment on catch",
        "metadata": {
        }
      }
    ]
  }
}

Delete an existing Fisherman Set

Endpoint

DELETE /api/v1/fisherman-sets/:id

Request

Route

DELETE /api/v1/fisherman-sets/25dc1c7f-ffb5-4937-8aa9-f549e5bb42f0

Headers

Authorization: Bearer 70a0b86d1c5547cd0c5e3a01627bf03a9ae924e0
Content-Type: application/json

cURL

curl "https://fisheriesapp.com/api/v1/fisherman-sets/25dc1c7f-ffb5-4937-8aa9-f549e5bb42f0" -d '' -X DELETE \
	-H "Authorization: Bearer 70a0b86d1c5547cd0c5e3a01627bf03a9ae924e0"

Response

Simulated Response

Status

204

Headers

X-Request-Id: 12196f97-88cb-470d-bf64-ea04c0611649

Return a list of Fisherman Sets

Endpoint

GET /api/v1/fisherman-sets

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time
fishery_id Optionally specify one or more fisheries as a comma separated list of IDs String
fishery_period_id Optionally specify one or more periods as a comma separated list of IDs; leaving blank defaults to returning data from any fisheries current period String

Request

Route

GET /api/v1/fisherman-sets

Headers

Authorization: Bearer 70a0b86d1c5547cd0c5e3a01627bf03a9ae924e0
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fisherman-sets" -X GET \
	-H "Authorization: Bearer 70a0b86d1c5547cd0c5e3a01627bf03a9ae924e0"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
soak_time Soak time Decimal
set_number Set number Integer
fisherman_id ID of fisherman UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Mesh size of gear (cm) Decimal
gear_length Length of gear (m) Decimal
gear_count Count of gear (panels, pots, etc) Integer
target_species_priority_1_id ID of priority 1 target species UUID
target_species_priority_2_id ID of priority 2 target species UUID
target_species_priority_3_id ID of priority 3 target species UUID
depth_target Target gear depth (m) Integer
depth_min Minimum gear depth (m) Integer
depth_max Maximum gear depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
submitted_date_time Submitted date/time ISO8601 date/time
validated_date_time Validated date/time ISO8601 date/time
validated_by_name Name of validating user String
validation_comments Validation comments String
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: ea1f7005-e9d5-441d-87e9-c1bcea020fbf

Body

{
  "data": [
    {
      "id": "36fd633a-85b3-4199-8b73-061652a7fa8d",
      "html_url": "/management/fisheries/8b34de0b1ada/fisherman-sets/247582afb297",
      "fishery_id": "6ee21aaf-59e6-468b-8600-d0324044a674",
      "fishery_period_id": "3af92f4c-2d01-4629-a297-956ccc4e161e",
      "trip_id": "dbdf45d0-b677-4c10-b0f3-29c89e5e6a12",
      "hail_id": "a8c031a4-be5d-491d-96de-2fb252bc05b2",
      "started_date_time": "2018-09-02T12:19:12Z",
      "ended_date_time": "2018-09-04T05:22:02Z",
      "soak_time": 2.0,
      "set_number": 4,
      "fisherman_id": "96d485a3-f37c-4586-9c78-537de44f7e99",
      "vessel_id": "cdbd784c-d9b2-49be-beed-b27ca4699adc",
      "area_id": "5a5c54cf-e4b1-41ae-af1a-30b54bb1b5b3",
      "fishery_gear_id": "f8019bab-ad6a-4d8c-9db6-fa6c5fcc6e67",
      "gear_mesh_size": 2.0,
      "gear_length": 5.5,
      "gear_count": 45,
      "target_species_priority_1_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
      "target_species_priority_2_id": "d9daeff1-ba65-4766-aa06-478dd5e8cf41",
      "target_species_priority_3_id": null,
      "depth_target": 9,
      "depth_min": 7,
      "depth_max": 8,
      "start_geo_point": {
        "lat": {
          "dd": {
            "degrees": 50.123
          },
          "ddm": {
            "degrees": 50,
            "minutes": 7.38
          },
          "dms": {
            "degrees": 50,
            "minutes": 7,
            "seconds": 22.8
          }
        },
        "long": {
          "dd": {
            "degrees": -127.123
          },
          "ddm": {
            "degrees": -127,
            "minutes": 7.38
          },
          "dms": {
            "degrees": -127,
            "minutes": 7,
            "seconds": 22.8
          }
        }
      },
      "mid_geo_point": {
        "lat": {
          "dd": {
            "degrees": 51.123
          },
          "ddm": {
            "degrees": 51,
            "minutes": 7.38
          },
          "dms": {
            "degrees": 51,
            "minutes": 7,
            "seconds": 22.8
          }
        },
        "long": {
          "dd": {
            "degrees": -128.123
          },
          "ddm": {
            "degrees": -128,
            "minutes": 7.38
          },
          "dms": {
            "degrees": -128,
            "minutes": 7,
            "seconds": 22.8
          }
        }
      },
      "end_geo_point": {
        "lat": {
          "dd": {
            "degrees": 52.123
          },
          "ddm": {
            "degrees": 52,
            "minutes": 7.38
          },
          "dms": {
            "degrees": 52,
            "minutes": 7,
            "seconds": 22.8
          }
        },
        "long": {
          "dd": {
            "degrees": -129.123
          },
          "ddm": {
            "degrees": -129,
            "minutes": 7.38
          },
          "dms": {
            "degrees": -129,
            "minutes": 7,
            "seconds": 22.8
          }
        }
      },
      "comments": "Summarized data for tow 4",
      "metadata": {
        "color": "grey"
      },
      "created_date_time": "2020-06-22T19:38:21Z",
      "created_by_name": "Isis Walsh",
      "updated_date_time": "2020-06-22T19:38:21Z",
      "updated_by_name": "Isis Walsh",
      "submitted_date_time": null,
      "validated_date_time": null,
      "validated_by_name": null,
      "validation_comments": null,
      "catch": [
        {
          "id": "2fd46675-c37a-43e1-a84d-433d28deb78a",
          "fishery_species_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
          "area_id": "5a5c54cf-e4b1-41ae-af1a-30b54bb1b5b3",
          "catch_category_id": null,
          "retained_weight": 102.1,
          "released_weight": 12.4,
          "retained_pieces": null,
          "released_pieces": null,
          "comments": null,
          "metadata": {
          }
        },
        {
          "id": "34eee455-4a6a-45a4-8b47-6c871f0daff2",
          "fishery_species_id": "d9daeff1-ba65-4766-aa06-478dd5e8cf41",
          "area_id": "e99f7bf7-1f39-4919-8f42-1803a3aa8d73",
          "catch_category_id": null,
          "retained_weight": null,
          "released_weight": 34.2,
          "retained_pieces": null,
          "released_pieces": null,
          "comments": "comment on catch",
          "metadata": {
          }
        }
      ]
    },
    {
      "id": "02a7a721-20e1-4090-a860-7cb9191c7a9f",
      "html_url": "/management/fisheries/8b34de0b1ada/fisherman-sets/e6202a3a6b88",
      "fishery_id": "6ee21aaf-59e6-468b-8600-d0324044a674",
      "fishery_period_id": "3af92f4c-2d01-4629-a297-956ccc4e161e",
      "trip_id": "dbdf45d0-b677-4c10-b0f3-29c89e5e6a12",
      "hail_id": null,
      "started_date_time": "2020-03-28T18:49:20Z",
      "ended_date_time": "2020-03-28T20:49:20Z",
      "soak_time": 674.13,
      "set_number": 1,
      "fisherman_id": "96d485a3-f37c-4586-9c78-537de44f7e99",
      "vessel_id": "cdbd784c-d9b2-49be-beed-b27ca4699adc",
      "area_id": "5a5c54cf-e4b1-41ae-af1a-30b54bb1b5b3",
      "fishery_gear_id": "f8019bab-ad6a-4d8c-9db6-fa6c5fcc6e67",
      "gear_mesh_size": 10.0,
      "gear_length": 70.5,
      "gear_count": 60,
      "target_species_priority_1_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
      "target_species_priority_2_id": null,
      "target_species_priority_3_id": null,
      "depth_target": 12,
      "depth_min": 10,
      "depth_max": 15,
      "start_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.686453
          },
          "ddm": {
            "degrees": 49,
            "minutes": 41.1872
          },
          "dms": {
            "degrees": 49,
            "minutes": 41,
            "seconds": 11.2308
          }
        },
        "long": {
          "dd": {
            "degrees": -124.280624
          },
          "ddm": {
            "degrees": -124,
            "minutes": 16.8374
          },
          "dms": {
            "degrees": -124,
            "minutes": 16,
            "seconds": 50.2464
          }
        }
      },
      "mid_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.498926
          },
          "ddm": {
            "degrees": 49,
            "minutes": 29.9356
          },
          "dms": {
            "degrees": 49,
            "minutes": 29,
            "seconds": 56.1336
          }
        },
        "long": {
          "dd": {
            "degrees": -124.041773
          },
          "ddm": {
            "degrees": -124,
            "minutes": 2.5064
          },
          "dms": {
            "degrees": -124,
            "minutes": 2,
            "seconds": 30.3828
          }
        }
      },
      "end_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.45798
          },
          "ddm": {
            "degrees": 49,
            "minutes": 27.4788
          },
          "dms": {
            "degrees": 49,
            "minutes": 27,
            "seconds": 28.728
          }
        },
        "long": {
          "dd": {
            "degrees": -123.978817
          },
          "ddm": {
            "degrees": -123,
            "minutes": 58.729
          },
          "dms": {
            "degrees": -123,
            "minutes": 58,
            "seconds": 43.7412
          }
        }
      },
      "comments": "",
      "metadata": {
        "color": "grey"
      },
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Isis Walsh",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Isis Walsh",
      "submitted_date_time": null,
      "validated_date_time": null,
      "validated_by_name": null,
      "validation_comments": null,
      "catch": [
        {
          "id": "b363583f-a152-4269-9943-5a78b2ffd317",
          "fishery_species_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
          "area_id": null,
          "catch_category_id": "c779d1c4-44ad-474f-8d67-0ef7c151e659",
          "retained_weight": 360.0,
          "released_weight": 18.3,
          "retained_pieces": 2352,
          "released_pieces": 241,
          "comments": "Released catch too small for market.",
          "metadata": {
            "integration_id": 4890
          }
        },
        {
          "id": "6108f95d-2de3-43cf-a0ba-08666c2e6fa2",
          "fishery_species_id": "d9daeff1-ba65-4766-aa06-478dd5e8cf41",
          "area_id": null,
          "catch_category_id": "99dca976-aa66-4df4-9e9b-4a75b4859661",
          "retained_weight": 81.5,
          "released_weight": null,
          "retained_pieces": 7,
          "released_pieces": null,
          "comments": "",
          "metadata": {
          }
        }
      ]
    },
    {
      "id": "fa275d7e-7ca4-4ad1-82d5-e0fdde451e91",
      "html_url": "/management/fisheries/8b34de0b1ada/fisherman-sets/c3d99cfe6d29",
      "fishery_id": "6ee21aaf-59e6-468b-8600-d0324044a674",
      "fishery_period_id": "3af92f4c-2d01-4629-a297-956ccc4e161e",
      "trip_id": null,
      "hail_id": null,
      "started_date_time": "2020-04-16T19:13:20Z",
      "ended_date_time": "2020-04-16T21:13:20Z",
      "soak_time": 296.77,
      "set_number": 2,
      "fisherman_id": "31ba1778-a059-46fe-bcd1-3113894ae6fc",
      "vessel_id": "e82ff582-5477-49a7-8d6d-988100402331",
      "area_id": "e99f7bf7-1f39-4919-8f42-1803a3aa8d73",
      "fishery_gear_id": "85b87621-0a1d-4106-ac62-bd54e35feab6",
      "gear_mesh_size": 1.0,
      "gear_length": 46.25,
      "gear_count": 160,
      "target_species_priority_1_id": "d9daeff1-ba65-4766-aa06-478dd5e8cf41",
      "target_species_priority_2_id": null,
      "target_species_priority_3_id": null,
      "depth_target": 5,
      "depth_min": 4,
      "depth_max": 6,
      "start_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.686453
          },
          "ddm": {
            "degrees": 49,
            "minutes": 41.1872
          },
          "dms": {
            "degrees": 49,
            "minutes": 41,
            "seconds": 11.2308
          }
        },
        "long": {
          "dd": {
            "degrees": -124.280624
          },
          "ddm": {
            "degrees": -124,
            "minutes": 16.8374
          },
          "dms": {
            "degrees": -124,
            "minutes": 16,
            "seconds": 50.2464
          }
        }
      },
      "mid_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.498926
          },
          "ddm": {
            "degrees": 49,
            "minutes": 29.9356
          },
          "dms": {
            "degrees": 49,
            "minutes": 29,
            "seconds": 56.1336
          }
        },
        "long": {
          "dd": {
            "degrees": -124.041773
          },
          "ddm": {
            "degrees": -124,
            "minutes": 2.5064
          },
          "dms": {
            "degrees": -124,
            "minutes": 2,
            "seconds": 30.3828
          }
        }
      },
      "end_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.45798
          },
          "ddm": {
            "degrees": 49,
            "minutes": 27.4788
          },
          "dms": {
            "degrees": 49,
            "minutes": 27,
            "seconds": 28.728
          }
        },
        "long": {
          "dd": {
            "degrees": -123.978817
          },
          "ddm": {
            "degrees": -123,
            "minutes": 58.729
          },
          "dms": {
            "degrees": -123,
            "minutes": 58,
            "seconds": 43.7412
          }
        }
      },
      "comments": "",
      "metadata": {
      },
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Isis Walsh",
      "updated_date_time": "2018-08-02T00:00:00Z",
      "updated_by_name": "Isis Walsh",
      "submitted_date_time": null,
      "validated_date_time": null,
      "validated_by_name": null,
      "validation_comments": null,
      "catch": [
        {
          "id": "5c851553-77ca-471a-bec4-ad27c1018f74",
          "fishery_species_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
          "area_id": null,
          "catch_category_id": "c779d1c4-44ad-474f-8d67-0ef7c151e659",
          "retained_weight": 11.2,
          "released_weight": null,
          "retained_pieces": 8,
          "released_pieces": null,
          "comments": "Unknown fish species.",
          "metadata": {
            "integration_id": 842
          }
        },
        {
          "id": "71207eaf-b16e-48b4-97b3-49cd0a38e01a",
          "fishery_species_id": "d9daeff1-ba65-4766-aa06-478dd5e8cf41",
          "area_id": null,
          "catch_category_id": "99dca976-aa66-4df4-9e9b-4a75b4859661",
          "retained_weight": 81.5,
          "released_weight": null,
          "retained_pieces": 332,
          "released_pieces": null,
          "comments": "",
          "metadata": {
          }
        }
      ]
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single Fisherman Set

Endpoint

GET /api/v1/fisherman-sets/:id

Request

Route

GET /api/v1/fisherman-sets/02a7a721-20e1-4090-a860-7cb9191c7a9f

Headers

Authorization: Bearer 70a0b86d1c5547cd0c5e3a01627bf03a9ae924e0
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fisherman-sets/02a7a721-20e1-4090-a860-7cb9191c7a9f" -X GET \
	-H "Authorization: Bearer 70a0b86d1c5547cd0c5e3a01627bf03a9ae924e0"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
soak_time Soak time Decimal
set_number Set number Integer
fisherman_id ID of fisherman UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Mesh size of gear (cm) Decimal
gear_length Length of gear (m) Decimal
gear_count Count of gear (panels, pots, etc) Integer
target_species_priority_1_id ID of priority 1 target species UUID
target_species_priority_2_id ID of priority 2 target species UUID
target_species_priority_3_id ID of priority 3 target species UUID
depth_target Target gear depth (m) Integer
depth_min Minimum gear depth (m) Integer
depth_max Maximum gear depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
submitted_date_time Submitted date/time ISO8601 date/time
validated_date_time Validated date/time ISO8601 date/time
validated_by_name Name of validating user String
validation_comments Validation comments String
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 825c0dc9-3cc4-43dc-8b99-3566c647d9a3

Body

{
  "data": {
    "id": "02a7a721-20e1-4090-a860-7cb9191c7a9f",
    "html_url": "/management/fisheries/8b34de0b1ada/fisherman-sets/e6202a3a6b88",
    "fishery_id": "6ee21aaf-59e6-468b-8600-d0324044a674",
    "fishery_period_id": "3af92f4c-2d01-4629-a297-956ccc4e161e",
    "trip_id": "dbdf45d0-b677-4c10-b0f3-29c89e5e6a12",
    "hail_id": null,
    "started_date_time": "2020-03-28T18:49:20Z",
    "ended_date_time": "2020-03-28T20:49:20Z",
    "soak_time": 674.13,
    "set_number": 1,
    "fisherman_id": "96d485a3-f37c-4586-9c78-537de44f7e99",
    "vessel_id": "cdbd784c-d9b2-49be-beed-b27ca4699adc",
    "area_id": "5a5c54cf-e4b1-41ae-af1a-30b54bb1b5b3",
    "fishery_gear_id": "f8019bab-ad6a-4d8c-9db6-fa6c5fcc6e67",
    "gear_mesh_size": 10.0,
    "gear_length": 70.5,
    "gear_count": 60,
    "target_species_priority_1_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
    "target_species_priority_2_id": null,
    "target_species_priority_3_id": null,
    "depth_target": 12,
    "depth_min": 10,
    "depth_max": 15,
    "start_geo_point": {
      "lat": {
        "dd": {
          "degrees": 49.686453
        },
        "ddm": {
          "degrees": 49,
          "minutes": 41.1872
        },
        "dms": {
          "degrees": 49,
          "minutes": 41,
          "seconds": 11.2308
        }
      },
      "long": {
        "dd": {
          "degrees": -124.280624
        },
        "ddm": {
          "degrees": -124,
          "minutes": 16.8374
        },
        "dms": {
          "degrees": -124,
          "minutes": 16,
          "seconds": 50.2464
        }
      }
    },
    "mid_geo_point": {
      "lat": {
        "dd": {
          "degrees": 49.498926
        },
        "ddm": {
          "degrees": 49,
          "minutes": 29.9356
        },
        "dms": {
          "degrees": 49,
          "minutes": 29,
          "seconds": 56.1336
        }
      },
      "long": {
        "dd": {
          "degrees": -124.041773
        },
        "ddm": {
          "degrees": -124,
          "minutes": 2.5064
        },
        "dms": {
          "degrees": -124,
          "minutes": 2,
          "seconds": 30.3828
        }
      }
    },
    "end_geo_point": {
      "lat": {
        "dd": {
          "degrees": 49.45798
        },
        "ddm": {
          "degrees": 49,
          "minutes": 27.4788
        },
        "dms": {
          "degrees": 49,
          "minutes": 27,
          "seconds": 28.728
        }
      },
      "long": {
        "dd": {
          "degrees": -123.978817
        },
        "ddm": {
          "degrees": -123,
          "minutes": 58.729
        },
        "dms": {
          "degrees": -123,
          "minutes": 58,
          "seconds": 43.7412
        }
      }
    },
    "comments": "",
    "metadata": {
      "color": "grey"
    },
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Isis Walsh",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Isis Walsh",
    "submitted_date_time": null,
    "validated_date_time": null,
    "validated_by_name": null,
    "validation_comments": null,
    "catch": [
      {
        "id": "b363583f-a152-4269-9943-5a78b2ffd317",
        "fishery_species_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
        "area_id": null,
        "catch_category_id": "c779d1c4-44ad-474f-8d67-0ef7c151e659",
        "retained_weight": 360.0,
        "released_weight": 18.3,
        "retained_pieces": 2352,
        "released_pieces": 241,
        "comments": "Released catch too small for market.",
        "metadata": {
          "integration_id": 4890
        }
      },
      {
        "id": "6108f95d-2de3-43cf-a0ba-08666c2e6fa2",
        "fishery_species_id": "d9daeff1-ba65-4766-aa06-478dd5e8cf41",
        "area_id": null,
        "catch_category_id": "99dca976-aa66-4df4-9e9b-4a75b4859661",
        "retained_weight": 81.5,
        "released_weight": null,
        "retained_pieces": 7,
        "released_pieces": null,
        "comments": "",
        "metadata": {
        }
      }
    ]
  }
}

Update an existing Fisherman Set

Endpoint

PUT /api/v1/fisherman-sets/:id

Parameters

Name Description Type
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
soak_time Soak time Decimal
set_number Set number Integer
fisherman_id ID of fisherman UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Gear mesh size (cm) Integer
gear_length Length of an individual panel, pot, etc (m) Decimal
gear_count Count of panels, pots, etc Integer
target_species_priority_1_id ID of priority 1 target species UUID
target_species_priority_2_id ID of priority 2 target species UUID
target_species_priority_3_id ID of priority 3 target species UUID
depth_target Target gear depth (m) Integer
depth_min Minimum depth (m) Integer
depth_max Maximum depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Request

Route

PUT /api/v1/fisherman-sets/fa275d7e-7ca4-4ad1-82d5-e0fdde451e91

Headers

Authorization: Bearer 70a0b86d1c5547cd0c5e3a01627bf03a9ae924e0
Content-Type: application/json

Body

{
  "trip_id": "dbdf45d0-b677-4c10-b0f3-29c89e5e6a12",
  "hail_id": "a8c031a4-be5d-491d-96de-2fb252bc05b2",
  "started_date_time": "2018-08-03T11:12Z",
  "ended_date_time": "2018-08-03T18:01Z",
  "soak_time": 3,
  "set_number": 12,
  "fisherman_id": "31ba1778-a059-46fe-bcd1-3113894ae6fc",
  "vessel_id": "e82ff582-5477-49a7-8d6d-988100402331",
  "area_id": "e99f7bf7-1f39-4919-8f42-1803a3aa8d73",
  "gear_id": "85b87621-0a1d-4106-ac62-bd54e35feab6",
  "gear_mesh_size": 2,
  "gear_length": 5.75,
  "gear_count": 40,
  "target_species_priority_1_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
  "target_species_priority_2_id": "d9daeff1-ba65-4766-aa06-478dd5e8cf41",
  "target_species_priority_3_id": null,
  "depth_target": 7,
  "depth_min": 6,
  "depth_max": 7,
  "start_geo_point": {
    "lat": {
      "ddm": {
        "degrees": 50,
        "minutes": 1.11
      }
    },
    "long": {
      "ddm": {
        "degrees": -127,
        "minutes": 1.11
      }
    }
  },
  "mid_geo_point": {
    "lat": {
      "ddm": {
        "degrees": 51,
        "minutes": 1.21
      }
    },
    "long": {
      "ddm": {
        "degrees": -128,
        "minutes": 1.21
      }
    }
  },
  "end_geo_point": {
    "lat": {
      "ddm": {
        "degrees": 52,
        "minutes": 1.31
      }
    },
    "long": {
      "ddm": {
        "degrees": -129,
        "minutes": 1.31
      }
    }
  },
  "comments": "2 cm gear mesh pots also used.",
  "metadata": {
    "color": "grey"
  },
  "catch": [
    {
      "id": "5c851553-77ca-471a-bec4-ad27c1018f74",
      "fishery_species_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
      "catch_category_id": "c779d1c4-44ad-474f-8d67-0ef7c151e659",
      "retained_weight": 11.2,
      "released_weight": null,
      "retained_pieces": 3,
      "released_pieces": "Unknown fish species."
    },
    {
      "id": "71207eaf-b16e-48b4-97b3-49cd0a38e01a",
      "fishery_species_id": "d9daeff1-ba65-4766-aa06-478dd5e8cf41",
      "catch_category_id": "99dca976-aa66-4df4-9e9b-4a75b4859661",
      "retained_weight": null,
      "released_weight": 14,
      "retained_pieces": null,
      "released_pieces": 7,
      "comments": null
    }
  ]
}

cURL

curl "https://fisheriesapp.com/api/v1/fisherman-sets/fa275d7e-7ca4-4ad1-82d5-e0fdde451e91" -d '{"trip_id":"dbdf45d0-b677-4c10-b0f3-29c89e5e6a12","hail_id":"a8c031a4-be5d-491d-96de-2fb252bc05b2","started_date_time":"2018-08-03T11:12Z","ended_date_time":"2018-08-03T18:01Z","soak_time":3,"set_number":12,"fisherman_id":"31ba1778-a059-46fe-bcd1-3113894ae6fc","vessel_id":"e82ff582-5477-49a7-8d6d-988100402331","area_id":"e99f7bf7-1f39-4919-8f42-1803a3aa8d73","gear_id":"85b87621-0a1d-4106-ac62-bd54e35feab6","gear_mesh_size":2,"gear_length":5.75,"gear_count":40,"target_species_priority_1_id":"9920543e-10a8-4f75-99cd-ed64ecf06515","target_species_priority_2_id":"d9daeff1-ba65-4766-aa06-478dd5e8cf41","target_species_priority_3_id":null,"depth_target":7,"depth_min":6,"depth_max":7,"start_geo_point":{"lat":{"ddm":{"degrees":50,"minutes":1.11}},"long":{"ddm":{"degrees":-127,"minutes":1.11}}},"mid_geo_point":{"lat":{"ddm":{"degrees":51,"minutes":1.21}},"long":{"ddm":{"degrees":-128,"minutes":1.21}}},"end_geo_point":{"lat":{"ddm":{"degrees":52,"minutes":1.31}},"long":{"ddm":{"degrees":-129,"minutes":1.31}}},"comments":"2 cm gear mesh pots also used.","metadata":{"color":"grey"},"catch":[{"id":"5c851553-77ca-471a-bec4-ad27c1018f74","fishery_species_id":"9920543e-10a8-4f75-99cd-ed64ecf06515","catch_category_id":"c779d1c4-44ad-474f-8d67-0ef7c151e659","retained_weight":11.2,"released_weight":null,"retained_pieces":3,"released_pieces":"Unknown fish species."},{"id":"71207eaf-b16e-48b4-97b3-49cd0a38e01a","fishery_species_id":"d9daeff1-ba65-4766-aa06-478dd5e8cf41","catch_category_id":"99dca976-aa66-4df4-9e9b-4a75b4859661","retained_weight":null,"released_weight":14,"retained_pieces":null,"released_pieces":7,"comments":null}]}' -X PUT \
	-H "Authorization: Bearer 70a0b86d1c5547cd0c5e3a01627bf03a9ae924e0"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
soak_time Soak time Decimal
set_number Set number Integer
fisherman_id ID of fisherman UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Mesh size of gear (cm) Decimal
gear_length Length of gear (m) Decimal
gear_count Count of gear (panels, pots, etc) Integer
target_species_priority_1_id ID of priority 1 target species UUID
target_species_priority_2_id ID of priority 2 target species UUID
target_species_priority_3_id ID of priority 3 target species UUID
depth_target Target gear depth (m) Integer
depth_min Minimum gear depth (m) Integer
depth_max Maximum gear depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
submitted_date_time Submitted date/time ISO8601 date/time
validated_date_time Validated date/time ISO8601 date/time
validated_by_name Name of validating user String
validation_comments Validation comments String
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 3d5b942f-a133-4af3-8ddb-d9c77a08e1c5

Body

{
  "data": {
    "id": "fa275d7e-7ca4-4ad1-82d5-e0fdde451e91",
    "html_url": "/management/fisheries/8b34de0b1ada/fisherman-sets/c3d99cfe6d29",
    "fishery_id": "6ee21aaf-59e6-468b-8600-d0324044a674",
    "fishery_period_id": "3af92f4c-2d01-4629-a297-956ccc4e161e",
    "trip_id": "dbdf45d0-b677-4c10-b0f3-29c89e5e6a12",
    "hail_id": "a8c031a4-be5d-491d-96de-2fb252bc05b2",
    "started_date_time": "2018-08-03T11:12:00Z",
    "ended_date_time": "2018-08-03T18:01:00Z",
    "soak_time": 3.0,
    "set_number": 12,
    "fisherman_id": "31ba1778-a059-46fe-bcd1-3113894ae6fc",
    "vessel_id": "e82ff582-5477-49a7-8d6d-988100402331",
    "area_id": "e99f7bf7-1f39-4919-8f42-1803a3aa8d73",
    "fishery_gear_id": "85b87621-0a1d-4106-ac62-bd54e35feab6",
    "gear_mesh_size": 2.0,
    "gear_length": 5.75,
    "gear_count": 40,
    "target_species_priority_1_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
    "target_species_priority_2_id": "d9daeff1-ba65-4766-aa06-478dd5e8cf41",
    "target_species_priority_3_id": null,
    "depth_target": 7,
    "depth_min": 6,
    "depth_max": 7,
    "start_geo_point": {
      "lat": {
        "dd": {
          "degrees": 50.0185
        },
        "ddm": {
          "degrees": 50,
          "minutes": 1.11
        },
        "dms": {
          "degrees": 50,
          "minutes": 1,
          "seconds": 6.6
        }
      },
      "long": {
        "dd": {
          "degrees": -127.0185
        },
        "ddm": {
          "degrees": -127,
          "minutes": 1.11
        },
        "dms": {
          "degrees": -127,
          "minutes": 1,
          "seconds": 6.6
        }
      }
    },
    "mid_geo_point": {
      "lat": {
        "dd": {
          "degrees": 51.020167
        },
        "ddm": {
          "degrees": 51,
          "minutes": 1.21
        },
        "dms": {
          "degrees": 51,
          "minutes": 1,
          "seconds": 12.6
        }
      },
      "long": {
        "dd": {
          "degrees": -128.020167
        },
        "ddm": {
          "degrees": -128,
          "minutes": 1.21
        },
        "dms": {
          "degrees": -128,
          "minutes": 1,
          "seconds": 12.6
        }
      }
    },
    "end_geo_point": {
      "lat": {
        "dd": {
          "degrees": 52.021833
        },
        "ddm": {
          "degrees": 52,
          "minutes": 1.31
        },
        "dms": {
          "degrees": 52,
          "minutes": 1,
          "seconds": 18.6
        }
      },
      "long": {
        "dd": {
          "degrees": -129.021833
        },
        "ddm": {
          "degrees": -129,
          "minutes": 1.31
        },
        "dms": {
          "degrees": -129,
          "minutes": 1,
          "seconds": 18.6
        }
      }
    },
    "comments": "2 cm gear mesh pots also used.",
    "metadata": {
      "color": "grey"
    },
    "created_date_time": "2018-08-01T00:00:00Z",
    "created_by_name": "Isis Walsh",
    "updated_date_time": "2020-06-22T19:38:21Z",
    "updated_by_name": "Isis Walsh",
    "submitted_date_time": null,
    "validated_date_time": null,
    "validated_by_name": null,
    "validation_comments": null,
    "catch": [
      {
        "id": "5c851553-77ca-471a-bec4-ad27c1018f74",
        "fishery_species_id": "9920543e-10a8-4f75-99cd-ed64ecf06515",
        "area_id": null,
        "catch_category_id": "c779d1c4-44ad-474f-8d67-0ef7c151e659",
        "retained_weight": 11.2,
        "released_weight": null,
        "retained_pieces": 8,
        "released_pieces": null,
        "comments": null,
        "metadata": {
          "integration_id": 842
        }
      },
      {
        "id": "71207eaf-b16e-48b4-97b3-49cd0a38e01a",
        "fishery_species_id": "d9daeff1-ba65-4766-aa06-478dd5e8cf41",
        "area_id": null,
        "catch_category_id": "99dca976-aa66-4df4-9e9b-4a75b4859661",
        "retained_weight": null,
        "released_weight": 14.0,
        "retained_pieces": 332,
        "released_pieces": null,
        "comments": null,
        "metadata": {
        }
      }
    ]
  }
}

Fishermen

Create a new Fisherman

Endpoint

POST /api/v1/fishermen

Parameters

Name Description Type
first_name First name String
last_name Last name String
code Code String
active Status Boolean
comments Comments String
metadada Metadata JSON

Request

Route

POST /api/v1/fishermen

Headers

Authorization: Bearer 70fefd5db51c03d372d03d3b3609105908b88eb8
Content-Type: application/json

Body

{
  "first_name": "John",
  "last_name": "Smith",
  "code": "JS001",
  "active": true,
  "comments": "New fisherman as of July 2018"
}

cURL

curl "https://fisheriesapp.com/api/v1/fishermen" -d '{"first_name":"John","last_name":"Smith","code":"JS001","active":true,"comments":"New fisherman as of July 2018"}' -X POST \
	-H "Authorization: Bearer 70fefd5db51c03d372d03d3b3609105908b88eb8"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
first_name First name String
last_name Last name String
code Code String
active Status Boolean
comments Comments String
metadada Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 2da60aaf-5aa5-43ed-abc7-6330490abbc8

Body

{
  "data": {
    "id": "4fe40014-42ad-4def-8d44-980b83120ab3",
    "html_url": "/management/account/fishermen/e585aaac3ca6",
    "first_name": "John",
    "last_name": "Smith",
    "code": "JS001",
    "active": true,
    "comments": "New fisherman as of July 2018",
    "metadata": {
    },
    "created_date_time": "2020-06-22T19:38:23Z",
    "created_by_name": "Mikel Rath",
    "updated_date_time": "2020-06-22T19:38:23Z",
    "updated_by_name": "Mikel Rath"
  }
}

Delete an existing Fisherman

Endpoint

DELETE /api/v1/fishermen/:id

Request

Route

DELETE /api/v1/fishermen/28feb572-f15d-4806-b08c-5ce1060747d9

Headers

Authorization: Bearer 70fefd5db51c03d372d03d3b3609105908b88eb8
Content-Type: application/json

cURL

curl "https://fisheriesapp.com/api/v1/fishermen/28feb572-f15d-4806-b08c-5ce1060747d9" -d '' -X DELETE \
	-H "Authorization: Bearer 70fefd5db51c03d372d03d3b3609105908b88eb8"

Response

Simulated Response

Status

204

Headers

X-Request-Id: e99951e9-5182-4382-bf73-6648417d246c

Return a list of Fishermen

Endpoint

GET /api/v1/fishermen

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/fishermen

Headers

Authorization: Bearer 70fefd5db51c03d372d03d3b3609105908b88eb8
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fishermen" -X GET \
	-H "Authorization: Bearer 70fefd5db51c03d372d03d3b3609105908b88eb8"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
first_name First name String
last_name Last name String
code Code String
active Status Boolean
comments Comments String
metadada Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 23cc448d-1bbc-4910-97f7-e02edc96fd71

Body

{
  "data": [
    {
      "id": "72e7a086-33a9-4011-bcc4-412376a715cb",
      "html_url": "/management/account/fishermen/b3d3d055d370",
      "first_name": "Dedi",
      "last_name": "Ferlamin",
      "code": "001",
      "active": true,
      "comments": "Comment",
      "metadata": {
        "color": "silver"
      },
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Mikel Rath",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Mikel Rath"
    },
    {
      "id": "751cf250-610d-4832-9bcb-465f22aee337",
      "html_url": "/management/account/fishermen/64eab47dd17d",
      "first_name": "Dharta",
      "last_name": "Mahardani",
      "code": "005",
      "active": true,
      "comments": "Optio voluptatem aut impedit.",
      "metadata": {
      },
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Mikel Rath",
      "updated_date_time": "2018-08-02T00:00:00Z",
      "updated_by_name": "Mikel Rath"
    },
    {
      "id": "28feb572-f15d-4806-b08c-5ce1060747d9",
      "html_url": "/management/account/fishermen/524cc4b58fb2",
      "first_name": "Khanif",
      "last_name": "Ardiansyah",
      "code": "022",
      "active": true,
      "comments": "Fuga alias numquam qui.",
      "metadata": {
      },
      "created_date_time": "2018-07-01T00:00:00Z",
      "created_by_name": "Mikel Rath",
      "updated_date_time": "2018-07-02T00:00:00Z",
      "updated_by_name": "Mikel Rath"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single Fisherman

Endpoint

GET /api/v1/fishermen/:id

Request

Route

GET /api/v1/fishermen/72e7a086-33a9-4011-bcc4-412376a715cb

Headers

Authorization: Bearer 70fefd5db51c03d372d03d3b3609105908b88eb8
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fishermen/72e7a086-33a9-4011-bcc4-412376a715cb" -X GET \
	-H "Authorization: Bearer 70fefd5db51c03d372d03d3b3609105908b88eb8"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
first_name First name String
last_name Last name String
code Code String
active Status Boolean
comments Comments String
metadada Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: c94332df-c315-410f-819d-6172a9ff3f77

Body

{
  "data": {
    "id": "72e7a086-33a9-4011-bcc4-412376a715cb",
    "html_url": "/management/account/fishermen/b3d3d055d370",
    "first_name": "Dedi",
    "last_name": "Ferlamin",
    "code": "001",
    "active": true,
    "comments": "Comment",
    "metadata": {
      "color": "silver"
    },
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Mikel Rath",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Mikel Rath"
  }
}

Update an existing Fisherman

Endpoint

PUT /api/v1/fishermen/:id

Parameters

Name Description Type
first_name First name String
last_name Last name String
code Code String
active Status Boolean
comments Comments String
metadada Metadata JSON

Request

Route

PUT /api/v1/fishermen/751cf250-610d-4832-9bcb-465f22aee337

Headers

Authorization: Bearer 70fefd5db51c03d372d03d3b3609105908b88eb8
Content-Type: application/json

Body

{
  "name": "Casey",
  "code": "Guy",
  "active": true,
  "comments": "Skipper of purse seiner"
}

cURL

curl "https://fisheriesapp.com/api/v1/fishermen/751cf250-610d-4832-9bcb-465f22aee337" -d '{"name":"Casey","code":"Guy","active":true,"comments":"Skipper of purse seiner"}' -X PUT \
	-H "Authorization: Bearer 70fefd5db51c03d372d03d3b3609105908b88eb8"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
first_name First name String
last_name Last name String
code Code String
active Status Boolean
comments Comments String
metadada Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 07eb7817-a816-4bbe-aad9-3348706dfa0a

Body

{
  "data": {
    "id": "751cf250-610d-4832-9bcb-465f22aee337",
    "html_url": "/management/account/fishermen/64eab47dd17d",
    "first_name": "Dharta",
    "last_name": "Mahardani",
    "code": "Guy",
    "active": true,
    "comments": "Skipper of purse seiner",
    "metadata": {
    },
    "created_date_time": "2018-08-01T00:00:00Z",
    "created_by_name": "Mikel Rath",
    "updated_date_time": "2020-06-22T19:38:23Z",
    "updated_by_name": "Mikel Rath"
  }
}

Gear

Return a list of fishery associated Gear

Endpoint

GET /api/v1/fishery-gear

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/fishery-gear

Headers

Authorization: Bearer fa2262955813e7a316aac96de608dcbcb3e6d7c3
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fishery-gear" -X GET \
	-H "Authorization: Bearer fa2262955813e7a316aac96de608dcbcb3e6d7c3"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
names Name Hash of ISO 639-1 language codes
code Code String
order Order Integer
active Status Boolean
comments Comments String
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: d966e7b9-af60-4d02-a9a3-35ca184767b3

Body

{
  "data": [
    {
      "id": "e1a769b7-5f6d-475b-9298-f6e21e92b216",
      "fishery_id": "1011d54f-a94f-468c-bc84-dad22f2f3f3f",
      "names": {
        "en": "Bottom Trawl",
        "es": "Gear ES 13",
        "fr": "Gear FR 13",
        "id": "Gear ID 13"
      },
      "code": "A0013",
      "order": 13,
      "active": true,
      "comments": "Numquam dolor perspiciatis sit.",
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Katherine Dickinson",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Katherine Dickinson"
    },
    {
      "id": "ad4be2b6-2475-4029-904c-315728116c1f",
      "fishery_id": "1011d54f-a94f-468c-bc84-dad22f2f3f3f",
      "names": {
        "en": "Midwater Trawl",
        "es": "Gear ES 14",
        "fr": "Gear FR 14",
        "id": "Gear ID 14"
      },
      "code": "A0014",
      "order": 14,
      "active": true,
      "comments": "Ab vel aut reiciendis.",
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Katherine Dickinson",
      "updated_date_time": "2018-08-02T00:00:00Z",
      "updated_by_name": "Katherine Dickinson"
    },
    {
      "id": "809be8c8-1ec6-486c-90a8-a32d94b2e19b",
      "fishery_id": "dff8da25-6d2b-4a17-80d6-1ae7eb3247c3",
      "names": {
        "en": "Purse Seine",
        "es": "Gear ES 15",
        "fr": "Gear FR 15",
        "id": "Gear ID 15"
      },
      "code": "A0015",
      "order": 15,
      "active": true,
      "comments": "Omnis autem officiis ratione.",
      "created_date_time": "2018-07-01T00:00:00Z",
      "created_by_name": "Katherine Dickinson",
      "updated_date_time": "2018-07-02T00:00:00Z",
      "updated_by_name": "Katherine Dickinson"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single fishery associated Gear

Endpoint

GET /api/v1/fishery-gear/:id

Request

Route

GET /api/v1/fishery-gear/e1a769b7-5f6d-475b-9298-f6e21e92b216

Headers

Authorization: Bearer fa2262955813e7a316aac96de608dcbcb3e6d7c3
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fishery-gear/e1a769b7-5f6d-475b-9298-f6e21e92b216" -X GET \
	-H "Authorization: Bearer fa2262955813e7a316aac96de608dcbcb3e6d7c3"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
names Name Hash of ISO 639-1 language codes
code Code String
order Order Integer
active Status Boolean
comments Comments String
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: cd9bb246-6962-4650-85ed-49a255bdbf2b

Body

{
  "data": {
    "id": "e1a769b7-5f6d-475b-9298-f6e21e92b216",
    "fishery_id": "1011d54f-a94f-468c-bc84-dad22f2f3f3f",
    "names": {
      "en": "Bottom Trawl",
      "es": "Gear ES 13",
      "fr": "Gear FR 13",
      "id": "Gear ID 13"
    },
    "code": "A0013",
    "order": 13,
    "active": true,
    "comments": "Numquam dolor perspiciatis sit.",
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Katherine Dickinson",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Katherine Dickinson"
  }
}

Hails

Create a new Hail In

Endpoint

POST /api/v1/trips/:trip_id/hails

Parameters

Name Description Type
fishery_id required ID of fishery UUID
fishery_period_id required ID of period UUID
hail_number Hail number String
fisherman_id required ID of fisherman UUID
monitor_id ID of monitor UUID
tied_up_date_time required Tie up date/dime ISO8601 date/time
tie_up_port_id required ID of tie up port UUID
tie_up_location_id required ID of tie up location UUID
landed_at required Landed date/time ISO8601 date/time
landing_port_id required ID of landing port UUID
landing_location_id required ID of landing location UUID
final Final Boolean
monitor_disembarked Monitor disembarked UUID
comments Comments String
metadata Metadata JSON

Request

Route

POST /api/v1/trips/b03714ec-42ac-46f0-aff6-7417667397bd/hails

Headers

Authorization: Bearer fdd30193772940c119adb8db0ea10ac886393c40
Content-Type: application/json

Body

{
  "fishery_id": "0c5ef8dc-cfb0-4e94-8ca5-15af5c29d778",
  "fishery_period_id": "8f4149d0-3441-4a0c-ac04-5f833c77ce9a",
  "fisherman_id": "76e2401b-dacd-47f3-a533-bde31ae61074",
  "monitor_id": "53fbd7c0-af50-4504-87b0-222d2ef136d8",
  "tied_up_date_time": "2019-10-04T21:29:00",
  "tie_up_port_id": "37760fb3-1a7d-4e6d-ba70-4f09a3f16ad6",
  "tie_up_location_id": "e9e569b8-63fc-47db-8f0d-1d06418f7d38",
  "landed_date_time": "2019-10-05T21:29:00Z",
  "landing_port_id": "f42c29da-df0d-414c-a151-7649bd89a844",
  "landing_location_id": "ba03a310-aa92-4928-9c97-355754966ab3",
  "final": true,
  "monitor_disembarked": false,
  "comments": "API Comment",
  "metadata": {
    "country": "CA"
  }
}

cURL

curl "https://fisheriesapp.com/api/v1/trips/b03714ec-42ac-46f0-aff6-7417667397bd/hails" -d '{"fishery_id":"0c5ef8dc-cfb0-4e94-8ca5-15af5c29d778","fishery_period_id":"8f4149d0-3441-4a0c-ac04-5f833c77ce9a","fisherman_id":"76e2401b-dacd-47f3-a533-bde31ae61074","monitor_id":"53fbd7c0-af50-4504-87b0-222d2ef136d8","tied_up_date_time":"2019-10-04T21:29:00","tie_up_port_id":"37760fb3-1a7d-4e6d-ba70-4f09a3f16ad6","tie_up_location_id":"e9e569b8-63fc-47db-8f0d-1d06418f7d38","landed_date_time":"2019-10-05T21:29:00Z","landing_port_id":"f42c29da-df0d-414c-a151-7649bd89a844","landing_location_id":"ba03a310-aa92-4928-9c97-355754966ab3","final":true,"monitor_disembarked":false,"comments":"API Comment","metadata":{"country":"CA"}}' -X POST \
	-H "Authorization: Bearer fdd30193772940c119adb8db0ea10ac886393c40"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
type Type of hail String
hail_number Hail number String
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
tied_up_date_time Tied up date/time ISO8601 date/time
tie_up_port_id ID of tie up port UUID
tie_up_location_id ID of tie up location UUID
landed_date_time Landed date/time ISO8601 date/time
landing_port_id ID of landing port UUID
landing_location_id ID of landing location UUID
final Final Boolean
monitor_disembarked Monitor disembarked Boolean
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 1c37e44d-8d1b-4ffc-9f81-4c7bd42fbbce

Body

{
  "data": {
    "id": "5a6c8140-7b29-4890-abb1-4fd9c26d10b1",
    "html_url": "/management/fisheries/caa85ab0c6b5/trips/23588c5785be/hails/6a8f7c58a85b",
    "type": "hail_in",
    "hail_number": "0",
    "fisherman_id": "76e2401b-dacd-47f3-a533-bde31ae61074",
    "monitor_id": "53fbd7c0-af50-4504-87b0-222d2ef136d8",
    "tied_up_date_time": "2019-10-04T21:29:00Z",
    "tie_up_port_id": "37760fb3-1a7d-4e6d-ba70-4f09a3f16ad6",
    "tie_up_location_id": "e9e569b8-63fc-47db-8f0d-1d06418f7d38",
    "landed_date_time": "2019-10-05T21:29:00Z",
    "landing_port_id": "f42c29da-df0d-414c-a151-7649bd89a844",
    "landing_location_id": "ba03a310-aa92-4928-9c97-355754966ab3",
    "final": true,
    "monitor_disembarked": false,
    "comments": "API Comment",
    "metadata": {
      "country": "CA"
    },
    "created_date_time": "2020-06-22T19:38:25Z",
    "created_by_user_name": "Theodora Franecki",
    "updated_date_time": "2020-06-22T19:38:25Z",
    "updated_by_user_name": "Theodora Franecki"
  }
}

Return a single Hail

Endpoint

GET /api/v1/trips/:trip_id/hails/:hail_id

Request

Route

GET /api/v1/trips/b03714ec-42ac-46f0-aff6-7417667397bd/hails/3896b477-328b-4d88-af83-e61914a3cecc

Headers

Authorization: Bearer fdd30193772940c119adb8db0ea10ac886393c40
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/trips/b03714ec-42ac-46f0-aff6-7417667397bd/hails/3896b477-328b-4d88-af83-e61914a3cecc" -X GET \
	-H "Authorization: Bearer fdd30193772940c119adb8db0ea10ac886393c40"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
type Type of hail String
hail_number Hail number String
fisherman_id ID of fisherman UUID
monitor_id ID of monitor (Only for Hail In) UUID
departed_date_time Departed date/time (Only for Hail Out) ISO8601 date/time
departure_port_id ID of departure port (Only for Hail Out) UUID
departure_location_id ID of departure location (Only for Hail Out) UUID
tied_up_date_time Tied up date/time (Only for Hail In) ISO8601 date/time
tie_up_port_id ID of tie up port (Only for Hail In) UUID
tie_up_location_id ID of tie up location (Only for Hail In) UUID
landed_date_time Landed date/time ISO8601 date/time
landing_port_id ID of landing port UUID
landing_location_id ID of landing location UUID
final Final (Only for Hail In) Boolean
monitor_disembarked Monitor disembarked (Only for Hail In) Boolean
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 29eb59d0-c48e-43ed-b0ad-79ec192e0602

Body

{
  "data": {
    "id": "3896b477-328b-4d88-af83-e61914a3cecc",
    "html_url": "/management/fisheries/caa85ab0c6b5/trips/23588c5785be/hails/8d8ec6d88029",
    "type": "hail_in",
    "hail_number": "S8148476G",
    "fisherman_id": "76e2401b-dacd-47f3-a533-bde31ae61074",
    "monitor_id": null,
    "tied_up_date_time": "2020-05-23T18:59:25Z",
    "tie_up_port_id": "fcb087fe-7fef-4dbc-a91c-dfcb6c01ae8c",
    "tie_up_location_id": "63d825ce-9ac0-42bd-b5ed-0cdfb41c50c8",
    "landed_date_time": "2020-05-24T08:00:26Z",
    "landing_port_id": "fcb087fe-7fef-4dbc-a91c-dfcb6c01ae8c",
    "landing_location_id": "63d825ce-9ac0-42bd-b5ed-0cdfb41c50c8",
    "final": null,
    "monitor_disembarked": null,
    "comments": "Numquam tenetur consequatur incidunt.",
    "metadata": {
    },
    "created_date_time": "2020-06-22T19:38:25Z",
    "created_by_user_name": "Theodora Franecki",
    "updated_date_time": "2020-06-22T19:38:25Z",
    "updated_by_user_name": "Theodora Franecki"
  }
}

Update an existing Hail

Endpoint

PUT /api/v1/trips/:trip_id/hails/:hail_id

Parameters

Name Description Type
fishery_id required ID of fishery UUID
fishery_period_id required ID of period UUID
hail_number Hail number String
fisherman_id required ID of fisherman UUID
monitor_id ID of monitor (Only for Hail In) UUID
departed_date_time required Departure date/time (Only for Hail Out) ISO8601 date/time
departure_port_id required ID of departure port (Only for Hail Out) UUID
departure_location_id required ID of departure location (Only for Hail Out) UUID
tied_up_date_time required Tie up date/dime (Only for Hail In) ISO8601 date/time
tie_up_port_id required ID of tie up port (Only for Hail In) UUID
tie_up_location_id required ID of tie up location (Only for Hail In) UUID
landed_at required Landed date/time ISO8601 date/time
landing_port_id required ID of landing port UUID
landing_location_id required ID of landing location UUID
final Final (Only for Hail In) Boolean
monitor_disembarked Monitor disembarked (Only for Hail In) UUID
comments Comments String
metadata Metadata JSON

Request

Route

PUT /api/v1/trips/3059caaf-b235-4a9f-9fe8-daa3dd90cbaf/hails/dd014a23-256a-4ee8-98e6-7f3506300a68

Headers

Authorization: Bearer fdd30193772940c119adb8db0ea10ac886393c40
Content-Type: application/json

Body

{
  "fishery_id": "d872b37a-3db7-4d44-9a67-d2cc60b449dd",
  "fishery_period_id": "6cb6999a-d245-4b85-a528-4f6aee48a26d",
  "fisherman_id": "9187bd7e-e8fc-463d-9fa0-31b9681eaeb8",
  "departed_date_time": "2019-11-04T11:29:00Z",
  "departure_port_id": "1127fa92-4ec1-49e6-8d6b-1251e978e3f2",
  "departure_location_id": "5a345e2b-6875-422a-9800-3aa4628bd0be",
  "landed_date_time": "2019-11-04T20:26:00Z",
  "landing_port_id": "f42c29da-df0d-414c-a151-7649bd89a844",
  "landing_location_id": "ba03a310-aa92-4928-9c97-355754966ab3",
  "comments": "Update comment",
  "metadata": null
}

cURL

curl "https://fisheriesapp.com/api/v1/trips/3059caaf-b235-4a9f-9fe8-daa3dd90cbaf/hails/dd014a23-256a-4ee8-98e6-7f3506300a68" -d '{"fishery_id":"d872b37a-3db7-4d44-9a67-d2cc60b449dd","fishery_period_id":"6cb6999a-d245-4b85-a528-4f6aee48a26d","fisherman_id":"9187bd7e-e8fc-463d-9fa0-31b9681eaeb8","departed_date_time":"2019-11-04T11:29:00Z","departure_port_id":"1127fa92-4ec1-49e6-8d6b-1251e978e3f2","departure_location_id":"5a345e2b-6875-422a-9800-3aa4628bd0be","landed_date_time":"2019-11-04T20:26:00Z","landing_port_id":"f42c29da-df0d-414c-a151-7649bd89a844","landing_location_id":"ba03a310-aa92-4928-9c97-355754966ab3","comments":"Update comment","metadata":null}' -X PUT \
	-H "Authorization: Bearer fdd30193772940c119adb8db0ea10ac886393c40"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
type Type of hail String
hail_number Hail number String
fisherman_id ID of fisherman UUID
monitor_id ID of monitor (Only for Hail In) UUID
departed_date_time Departed date/time (Only for Hail Out) ISO8601 date/time
departure_port_id ID of departure port (Only for Hail Out) UUID
departure_location_id ID of departure location (Only for Hail Out) UUID
tied_up_date_time Tied up date/time (Only for Hail In) ISO8601 date/time
tie_up_port_id ID of tie up port (Only for Hail In) UUID
tie_up_location_id ID of tie up location (Only for Hail In) UUID
landed_date_time Landed date/time ISO8601 date/time
landing_port_id ID of landing port UUID
landing_location_id ID of landing location UUID
final Final Boolean (Only for Hail In)
monitor_disembarked Monitor disembarked (Only for Hail In) Boolean
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 4b81e054-8334-42a9-8e1b-98e52d91d785

Body

{
  "data": {
    "id": "dd014a23-256a-4ee8-98e6-7f3506300a68",
    "html_url": "/management/fisheries/788250ab8bc6/trips/d8cf4e33b908/hails/56afde5693e9",
    "type": "hail_out",
    "hail_number": "S8023881I",
    "fisherman_id": "05035c40-8584-4a2d-88ae-282a4e79318d",
    "departed_date_time": "2020-04-26T19:25:25Z",
    "departure_port_id": "a5beacc5-439f-4243-accd-6faf8a5efe41",
    "departure_location_id": "391b9ee7-f77a-4f87-b6b6-8356715ccd8a",
    "landed_date_time": null,
    "landing_port_id": null,
    "landing_location_id": null,
    "comments": "Aut ea rerum sint.",
    "metadata": {
    },
    "created_date_time": "2020-06-22T19:38:25Z",
    "created_by_user_name": "Theodora Franecki",
    "updated_date_time": "2020-06-22T19:38:25Z",
    "updated_by_user_name": "Theodora Franecki"
  }
}

Landings

Create a new Landing

Endpoint

POST /api/v1/landings

Parameters

Name Description Type
fishery_id required ID of fishery UUID
fishery_period_id required ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time required Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
document_number Document number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
port_id ID of port UUID
location_id ID of location UUID
first_receiver_id ID of first receiver UUID
buyer_processor_id ID of buyer/processor UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
effort Fishing effort (in days) Decimal
brand_variant_id ID of brand/variant UUID
comments Comments String
metadata Metadata JSON
catch Catch details Array
- fishery_species_id ID of species UUID
- catch_category_id ID of catch category UUID
- brand_variant_id ID of brand/variant UUID
- buyer_processor_id ID of buyer/processor UUID
- weight Weight Decimal
- pieces Pieces Integer
- metadata Metadata JSON

Request

Route

POST /api/v1/landings

Headers

Authorization: Bearer ad902f2d261a18c855b2b916996dd62a1dec9fa2
Content-Type: application/json

Body

{
  "fishery_id": "33afaa5c-c8a2-426d-b0a5-034159b7370e",
  "fishery_period_id": "3d4b9642-6075-468a-a920-86205efa67ef",
  "started_date_time": "2018-09-02T12:19:12",
  "ended_date_time": "2018-09-04T05:22:02",
  "document_number": "X33U9871",
  "fisherman_id": "b40870c9-3e66-4af2-af5b-ad03914b4818",
  "monitor_id": "5f286afb-61b2-4e72-8371-e732b46c5e88",
  "vessel_id": "faa0a164-6049-4f0b-9ac2-3697cfaaa770",
  "port_id": "9fb0c08d-b60a-43cb-a411-fc11f4135a9f",
  "location_id": "a424f33f-c8f4-4d3e-90fd-2abb8c4621fe",
  "first_receiver_id": "f9c768fa-c22e-4a69-bb22-b4ea01c4b995",
  "buyer_processor_id": "a9b77484-d363-4f43-bbe8-1db6bdf1d16f",
  "area_id": "3319d4f7-3d05-444c-9127-995a4370d3f4",
  "fishery_gear_id": "d9dbf668-bba8-4fd8-9730-9c36aba4be19",
  "effort": 1.25,
  "brand_variant_id": "b1e78132-1ab6-4efc-a757-1155b60f1a09",
  "comments": "Summarized data for landing",
  "catch": [
    {
      "fishery_species_id": "5167764e-cb27-4a96-bf67-a92dcf1685c1",
      "catch_category_id": "8a9612d1-dc3c-4bbb-ac3a-c36317709df3",
      "brand_variant_id": "b1e78132-1ab6-4efc-a757-1155b60f1a09",
      "buyer_processor_id": "a9b77484-d363-4f43-bbe8-1db6bdf1d16f",
      "weight": 81.5,
      "pieces": 332
    },
    {
      "fishery_species_id": "4e244f31-9835-409b-a645-6b5bc0aeed0e",
      "catch_category_id": "a2c95968-02f5-41ed-be04-a13ffd2e2056",
      "brand_variant_id": "6646e203-1c52-47c4-a147-324b5d49c69c",
      "buyer_processor_id": "bece1b15-9702-4e5d-bc2d-c28b781ab607",
      "weight": 23.1,
      "pieces": 12
    }
  ]
}

cURL

curl "https://fisheriesapp.com/api/v1/landings" -d '{"fishery_id":"33afaa5c-c8a2-426d-b0a5-034159b7370e","fishery_period_id":"3d4b9642-6075-468a-a920-86205efa67ef","started_date_time":"2018-09-02T12:19:12","ended_date_time":"2018-09-04T05:22:02","document_number":"X33U9871","fisherman_id":"b40870c9-3e66-4af2-af5b-ad03914b4818","monitor_id":"5f286afb-61b2-4e72-8371-e732b46c5e88","vessel_id":"faa0a164-6049-4f0b-9ac2-3697cfaaa770","port_id":"9fb0c08d-b60a-43cb-a411-fc11f4135a9f","location_id":"a424f33f-c8f4-4d3e-90fd-2abb8c4621fe","first_receiver_id":"f9c768fa-c22e-4a69-bb22-b4ea01c4b995","buyer_processor_id":"a9b77484-d363-4f43-bbe8-1db6bdf1d16f","area_id":"3319d4f7-3d05-444c-9127-995a4370d3f4","fishery_gear_id":"d9dbf668-bba8-4fd8-9730-9c36aba4be19","effort":1.25,"brand_variant_id":"b1e78132-1ab6-4efc-a757-1155b60f1a09","comments":"Summarized data for landing","catch":[{"fishery_species_id":"5167764e-cb27-4a96-bf67-a92dcf1685c1","catch_category_id":"8a9612d1-dc3c-4bbb-ac3a-c36317709df3","brand_variant_id":"b1e78132-1ab6-4efc-a757-1155b60f1a09","buyer_processor_id":"a9b77484-d363-4f43-bbe8-1db6bdf1d16f","weight":81.5,"pieces":332},{"fishery_species_id":"4e244f31-9835-409b-a645-6b5bc0aeed0e","catch_category_id":"a2c95968-02f5-41ed-be04-a13ffd2e2056","brand_variant_id":"6646e203-1c52-47c4-a147-324b5d49c69c","buyer_processor_id":"bece1b15-9702-4e5d-bc2d-c28b781ab607","weight":23.1,"pieces":12}]}' -X POST \
	-H "Authorization: Bearer ad902f2d261a18c855b2b916996dd62a1dec9fa2"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
document_number Document number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
port_id ID of port UUID
location_id ID of location UUID
first_receiver_id ID of first receiver UUID
buyer_processor_id ID of buyer/processor UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
effort Fishing effort (in days) Decimal
brand_variant_id ID of brand/variant UUID
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name ID of creating user UUID
updated_date_time Updated date/time ISO8601 date/time
updated_by_name ID of updating user UUID
submitted_date_time Submitted date/time ISO8601 date/time
validated_by_name ID of validating user UUID
validation_comments Validation comments String
catch Catch details Array
- id ID String
- fishery_species_id ID of species UUID
- catch_category_id ID of catch category UUID
- brand_variant_id ID of brand/variant UUID
- buyer_processor_id ID of buyer/processor UUID
- weight Weight Decimal
- pieces Pieces Integer
- metadata Metadata JSON

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 911501fe-d2f0-4478-9e5c-996aa0ac0259

Body

{
  "data": {
    "id": "99b34709-1672-4a19-adbf-bf3646e0b564",
    "html_url": "/management/fisheries/154543eedce6/landings/376da231629e",
    "fishery_id": "33afaa5c-c8a2-426d-b0a5-034159b7370e",
    "fishery_period_id": "3d4b9642-6075-468a-a920-86205efa67ef",
    "trip_id": null,
    "hail_id": null,
    "started_date_time": "2018-09-02T12:19:12Z",
    "ended_date_time": "2018-09-04T05:22:02Z",
    "document_number": "X33U9871",
    "fisherman_id": "b40870c9-3e66-4af2-af5b-ad03914b4818",
    "monitor_id": "5f286afb-61b2-4e72-8371-e732b46c5e88",
    "vessel_id": "faa0a164-6049-4f0b-9ac2-3697cfaaa770",
    "port_id": "9fb0c08d-b60a-43cb-a411-fc11f4135a9f",
    "location_id": "a424f33f-c8f4-4d3e-90fd-2abb8c4621fe",
    "first_receiver_id": "f9c768fa-c22e-4a69-bb22-b4ea01c4b995",
    "buyer_processor_id": "a9b77484-d363-4f43-bbe8-1db6bdf1d16f",
    "area_id": "3319d4f7-3d05-444c-9127-995a4370d3f4",
    "fishery_gear_id": "d9dbf668-bba8-4fd8-9730-9c36aba4be19",
    "effort": 1.25,
    "brand_variant_id": "b1e78132-1ab6-4efc-a757-1155b60f1a09",
    "comments": "Summarized data for landing",
    "metadata": {
    },
    "created_date_time": "2020-06-22T19:38:26Z",
    "created_by_name": "Lenny Hermann",
    "updated_date_time": "2020-06-22T19:38:26Z",
    "updated_by_name": "Lenny Hermann",
    "submitted_date_time": null,
    "validated_date_time": null,
    "validated_by_name": null,
    "validation_comments": null,
    "catch": [
      {
        "id": "6c626bbb-998d-487a-993f-c719afcc9246",
        "fishery_species_id": "5167764e-cb27-4a96-bf67-a92dcf1685c1",
        "catch_category_id": null,
        "brand_variant_id": "b1e78132-1ab6-4efc-a757-1155b60f1a09",
        "buyer_processor_id": "a9b77484-d363-4f43-bbe8-1db6bdf1d16f",
        "weight": 81.5,
        "pieces": null,
        "metadata": {
        }
      },
      {
        "id": "b2f71128-8eac-4833-b8ed-f7eae19ee675",
        "fishery_species_id": "4e244f31-9835-409b-a645-6b5bc0aeed0e",
        "catch_category_id": null,
        "brand_variant_id": "6646e203-1c52-47c4-a147-324b5d49c69c",
        "buyer_processor_id": "bece1b15-9702-4e5d-bc2d-c28b781ab607",
        "weight": 23.1,
        "pieces": null,
        "metadata": {
        }
      }
    ]
  }
}

Delete an existing Landing

Endpoint

DELETE /api/v1/landings/:id

Request

Route

DELETE /api/v1/landings/8e326920-4a0f-40c7-8e5a-c0fe58a5a63c

Headers

Authorization: Bearer ad902f2d261a18c855b2b916996dd62a1dec9fa2
Content-Type: application/json

cURL

curl "https://fisheriesapp.com/api/v1/landings/8e326920-4a0f-40c7-8e5a-c0fe58a5a63c" -d '' -X DELETE \
	-H "Authorization: Bearer ad902f2d261a18c855b2b916996dd62a1dec9fa2"

Response

Simulated Response

Status

204

Headers

X-Request-Id: a30011fb-0ae5-42c3-80fc-4f2a3a015127

Return a list of Landings

Endpoint

GET /api/v1/landings

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time
fishery_id Optionally specify one or more fisheries as a comma separated list of IDs String
fishery_period_id Optionally specify one or more periods as a comma separated list of IDs; leaving blank defaults to returning data from any fisheries current period String

Request

Route

GET /api/v1/landings

Headers

Authorization: Bearer ad902f2d261a18c855b2b916996dd62a1dec9fa2
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/landings" -X GET \
	-H "Authorization: Bearer ad902f2d261a18c855b2b916996dd62a1dec9fa2"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
document_number Document number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
port_id ID of port UUID
location_id ID of location UUID
first_receiver_id ID of first receiver UUID
buyer_processor_id ID of buyer/processor UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
effort Fishing effort (in days) Decimal
brand_variant_id ID of brand/variant UUID
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name ID of creating user UUID
updated_date_time Updated date/time ISO8601 date/time
updated_by_name ID of updating user UUID
submitted_date_time Submitted date/time ISO8601 date/time
validated_by_name ID of validating user UUID
validation_comments Validation comments String
catch Catch details Array
- id ID String
- fishery_species_id ID of species UUID
- catch_category_id ID of catch category UUID
- brand_variant_id ID of brand/variant UUID
- buyer_processor_id ID of buyer/processor UUID
- weight Weight Decimal
- pieces Pieces Integer
- metadata Metadata JSON

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 3f6a52d1-c8a8-4176-a054-2f30ddc9c3e5

Body

{
  "data": [
    {
      "id": "1ca67826-8552-43f8-8813-0522dceb2f0a",
      "html_url": "/management/fisheries/154543eedce6/landings/b8f2ff6c188b",
      "fishery_id": "33afaa5c-c8a2-426d-b0a5-034159b7370e",
      "fishery_period_id": "3d4b9642-6075-468a-a920-86205efa67ef",
      "trip_id": "4b2ea983-33e9-4e68-8349-2e385bde9538",
      "hail_id": "633c2698-360c-431c-88ed-3c0e22635dfa",
      "started_date_time": "2020-06-29T20:23:26Z",
      "ended_date_time": "2020-06-29T22:23:26Z",
      "document_number": "132912821",
      "fisherman_id": "b40870c9-3e66-4af2-af5b-ad03914b4818",
      "monitor_id": "5f286afb-61b2-4e72-8371-e732b46c5e88",
      "vessel_id": "faa0a164-6049-4f0b-9ac2-3697cfaaa770",
      "port_id": "9fb0c08d-b60a-43cb-a411-fc11f4135a9f",
      "location_id": "a424f33f-c8f4-4d3e-90fd-2abb8c4621fe",
      "first_receiver_id": "f9c768fa-c22e-4a69-bb22-b4ea01c4b995",
      "buyer_processor_id": "a9b77484-d363-4f43-bbe8-1db6bdf1d16f",
      "area_id": "3319d4f7-3d05-444c-9127-995a4370d3f4",
      "fishery_gear_id": "d9dbf668-bba8-4fd8-9730-9c36aba4be19",
      "effort": 3.25,
      "brand_variant_id": "b1e78132-1ab6-4efc-a757-1155b60f1a09",
      "comments": "",
      "metadata": {
        "color": "pink"
      },
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Lenny Hermann",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Lenny Hermann",
      "submitted_date_time": null,
      "validated_date_time": null,
      "validated_by_name": null,
      "validation_comments": null,
      "catch": [
        {
          "id": "741e9305-ec6f-4cac-9b8f-a8f055b27e44",
          "fishery_species_id": "5167764e-cb27-4a96-bf67-a92dcf1685c1",
          "catch_category_id": "8a9612d1-dc3c-4bbb-ac3a-c36317709df3",
          "brand_variant_id": "b1e78132-1ab6-4efc-a757-1155b60f1a09",
          "buyer_processor_id": "a9b77484-d363-4f43-bbe8-1db6bdf1d16f",
          "weight": 360.0,
          "pieces": 42,
          "metadata": {
            "integration_id": 942
          }
        },
        {
          "id": "37d5c722-7bff-46a3-8123-c6c1774e52bd",
          "fishery_species_id": "4e244f31-9835-409b-a645-6b5bc0aeed0e",
          "catch_category_id": "a2c95968-02f5-41ed-be04-a13ffd2e2056",
          "brand_variant_id": "6646e203-1c52-47c4-a147-324b5d49c69c",
          "buyer_processor_id": "a9b77484-d363-4f43-bbe8-1db6bdf1d16f",
          "weight": 81.5,
          "pieces": 7,
          "metadata": {
          }
        }
      ]
    },
    {
      "id": "07ed31ec-32be-43d4-bf8a-166b4c4332c5",
      "html_url": "/management/fisheries/154543eedce6/landings/4326b296909a",
      "fishery_id": "33afaa5c-c8a2-426d-b0a5-034159b7370e",
      "fishery_period_id": "3d4b9642-6075-468a-a920-86205efa67ef",
      "trip_id": null,
      "hail_id": null,
      "started_date_time": "2020-07-01T20:36:26Z",
      "ended_date_time": "2020-07-01T22:36:26Z",
      "document_number": "132912824",
      "fisherman_id": "86ff6751-7dea-4a32-89ae-ebfb879c2c4e",
      "monitor_id": "c32cdc97-5756-4e50-8dcf-c4b5dc321e70",
      "vessel_id": "1758c3bb-8eba-4300-8379-9e00dde616b3",
      "port_id": "c8fb64d9-0bfa-4910-af74-134f078c5ff6",
      "location_id": "d6f2bb38-1e42-431b-a361-c9da903a3336",
      "first_receiver_id": "cebc5897-af5f-4a60-a992-007ac82c9ce8",
      "buyer_processor_id": "bece1b15-9702-4e5d-bc2d-c28b781ab607",
      "area_id": "915353cb-66d9-468f-b1d2-0cfce5f4ef99",
      "fishery_gear_id": "f271d94c-9254-42ae-af27-83aa69c9f824",
      "effort": 2.75,
      "brand_variant_id": "6646e203-1c52-47c4-a147-324b5d49c69c",
      "comments": "",
      "metadata": {
      },
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Lenny Hermann",
      "updated_date_time": "2018-08-02T00:00:00Z",
      "updated_by_name": "Lenny Hermann",
      "submitted_date_time": null,
      "validated_date_time": null,
      "validated_by_name": null,
      "validation_comments": null,
      "catch": [
        {
          "id": "a41eea74-1008-4dc7-b823-aff89918bc2d",
          "fishery_species_id": "4e244f31-9835-409b-a645-6b5bc0aeed0e",
          "catch_category_id": "a2c95968-02f5-41ed-be04-a13ffd2e2056",
          "brand_variant_id": null,
          "buyer_processor_id": null,
          "weight": 11.2,
          "pieces": 8,
          "metadata": {
          }
        },
        {
          "id": "78321a36-6bf7-4f90-879c-3e072d8f3e25",
          "fishery_species_id": "e06cb721-3215-42f5-90d6-8bfbfd060359",
          "catch_category_id": "a2c95968-02f5-41ed-be04-a13ffd2e2056",
          "brand_variant_id": null,
          "buyer_processor_id": null,
          "weight": 81.5,
          "pieces": 332,
          "metadata": {
            "integration_id": 124
          }
        }
      ]
    }
  ],
  "objects": 2,
  "pages": 1
}

Return a single Landing

Endpoint

GET /api/v1/landings/:id

Request

Route

GET /api/v1/landings/1ca67826-8552-43f8-8813-0522dceb2f0a

Headers

Authorization: Bearer ad902f2d261a18c855b2b916996dd62a1dec9fa2
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/landings/1ca67826-8552-43f8-8813-0522dceb2f0a" -X GET \
	-H "Authorization: Bearer ad902f2d261a18c855b2b916996dd62a1dec9fa2"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
document_number Document number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
port_id ID of port UUID
location_id ID of location UUID
first_receiver_id ID of first receiver UUID
buyer_processor_id ID of buyer/processor UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
effort Fishing effort (in days) Decimal
brand_variant_id ID of brand/variant UUID
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name ID of creating user UUID
updated_date_time Updated date/time ISO8601 date/time
updated_by_name ID of updating user UUID
submitted_date_time Submitted date/time ISO8601 date/time
validated_by_name ID of validating user UUID
validation_comments Validation comments String
catch Catch details Array
- id ID String
- fishery_species_id ID of species UUID
- catch_category_id ID of catch category UUID
- brand_variant_id ID of brand/variant UUID
- buyer_processor_id ID of buyer/processor UUID
- weight Weight Decimal
- pieces Pieces Integer
- metadata Metadata JSON

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 999e3b59-f17c-4a76-ac3c-35f40c1edf20

Body

{
  "data": {
    "id": "1ca67826-8552-43f8-8813-0522dceb2f0a",
    "html_url": "/management/fisheries/154543eedce6/landings/b8f2ff6c188b",
    "fishery_id": "33afaa5c-c8a2-426d-b0a5-034159b7370e",
    "fishery_period_id": "3d4b9642-6075-468a-a920-86205efa67ef",
    "trip_id": "4b2ea983-33e9-4e68-8349-2e385bde9538",
    "hail_id": "633c2698-360c-431c-88ed-3c0e22635dfa",
    "started_date_time": "2020-06-29T20:23:26Z",
    "ended_date_time": "2020-06-29T22:23:26Z",
    "document_number": "132912821",
    "fisherman_id": "b40870c9-3e66-4af2-af5b-ad03914b4818",
    "monitor_id": "5f286afb-61b2-4e72-8371-e732b46c5e88",
    "vessel_id": "faa0a164-6049-4f0b-9ac2-3697cfaaa770",
    "port_id": "9fb0c08d-b60a-43cb-a411-fc11f4135a9f",
    "location_id": "a424f33f-c8f4-4d3e-90fd-2abb8c4621fe",
    "first_receiver_id": "f9c768fa-c22e-4a69-bb22-b4ea01c4b995",
    "buyer_processor_id": "a9b77484-d363-4f43-bbe8-1db6bdf1d16f",
    "area_id": "3319d4f7-3d05-444c-9127-995a4370d3f4",
    "fishery_gear_id": "d9dbf668-bba8-4fd8-9730-9c36aba4be19",
    "effort": 3.25,
    "brand_variant_id": "b1e78132-1ab6-4efc-a757-1155b60f1a09",
    "comments": "",
    "metadata": {
      "color": "pink"
    },
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Lenny Hermann",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Lenny Hermann",
    "submitted_date_time": null,
    "validated_date_time": null,
    "validated_by_name": null,
    "validation_comments": null,
    "catch": [
      {
        "id": "741e9305-ec6f-4cac-9b8f-a8f055b27e44",
        "fishery_species_id": "5167764e-cb27-4a96-bf67-a92dcf1685c1",
        "catch_category_id": "8a9612d1-dc3c-4bbb-ac3a-c36317709df3",
        "brand_variant_id": "b1e78132-1ab6-4efc-a757-1155b60f1a09",
        "buyer_processor_id": "a9b77484-d363-4f43-bbe8-1db6bdf1d16f",
        "weight": 360.0,
        "pieces": 42,
        "metadata": {
          "integration_id": 942
        }
      },
      {
        "id": "37d5c722-7bff-46a3-8123-c6c1774e52bd",
        "fishery_species_id": "4e244f31-9835-409b-a645-6b5bc0aeed0e",
        "catch_category_id": "a2c95968-02f5-41ed-be04-a13ffd2e2056",
        "brand_variant_id": "6646e203-1c52-47c4-a147-324b5d49c69c",
        "buyer_processor_id": "a9b77484-d363-4f43-bbe8-1db6bdf1d16f",
        "weight": 81.5,
        "pieces": 7,
        "metadata": {
        }
      }
    ]
  }
}

Update an existing Landing

Endpoint

PUT /api/v1/landings/:id

Parameters

Name Description Type
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
document_number Document number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
port_id ID of port UUID
location_id ID of location UUID
first_receiver_id ID of first receiver UUID
buyer_processor_id ID of buyer/processor UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
effort Fishing effort (in days) Decimal
brand_variant_id ID of brand/variant UUID
comments Comments String
metadata Metadata JSON
catch Catch details Array
- id ID String
- fishery_species_id ID of species UUID
- catch_category_id ID of catch category UUID
- brand_variant_id ID of brand/variant UUID
- buyer_processor_id ID of buyer/processor UUID
- weight Weight Decimal
- pieces Pieces Integer
- metadata Metadata JSON

Request

Route

PUT /api/v1/landings/07ed31ec-32be-43d4-bf8a-166b4c4332c5

Headers

Authorization: Bearer ad902f2d261a18c855b2b916996dd62a1dec9fa2
Content-Type: application/json

Body

{
  "started_date_time": "2018-09-02T12:19:12",
  "ended_date_time": "2018-09-04T05:22:02",
  "document_number": "X33U9871",
  "fisherman_id": "b40870c9-3e66-4af2-af5b-ad03914b4818",
  "monitor_id": "5f286afb-61b2-4e72-8371-e732b46c5e88",
  "vessel_id": "faa0a164-6049-4f0b-9ac2-3697cfaaa770",
  "port_id": "9fb0c08d-b60a-43cb-a411-fc11f4135a9f",
  "location_id": "a424f33f-c8f4-4d3e-90fd-2abb8c4621fe",
  "first_receiver_id": "f9c768fa-c22e-4a69-bb22-b4ea01c4b995",
  "buyer_processor_id": "a9b77484-d363-4f43-bbe8-1db6bdf1d16f",
  "area_id": "3319d4f7-3d05-444c-9127-995a4370d3f4",
  "fishery_gear_id": "d9dbf668-bba8-4fd8-9730-9c36aba4be19",
  "effort": 2.125,
  "brand_variant_id": "b1e78132-1ab6-4efc-a757-1155b60f1a09",
  "comments": "Summarized data for landing",
  "catch": [
    {
      "fishery_species_id": "5167764e-cb27-4a96-bf67-a92dcf1685c1",
      "catch_category_id": "8a9612d1-dc3c-4bbb-ac3a-c36317709df3",
      "brand_variant_id": "b1e78132-1ab6-4efc-a757-1155b60f1a09",
      "buyer_processor_id": "a9b77484-d363-4f43-bbe8-1db6bdf1d16f",
      "weight": 90,
      "pieces": null
    },
    {
      "fishery_species_id": "4e244f31-9835-409b-a645-6b5bc0aeed0e",
      "catch_category_id": "a2c95968-02f5-41ed-be04-a13ffd2e2056",
      "brand_variant_id": "6646e203-1c52-47c4-a147-324b5d49c69c",
      "buyer_processor_id": "bece1b15-9702-4e5d-bc2d-c28b781ab607",
      "weight": 15.1,
      "pieces": 4
    }
  ]
}

cURL

curl "https://fisheriesapp.com/api/v1/landings/07ed31ec-32be-43d4-bf8a-166b4c4332c5" -d '{"started_date_time":"2018-09-02T12:19:12","ended_date_time":"2018-09-04T05:22:02","document_number":"X33U9871","fisherman_id":"b40870c9-3e66-4af2-af5b-ad03914b4818","monitor_id":"5f286afb-61b2-4e72-8371-e732b46c5e88","vessel_id":"faa0a164-6049-4f0b-9ac2-3697cfaaa770","port_id":"9fb0c08d-b60a-43cb-a411-fc11f4135a9f","location_id":"a424f33f-c8f4-4d3e-90fd-2abb8c4621fe","first_receiver_id":"f9c768fa-c22e-4a69-bb22-b4ea01c4b995","buyer_processor_id":"a9b77484-d363-4f43-bbe8-1db6bdf1d16f","area_id":"3319d4f7-3d05-444c-9127-995a4370d3f4","fishery_gear_id":"d9dbf668-bba8-4fd8-9730-9c36aba4be19","effort":2.125,"brand_variant_id":"b1e78132-1ab6-4efc-a757-1155b60f1a09","comments":"Summarized data for landing","catch":[{"fishery_species_id":"5167764e-cb27-4a96-bf67-a92dcf1685c1","catch_category_id":"8a9612d1-dc3c-4bbb-ac3a-c36317709df3","brand_variant_id":"b1e78132-1ab6-4efc-a757-1155b60f1a09","buyer_processor_id":"a9b77484-d363-4f43-bbe8-1db6bdf1d16f","weight":90,"pieces":null},{"fishery_species_id":"4e244f31-9835-409b-a645-6b5bc0aeed0e","catch_category_id":"a2c95968-02f5-41ed-be04-a13ffd2e2056","brand_variant_id":"6646e203-1c52-47c4-a147-324b5d49c69c","buyer_processor_id":"bece1b15-9702-4e5d-bc2d-c28b781ab607","weight":15.1,"pieces":4}]}' -X PUT \
	-H "Authorization: Bearer ad902f2d261a18c855b2b916996dd62a1dec9fa2"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
document_number Document number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
port_id ID of port UUID
location_id ID of location UUID
first_receiver_id ID of first receiver UUID
buyer_processor_id ID of buyer/processor UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
effort Fishing effort (in days) Decimal
brand_variant_id ID of brand/variant UUID
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name ID of creating user UUID
updated_date_time Updated date/time ISO8601 date/time
updated_by_name ID of updating user UUID
submitted_date_time Submitted date/time ISO8601 date/time
validated_by_name ID of validating user UUID
validation_comments Validation comments String
catch Catch details Array
- id ID String
- fishery_species_id ID of species UUID
- catch_category_id ID of catch category UUID
- brand_variant_id ID of brand/variant UUID
- buyer_processor_id ID of buyer/processor UUID
- weight Weight Decimal
- pieces Pieces Integer
- metadata Metadata JSON

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: a1b78a8e-5ac8-4196-8bd2-47a33e86713c

Body

{
  "data": {
    "id": "07ed31ec-32be-43d4-bf8a-166b4c4332c5",
    "html_url": "/management/fisheries/154543eedce6/landings/4326b296909a",
    "fishery_id": "33afaa5c-c8a2-426d-b0a5-034159b7370e",
    "fishery_period_id": "3d4b9642-6075-468a-a920-86205efa67ef",
    "trip_id": null,
    "hail_id": null,
    "started_date_time": "2018-09-02T12:19:12Z",
    "ended_date_time": "2018-09-04T05:22:02Z",
    "document_number": "X33U9871",
    "fisherman_id": "b40870c9-3e66-4af2-af5b-ad03914b4818",
    "monitor_id": "5f286afb-61b2-4e72-8371-e732b46c5e88",
    "vessel_id": "faa0a164-6049-4f0b-9ac2-3697cfaaa770",
    "port_id": "9fb0c08d-b60a-43cb-a411-fc11f4135a9f",
    "location_id": "a424f33f-c8f4-4d3e-90fd-2abb8c4621fe",
    "first_receiver_id": "f9c768fa-c22e-4a69-bb22-b4ea01c4b995",
    "buyer_processor_id": "a9b77484-d363-4f43-bbe8-1db6bdf1d16f",
    "area_id": "3319d4f7-3d05-444c-9127-995a4370d3f4",
    "fishery_gear_id": "d9dbf668-bba8-4fd8-9730-9c36aba4be19",
    "effort": 2.125,
    "brand_variant_id": "b1e78132-1ab6-4efc-a757-1155b60f1a09",
    "comments": "Summarized data for landing",
    "metadata": {
    },
    "created_date_time": "2018-08-01T00:00:00Z",
    "created_by_name": "Lenny Hermann",
    "updated_date_time": "2020-06-22T19:38:26Z",
    "updated_by_name": "Lenny Hermann",
    "submitted_date_time": null,
    "validated_date_time": null,
    "validated_by_name": null,
    "validation_comments": null,
    "catch": [
      {
        "id": "a41eea74-1008-4dc7-b823-aff89918bc2d",
        "fishery_species_id": "4e244f31-9835-409b-a645-6b5bc0aeed0e",
        "catch_category_id": "a2c95968-02f5-41ed-be04-a13ffd2e2056",
        "brand_variant_id": null,
        "buyer_processor_id": null,
        "weight": 11.2,
        "pieces": 8,
        "metadata": {
        }
      },
      {
        "id": "78321a36-6bf7-4f90-879c-3e072d8f3e25",
        "fishery_species_id": "e06cb721-3215-42f5-90d6-8bfbfd060359",
        "catch_category_id": "a2c95968-02f5-41ed-be04-a13ffd2e2056",
        "brand_variant_id": null,
        "buyer_processor_id": null,
        "weight": 81.5,
        "pieces": 332,
        "metadata": {
          "integration_id": 124
        }
      },
      {
        "id": "b4110e9b-31c7-409c-a2d2-019482a3d35b",
        "fishery_species_id": "5167764e-cb27-4a96-bf67-a92dcf1685c1",
        "catch_category_id": null,
        "brand_variant_id": "b1e78132-1ab6-4efc-a757-1155b60f1a09",
        "buyer_processor_id": "a9b77484-d363-4f43-bbe8-1db6bdf1d16f",
        "weight": 90.0,
        "pieces": null,
        "metadata": {
        }
      },
      {
        "id": "41f17301-a6f1-4840-8c36-6dfe2a666d31",
        "fishery_species_id": "4e244f31-9835-409b-a645-6b5bc0aeed0e",
        "catch_category_id": null,
        "brand_variant_id": "6646e203-1c52-47c4-a147-324b5d49c69c",
        "buyer_processor_id": "bece1b15-9702-4e5d-bc2d-c28b781ab607",
        "weight": 15.1,
        "pieces": null,
        "metadata": {
        }
      }
    ]
  }
}

Locations

Create a new Location

Endpoint

POST /api/v1/locations

Parameters

Name Description Type
name Name String
code Code String
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON

Request

Route

POST /api/v1/locations

Headers

Authorization: Bearer 8f93b8521ce92bfb939a2d263e01016255b68210
Content-Type: application/json

Body

{
  "name": "Waterway Dock",
  "code": "2716",
  "active": true,
  "address_line_1": "1726 Wayfinder St",
  "address_line_2": null,
  "city": "Vancouver",
  "province_state": "BC",
  "country": "CAN",
  "postal_zip_code": "V6J2K1",
  "latitude": 54.128172,
  "longitude": -125.221292,
  "primary_contact": "John Smith",
  "phone": "555-555-5555 x122",
  "mobile": "555-555-5556",
  "fax": "555-555-5557",
  "alternate_email": "john@vericatch.com",
  "website": "http://vericatch.com",
  "comments": "End of the road, turn right",
  "metadata": {
    "totes_transported": 315
  }
}

cURL

curl "https://fisheriesapp.com/api/v1/locations" -d '{"name":"Waterway Dock","code":"2716","active":true,"address_line_1":"1726 Wayfinder St","address_line_2":null,"city":"Vancouver","province_state":"BC","country":"CAN","postal_zip_code":"V6J2K1","latitude":54.128172,"longitude":-125.221292,"primary_contact":"John Smith","phone":"555-555-5555 x122","mobile":"555-555-5556","fax":"555-555-5557","alternate_email":"john@vericatch.com","website":"http://vericatch.com","comments":"End of the road, turn right","metadata":{"totes_transported":315}}' -X POST \
	-H "Authorization: Bearer 8f93b8521ce92bfb939a2d263e01016255b68210"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
code Code String
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 19a3efc2-af12-4994-a584-cd6683c63d5c

Body

{
  "data": {
    "id": "a51a552c-49d8-498c-b895-d07bc9d72fbb",
    "html_url": "/management/account/locations/6b1aa0aedcbc",
    "name": "Waterway Dock",
    "code": "2716",
    "active": true,
    "address_line_1": "1726 Wayfinder St",
    "address_line_2": null,
    "city": "Vancouver",
    "province_state": "BC",
    "country": "CAN",
    "postal_zip_code": "V6J2K1",
    "latitude": 54.128172,
    "longitude": -125.221292,
    "primary_contact": "John Smith",
    "phone": "555-555-5555 x122",
    "mobile": "555-555-5556",
    "fax": "555-555-5557",
    "alternate_email": "john@vericatch.com",
    "website": "http://vericatch.com",
    "comments": "End of the road, turn right",
    "metadata": {
      "totes_transported": 315
    },
    "created_date_time": "2020-06-22T19:38:21Z",
    "created_by_name": "Vikki Armstrong",
    "updated_date_time": "2020-06-22T19:38:21Z",
    "updated_by_name": "Vikki Armstrong"
  }
}

Delete an existing Location

Endpoint

DELETE /api/v1/locations/:id

Request

Route

DELETE /api/v1/locations/9e35e7dc-99e8-448b-aafa-7883522f20d4

Headers

Authorization: Bearer 8f93b8521ce92bfb939a2d263e01016255b68210
Content-Type: application/json

cURL

curl "https://fisheriesapp.com/api/v1/locations/9e35e7dc-99e8-448b-aafa-7883522f20d4" -d '' -X DELETE \
	-H "Authorization: Bearer 8f93b8521ce92bfb939a2d263e01016255b68210"

Response

Simulated Response

Status

204

Headers

X-Request-Id: 59efc39b-98e0-4b15-b5ea-e4b36fd4952b

Return a list of Locations

Endpoint

GET /api/v1/locations

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/locations

Headers

Authorization: Bearer 8f93b8521ce92bfb939a2d263e01016255b68210
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/locations" -X GET \
	-H "Authorization: Bearer 8f93b8521ce92bfb939a2d263e01016255b68210"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
code Code String
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 6655b949-a948-408e-abab-05ffba94a050

Body

{
  "data": [
    {
      "id": "a51a552c-49d8-498c-b895-d07bc9d72fbb",
      "html_url": "/management/account/locations/6b1aa0aedcbc",
      "name": "Waterway Dock",
      "code": "2716",
      "active": true,
      "address_line_1": "1726 Wayfinder St",
      "address_line_2": null,
      "city": "Vancouver",
      "province_state": "BC",
      "country": "CAN",
      "postal_zip_code": "V6J2K1",
      "latitude": 54.128172,
      "longitude": -125.221292,
      "primary_contact": "John Smith",
      "phone": "555-555-5555 x122",
      "mobile": "555-555-5556",
      "fax": "555-555-5557",
      "alternate_email": "john@vericatch.com",
      "website": "http://vericatch.com",
      "comments": "End of the road, turn right",
      "metadata": {
        "totes_transported": 315
      },
      "created_date_time": "2020-06-22T19:38:21Z",
      "created_by_name": "Vikki Armstrong",
      "updated_date_time": "2020-06-22T19:38:21Z",
      "updated_by_name": "Vikki Armstrong"
    },
    {
      "id": "8d1e9396-fe58-4e2f-8d7a-a815d04029b3",
      "html_url": "/management/account/locations/aca54b6d71b4",
      "name": "Floating Dock",
      "code": "1003",
      "active": true,
      "address_line_1": null,
      "address_line_2": null,
      "city": null,
      "province_state": null,
      "country": null,
      "postal_zip_code": null,
      "latitude": null,
      "longitude": null,
      "primary_contact": null,
      "phone": null,
      "mobile": null,
      "fax": null,
      "alternate_email": null,
      "website": null,
      "comments": "Repellat labore temporibus et.",
      "metadata": {
        "color": "orange"
      },
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Vikki Armstrong",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Vikki Armstrong"
    },
    {
      "id": "d0c8827d-f142-47e0-8f3b-f3d5209c5257",
      "html_url": "/management/account/locations/42b63992b5e2",
      "name": "Government Dock",
      "code": "2008",
      "active": true,
      "address_line_1": null,
      "address_line_2": null,
      "city": null,
      "province_state": null,
      "country": null,
      "postal_zip_code": null,
      "latitude": null,
      "longitude": null,
      "primary_contact": null,
      "phone": null,
      "mobile": null,
      "fax": null,
      "alternate_email": null,
      "website": null,
      "comments": "Ut quia quasi voluptatum.",
      "metadata": {
      },
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Vikki Armstrong",
      "updated_date_time": "2018-08-02T00:00:00Z",
      "updated_by_name": "Vikki Armstrong"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single Location

Endpoint

GET /api/v1/locations/:id

Request

Route

GET /api/v1/locations/8d1e9396-fe58-4e2f-8d7a-a815d04029b3

Headers

Authorization: Bearer 8f93b8521ce92bfb939a2d263e01016255b68210
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/locations/8d1e9396-fe58-4e2f-8d7a-a815d04029b3" -X GET \
	-H "Authorization: Bearer 8f93b8521ce92bfb939a2d263e01016255b68210"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
code Code String
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 5d655e7d-e1df-4f0d-98ee-c932578491c2

Body

{
  "data": {
    "id": "8d1e9396-fe58-4e2f-8d7a-a815d04029b3",
    "html_url": "/management/account/locations/aca54b6d71b4",
    "name": "Floating Dock",
    "code": "1003",
    "active": true,
    "address_line_1": null,
    "address_line_2": null,
    "city": null,
    "province_state": null,
    "country": null,
    "postal_zip_code": null,
    "latitude": null,
    "longitude": null,
    "primary_contact": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "alternate_email": null,
    "website": null,
    "comments": "Repellat labore temporibus et.",
    "metadata": {
      "color": "orange"
    },
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Vikki Armstrong",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Vikki Armstrong"
  }
}

Update an existing Location

Endpoint

PUT /api/v1/locations/:id

Parameters

Name Description Type
name Name String
code Code String
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON

Request

Route

PUT /api/v1/locations/d0c8827d-f142-47e0-8f3b-f3d5209c5257

Headers

Authorization: Bearer 8f93b8521ce92bfb939a2d263e01016255b68210
Content-Type: application/json

Body

{
  "name": "Dock #8",
  "code": "D8",
  "active": true,
  "address_line_1": "1827 Pathfinder Ave",
  "address_line_2": null,
  "city": "Vancouver",
  "province_state": "BC",
  "country": "CAN",
  "postal_zip_code": "V6L3J2",
  "latitude": 55.216172,
  "longitude": -126.211522,
  "primary_contact": "John Smith",
  "phone": "555-555-5555 x122",
  "mobile": "555-555-5556",
  "fax": "555-555-5557",
  "alternate_email": "john@vericatch.com",
  "website": "http://vericatch.com",
  "comments": null,
  "metadata": {
    "totes_transported": 271
  }
}

cURL

curl "https://fisheriesapp.com/api/v1/locations/d0c8827d-f142-47e0-8f3b-f3d5209c5257" -d '{"name":"Dock #8","code":"D8","active":true,"address_line_1":"1827 Pathfinder Ave","address_line_2":null,"city":"Vancouver","province_state":"BC","country":"CAN","postal_zip_code":"V6L3J2","latitude":55.216172,"longitude":-126.211522,"primary_contact":"John Smith","phone":"555-555-5555 x122","mobile":"555-555-5556","fax":"555-555-5557","alternate_email":"john@vericatch.com","website":"http://vericatch.com","comments":null,"metadata":{"totes_transported":271}}' -X PUT \
	-H "Authorization: Bearer 8f93b8521ce92bfb939a2d263e01016255b68210"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
code Code String
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 7e3f3a45-6453-4e7a-8178-633a7240f8ca

Body

{
  "data": {
    "id": "d0c8827d-f142-47e0-8f3b-f3d5209c5257",
    "html_url": "/management/account/locations/42b63992b5e2",
    "name": "Dock #8",
    "code": "D8",
    "active": true,
    "address_line_1": "1827 Pathfinder Ave",
    "address_line_2": null,
    "city": "Vancouver",
    "province_state": "BC",
    "country": "CAN",
    "postal_zip_code": "V6L3J2",
    "latitude": 55.216172,
    "longitude": -126.211522,
    "primary_contact": "John Smith",
    "phone": "555-555-5555 x122",
    "mobile": "555-555-5556",
    "fax": "555-555-5557",
    "alternate_email": "john@vericatch.com",
    "website": "http://vericatch.com",
    "comments": null,
    "metadata": {
      "totes_transported": 271
    },
    "created_date_time": "2018-08-01T00:00:00Z",
    "created_by_name": "Vikki Armstrong",
    "updated_date_time": "2020-06-22T19:38:21Z",
    "updated_by_name": "Vikki Armstrong"
  }
}

Monitor Sets

Create a new Monitor Set

Endpoint

POST /api/v1/monitor-sets

Parameters

Name Description Type
fishery_id required ID of fishery UUID
fishery_period_id required ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time required Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
soak_time Soak time Decimal
set_number Set number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Gear mesh size (cm) Integer
gear_length Length of an individual panel, pot, etc (m) Decimal
gear_count Count of panels, pots, etc Integer
depth_min Minimum depth (m) Integer
depth_max Maximum depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
catch Catch details Array
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Request

Route

POST /api/v1/monitor-sets

Headers

Authorization: Bearer b7578a2459f4dd585ca38e1bb6ab9656575b826c
Content-Type: application/json

Body

{
  "fishery_id": "404fa955-5165-4b93-9286-e70b09bc9991",
  "fishery_period_id": "8964372f-675f-4c45-ba4f-fa5166d06eda",
  "trip_id": "84e70156-cc61-435e-9163-b2342a8da55f",
  "hail_id": "d9ad9e49-5bcc-4392-ace7-56faeafb864c",
  "started_date_time": "2018-09-02T12:19:12",
  "ended_date_time": "2018-09-04T05:22:02",
  "soak_time": 2,
  "set_number": 4,
  "fisherman_id": "df173193-0546-47b3-8064-3c0b9f8b148e",
  "monitor_id": "db4b1a70-25a9-420a-97c3-e50c705bcec6",
  "vessel_id": "f19e518d-59cb-4920-a65d-c8c92361027d",
  "area_id": "66e53c29-579c-44dc-8ead-cbb678912d1b",
  "fishery_gear_id": "4802a692-fb58-45b9-825d-08dc0d60ed7e",
  "gear_mesh_size": 2,
  "gear_length": 5.5,
  "gear_count": 45,
  "target_species_priority_1_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
  "target_species_priority_2_id": "e0b25980-718a-4022-9adc-b2f9bb7788ec",
  "target_species_priority_3_id": null,
  "depth_target": 9,
  "depth_min": 7,
  "depth_max": 8,
  "start_geo_point": {
    "lat": {
      "dd": {
        "degrees": 50.123
      }
    },
    "long": {
      "dd": {
        "degrees": -127.123
      }
    }
  },
  "mid_geo_point": {
    "lat": {
      "dd": {
        "degrees": 51.123
      }
    },
    "long": {
      "dd": {
        "degrees": -128.123
      }
    }
  },
  "end_geo_point": {
    "lat": {
      "dd": {
        "degrees": 52.123
      }
    },
    "long": {
      "dd": {
        "degrees": -129.123
      }
    }
  },
  "comments": "Summarized data for tow 4",
  "metadata": {
    "color": "grey"
  },
  "catch": [
    {
      "fishery_species_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
      "area_id": "66e53c29-579c-44dc-8ead-cbb678912d1b",
      "catch_category_id": null,
      "retained_weight": 102.1,
      "released_weight": 12.4,
      "retained_pieces": 67,
      "released_pieces": 5
    },
    {
      "fishery_species_id": "e0b25980-718a-4022-9adc-b2f9bb7788ec",
      "area_id": "31be2389-7723-42ba-9aa4-120a6602fdef",
      "catch_category_id": null,
      "retained_weight": null,
      "released_weight": 34.2,
      "retained_pieces": null,
      "released_pieces": 6,
      "comments": "comment on catch"
    }
  ]
}

cURL

curl "https://fisheriesapp.com/api/v1/monitor-sets" -d '{"fishery_id":"404fa955-5165-4b93-9286-e70b09bc9991","fishery_period_id":"8964372f-675f-4c45-ba4f-fa5166d06eda","trip_id":"84e70156-cc61-435e-9163-b2342a8da55f","hail_id":"d9ad9e49-5bcc-4392-ace7-56faeafb864c","started_date_time":"2018-09-02T12:19:12","ended_date_time":"2018-09-04T05:22:02","soak_time":2,"set_number":4,"fisherman_id":"df173193-0546-47b3-8064-3c0b9f8b148e","monitor_id":"db4b1a70-25a9-420a-97c3-e50c705bcec6","vessel_id":"f19e518d-59cb-4920-a65d-c8c92361027d","area_id":"66e53c29-579c-44dc-8ead-cbb678912d1b","fishery_gear_id":"4802a692-fb58-45b9-825d-08dc0d60ed7e","gear_mesh_size":2,"gear_length":5.5,"gear_count":45,"target_species_priority_1_id":"c613f627-1af9-49b9-82fe-5d715aea50f1","target_species_priority_2_id":"e0b25980-718a-4022-9adc-b2f9bb7788ec","target_species_priority_3_id":null,"depth_target":9,"depth_min":7,"depth_max":8,"start_geo_point":{"lat":{"dd":{"degrees":50.123}},"long":{"dd":{"degrees":-127.123}}},"mid_geo_point":{"lat":{"dd":{"degrees":51.123}},"long":{"dd":{"degrees":-128.123}}},"end_geo_point":{"lat":{"dd":{"degrees":52.123}},"long":{"dd":{"degrees":-129.123}}},"comments":"Summarized data for tow 4","metadata":{"color":"grey"},"catch":[{"fishery_species_id":"c613f627-1af9-49b9-82fe-5d715aea50f1","area_id":"66e53c29-579c-44dc-8ead-cbb678912d1b","catch_category_id":null,"retained_weight":102.1,"released_weight":12.4,"retained_pieces":67,"released_pieces":5},{"fishery_species_id":"e0b25980-718a-4022-9adc-b2f9bb7788ec","area_id":"31be2389-7723-42ba-9aa4-120a6602fdef","catch_category_id":null,"retained_weight":null,"released_weight":34.2,"retained_pieces":null,"released_pieces":6,"comments":"comment on catch"}]}' -X POST \
	-H "Authorization: Bearer b7578a2459f4dd585ca38e1bb6ab9656575b826c"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
soak_time Soak time Decimal
set_number Set number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Mesh size of gear (cm) Decimal
gear_length Length of gear (m) Decimal
gear_count Count of gear (panels, pots, etc) Integer
target_species_priority_1_id ID of priority 1 target species UUID
target_species_priority_2_id ID of priority 2 target species UUID
target_species_priority_3_id ID of priority 3 target species UUID
depth_target Target gear depth (m) Integer
depth_min Minimum gear depth (m) Integer
depth_max Maximum gear depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
submitted_date_time Submitted date/time ISO8601 date/time
validated_date_time Validated date/time ISO8601 date/time
validated_by_name Name of validating user String
validation_comments Validation comments String
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 25f2898d-386d-405f-8d2a-e47d0dc3f60f

Body

{
  "data": {
    "id": "25edeb09-e27e-4116-b89b-0a1d470284fa",
    "html_url": "/management/fisheries/ed5131017bb5/monitor-sets/58672161d6c6",
    "fishery_id": "404fa955-5165-4b93-9286-e70b09bc9991",
    "fishery_period_id": "8964372f-675f-4c45-ba4f-fa5166d06eda",
    "trip_id": "84e70156-cc61-435e-9163-b2342a8da55f",
    "hail_id": "d9ad9e49-5bcc-4392-ace7-56faeafb864c",
    "started_date_time": "2018-09-02T12:19:12Z",
    "ended_date_time": "2018-09-04T05:22:02Z",
    "soak_time": 2.0,
    "set_number": 4,
    "fisherman_id": "df173193-0546-47b3-8064-3c0b9f8b148e",
    "monitor_id": "db4b1a70-25a9-420a-97c3-e50c705bcec6",
    "vessel_id": "f19e518d-59cb-4920-a65d-c8c92361027d",
    "area_id": "66e53c29-579c-44dc-8ead-cbb678912d1b",
    "fishery_gear_id": "4802a692-fb58-45b9-825d-08dc0d60ed7e",
    "gear_mesh_size": 2.0,
    "gear_length": 5.5,
    "gear_count": 45,
    "target_species_priority_1_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
    "target_species_priority_2_id": "e0b25980-718a-4022-9adc-b2f9bb7788ec",
    "target_species_priority_3_id": null,
    "depth_target": 9,
    "depth_min": 7,
    "depth_max": 8,
    "start_geo_point": {
      "lat": {
        "dd": {
          "degrees": 50.123
        },
        "ddm": {
          "degrees": 50,
          "minutes": 7.38
        },
        "dms": {
          "degrees": 50,
          "minutes": 7,
          "seconds": 22.8
        }
      },
      "long": {
        "dd": {
          "degrees": -127.123
        },
        "ddm": {
          "degrees": -127,
          "minutes": 7.38
        },
        "dms": {
          "degrees": -127,
          "minutes": 7,
          "seconds": 22.8
        }
      }
    },
    "mid_geo_point": {
      "lat": {
        "dd": {
          "degrees": 51.123
        },
        "ddm": {
          "degrees": 51,
          "minutes": 7.38
        },
        "dms": {
          "degrees": 51,
          "minutes": 7,
          "seconds": 22.8
        }
      },
      "long": {
        "dd": {
          "degrees": -128.123
        },
        "ddm": {
          "degrees": -128,
          "minutes": 7.38
        },
        "dms": {
          "degrees": -128,
          "minutes": 7,
          "seconds": 22.8
        }
      }
    },
    "end_geo_point": {
      "lat": {
        "dd": {
          "degrees": 52.123
        },
        "ddm": {
          "degrees": 52,
          "minutes": 7.38
        },
        "dms": {
          "degrees": 52,
          "minutes": 7,
          "seconds": 22.8
        }
      },
      "long": {
        "dd": {
          "degrees": -129.123
        },
        "ddm": {
          "degrees": -129,
          "minutes": 7.38
        },
        "dms": {
          "degrees": -129,
          "minutes": 7,
          "seconds": 22.8
        }
      }
    },
    "comments": "Summarized data for tow 4",
    "metadata": {
      "color": "grey"
    },
    "created_date_time": "2020-06-22T19:38:19Z",
    "created_by_name": "Majorie Blick",
    "updated_date_time": "2020-06-22T19:38:19Z",
    "updated_by_name": "Majorie Blick",
    "submitted_date_time": null,
    "validated_date_time": null,
    "validated_by_name": null,
    "validation_comments": null,
    "catch": [
      {
        "id": "d21b75a4-b85f-410a-8b0f-2f429f7b7d31",
        "fishery_species_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
        "area_id": "66e53c29-579c-44dc-8ead-cbb678912d1b",
        "catch_category_id": null,
        "retained_weight": 102.1,
        "released_weight": 12.4,
        "retained_pieces": null,
        "released_pieces": null,
        "comments": null,
        "metadata": {
        }
      },
      {
        "id": "61e1a6fc-6aef-4a53-9735-cada38de302c",
        "fishery_species_id": "e0b25980-718a-4022-9adc-b2f9bb7788ec",
        "area_id": "31be2389-7723-42ba-9aa4-120a6602fdef",
        "catch_category_id": null,
        "retained_weight": null,
        "released_weight": 34.2,
        "retained_pieces": null,
        "released_pieces": null,
        "comments": "comment on catch",
        "metadata": {
        }
      }
    ]
  }
}

Delete an existing Monitor Set

Endpoint

DELETE /api/v1/monitor-sets/:id

Request

Route

DELETE /api/v1/monitor-sets/669ee5d5-2383-443d-b5ed-401891d07e1b

Headers

Authorization: Bearer b7578a2459f4dd585ca38e1bb6ab9656575b826c
Content-Type: application/json

cURL

curl "https://fisheriesapp.com/api/v1/monitor-sets/669ee5d5-2383-443d-b5ed-401891d07e1b" -d '' -X DELETE \
	-H "Authorization: Bearer b7578a2459f4dd585ca38e1bb6ab9656575b826c"

Response

Simulated Response

Status

204

Headers

X-Request-Id: 4ea72e81-43c1-43b2-99de-fba8e4ed29bc

Return a list of Monitor Sets

Endpoint

GET /api/v1/monitor-sets

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time
fishery_id Optionally specify one or more fisheries as a comma separated list of IDs String
fishery_period_id Optionally specify one or more periods as a comma separated list of IDs; leaving blank defaults to returning data from any fisheries current period String

Request

Route

GET /api/v1/monitor-sets

Headers

Authorization: Bearer b7578a2459f4dd585ca38e1bb6ab9656575b826c
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/monitor-sets" -X GET \
	-H "Authorization: Bearer b7578a2459f4dd585ca38e1bb6ab9656575b826c"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
soak_time Soak time Decimal
set_number Set number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Mesh size of gear (cm) Decimal
gear_length Length of gear (m) Decimal
gear_count Count of gear (panels, pots, etc) Integer
target_species_priority_1_id ID of priority 1 target species UUID
target_species_priority_2_id ID of priority 2 target species UUID
target_species_priority_3_id ID of priority 3 target species UUID
depth_target Target gear depth (m) Integer
depth_min Minimum gear depth (m) Integer
depth_max Maximum gear depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
submitted_date_time Submitted date/time ISO8601 date/time
validated_date_time Validated date/time ISO8601 date/time
validated_by_name Name of validating user String
validation_comments Validation comments String
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 164c3752-bad1-4373-87cc-e6810d387548

Body

{
  "data": [
    {
      "id": "25edeb09-e27e-4116-b89b-0a1d470284fa",
      "html_url": "/management/fisheries/ed5131017bb5/monitor-sets/58672161d6c6",
      "fishery_id": "404fa955-5165-4b93-9286-e70b09bc9991",
      "fishery_period_id": "8964372f-675f-4c45-ba4f-fa5166d06eda",
      "trip_id": "84e70156-cc61-435e-9163-b2342a8da55f",
      "hail_id": "d9ad9e49-5bcc-4392-ace7-56faeafb864c",
      "started_date_time": "2018-09-02T12:19:12Z",
      "ended_date_time": "2018-09-04T05:22:02Z",
      "soak_time": 2.0,
      "set_number": 4,
      "fisherman_id": "df173193-0546-47b3-8064-3c0b9f8b148e",
      "monitor_id": "db4b1a70-25a9-420a-97c3-e50c705bcec6",
      "vessel_id": "f19e518d-59cb-4920-a65d-c8c92361027d",
      "area_id": "66e53c29-579c-44dc-8ead-cbb678912d1b",
      "fishery_gear_id": "4802a692-fb58-45b9-825d-08dc0d60ed7e",
      "gear_mesh_size": 2.0,
      "gear_length": 5.5,
      "gear_count": 45,
      "target_species_priority_1_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
      "target_species_priority_2_id": "e0b25980-718a-4022-9adc-b2f9bb7788ec",
      "target_species_priority_3_id": null,
      "depth_target": 9,
      "depth_min": 7,
      "depth_max": 8,
      "start_geo_point": {
        "lat": {
          "dd": {
            "degrees": 50.123
          },
          "ddm": {
            "degrees": 50,
            "minutes": 7.38
          },
          "dms": {
            "degrees": 50,
            "minutes": 7,
            "seconds": 22.8
          }
        },
        "long": {
          "dd": {
            "degrees": -127.123
          },
          "ddm": {
            "degrees": -127,
            "minutes": 7.38
          },
          "dms": {
            "degrees": -127,
            "minutes": 7,
            "seconds": 22.8
          }
        }
      },
      "mid_geo_point": {
        "lat": {
          "dd": {
            "degrees": 51.123
          },
          "ddm": {
            "degrees": 51,
            "minutes": 7.38
          },
          "dms": {
            "degrees": 51,
            "minutes": 7,
            "seconds": 22.8
          }
        },
        "long": {
          "dd": {
            "degrees": -128.123
          },
          "ddm": {
            "degrees": -128,
            "minutes": 7.38
          },
          "dms": {
            "degrees": -128,
            "minutes": 7,
            "seconds": 22.8
          }
        }
      },
      "end_geo_point": {
        "lat": {
          "dd": {
            "degrees": 52.123
          },
          "ddm": {
            "degrees": 52,
            "minutes": 7.38
          },
          "dms": {
            "degrees": 52,
            "minutes": 7,
            "seconds": 22.8
          }
        },
        "long": {
          "dd": {
            "degrees": -129.123
          },
          "ddm": {
            "degrees": -129,
            "minutes": 7.38
          },
          "dms": {
            "degrees": -129,
            "minutes": 7,
            "seconds": 22.8
          }
        }
      },
      "comments": "Summarized data for tow 4",
      "metadata": {
        "color": "grey"
      },
      "created_date_time": "2020-06-22T19:38:19Z",
      "created_by_name": "Majorie Blick",
      "updated_date_time": "2020-06-22T19:38:19Z",
      "updated_by_name": "Majorie Blick",
      "submitted_date_time": null,
      "validated_date_time": null,
      "validated_by_name": null,
      "validation_comments": null,
      "catch": [
        {
          "id": "d21b75a4-b85f-410a-8b0f-2f429f7b7d31",
          "fishery_species_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
          "area_id": "66e53c29-579c-44dc-8ead-cbb678912d1b",
          "catch_category_id": null,
          "retained_weight": 102.1,
          "released_weight": 12.4,
          "retained_pieces": null,
          "released_pieces": null,
          "comments": null,
          "metadata": {
          }
        },
        {
          "id": "61e1a6fc-6aef-4a53-9735-cada38de302c",
          "fishery_species_id": "e0b25980-718a-4022-9adc-b2f9bb7788ec",
          "area_id": "31be2389-7723-42ba-9aa4-120a6602fdef",
          "catch_category_id": null,
          "retained_weight": null,
          "released_weight": 34.2,
          "retained_pieces": null,
          "released_pieces": null,
          "comments": "comment on catch",
          "metadata": {
          }
        }
      ]
    },
    {
      "id": "80fb4c94-60e8-4f89-bc2f-692ef5139377",
      "html_url": "/management/fisheries/ed5131017bb5/monitor-sets/2f9a0913fe18",
      "fishery_id": "404fa955-5165-4b93-9286-e70b09bc9991",
      "fishery_period_id": "8964372f-675f-4c45-ba4f-fa5166d06eda",
      "trip_id": "84e70156-cc61-435e-9163-b2342a8da55f",
      "hail_id": null,
      "started_date_time": "2020-04-09T18:41:18Z",
      "ended_date_time": "2020-04-09T20:41:18Z",
      "soak_time": 171.68,
      "set_number": 1,
      "fisherman_id": "df173193-0546-47b3-8064-3c0b9f8b148e",
      "monitor_id": "db4b1a70-25a9-420a-97c3-e50c705bcec6",
      "vessel_id": "f19e518d-59cb-4920-a65d-c8c92361027d",
      "area_id": "66e53c29-579c-44dc-8ead-cbb678912d1b",
      "fishery_gear_id": "4802a692-fb58-45b9-825d-08dc0d60ed7e",
      "gear_mesh_size": 10.0,
      "gear_length": 70.5,
      "gear_count": 60,
      "target_species_priority_1_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
      "target_species_priority_2_id": null,
      "target_species_priority_3_id": null,
      "depth_target": 12,
      "depth_min": 10,
      "depth_max": 15,
      "start_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.686453
          },
          "ddm": {
            "degrees": 49,
            "minutes": 41.1872
          },
          "dms": {
            "degrees": 49,
            "minutes": 41,
            "seconds": 11.2308
          }
        },
        "long": {
          "dd": {
            "degrees": -124.280624
          },
          "ddm": {
            "degrees": -124,
            "minutes": 16.8374
          },
          "dms": {
            "degrees": -124,
            "minutes": 16,
            "seconds": 50.2464
          }
        }
      },
      "mid_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.498926
          },
          "ddm": {
            "degrees": 49,
            "minutes": 29.9356
          },
          "dms": {
            "degrees": 49,
            "minutes": 29,
            "seconds": 56.1336
          }
        },
        "long": {
          "dd": {
            "degrees": -124.041773
          },
          "ddm": {
            "degrees": -124,
            "minutes": 2.5064
          },
          "dms": {
            "degrees": -124,
            "minutes": 2,
            "seconds": 30.3828
          }
        }
      },
      "end_geo_point": {
        "lat": {
          "dd": {
            "degrees": 49.45798
          },
          "ddm": {
            "degrees": 49,
            "minutes": 27.4788
          },
          "dms": {
            "degrees": 49,
            "minutes": 27,
            "seconds": 28.728
          }
        },
        "long": {
          "dd": {
            "degrees": -123.978817
          },
          "ddm": {
            "degrees": -123,
            "minutes": 58.729
          },
          "dms": {
            "degrees": -123,
            "minutes": 58,
            "seconds": 43.7412
          }
        }
      },
      "comments": "",
      "metadata": {
        "color": "grey"
      },
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Majorie Blick",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Majorie Blick",
      "submitted_date_time": null,
      "validated_date_time": null,
      "validated_by_name": null,
      "validation_comments": null,
      "catch": [
        {
          "id": "e50c9802-95ac-4547-bdf4-e9591386883f",
          "fishery_species_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
          "area_id": null,
          "catch_category_id": "17fbd563-f38b-4207-bcf6-9e40bdee98f3",
          "retained_weight": 360.0,
          "released_weight": 18.3,
          "retained_pieces": 2352,
          "released_pieces": 241,
          "comments": "Released catch too small for market.",
          "metadata": {
            "integration_id": 4890
          }
        },
        {
          "id": "0c9929d5-a3c1-4f56-9c08-d5b66683297f",
          "fishery_species_id": "e0b25980-718a-4022-9adc-b2f9bb7788ec",
          "area_id": null,
          "catch_category_id": "966d4c00-6aad-446a-873c-f3d39a7cca56",
          "retained_weight": 81.5,
          "released_weight": null,
          "retained_pieces": 7,
          "released_pieces": null,
          "comments": "",
          "metadata": {
          }
        }
      ]
    },
    {
      "id": "15ddf33f-1eda-484f-8cd4-11042e66795f",
      "html_url": "/management/fisheries/ed5131017bb5/monitor-sets/b4ea8207e8cc",
      "fishery_id": "404fa955-5165-4b93-9286-e70b09bc9991",
      "fishery_period_id": "8964372f-675f-4c45-ba4f-fa5166d06eda",
      "trip_id": "84e70156-cc61-435e-9163-b2342a8da55f",
      "hail_id": "d9ad9e49-5bcc-4392-ace7-56faeafb864c",
      "started_date_time": "2018-08-03T11:12:00Z",
      "ended_date_time": "2018-08-03T18:01:00Z",
      "soak_time": 3.0,
      "set_number": 12,
      "fisherman_id": "f91cc267-1710-49d3-a120-cbbe15f1546b",
      "monitor_id": "81ae9c5d-b875-4d5d-bc5b-08c916a02b21",
      "vessel_id": "d1dbfc36-56f2-4cbd-aa66-60633d087dc8",
      "area_id": "31be2389-7723-42ba-9aa4-120a6602fdef",
      "fishery_gear_id": "de73955c-04b3-4bcc-8b12-e77d3ecc008d",
      "gear_mesh_size": 2.0,
      "gear_length": 5.75,
      "gear_count": 40,
      "target_species_priority_1_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
      "target_species_priority_2_id": "e0b25980-718a-4022-9adc-b2f9bb7788ec",
      "target_species_priority_3_id": null,
      "depth_target": 7,
      "depth_min": 6,
      "depth_max": 7,
      "start_geo_point": {
        "lat": {
          "dd": {
            "degrees": 50.0185
          },
          "ddm": {
            "degrees": 50,
            "minutes": 1.11
          },
          "dms": {
            "degrees": 50,
            "minutes": 1,
            "seconds": 6.6
          }
        },
        "long": {
          "dd": {
            "degrees": -127.0185
          },
          "ddm": {
            "degrees": -127,
            "minutes": 1.11
          },
          "dms": {
            "degrees": -127,
            "minutes": 1,
            "seconds": 6.6
          }
        }
      },
      "mid_geo_point": {
        "lat": {
          "dd": {
            "degrees": 51.020167
          },
          "ddm": {
            "degrees": 51,
            "minutes": 1.21
          },
          "dms": {
            "degrees": 51,
            "minutes": 1,
            "seconds": 12.6
          }
        },
        "long": {
          "dd": {
            "degrees": -128.020167
          },
          "ddm": {
            "degrees": -128,
            "minutes": 1.21
          },
          "dms": {
            "degrees": -128,
            "minutes": 1,
            "seconds": 12.6
          }
        }
      },
      "end_geo_point": {
        "lat": {
          "dd": {
            "degrees": 52.021833
          },
          "ddm": {
            "degrees": 52,
            "minutes": 1.31
          },
          "dms": {
            "degrees": 52,
            "minutes": 1,
            "seconds": 18.6
          }
        },
        "long": {
          "dd": {
            "degrees": -129.021833
          },
          "ddm": {
            "degrees": -129,
            "minutes": 1.31
          },
          "dms": {
            "degrees": -129,
            "minutes": 1,
            "seconds": 18.6
          }
        }
      },
      "comments": "2 cm gear mesh pots also used.",
      "metadata": {
      },
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Majorie Blick",
      "updated_date_time": "2020-06-22T19:38:18Z",
      "updated_by_name": "Majorie Blick",
      "submitted_date_time": null,
      "validated_date_time": null,
      "validated_by_name": null,
      "validation_comments": null,
      "catch": [
        {
          "id": "6f7a8d2f-fc75-4c85-9ebb-6101f6ca1a71",
          "fishery_species_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
          "area_id": null,
          "catch_category_id": "17fbd563-f38b-4207-bcf6-9e40bdee98f3",
          "retained_weight": 11.2,
          "released_weight": null,
          "retained_pieces": 8,
          "released_pieces": null,
          "comments": null,
          "metadata": {
            "integration_id": 932
          }
        },
        {
          "id": "53aaa2b8-5402-4a25-bffd-b876d61ae200",
          "fishery_species_id": "e0b25980-718a-4022-9adc-b2f9bb7788ec",
          "area_id": null,
          "catch_category_id": "966d4c00-6aad-446a-873c-f3d39a7cca56",
          "retained_weight": null,
          "released_weight": 14.0,
          "retained_pieces": 332,
          "released_pieces": null,
          "comments": null,
          "metadata": {
          }
        }
      ]
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single Monitor Set

Endpoint

GET /api/v1/monitor-sets/:id

Request

Route

GET /api/v1/monitor-sets/80fb4c94-60e8-4f89-bc2f-692ef5139377

Headers

Authorization: Bearer b7578a2459f4dd585ca38e1bb6ab9656575b826c
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/monitor-sets/80fb4c94-60e8-4f89-bc2f-692ef5139377" -X GET \
	-H "Authorization: Bearer b7578a2459f4dd585ca38e1bb6ab9656575b826c"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
soak_time Soak time Decimal
set_number Set number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Mesh size of gear (cm) Decimal
gear_length Length of gear (m) Decimal
gear_count Count of gear (panels, pots, etc) Integer
target_species_priority_1_id ID of priority 1 target species UUID
target_species_priority_2_id ID of priority 2 target species UUID
target_species_priority_3_id ID of priority 3 target species UUID
depth_target Target gear depth (m) Integer
depth_min Minimum gear depth (m) Integer
depth_max Maximum gear depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
submitted_date_time Submitted date/time ISO8601 date/time
validated_date_time Validated date/time ISO8601 date/time
validated_by_name Name of validating user String
validation_comments Validation comments String
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: e0b16739-4b99-4dc9-af68-ac2e474ada09

Body

{
  "data": {
    "id": "80fb4c94-60e8-4f89-bc2f-692ef5139377",
    "html_url": "/management/fisheries/ed5131017bb5/monitor-sets/2f9a0913fe18",
    "fishery_id": "404fa955-5165-4b93-9286-e70b09bc9991",
    "fishery_period_id": "8964372f-675f-4c45-ba4f-fa5166d06eda",
    "trip_id": "84e70156-cc61-435e-9163-b2342a8da55f",
    "hail_id": null,
    "started_date_time": "2020-04-09T18:41:18Z",
    "ended_date_time": "2020-04-09T20:41:18Z",
    "soak_time": 171.68,
    "set_number": 1,
    "fisherman_id": "df173193-0546-47b3-8064-3c0b9f8b148e",
    "monitor_id": "db4b1a70-25a9-420a-97c3-e50c705bcec6",
    "vessel_id": "f19e518d-59cb-4920-a65d-c8c92361027d",
    "area_id": "66e53c29-579c-44dc-8ead-cbb678912d1b",
    "fishery_gear_id": "4802a692-fb58-45b9-825d-08dc0d60ed7e",
    "gear_mesh_size": 10.0,
    "gear_length": 70.5,
    "gear_count": 60,
    "target_species_priority_1_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
    "target_species_priority_2_id": null,
    "target_species_priority_3_id": null,
    "depth_target": 12,
    "depth_min": 10,
    "depth_max": 15,
    "start_geo_point": {
      "lat": {
        "dd": {
          "degrees": 49.686453
        },
        "ddm": {
          "degrees": 49,
          "minutes": 41.1872
        },
        "dms": {
          "degrees": 49,
          "minutes": 41,
          "seconds": 11.2308
        }
      },
      "long": {
        "dd": {
          "degrees": -124.280624
        },
        "ddm": {
          "degrees": -124,
          "minutes": 16.8374
        },
        "dms": {
          "degrees": -124,
          "minutes": 16,
          "seconds": 50.2464
        }
      }
    },
    "mid_geo_point": {
      "lat": {
        "dd": {
          "degrees": 49.498926
        },
        "ddm": {
          "degrees": 49,
          "minutes": 29.9356
        },
        "dms": {
          "degrees": 49,
          "minutes": 29,
          "seconds": 56.1336
        }
      },
      "long": {
        "dd": {
          "degrees": -124.041773
        },
        "ddm": {
          "degrees": -124,
          "minutes": 2.5064
        },
        "dms": {
          "degrees": -124,
          "minutes": 2,
          "seconds": 30.3828
        }
      }
    },
    "end_geo_point": {
      "lat": {
        "dd": {
          "degrees": 49.45798
        },
        "ddm": {
          "degrees": 49,
          "minutes": 27.4788
        },
        "dms": {
          "degrees": 49,
          "minutes": 27,
          "seconds": 28.728
        }
      },
      "long": {
        "dd": {
          "degrees": -123.978817
        },
        "ddm": {
          "degrees": -123,
          "minutes": 58.729
        },
        "dms": {
          "degrees": -123,
          "minutes": 58,
          "seconds": 43.7412
        }
      }
    },
    "comments": "",
    "metadata": {
      "color": "grey"
    },
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Majorie Blick",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Majorie Blick",
    "submitted_date_time": null,
    "validated_date_time": null,
    "validated_by_name": null,
    "validation_comments": null,
    "catch": [
      {
        "id": "e50c9802-95ac-4547-bdf4-e9591386883f",
        "fishery_species_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
        "area_id": null,
        "catch_category_id": "17fbd563-f38b-4207-bcf6-9e40bdee98f3",
        "retained_weight": 360.0,
        "released_weight": 18.3,
        "retained_pieces": 2352,
        "released_pieces": 241,
        "comments": "Released catch too small for market.",
        "metadata": {
          "integration_id": 4890
        }
      },
      {
        "id": "0c9929d5-a3c1-4f56-9c08-d5b66683297f",
        "fishery_species_id": "e0b25980-718a-4022-9adc-b2f9bb7788ec",
        "area_id": null,
        "catch_category_id": "966d4c00-6aad-446a-873c-f3d39a7cca56",
        "retained_weight": 81.5,
        "released_weight": null,
        "retained_pieces": 7,
        "released_pieces": null,
        "comments": "",
        "metadata": {
        }
      }
    ]
  }
}

Update an existing Monitor Set

Endpoint

PUT /api/v1/monitor-sets/:id

Parameters

Name Description Type
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
soak_time Soak time Decimal
set_number Set number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Gear mesh size (cm) Integer
gear_length Length of an individual panel, pot, etc (m) Decimal
gear_count Count of panels, pots, etc Integer
depth_min Minimum depth (m) Integer
depth_max Maximum depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), or Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Request

Route

PUT /api/v1/monitor-sets/15ddf33f-1eda-484f-8cd4-11042e66795f

Headers

Authorization: Bearer b7578a2459f4dd585ca38e1bb6ab9656575b826c
Content-Type: application/json

Body

{
  "trip_id": "84e70156-cc61-435e-9163-b2342a8da55f",
  "hail_id": "d9ad9e49-5bcc-4392-ace7-56faeafb864c",
  "started_date_time": "2018-08-03T11:12Z",
  "ended_date_time": "2018-08-03T18:01Z",
  "soak_time": 3,
  "set_number": 12,
  "fisherman_id": "f91cc267-1710-49d3-a120-cbbe15f1546b",
  "monitor_id": "81ae9c5d-b875-4d5d-bc5b-08c916a02b21",
  "vessel_id": "d1dbfc36-56f2-4cbd-aa66-60633d087dc8",
  "area_id": "31be2389-7723-42ba-9aa4-120a6602fdef",
  "gear_id": "de73955c-04b3-4bcc-8b12-e77d3ecc008d",
  "gear_mesh_size": 2,
  "gear_length": 5.75,
  "gear_count": 40,
  "target_species_priority_1_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
  "target_species_priority_2_id": "e0b25980-718a-4022-9adc-b2f9bb7788ec",
  "target_species_priority_3_id": null,
  "depth_target": 7,
  "depth_min": 6,
  "depth_max": 7,
  "start_geo_point": {
    "lat": {
      "ddm": {
        "degrees": 50,
        "minutes": 1.11
      }
    },
    "long": {
      "ddm": {
        "degrees": -127,
        "minutes": 1.11
      }
    }
  },
  "mid_geo_point": {
    "lat": {
      "ddm": {
        "degrees": 51,
        "minutes": 1.21
      }
    },
    "long": {
      "ddm": {
        "degrees": -128,
        "minutes": 1.21
      }
    }
  },
  "end_geo_point": {
    "lat": {
      "ddm": {
        "degrees": 52,
        "minutes": 1.31
      }
    },
    "long": {
      "ddm": {
        "degrees": -129,
        "minutes": 1.31
      }
    }
  },
  "comments": "2 cm gear mesh pots also used.",
  "catch": [
    {
      "id": "6f7a8d2f-fc75-4c85-9ebb-6101f6ca1a71",
      "fishery_species_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
      "catch_category_id": "17fbd563-f38b-4207-bcf6-9e40bdee98f3",
      "retained_weight": 11.2,
      "released_weight": null,
      "retained_pieces": 3,
      "released_pieces": "Unknown fish species."
    },
    {
      "id": "53aaa2b8-5402-4a25-bffd-b876d61ae200",
      "fishery_species_id": "e0b25980-718a-4022-9adc-b2f9bb7788ec",
      "catch_category_id": "966d4c00-6aad-446a-873c-f3d39a7cca56",
      "retained_weight": null,
      "released_weight": 14,
      "retained_pieces": null,
      "released_pieces": 7,
      "comments": null
    }
  ]
}

cURL

curl "https://fisheriesapp.com/api/v1/monitor-sets/15ddf33f-1eda-484f-8cd4-11042e66795f" -d '{"trip_id":"84e70156-cc61-435e-9163-b2342a8da55f","hail_id":"d9ad9e49-5bcc-4392-ace7-56faeafb864c","started_date_time":"2018-08-03T11:12Z","ended_date_time":"2018-08-03T18:01Z","soak_time":3,"set_number":12,"fisherman_id":"f91cc267-1710-49d3-a120-cbbe15f1546b","monitor_id":"81ae9c5d-b875-4d5d-bc5b-08c916a02b21","vessel_id":"d1dbfc36-56f2-4cbd-aa66-60633d087dc8","area_id":"31be2389-7723-42ba-9aa4-120a6602fdef","gear_id":"de73955c-04b3-4bcc-8b12-e77d3ecc008d","gear_mesh_size":2,"gear_length":5.75,"gear_count":40,"target_species_priority_1_id":"c613f627-1af9-49b9-82fe-5d715aea50f1","target_species_priority_2_id":"e0b25980-718a-4022-9adc-b2f9bb7788ec","target_species_priority_3_id":null,"depth_target":7,"depth_min":6,"depth_max":7,"start_geo_point":{"lat":{"ddm":{"degrees":50,"minutes":1.11}},"long":{"ddm":{"degrees":-127,"minutes":1.11}}},"mid_geo_point":{"lat":{"ddm":{"degrees":51,"minutes":1.21}},"long":{"ddm":{"degrees":-128,"minutes":1.21}}},"end_geo_point":{"lat":{"ddm":{"degrees":52,"minutes":1.31}},"long":{"ddm":{"degrees":-129,"minutes":1.31}}},"comments":"2 cm gear mesh pots also used.","catch":[{"id":"6f7a8d2f-fc75-4c85-9ebb-6101f6ca1a71","fishery_species_id":"c613f627-1af9-49b9-82fe-5d715aea50f1","catch_category_id":"17fbd563-f38b-4207-bcf6-9e40bdee98f3","retained_weight":11.2,"released_weight":null,"retained_pieces":3,"released_pieces":"Unknown fish species."},{"id":"53aaa2b8-5402-4a25-bffd-b876d61ae200","fishery_species_id":"e0b25980-718a-4022-9adc-b2f9bb7788ec","catch_category_id":"966d4c00-6aad-446a-873c-f3d39a7cca56","retained_weight":null,"released_weight":14,"retained_pieces":null,"released_pieces":7,"comments":null}]}' -X PUT \
	-H "Authorization: Bearer b7578a2459f4dd585ca38e1bb6ab9656575b826c"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of period UUID
trip_id ID of trip UUID
hail_id ID of hail UUID
started_date_time Start date/time ISO8601 date/time
ended_date_time End date/time ISO8601 date/time
soak_time Soak time Decimal
set_number Set number Integer
fisherman_id ID of fisherman UUID
monitor_id ID of monitor UUID
vessel_id ID of vessel UUID
area_id ID of area UUID
fishery_gear_id ID of gear UUID
gear_mesh_size Mesh size of gear (cm) Decimal
gear_length Length of gear (m) Decimal
gear_count Count of gear (panels, pots, etc) Integer
target_species_priority_1_id ID of priority 1 target species UUID
target_species_priority_2_id ID of priority 2 target species UUID
target_species_priority_3_id ID of priority 3 target species UUID
depth_target Target gear depth (m) Integer
depth_min Minimum gear depth (m) Integer
depth_max Maximum gear depth (m) Integer
start_geo_point Start lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
mid_geo_point Mid lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
end_geo_point End lat/long key/value pairs in Degrees (dd), Degrees Decimal Minutes (ddm), and Degrees Minutes Seconds (dms) Hash
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
submitted_date_time Submitted date/time ISO8601 date/time
validated_date_time Validated date/time ISO8601 date/time
validated_by_name Name of validating user String
validation_comments Validation comments String
catch Catch details Array
- id ID UUID
- fishery_species_id ID of species UUID
- area_id ID of area UUID
- catch_category_id ID of catch category UUID
- retained_weight Retained weight Decimal
- released_weight Released weight Decimal
- retained_pieces Retained pieces Integer
- released_pieces Released pieces Integer
- comments Comments Text
- metadata Metadata JSON

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: d18c2f59-a067-4815-b3f2-0c6d3aebdd14

Body

{
  "data": {
    "id": "15ddf33f-1eda-484f-8cd4-11042e66795f",
    "html_url": "/management/fisheries/ed5131017bb5/monitor-sets/b4ea8207e8cc",
    "fishery_id": "404fa955-5165-4b93-9286-e70b09bc9991",
    "fishery_period_id": "8964372f-675f-4c45-ba4f-fa5166d06eda",
    "trip_id": "84e70156-cc61-435e-9163-b2342a8da55f",
    "hail_id": "d9ad9e49-5bcc-4392-ace7-56faeafb864c",
    "started_date_time": "2018-08-03T11:12:00Z",
    "ended_date_time": "2018-08-03T18:01:00Z",
    "soak_time": 3.0,
    "set_number": 12,
    "fisherman_id": "f91cc267-1710-49d3-a120-cbbe15f1546b",
    "monitor_id": "81ae9c5d-b875-4d5d-bc5b-08c916a02b21",
    "vessel_id": "d1dbfc36-56f2-4cbd-aa66-60633d087dc8",
    "area_id": "31be2389-7723-42ba-9aa4-120a6602fdef",
    "fishery_gear_id": "de73955c-04b3-4bcc-8b12-e77d3ecc008d",
    "gear_mesh_size": 2.0,
    "gear_length": 5.75,
    "gear_count": 40,
    "target_species_priority_1_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
    "target_species_priority_2_id": "e0b25980-718a-4022-9adc-b2f9bb7788ec",
    "target_species_priority_3_id": null,
    "depth_target": 7,
    "depth_min": 6,
    "depth_max": 7,
    "start_geo_point": {
      "lat": {
        "dd": {
          "degrees": 50.0185
        },
        "ddm": {
          "degrees": 50,
          "minutes": 1.11
        },
        "dms": {
          "degrees": 50,
          "minutes": 1,
          "seconds": 6.6
        }
      },
      "long": {
        "dd": {
          "degrees": -127.0185
        },
        "ddm": {
          "degrees": -127,
          "minutes": 1.11
        },
        "dms": {
          "degrees": -127,
          "minutes": 1,
          "seconds": 6.6
        }
      }
    },
    "mid_geo_point": {
      "lat": {
        "dd": {
          "degrees": 51.020167
        },
        "ddm": {
          "degrees": 51,
          "minutes": 1.21
        },
        "dms": {
          "degrees": 51,
          "minutes": 1,
          "seconds": 12.6
        }
      },
      "long": {
        "dd": {
          "degrees": -128.020167
        },
        "ddm": {
          "degrees": -128,
          "minutes": 1.21
        },
        "dms": {
          "degrees": -128,
          "minutes": 1,
          "seconds": 12.6
        }
      }
    },
    "end_geo_point": {
      "lat": {
        "dd": {
          "degrees": 52.021833
        },
        "ddm": {
          "degrees": 52,
          "minutes": 1.31
        },
        "dms": {
          "degrees": 52,
          "minutes": 1,
          "seconds": 18.6
        }
      },
      "long": {
        "dd": {
          "degrees": -129.021833
        },
        "ddm": {
          "degrees": -129,
          "minutes": 1.31
        },
        "dms": {
          "degrees": -129,
          "minutes": 1,
          "seconds": 18.6
        }
      }
    },
    "comments": "2 cm gear mesh pots also used.",
    "metadata": {
    },
    "created_date_time": "2018-08-01T00:00:00Z",
    "created_by_name": "Majorie Blick",
    "updated_date_time": "2020-06-22T19:38:18Z",
    "updated_by_name": "Majorie Blick",
    "submitted_date_time": null,
    "validated_date_time": null,
    "validated_by_name": null,
    "validation_comments": null,
    "catch": [
      {
        "id": "6f7a8d2f-fc75-4c85-9ebb-6101f6ca1a71",
        "fishery_species_id": "c613f627-1af9-49b9-82fe-5d715aea50f1",
        "area_id": null,
        "catch_category_id": "17fbd563-f38b-4207-bcf6-9e40bdee98f3",
        "retained_weight": 11.2,
        "released_weight": null,
        "retained_pieces": 8,
        "released_pieces": null,
        "comments": null,
        "metadata": {
          "integration_id": 932
        }
      },
      {
        "id": "53aaa2b8-5402-4a25-bffd-b876d61ae200",
        "fishery_species_id": "e0b25980-718a-4022-9adc-b2f9bb7788ec",
        "area_id": null,
        "catch_category_id": "966d4c00-6aad-446a-873c-f3d39a7cca56",
        "retained_weight": null,
        "released_weight": 14.0,
        "retained_pieces": 332,
        "released_pieces": null,
        "comments": null,
        "metadata": {
        }
      }
    ]
  }
}

Monitors

Create a new Monitor

Endpoint

POST /api/v1/monitors

Parameters

Name Description Type
first_name First name String
last_name Last name String
code Code String
active Status Boolean
comments Comments String
metadata Metadata JSON

Request

Route

POST /api/v1/monitors

Headers

Authorization: Bearer aeb1f8710f24c49842cc34e0e872e78b94cc5630
Content-Type: application/json

Body

{
  "first_name": "Jason",
  "last_name": "Greene",
  "code": "JG101",
  "active": true,
  "comments": "New on vessel observer"
}

cURL

curl "https://fisheriesapp.com/api/v1/monitors" -d '{"first_name":"Jason","last_name":"Greene","code":"JG101","active":true,"comments":"New on vessel observer"}' -X POST \
	-H "Authorization: Bearer aeb1f8710f24c49842cc34e0e872e78b94cc5630"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
first_name First name String
last_name Last name String
code Code String
active Status Boolean
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 5fa4e357-0ce1-49a3-aa01-3048c52d8108

Body

{
  "data": {
    "id": "686471da-e4a4-4e46-ba80-cb678f7ab706",
    "html_url": "/management/account/monitors/ed325154aa6a",
    "first_name": "Jason",
    "last_name": "Greene",
    "code": "JG101",
    "active": true,
    "comments": "New on vessel observer",
    "metadata": {
    },
    "created_date_time": "2020-06-22T19:38:25Z",
    "created_by_name": "Daryl Flatley",
    "updated_date_time": "2020-06-22T19:38:25Z",
    "updated_by_name": "Daryl Flatley"
  }
}

Delete an existing Monitor

Endpoint

DELETE /api/v1/monitors/:id

Request

Route

DELETE /api/v1/monitors/d0dddaf0-9402-4c47-af44-4c10fc802652

Headers

Authorization: Bearer aeb1f8710f24c49842cc34e0e872e78b94cc5630
Content-Type: application/json

cURL

curl "https://fisheriesapp.com/api/v1/monitors/d0dddaf0-9402-4c47-af44-4c10fc802652" -d '' -X DELETE \
	-H "Authorization: Bearer aeb1f8710f24c49842cc34e0e872e78b94cc5630"

Response

Simulated Response

Status

204

Headers

X-Request-Id: eb545ca9-fb4a-4f9f-a3b2-0da1ea85ce18

Return a list of Monitors

Endpoint

GET /api/v1/monitors

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/monitors

Headers

Authorization: Bearer aeb1f8710f24c49842cc34e0e872e78b94cc5630
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/monitors" -X GET \
	-H "Authorization: Bearer aeb1f8710f24c49842cc34e0e872e78b94cc5630"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
first_name First name String
last_name Last name String
code Code String
active Status Boolean
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 68a58934-5a0f-4cf2-9843-fb5fa8f4bd51

Body

{
  "data": [
    {
      "id": "34c74877-43df-4f95-8641-40271a8f6419",
      "html_url": "/management/account/monitors/2ea5ee8dc4bc",
      "first_name": "James",
      "last_name": "John",
      "code": "1213",
      "active": true,
      "comments": "Pariatur eos doloremque odit.",
      "metadata": {
        "color": "dark blue"
      },
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Daryl Flatley",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Daryl Flatley"
    },
    {
      "id": "a80cc59e-d34f-4ce8-9ddb-802577aa910a",
      "html_url": "/management/account/monitors/ab57fb75ed13",
      "first_name": "Colby",
      "last_name": "Cranston",
      "code": "1928",
      "active": true,
      "comments": "Hic sunt veritatis repudiandae.",
      "metadata": {
      },
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Daryl Flatley",
      "updated_date_time": "2018-08-02T00:00:00Z",
      "updated_by_name": "Daryl Flatley"
    },
    {
      "id": "d0dddaf0-9402-4c47-af44-4c10fc802652",
      "html_url": "/management/account/monitors/a59136fec48d",
      "first_name": "Greg",
      "last_name": "Conner",
      "code": "1827",
      "active": true,
      "comments": "Ut ipsa accusantium natus.",
      "metadata": {
      },
      "created_date_time": "2018-07-01T00:00:00Z",
      "created_by_name": "Daryl Flatley",
      "updated_date_time": "2018-07-02T00:00:00Z",
      "updated_by_name": "Daryl Flatley"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single Monitor

Endpoint

GET /api/v1/monitors/:id

Request

Route

GET /api/v1/monitors/34c74877-43df-4f95-8641-40271a8f6419

Headers

Authorization: Bearer aeb1f8710f24c49842cc34e0e872e78b94cc5630
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/monitors/34c74877-43df-4f95-8641-40271a8f6419" -X GET \
	-H "Authorization: Bearer aeb1f8710f24c49842cc34e0e872e78b94cc5630"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
first_name First name String
last_name Last name String
code Code String
active Status Boolean
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 45cda6d3-ed4c-4656-b386-3064ec34c2cf

Body

{
  "data": {
    "id": "34c74877-43df-4f95-8641-40271a8f6419",
    "html_url": "/management/account/monitors/2ea5ee8dc4bc",
    "first_name": "James",
    "last_name": "John",
    "code": "1213",
    "active": true,
    "comments": "Pariatur eos doloremque odit.",
    "metadata": {
      "color": "dark blue"
    },
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Daryl Flatley",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Daryl Flatley"
  }
}

Update an existing Monitor

Endpoint

PUT /api/v1/monitors/:id

Parameters

Name Description Type
first_name First name String
last_name Last name String
code Code String
active Status Boolean
comments Comments String
metadata Metadata JSON

Request

Route

PUT /api/v1/monitors/a80cc59e-d34f-4ce8-9ddb-802577aa910a

Headers

Authorization: Bearer aeb1f8710f24c49842cc34e0e872e78b94cc5630
Content-Type: application/json

Body

{
  "name": "Jerry",
  "code": "Jones",
  "active": true,
  "comments": "On river monitoring specialist"
}

cURL

curl "https://fisheriesapp.com/api/v1/monitors/a80cc59e-d34f-4ce8-9ddb-802577aa910a" -d '{"name":"Jerry","code":"Jones","active":true,"comments":"On river monitoring specialist"}' -X PUT \
	-H "Authorization: Bearer aeb1f8710f24c49842cc34e0e872e78b94cc5630"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
first_name First name String
last_name Last name String
code Code String
active Status Boolean
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 3288aec8-6ed5-4db8-a213-a535c24f652d

Body

{
  "data": {
    "id": "a80cc59e-d34f-4ce8-9ddb-802577aa910a",
    "html_url": "/management/account/monitors/ab57fb75ed13",
    "first_name": "Colby",
    "last_name": "Cranston",
    "code": "Jones",
    "active": true,
    "comments": "On river monitoring specialist",
    "metadata": {
    },
    "created_date_time": "2018-08-01T00:00:00Z",
    "created_by_name": "Daryl Flatley",
    "updated_date_time": "2020-06-22T19:38:25Z",
    "updated_by_name": "Daryl Flatley"
  }
}

Organizations

Create a new Organization

Endpoint

POST /api/v1/organizations

Parameters

Name Description Type
name Name String
code Code String
first_receiver First receiver Boolean
buyer_processor Buyer/processor Boolean
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON

Request

Route

POST /api/v1/organizations

Headers

Authorization: Bearer e2d8e112ce38ab9ea3d41be14f0c8bc0f78c5ac3
Content-Type: application/json

Body

{
  "name": "Finfish, Inc",
  "code": "FF01",
  "first_receiver": false,
  "buyer_processor": true,
  "active": true,
  "address_line_1": "1726 Wayfinder St",
  "address_line_2": null,
  "city": "Vancouver",
  "province_state": "BC",
  "country": "CAN",
  "postal_zip_code": "V6J2K1",
  "latitude": 54.128172,
  "longitude": -125.221292,
  "primary_contact": "John Smith",
  "phone": "555-555-5555 x122",
  "mobile": "555-555-5556",
  "fax": "555-555-5557",
  "alternate_email": "john@vericatch.com",
  "website": "http://vericatch.com",
  "comments": "Added as new organization",
  "metadata": {
    "orders_shipped_2014": 123
  }
}

cURL

curl "https://fisheriesapp.com/api/v1/organizations" -d '{"name":"Finfish, Inc","code":"FF01","first_receiver":false,"buyer_processor":true,"active":true,"address_line_1":"1726 Wayfinder St","address_line_2":null,"city":"Vancouver","province_state":"BC","country":"CAN","postal_zip_code":"V6J2K1","latitude":54.128172,"longitude":-125.221292,"primary_contact":"John Smith","phone":"555-555-5555 x122","mobile":"555-555-5556","fax":"555-555-5557","alternate_email":"john@vericatch.com","website":"http://vericatch.com","comments":"Added as new organization","metadata":{"orders_shipped_2014":123}}' -X POST \
	-H "Authorization: Bearer e2d8e112ce38ab9ea3d41be14f0c8bc0f78c5ac3"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
code Code String
first_receiver First receiver Boolean
buyer_processor Buyer/processor Boolean
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 97d59002-ba19-43e0-af75-e04a66886749

Body

{
  "data": {
    "id": "6de2fffc-f860-441b-83a6-36898720fd98",
    "html_url": "/management/account/organizations/7983e1cb6d81",
    "name": "Finfish, Inc",
    "code": "FF01",
    "first_receiver": false,
    "buyer_processor": true,
    "active": true,
    "address_line_1": "1726 Wayfinder St",
    "address_line_2": null,
    "city": "Vancouver",
    "province_state": "BC",
    "country": "CAN",
    "postal_zip_code": "V6J2K1",
    "latitude": 54.128172,
    "longitude": -125.221292,
    "primary_contact": "John Smith",
    "phone": "555-555-5555 x122",
    "mobile": "555-555-5556",
    "fax": "555-555-5557",
    "alternate_email": "john@vericatch.com",
    "website": "http://vericatch.com",
    "comments": "Added as new organization",
    "metadata": {
      "orders_shipped_2014": 123
    },
    "created_date_time": "2020-06-22T19:38:24Z",
    "created_by_name": "Tianna Bosco",
    "updated_date_time": "2020-06-22T19:38:24Z",
    "updated_by_name": "Tianna Bosco"
  }
}

Delete an existing Organization

Endpoint

DELETE /api/v1/organizations/:id

Request

Route

DELETE /api/v1/organizations/cd848539-9b61-4587-ad5f-ea242957a62c

Headers

Authorization: Bearer e2d8e112ce38ab9ea3d41be14f0c8bc0f78c5ac3
Content-Type: application/json

cURL

curl "https://fisheriesapp.com/api/v1/organizations/cd848539-9b61-4587-ad5f-ea242957a62c" -d '' -X DELETE \
	-H "Authorization: Bearer e2d8e112ce38ab9ea3d41be14f0c8bc0f78c5ac3"

Response

Simulated Response

Status

204

Headers

X-Request-Id: 0762e437-67d7-45e5-8f4f-45b69a86b7a2

Return a list of Organizations

Endpoint

GET /api/v1/organizations

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/organizations

Headers

Authorization: Bearer e2d8e112ce38ab9ea3d41be14f0c8bc0f78c5ac3
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/organizations" -X GET \
	-H "Authorization: Bearer e2d8e112ce38ab9ea3d41be14f0c8bc0f78c5ac3"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
code Code String
first_receiver First receiver Boolean
buyer_processor Buyer/processor Boolean
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: db821fae-c399-41b1-9ec9-d78e6956c180

Body

{
  "data": [
    {
      "id": "6de2fffc-f860-441b-83a6-36898720fd98",
      "html_url": "/management/account/organizations/7983e1cb6d81",
      "name": "Finfish, Inc",
      "code": "FF01",
      "first_receiver": false,
      "buyer_processor": true,
      "active": true,
      "address_line_1": "1726 Wayfinder St",
      "address_line_2": null,
      "city": "Vancouver",
      "province_state": "BC",
      "country": "CAN",
      "postal_zip_code": "V6J2K1",
      "latitude": 54.128172,
      "longitude": -125.221292,
      "primary_contact": "John Smith",
      "phone": "555-555-5555 x122",
      "mobile": "555-555-5556",
      "fax": "555-555-5557",
      "alternate_email": "john@vericatch.com",
      "website": "http://vericatch.com",
      "comments": "Added as new organization",
      "metadata": {
        "orders_shipped_2014": 123
      },
      "created_date_time": "2020-06-22T19:38:24Z",
      "created_by_name": "Tianna Bosco",
      "updated_date_time": "2020-06-22T19:38:24Z",
      "updated_by_name": "Tianna Bosco"
    },
    {
      "id": "2f41c1bc-f5ff-4ba6-9e2d-0920fa77903e",
      "html_url": "/management/account/organizations/1212254a4963",
      "name": "Fish Trading Company",
      "code": "002",
      "first_receiver": true,
      "buyer_processor": false,
      "active": true,
      "address_line_1": null,
      "address_line_2": null,
      "city": null,
      "province_state": null,
      "country": null,
      "postal_zip_code": null,
      "latitude": null,
      "longitude": null,
      "primary_contact": null,
      "phone": null,
      "mobile": null,
      "fax": null,
      "alternate_email": null,
      "website": null,
      "comments": "Quis voluptatem architecto incidunt.",
      "metadata": {
        "color": "grey"
      },
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Tianna Bosco",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Tianna Bosco"
    },
    {
      "id": "16c842ad-ee2a-4ce9-9b01-35fdedb85d2b",
      "html_url": "/management/account/organizations/3ec112dd1cf0",
      "name": "Seahorse Shipping",
      "code": "SS0192",
      "first_receiver": false,
      "buyer_processor": false,
      "active": true,
      "address_line_1": "1827 Pathfinder Ave",
      "address_line_2": null,
      "city": "Vancouver",
      "province_state": "BC",
      "country": "CAN",
      "postal_zip_code": "V6L3J2",
      "latitude": 55.216172,
      "longitude": -126.211522,
      "primary_contact": "John Smith",
      "phone": "555-555-5555 x122",
      "mobile": "555-555-5556",
      "fax": "555-555-5557",
      "alternate_email": "john@vericatch.com",
      "website": "http://vericatch.com",
      "comments": "Added as new organization",
      "metadata": {
        "orders_shipped_2015": 311
      },
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Tianna Bosco",
      "updated_date_time": "2020-06-22T19:38:24Z",
      "updated_by_name": "Tianna Bosco"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single Organization

Endpoint

GET /api/v1/organizations/:id

Request

Route

GET /api/v1/organizations/2f41c1bc-f5ff-4ba6-9e2d-0920fa77903e

Headers

Authorization: Bearer e2d8e112ce38ab9ea3d41be14f0c8bc0f78c5ac3
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/organizations/2f41c1bc-f5ff-4ba6-9e2d-0920fa77903e" -X GET \
	-H "Authorization: Bearer e2d8e112ce38ab9ea3d41be14f0c8bc0f78c5ac3"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
code Code String
first_receiver First receiver Boolean
buyer_processor Buyer/processor Boolean
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 3e1de605-92de-4074-9bcb-0debed05d103

Body

{
  "data": {
    "id": "2f41c1bc-f5ff-4ba6-9e2d-0920fa77903e",
    "html_url": "/management/account/organizations/1212254a4963",
    "name": "Fish Trading Company",
    "code": "002",
    "first_receiver": true,
    "buyer_processor": false,
    "active": true,
    "address_line_1": null,
    "address_line_2": null,
    "city": null,
    "province_state": null,
    "country": null,
    "postal_zip_code": null,
    "latitude": null,
    "longitude": null,
    "primary_contact": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "alternate_email": null,
    "website": null,
    "comments": "Quis voluptatem architecto incidunt.",
    "metadata": {
      "color": "grey"
    },
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Tianna Bosco",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Tianna Bosco"
  }
}

Update an existing Organization

Endpoint

PUT /api/v1/organizations/:id

Parameters

Name Description Type
name Name String
code Code String
first_receiver First receiver Boolean
buyer_processor Buyer/processor Boolean
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON

Request

Route

PUT /api/v1/organizations/16c842ad-ee2a-4ce9-9b01-35fdedb85d2b

Headers

Authorization: Bearer e2d8e112ce38ab9ea3d41be14f0c8bc0f78c5ac3
Content-Type: application/json

Body

{
  "name": "Seahorse Shipping",
  "code": "SS0192",
  "first_receiver": false,
  "buyer_processor": false,
  "active": true,
  "address_line_1": "1827 Pathfinder Ave",
  "address_line_2": null,
  "city": "Vancouver",
  "province_state": "BC",
  "country": "CAN",
  "postal_zip_code": "V6L3J2",
  "latitude": 55.216172,
  "longitude": -126.211522,
  "primary_contact": "John Smith",
  "phone": "555-555-5555 x122",
  "mobile": "555-555-5556",
  "fax": "555-555-5557",
  "alternate_email": "john@vericatch.com",
  "website": "http://vericatch.com",
  "comments": "Added as new organization",
  "metadata": {
    "orders_shipped_2015": 311
  }
}

cURL

curl "https://fisheriesapp.com/api/v1/organizations/16c842ad-ee2a-4ce9-9b01-35fdedb85d2b" -d '{"name":"Seahorse Shipping","code":"SS0192","first_receiver":false,"buyer_processor":false,"active":true,"address_line_1":"1827 Pathfinder Ave","address_line_2":null,"city":"Vancouver","province_state":"BC","country":"CAN","postal_zip_code":"V6L3J2","latitude":55.216172,"longitude":-126.211522,"primary_contact":"John Smith","phone":"555-555-5555 x122","mobile":"555-555-5556","fax":"555-555-5557","alternate_email":"john@vericatch.com","website":"http://vericatch.com","comments":"Added as new organization","metadata":{"orders_shipped_2015":311}}' -X PUT \
	-H "Authorization: Bearer e2d8e112ce38ab9ea3d41be14f0c8bc0f78c5ac3"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
code Code String
first_receiver First receiver Boolean
buyer_processor Buyer/processor Boolean
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: aca9a3e3-4fae-45d5-a0e2-305c66918915

Body

{
  "data": {
    "id": "16c842ad-ee2a-4ce9-9b01-35fdedb85d2b",
    "html_url": "/management/account/organizations/3ec112dd1cf0",
    "name": "Seahorse Shipping",
    "code": "SS0192",
    "first_receiver": false,
    "buyer_processor": false,
    "active": true,
    "address_line_1": "1827 Pathfinder Ave",
    "address_line_2": null,
    "city": "Vancouver",
    "province_state": "BC",
    "country": "CAN",
    "postal_zip_code": "V6L3J2",
    "latitude": 55.216172,
    "longitude": -126.211522,
    "primary_contact": "John Smith",
    "phone": "555-555-5555 x122",
    "mobile": "555-555-5556",
    "fax": "555-555-5557",
    "alternate_email": "john@vericatch.com",
    "website": "http://vericatch.com",
    "comments": "Added as new organization",
    "metadata": {
      "orders_shipped_2015": 311
    },
    "created_date_time": "2018-08-01T00:00:00Z",
    "created_by_name": "Tianna Bosco",
    "updated_date_time": "2020-06-22T19:38:24Z",
    "updated_by_name": "Tianna Bosco"
  }
}

Periods

Return a list of fishery associated Periods

Endpoint

GET /api/v1/fishery-periods

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/fishery-periods

Headers

Authorization: Bearer 7473df3be211d4a31396df33ff0558edad61da42
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fishery-periods" -X GET \
	-H "Authorization: Bearer 7473df3be211d4a31396df33ff0558edad61da42"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
names Name String
started_date_time Name String
ended_date_time Name String
active Status Boolean
comments Comments String
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 6a2f4aa5-c6ac-4bba-b09d-7aa3da89c676

Body

{
  "data": [
    {
      "id": "2d667b4a-9909-4023-8df1-178d9bd1eea1",
      "fishery_id": "bb839db2-0663-4002-bb8f-178bd636749d",
      "name": "Fishery Period 3",
      "started_date_time": "2020-06-22T19:38:20Z",
      "ended_date_time": "2020-08-22T19:38:20Z",
      "active": true,
      "comments": "Aut nesciunt velit non.",
      "created_date_time": "2019-01-01T00:00:00Z",
      "created_by_name": "Keshia Cole",
      "updated_date_time": "2019-01-02T00:00:00Z",
      "updated_by_name": "Keshia Cole"
    },
    {
      "id": "6c808c10-97a3-47f5-a509-56e938827960",
      "fishery_id": "bb839db2-0663-4002-bb8f-178bd636749d",
      "name": "Fishery Period 4",
      "started_date_time": "2020-06-22T19:38:20Z",
      "ended_date_time": "2020-08-22T19:38:20Z",
      "active": false,
      "comments": "Doloribus aut id atque.",
      "created_date_time": "2018-01-01T00:00:00Z",
      "created_by_name": "Keshia Cole",
      "updated_date_time": "2018-01-02T00:00:00Z",
      "updated_by_name": "Keshia Cole"
    },
    {
      "id": "7931a563-176c-48ab-bd50-2b4931694a02",
      "fishery_id": "71d9cbf3-d0d2-40e7-bf07-7878cba60993",
      "name": "Fishery Period 5",
      "started_date_time": "2020-06-22T19:38:20Z",
      "ended_date_time": "2020-08-22T19:38:20Z",
      "active": true,
      "comments": "Architecto omnis error aspernatur.",
      "created_date_time": "2017-01-01T00:00:00Z",
      "created_by_name": "Keshia Cole",
      "updated_date_time": "2017-01-02T00:00:00Z",
      "updated_by_name": "Keshia Cole"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single fishery associated Period

Endpoint

GET /api/v1/fishery-periods/:id

Request

Route

GET /api/v1/fishery-periods/2d667b4a-9909-4023-8df1-178d9bd1eea1

Headers

Authorization: Bearer 7473df3be211d4a31396df33ff0558edad61da42
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fishery-periods/2d667b4a-9909-4023-8df1-178d9bd1eea1" -X GET \
	-H "Authorization: Bearer 7473df3be211d4a31396df33ff0558edad61da42"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
name Name String
started_date_time Name String
ended_date_time Name String
active Status Boolean
comments Comments String
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: b32cc318-6579-4561-b6b7-e90ec383cd01

Body

{
  "data": {
    "id": "2d667b4a-9909-4023-8df1-178d9bd1eea1",
    "fishery_id": "bb839db2-0663-4002-bb8f-178bd636749d",
    "name": "Fishery Period 3",
    "started_date_time": "2020-06-22T19:38:20Z",
    "ended_date_time": "2020-08-22T19:38:20Z",
    "active": true,
    "comments": "Aut nesciunt velit non.",
    "created_date_time": "2019-01-01T00:00:00Z",
    "created_by_name": "Keshia Cole",
    "updated_date_time": "2019-01-02T00:00:00Z",
    "updated_by_name": "Keshia Cole"
  }
}

Ports

Create a new Port

Endpoint

POST /api/v1/ports

Parameters

Name Description Type
name Name String
code Code String
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON

Request

Route

POST /api/v1/ports

Headers

Authorization: Bearer aaa30188ad9947b9b9975bfb13b5e9ec6e09ff34
Content-Type: application/json

Body

{
  "name": "Vancouver",
  "code": "V0019",
  "active": true,
  "address_line_1": "1726 Wayfinder St",
  "address_line_2": null,
  "city": "Vancouver",
  "province_state": "BC",
  "country": "CAN",
  "postal_zip_code": "V6J2K1",
  "latitude": 54.128172,
  "longitude": -125.221292,
  "primary_contact": "John Smith",
  "phone": "555-555-5555 x122",
  "mobile": "555-555-5556",
  "fax": "555-555-5557",
  "alternate_email": "john@vericatch.com",
  "website": "http://vericatch.com",
  "comments": "Port of Vancouver and area",
  "metadata": {
    "vessels_processed": 176
  }
}

cURL

curl "https://fisheriesapp.com/api/v1/ports" -d '{"name":"Vancouver","code":"V0019","active":true,"address_line_1":"1726 Wayfinder St","address_line_2":null,"city":"Vancouver","province_state":"BC","country":"CAN","postal_zip_code":"V6J2K1","latitude":54.128172,"longitude":-125.221292,"primary_contact":"John Smith","phone":"555-555-5555 x122","mobile":"555-555-5556","fax":"555-555-5557","alternate_email":"john@vericatch.com","website":"http://vericatch.com","comments":"Port of Vancouver and area","metadata":{"vessels_processed":176}}' -X POST \
	-H "Authorization: Bearer aaa30188ad9947b9b9975bfb13b5e9ec6e09ff34"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
code Code String
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: cbca84a1-9fcc-44b7-870b-60a46be72867

Body

{
  "data": {
    "id": "94242d90-f57b-4a4b-99d3-d33d13a86063",
    "html_url": "/management/account/ports/638b75afffb3",
    "name": "Vancouver",
    "code": "V0019",
    "active": true,
    "address_line_1": "1726 Wayfinder St",
    "address_line_2": null,
    "city": "Vancouver",
    "province_state": "BC",
    "country": "CAN",
    "postal_zip_code": "V6J2K1",
    "latitude": 54.128172,
    "longitude": -125.221292,
    "primary_contact": "John Smith",
    "phone": "555-555-5555 x122",
    "mobile": "555-555-5556",
    "fax": "555-555-5557",
    "alternate_email": "john@vericatch.com",
    "website": "http://vericatch.com",
    "comments": "Port of Vancouver and area",
    "metadata": {
      "vessels_processed": 176
    },
    "created_date_time": "2020-06-22T19:38:23Z",
    "created_by_name": "Tim Huel",
    "updated_date_time": "2020-06-22T19:38:23Z",
    "updated_by_name": "Tim Huel"
  }
}

Delete an existing Port

Endpoint

DELETE /api/v1/ports/:id

Request

Route

DELETE /api/v1/ports/a57575b6-bb7d-47ab-a104-7b68d78ee101

Headers

Authorization: Bearer aaa30188ad9947b9b9975bfb13b5e9ec6e09ff34
Content-Type: application/json

cURL

curl "https://fisheriesapp.com/api/v1/ports/a57575b6-bb7d-47ab-a104-7b68d78ee101" -d '' -X DELETE \
	-H "Authorization: Bearer aaa30188ad9947b9b9975bfb13b5e9ec6e09ff34"

Response

Simulated Response

Status

204

Headers

X-Request-Id: 5aeefd70-ccb1-48bc-b2de-58a511f2b7eb

Return a list of Ports

Endpoint

GET /api/v1/ports

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/ports

Headers

Authorization: Bearer aaa30188ad9947b9b9975bfb13b5e9ec6e09ff34
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/ports" -X GET \
	-H "Authorization: Bearer aaa30188ad9947b9b9975bfb13b5e9ec6e09ff34"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
code Code String
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: ec888d9d-0a30-48d1-8af1-432b6b0c98f5

Body

{
  "data": [
    {
      "id": "94242d90-f57b-4a4b-99d3-d33d13a86063",
      "html_url": "/management/account/ports/638b75afffb3",
      "name": "Vancouver",
      "code": "V0019",
      "active": true,
      "address_line_1": "1726 Wayfinder St",
      "address_line_2": null,
      "city": "Vancouver",
      "province_state": "BC",
      "country": "CAN",
      "postal_zip_code": "V6J2K1",
      "latitude": 54.128172,
      "longitude": -125.221292,
      "primary_contact": "John Smith",
      "phone": "555-555-5555 x122",
      "mobile": "555-555-5556",
      "fax": "555-555-5557",
      "alternate_email": "john@vericatch.com",
      "website": "http://vericatch.com",
      "comments": "Port of Vancouver and area",
      "metadata": {
        "vessels_processed": 176
      },
      "created_date_time": "2020-06-22T19:38:23Z",
      "created_by_name": "Tim Huel",
      "updated_date_time": "2020-06-22T19:38:23Z",
      "updated_by_name": "Tim Huel"
    },
    {
      "id": "dd25079e-1024-491a-a7a0-2a3b3312f642",
      "html_url": "/management/account/ports/d4cafcafb664",
      "name": "Bangko-Kendari",
      "code": "1003",
      "active": true,
      "address_line_1": null,
      "address_line_2": null,
      "city": null,
      "province_state": null,
      "country": null,
      "postal_zip_code": null,
      "latitude": null,
      "longitude": null,
      "primary_contact": null,
      "phone": null,
      "mobile": null,
      "fax": null,
      "alternate_email": null,
      "website": null,
      "comments": "Sit sed voluptate ipsum.",
      "metadata": {
        "color": "olive"
      },
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Tim Huel",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Tim Huel"
    },
    {
      "id": "d0da31cd-59a4-469e-b4cd-e463b55c699c",
      "html_url": "/management/account/ports/f09456aa0363",
      "name": "Port of Richmond",
      "code": "R128",
      "active": true,
      "address_line_1": "1827 Pathfinder Ave",
      "address_line_2": null,
      "city": "Vancouver",
      "province_state": "BC",
      "country": "CAN",
      "postal_zip_code": "V6L3J2",
      "latitude": 55.216172,
      "longitude": -126.211522,
      "primary_contact": "John Smith",
      "phone": "555-555-5555 x122",
      "mobile": "555-555-5556",
      "fax": "555-555-5557",
      "alternate_email": "john@vericatch.com",
      "website": "http://vericatch.com",
      "comments": "Port of Richmond/Steveston",
      "metadata": {
        "vessels_processed": 442
      },
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Tim Huel",
      "updated_date_time": "2020-06-22T19:38:23Z",
      "updated_by_name": "Tim Huel"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single Port

Endpoint

GET /api/v1/ports/:id

Request

Route

GET /api/v1/ports/dd25079e-1024-491a-a7a0-2a3b3312f642

Headers

Authorization: Bearer aaa30188ad9947b9b9975bfb13b5e9ec6e09ff34
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/ports/dd25079e-1024-491a-a7a0-2a3b3312f642" -X GET \
	-H "Authorization: Bearer aaa30188ad9947b9b9975bfb13b5e9ec6e09ff34"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
code Code String
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 01e69fa3-cd67-4e63-95fa-6f39915903db

Body

{
  "data": {
    "id": "dd25079e-1024-491a-a7a0-2a3b3312f642",
    "html_url": "/management/account/ports/d4cafcafb664",
    "name": "Bangko-Kendari",
    "code": "1003",
    "active": true,
    "address_line_1": null,
    "address_line_2": null,
    "city": null,
    "province_state": null,
    "country": null,
    "postal_zip_code": null,
    "latitude": null,
    "longitude": null,
    "primary_contact": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "alternate_email": null,
    "website": null,
    "comments": "Sit sed voluptate ipsum.",
    "metadata": {
      "color": "olive"
    },
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Tim Huel",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Tim Huel"
  }
}

Update an existing Port

Endpoint

PUT /api/v1/ports/:id

Parameters

Name Description Type
name Name String
code Code String
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON

Request

Route

PUT /api/v1/ports/d0da31cd-59a4-469e-b4cd-e463b55c699c

Headers

Authorization: Bearer aaa30188ad9947b9b9975bfb13b5e9ec6e09ff34
Content-Type: application/json

Body

{
  "name": "Port of Richmond",
  "code": "R128",
  "active": true,
  "address_line_1": "1827 Pathfinder Ave",
  "address_line_2": null,
  "city": "Vancouver",
  "province_state": "BC",
  "country": "CAN",
  "postal_zip_code": "V6L3J2",
  "latitude": 55.216172,
  "longitude": -126.211522,
  "primary_contact": "John Smith",
  "phone": "555-555-5555 x122",
  "mobile": "555-555-5556",
  "fax": "555-555-5557",
  "alternate_email": "john@vericatch.com",
  "website": "http://vericatch.com",
  "comments": "Port of Richmond/Steveston",
  "metadata": {
    "vessels_processed": 442
  }
}

cURL

curl "https://fisheriesapp.com/api/v1/ports/d0da31cd-59a4-469e-b4cd-e463b55c699c" -d '{"name":"Port of Richmond","code":"R128","active":true,"address_line_1":"1827 Pathfinder Ave","address_line_2":null,"city":"Vancouver","province_state":"BC","country":"CAN","postal_zip_code":"V6L3J2","latitude":55.216172,"longitude":-126.211522,"primary_contact":"John Smith","phone":"555-555-5555 x122","mobile":"555-555-5556","fax":"555-555-5557","alternate_email":"john@vericatch.com","website":"http://vericatch.com","comments":"Port of Richmond/Steveston","metadata":{"vessels_processed":442}}' -X PUT \
	-H "Authorization: Bearer aaa30188ad9947b9b9975bfb13b5e9ec6e09ff34"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
code Code String
active Status Boolean
address_line_1 Address line 1 String
address_line_2 Address line 2 String
city City String
province_state Province/State String
country Country ISO3166-1 Alpha 3 code
postal_zip_code Postal/Zip code String
latitude Latitude Decimal
longitude Longitude Decimal
primary_contact Primary contact String
phone Phone String
mobile Mobile String
fax Fax String
alternate_email Alternate email String
website Website String
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 74d9a03a-831c-4216-82c9-c19fdd32a093

Body

{
  "data": {
    "id": "d0da31cd-59a4-469e-b4cd-e463b55c699c",
    "html_url": "/management/account/ports/f09456aa0363",
    "name": "Port of Richmond",
    "code": "R128",
    "active": true,
    "address_line_1": "1827 Pathfinder Ave",
    "address_line_2": null,
    "city": "Vancouver",
    "province_state": "BC",
    "country": "CAN",
    "postal_zip_code": "V6L3J2",
    "latitude": 55.216172,
    "longitude": -126.211522,
    "primary_contact": "John Smith",
    "phone": "555-555-5555 x122",
    "mobile": "555-555-5556",
    "fax": "555-555-5557",
    "alternate_email": "john@vericatch.com",
    "website": "http://vericatch.com",
    "comments": "Port of Richmond/Steveston",
    "metadata": {
      "vessels_processed": 442
    },
    "created_date_time": "2018-08-01T00:00:00Z",
    "created_by_name": "Tim Huel",
    "updated_date_time": "2020-06-22T19:38:23Z",
    "updated_by_name": "Tim Huel"
  }
}

Product Forms

Return a list of fishery associated Product Forms

Endpoint

GET /api/v1/fishery-product-forms

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/fishery-product-forms

Headers

Authorization: Bearer f9aa832509ee22ddc59ea9248c65e4ad2b8f38f6
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fishery-product-forms" -X GET \
	-H "Authorization: Bearer f9aa832509ee22ddc59ea9248c65e4ad2b8f38f6"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
name Name String
code Code String
active Status Boolean
comments Comments String
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: fcc98360-c46c-49c2-a848-cee9fe6c3a3a

Body

{
  "data": [
    {
      "id": "a732180e-a680-40b3-b0bc-bff1c9a8a98f",
      "fishery_id": "6531fec2-1724-4cbf-bd8f-ed1c495c478f",
      "name": "Headed",
      "code": "H01",
      "active": true,
      "comments": "Quo molestiae qui et.",
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Jayme Rolfson",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Jayme Rolfson"
    },
    {
      "id": "7e546546-975c-4400-bde9-37bad107ecaa",
      "fishery_id": "6531fec2-1724-4cbf-bd8f-ed1c495c478f",
      "name": "Headed and Tailed",
      "code": "H&T",
      "active": true,
      "comments": "Ut non magni odio.",
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Jayme Rolfson",
      "updated_date_time": "2018-08-02T00:00:00Z",
      "updated_by_name": "Jayme Rolfson"
    },
    {
      "id": "f8cb1017-51d0-456a-99eb-0fb99d210430",
      "fishery_id": "6063acf6-d960-4a0d-8f3f-5b3e19db3bc4",
      "name": "J-Cut",
      "code": "JCUT",
      "active": true,
      "comments": "Optio ut a eius.",
      "created_date_time": "2018-07-01T00:00:00Z",
      "created_by_name": "Jayme Rolfson",
      "updated_date_time": "2018-07-02T00:00:00Z",
      "updated_by_name": "Jayme Rolfson"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single fishery associated Product Forms

Endpoint

GET /api/v1/fishery-product-forms/:id

Request

Route

GET /api/v1/fishery-product-forms/a732180e-a680-40b3-b0bc-bff1c9a8a98f

Headers

Authorization: Bearer f9aa832509ee22ddc59ea9248c65e4ad2b8f38f6
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fishery-product-forms/a732180e-a680-40b3-b0bc-bff1c9a8a98f" -X GET \
	-H "Authorization: Bearer f9aa832509ee22ddc59ea9248c65e4ad2b8f38f6"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
name Name String
code Code String
active Status Boolean
comments Comments String
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: e6cc3a19-4263-453e-aed9-07f0033dd5f4

Body

{
  "data": {
    "id": "a732180e-a680-40b3-b0bc-bff1c9a8a98f",
    "fishery_id": "6531fec2-1724-4cbf-bd8f-ed1c495c478f",
    "name": "Headed",
    "code": "H01",
    "active": true,
    "comments": "Quo molestiae qui et.",
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Jayme Rolfson",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Jayme Rolfson"
  }
}

Product States

Return a list of fishery associated Product States

Endpoint

GET /api/v1/fishery-product-states

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/fishery-product-states

Headers

Authorization: Bearer 4e1ed4a60fe824e40f8f855918d094cf2454de96
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fishery-product-states" -X GET \
	-H "Authorization: Bearer 4e1ed4a60fe824e40f8f855918d094cf2454de96"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
name Name String
code Code String
active Status Boolean
comments Comments String
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: c73c6c03-7920-4bd8-82e7-d39966a7157c

Body

{
  "data": [
    {
      "id": "49a54e42-9d1d-4d0f-85cc-f0909ce4872a",
      "fishery_id": "b0f1c9e9-f780-448a-8b8b-55ab47a0722a",
      "name": "Live",
      "code": "L01",
      "active": true,
      "comments": "Ex nobis similique sapiente.",
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Shirl Volkman",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Shirl Volkman"
    },
    {
      "id": "80a69c7b-5b6f-49fb-81a8-22ebaf8408bd",
      "fishery_id": "b0f1c9e9-f780-448a-8b8b-55ab47a0722a",
      "name": "Frozen",
      "code": "F01",
      "active": true,
      "comments": "Minima exercitationem voluptatem molestiae.",
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Shirl Volkman",
      "updated_date_time": "2018-08-02T00:00:00Z",
      "updated_by_name": "Shirl Volkman"
    },
    {
      "id": "2eae1b3f-9353-4d1d-bcc7-8e845930b3c7",
      "fishery_id": "47f6fe76-f0e3-4183-a82a-63bffa452edf",
      "name": "Fresh",
      "code": "F02",
      "active": true,
      "comments": "Voluptate et quia enim.",
      "created_date_time": "2018-07-01T00:00:00Z",
      "created_by_name": "Shirl Volkman",
      "updated_date_time": "2018-07-02T00:00:00Z",
      "updated_by_name": "Shirl Volkman"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single fishery associated Product States

Endpoint

GET /api/v1/fishery-product-states/:id

Request

Route

GET /api/v1/fishery-product-states/49a54e42-9d1d-4d0f-85cc-f0909ce4872a

Headers

Authorization: Bearer 4e1ed4a60fe824e40f8f855918d094cf2454de96
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fishery-product-states/49a54e42-9d1d-4d0f-85cc-f0909ce4872a" -X GET \
	-H "Authorization: Bearer 4e1ed4a60fe824e40f8f855918d094cf2454de96"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
name Name String
code Code String
active Status Boolean
comments Comments String
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 0fd0552a-cb9c-40e1-9caf-e25dd06879be

Body

{
  "data": {
    "id": "49a54e42-9d1d-4d0f-85cc-f0909ce4872a",
    "fishery_id": "b0f1c9e9-f780-448a-8b8b-55ab47a0722a",
    "name": "Live",
    "code": "L01",
    "active": true,
    "comments": "Ex nobis similique sapiente.",
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Shirl Volkman",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Shirl Volkman"
  }
}

Species

Return a list of fishery associated Species

Endpoint

GET /api/v1/fishery-species

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/fishery-species

Headers

Authorization: Bearer c3a3a024d3ce0d25e1bc27c942b96c64864809bd
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fishery-species" -X GET \
	-H "Authorization: Bearer c3a3a024d3ce0d25e1bc27c942b96c64864809bd"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
names Name Hash of ISO 639-1 language codes
scientific_name Scientific name String
code Code String
gbif_id GBIF code String
asfis_3a_code ASFIS 3-alpha code String
itis_tsn ITIS TSN code String
order Order Integer
target Target Boolean
fisherman_sets Enabled for fisherman set forms Boolean
monitor_sets Enabled for monitor set forms Boolean
landings Enabled for landing forms Boolean
biology_samples Enabled for biology sample forms Boolean
active Status Boolean
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 10400359-aa92-471d-ba5f-c2086f26c2c9

Body

{
  "data": [
    {
      "id": "9cf6f0be-96c8-44df-a68f-1671ad71e8a5",
      "fishery_id": "908f5dce-ce35-491b-9a23-ef422945d696",
      "names": {
        "en": "Deep Trevally",
        "es": "Tanja Boyle",
        "fr": "Abel Labadie",
        "id": "Ikan Kwek"
      },
      "scientific_name": "Sebastes Mystinus",
      "code": "870ac5",
      "gbif_id": "191189",
      "asfis_3a_code": "49s",
      "itis_tsn": "214277",
      "order": 788,
      "target": false,
      "fisherman_sets": true,
      "monitor_sets": true,
      "landings": true,
      "biology_samples": true,
      "active": true,
      "comments": "Ut accusantium architecto magnam.",
      "metadata": {
        "ext_id": 1234,
        "integration_user": "John Smith"
      },
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Emmett Koelpin",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Emmett Koelpin"
    },
    {
      "id": "a1d9c4ad-15ff-4c2b-92ed-2b9c0132de78",
      "fishery_id": "908f5dce-ce35-491b-9a23-ef422945d696",
      "names": {
        "en": "Sand Star",
        "es": "Dan Goldner",
        "fr": "Antonio Ratke",
        "id": "Bintang Laut"
      },
      "scientific_name": "Sebastes Entomelas",
      "code": "04df5a",
      "gbif_id": "194699",
      "asfis_3a_code": "0sf",
      "itis_tsn": "228044",
      "order": 680,
      "target": false,
      "fisherman_sets": true,
      "monitor_sets": true,
      "landings": true,
      "biology_samples": true,
      "active": true,
      "comments": "Mollitia quo vitae ex.",
      "metadata": {
      },
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Emmett Koelpin",
      "updated_date_time": "2018-08-02T00:00:00Z",
      "updated_by_name": "Emmett Koelpin"
    },
    {
      "id": "cbf3ad7a-49af-4838-bdb0-c3fc27ccb2ad",
      "fishery_id": "6d96d345-4b3c-4748-bb3c-360c240d3d85",
      "names": {
        "en": "Long Tongue Sole",
        "es": "Gina Wiegand",
        "fr": "Inger Vandervort",
        "id": "Ikan Lidah"
      },
      "scientific_name": "Sebastes Reedi",
      "code": "8b326c",
      "gbif_id": "188516",
      "asfis_3a_code": "nnv",
      "itis_tsn": "258882",
      "order": 551,
      "target": true,
      "fisherman_sets": true,
      "monitor_sets": true,
      "landings": true,
      "biology_samples": true,
      "active": true,
      "comments": "Alias nam officiis quia.",
      "metadata": {
      },
      "created_date_time": "2018-07-01T00:00:00Z",
      "created_by_name": "Emmett Koelpin",
      "updated_date_time": "2018-07-02T00:00:00Z",
      "updated_by_name": "Emmett Koelpin"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single fishery associated Species

Endpoint

GET /api/v1/fishery-species/:id

Request

Route

GET /api/v1/fishery-species/9cf6f0be-96c8-44df-a68f-1671ad71e8a5

Headers

Authorization: Bearer c3a3a024d3ce0d25e1bc27c942b96c64864809bd
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/fishery-species/9cf6f0be-96c8-44df-a68f-1671ad71e8a5" -X GET \
	-H "Authorization: Bearer c3a3a024d3ce0d25e1bc27c942b96c64864809bd"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
names Name Hash of ISO 639-1 language codes
scientific_name Scientific name String
code Code String
gbif_id GBIF code String
asfis_3a_code ASFIS 3-alpha code String
itis_tsn ITIS TSN code String
order Order Integer
target Target Boolean
fisherman_sets Enabled for fisherman set forms Boolean
monitor_sets Enabled for monitor set forms Boolean
landings Enabled for landing forms Boolean
biology_samples Enabled for biology sample forms Boolean
active Status Boolean
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: f42008ac-2be3-4350-81f9-a21d757d2bbe

Body

{
  "data": {
    "id": "9cf6f0be-96c8-44df-a68f-1671ad71e8a5",
    "fishery_id": "908f5dce-ce35-491b-9a23-ef422945d696",
    "names": {
      "en": "Deep Trevally",
      "es": "Tanja Boyle",
      "fr": "Abel Labadie",
      "id": "Ikan Kwek"
    },
    "scientific_name": "Sebastes Mystinus",
    "code": "870ac5",
    "gbif_id": "191189",
    "asfis_3a_code": "49s",
    "itis_tsn": "214277",
    "order": 788,
    "target": false,
    "fisherman_sets": true,
    "monitor_sets": true,
    "landings": true,
    "biology_samples": true,
    "active": true,
    "comments": "Ut accusantium architecto magnam.",
    "metadata": {
      "ext_id": 1234,
      "integration_user": "John Smith"
    },
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Emmett Koelpin",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Emmett Koelpin"
  }
}

Trips

Create a new Trip

Endpoint

POST /api/v1/trips

Parameters

Name Description Type
departed_date_time required Departure date/time ISO8601 date/time
reference Reference of trip UUID
fisherman_id ID of fisherman UUID
vessel_id ID of vessel UUID
type_id ID of type UUID
comments Comments String
metadata Metadata JSON
hail_out Hail Out (Required for Advanced Trips) JSON
- hail_number Hail number String
- fisherman_id ID of fisherman UUID
- departed_date_time Departure date/time ISO8601 date/time
- departure_port_id ID of departure port UUID
- departure_location_id ID of departure location UUID
- landed_at Landed date/time ISO8601 date/time
- landing_port_id ID of landing port UUID
- landing_location_id ID of landing location UUID
- comments Comments Text
- metadata Metadata JSON

Request

Route

POST /api/v1/trips

Headers

Authorization: Bearer 68ece9d72455b6cf05c29fbb676f1de2186229b1
Content-Type: application/json

Body

{
  "fishery_id": "93b32b57-b4fa-4e5c-8181-6814bc73ec6f",
  "fishery_period_id": "96c06cf4-47b5-4054-8429-cf44cb0f94de",
  "departed_date_time": "2018-09-02T12:19:12",
  "reference": "39810221",
  "fisherman_id": "a8861150-8110-441b-bffb-64ab0744c2ba",
  "vessel_id": "edb9e2fe-35b3-46f7-8348-654bab3bc146",
  "type_id": "7137f7db-fa5d-4566-bebb-dc18565875c7",
  "comments": "Keeping an eye on the weather",
  "metadata": {
    "crew_count": 5
  }
}

cURL

curl "https://fisheriesapp.com/api/v1/trips" -d '{"fishery_id":"93b32b57-b4fa-4e5c-8181-6814bc73ec6f","fishery_period_id":"96c06cf4-47b5-4054-8429-cf44cb0f94de","departed_date_time":"2018-09-02T12:19:12","reference":"39810221","fisherman_id":"a8861150-8110-441b-bffb-64ab0744c2ba","vessel_id":"edb9e2fe-35b3-46f7-8348-654bab3bc146","type_id":"7137f7db-fa5d-4566-bebb-dc18565875c7","comments":"Keeping an eye on the weather","metadata":{"crew_count":5}}' -X POST \
	-H "Authorization: Bearer 68ece9d72455b6cf05c29fbb676f1de2186229b1"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of fishery period UUID
departed_date_time Departure date/time ISO8601 date/time
reference Reference of trip UUID
fisherman_id ID of fisherman UUID
vessel_id ID of vessel UUID
type_id ID of type UUID
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
hail_out Hail Out (Required for Advanced Trips) JSON
- id ID UUID
- html_url Management URL String
- type Type of hail String
- hail_number Hail number String
- fisherman_id ID of fisherman UUID
- monitor_id ID of monitor UUID
- departed_date_time Departed date/time ISO8601 date/time
- departure_port_id ID of departure port UUID
- departure_location_id ID of departure location UUID
- landed_date_time Landed date/time ISO8601 date/time
- landing_port_id ID of landing port UUID
- landing_location_id ID of landing location UUID
- comments Comments Text
- metadata Metadata JSON

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 194ad850-9835-4055-a8e9-d2906c0f9293

Body

{
  "data": {
    "id": "66a12665-8e08-4daf-8d29-aec6e4aecab4",
    "html_url": "/management/fisheries/c02c94406b17/trips/b58f77bef14d",
    "fishery_id": "93b32b57-b4fa-4e5c-8181-6814bc73ec6f",
    "fishery_period_id": "96c06cf4-47b5-4054-8429-cf44cb0f94de",
    "departed_date_time": "2018-09-02T12:19:12Z",
    "reference": "39810221",
    "fisherman_id": "a8861150-8110-441b-bffb-64ab0744c2ba",
    "vessel_id": "edb9e2fe-35b3-46f7-8348-654bab3bc146",
    "type_id": "7137f7db-fa5d-4566-bebb-dc18565875c7",
    "comments": "Keeping an eye on the weather",
    "metadata": {
      "crew_count": 5
    },
    "created_date_time": "2020-06-22T19:38:24Z",
    "created_by_name": "Rosalva Vandervort",
    "updated_date_time": "2020-06-22T19:38:24Z",
    "updated_by_name": "Rosalva Vandervort",
    "hails": [

    ]
  }
}

Delete an existing Trip

Endpoint

DELETE /api/v1/trips/:id

Request

Route

DELETE /api/v1/trips/e0e20f9c-e171-47cb-9f7c-91ca1731d775

Headers

Authorization: Bearer 68ece9d72455b6cf05c29fbb676f1de2186229b1
Content-Type: application/json

cURL

curl "https://fisheriesapp.com/api/v1/trips/e0e20f9c-e171-47cb-9f7c-91ca1731d775" -d '' -X DELETE \
	-H "Authorization: Bearer 68ece9d72455b6cf05c29fbb676f1de2186229b1"

Response

Simulated Response

Status

204

Headers

X-Request-Id: 048e55d8-79be-46a9-86a0-88dbfd77c553

Return a list of Trips

Endpoint

GET /api/v1/trips

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date including any changes to hails ISO8601 date/time
fishery_id Optionally specify one or more fisheries as a comma separated list of IDs String
fishery_period_id Optionally specify one or more periods as a comma separated list of IDs; leaving blank defaults to returning data from any fisheries current period String

Request

Route

GET /api/v1/trips

Headers

Authorization: Bearer 68ece9d72455b6cf05c29fbb676f1de2186229b1
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/trips" -X GET \
	-H "Authorization: Bearer 68ece9d72455b6cf05c29fbb676f1de2186229b1"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of fishery period UUID
departed_date_time Departure date/time ISO8601 date/time
reference Reference of trip String
fisherman_id ID of fisherman UUID
vessel_id ID of vessel UUID
type_id ID of type UUID
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
hails Hails Array
- id ID UUID
- html_url Management URL String
- type Type of hail String
- hail_number Hail number String
- fisherman_id ID of fisherman UUID
- monitor_id ID of monitor UUID
- departed_date_time Departed date/time ISO8601 date/time
- departure_port_id ID of departure port UUID
- departure_location_id ID of departure location UUID
- tied_up_date_time Tied up date/time ISO8601 date/time
- tie_up_port_id ID of tie up port UUID
- tie_up_location_id ID of tie up location UUID
- landed_date_time Landed date/time ISO8601 date/time
- landing_port_id ID of landing port UUID
- landing_location_id ID of landing location UUID
- final Final Boolean
- monitor_disembarked Monitor disembarked Boolean
- comments Comments Text
- metadata Metadata JSON
- created_date_time Created date/time ISO8601 date/time
- created_by_user_name Name of creating user String
- updated_date_time Updated date/time ISO8601 date/time
- updated_by_user_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 078c3cd0-440e-47be-8fac-0b1f43773e86

Body

{
  "data": [
    {
      "id": "66a12665-8e08-4daf-8d29-aec6e4aecab4",
      "html_url": "/management/fisheries/c02c94406b17/trips/b58f77bef14d",
      "fishery_id": "93b32b57-b4fa-4e5c-8181-6814bc73ec6f",
      "fishery_period_id": "96c06cf4-47b5-4054-8429-cf44cb0f94de",
      "departed_date_time": "2018-09-02T12:19:12Z",
      "reference": "39810221",
      "fisherman_id": "a8861150-8110-441b-bffb-64ab0744c2ba",
      "vessel_id": "edb9e2fe-35b3-46f7-8348-654bab3bc146",
      "type_id": "7137f7db-fa5d-4566-bebb-dc18565875c7",
      "comments": "Keeping an eye on the weather",
      "metadata": {
        "crew_count": 5
      },
      "created_date_time": "2020-06-22T19:38:24Z",
      "created_by_name": "Rosalva Vandervort",
      "updated_date_time": "2020-06-22T19:38:24Z",
      "updated_by_name": "Rosalva Vandervort",
      "hails": [

      ]
    },
    {
      "id": "878426f8-38d8-44cf-b0e7-911081738096",
      "html_url": "/management/fisheries/27f12b35180b/trips/6506ae7ed0e7",
      "fishery_id": "7c485bbb-abf9-4963-901b-b84f0b40ba2a",
      "fishery_period_id": "4526a476-48ee-4ddb-ac41-cf1738ba4ed2",
      "departed_date_time": null,
      "reference": "39810011",
      "fisherman_id": null,
      "vessel_id": "edb9e2fe-35b3-46f7-8348-654bab3bc146",
      "type_id": "316e7884-01cc-43d7-aa69-58c342c3c89d",
      "comments": "Weather looking good, going to head out",
      "metadata": {
        "color": "silver"
      },
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Rosalva Vandervort",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Rosalva Vandervort",
      "hails": [
        {
          "id": "ce8473ef-4a86-49c8-be42-7990784313e4",
          "html_url": "/management/fisheries/27f12b35180b/trips/6506ae7ed0e7/hails/3ccb4696050d",
          "type": "hail_in",
          "hail_number": "S6217294J",
          "fisherman_id": "a8861150-8110-441b-bffb-64ab0744c2ba",
          "monitor_id": null,
          "tied_up_date_time": "2020-03-30T18:52:24Z",
          "tie_up_port_id": "25fb38c3-bac9-47e9-afae-928d026c1d67",
          "tie_up_location_id": "bd7aaf41-f99b-413f-9993-c89c0d175d7c",
          "landed_date_time": "2020-03-31T05:15:12Z",
          "landing_port_id": "25fb38c3-bac9-47e9-afae-928d026c1d67",
          "landing_location_id": "bd7aaf41-f99b-413f-9993-c89c0d175d7c",
          "final": null,
          "monitor_disembarked": null,
          "comments": "Voluptas nesciunt architecto maiores.",
          "metadata": {
          },
          "created_date_time": "2020-06-22T19:38:24Z",
          "created_by_user_name": "Rosalva Vandervort",
          "updated_date_time": "2020-06-22T19:38:24Z",
          "updated_by_user_name": "Rosalva Vandervort"
        },
        {
          "id": "33e4e5f4-ea6d-441e-bb13-15501a767c91",
          "html_url": "/management/fisheries/27f12b35180b/trips/6506ae7ed0e7/hails/bd319509abce",
          "type": "hail_out",
          "hail_number": "S9260515I",
          "fisherman_id": "a8861150-8110-441b-bffb-64ab0744c2ba",
          "monitor_id": null,
          "departed_date_time": "2020-06-18T19:12:24Z",
          "departure_port_id": "4c9128b0-1c7d-41aa-b681-381a50f8aad1",
          "departure_location_id": "89c1d9ea-0311-4c90-8594-415964f9ab7e",
          "landed_date_time": null,
          "landing_port_id": null,
          "landing_location_id": null,
          "comments": "Cumque sunt adipisci quia.",
          "metadata": {
          },
          "created_date_time": "2020-06-22T19:38:24Z",
          "created_by_user_name": "Rosalva Vandervort",
          "updated_date_time": "2020-06-22T19:38:24Z",
          "updated_by_user_name": "Rosalva Vandervort"
        }
      ]
    },
    {
      "id": "4342bdb5-32b9-42d9-a7ed-412f29d60a91",
      "html_url": "/management/fisheries/c02c94406b17/trips/9712069cb627",
      "fishery_id": "93b32b57-b4fa-4e5c-8181-6814bc73ec6f",
      "fishery_period_id": "96c06cf4-47b5-4054-8429-cf44cb0f94de",
      "departed_date_time": "2018-08-03T11:12:00Z",
      "reference": "39810182",
      "fisherman_id": "87ed40bf-3358-43f1-9a0c-5e88c533e21c",
      "vessel_id": "d55347c2-803e-4dba-a01b-576103f69194",
      "type_id": "7137f7db-fa5d-4566-bebb-dc18565875c7",
      "comments": "Moving departure date of trip out to tomorrow",
      "metadata": {
      },
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Rosalva Vandervort",
      "updated_date_time": "2020-06-22T19:38:24Z",
      "updated_by_name": "Rosalva Vandervort",
      "hails": [

      ]
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single Trip

Endpoint

GET /api/v1/trips/:id

Request

Route

GET /api/v1/trips/878426f8-38d8-44cf-b0e7-911081738096

Headers

Authorization: Bearer 68ece9d72455b6cf05c29fbb676f1de2186229b1
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/trips/878426f8-38d8-44cf-b0e7-911081738096" -X GET \
	-H "Authorization: Bearer 68ece9d72455b6cf05c29fbb676f1de2186229b1"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of fishery period UUID
departed_date_time Departure date/time ISO8601 date/time
reference Reference of trip UUID
fisherman_id ID of fisherman UUID
vessel_id ID of vessel UUID
type_id ID of type UUID
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
hails Hails Array
- id ID UUID
- html_url Management URL String
- type Type of hail String
- hail_number Hail number String
- fisherman_id ID of fisherman UUID
- monitor_id ID of monitor UUID
- departed_date_time Departed date/time ISO8601 date/time
- departure_port_id ID of departure port UUID
- departure_location_id ID of departure location UUID
- tied_up_date_time Tied up date/time ISO8601 date/time
- tie_up_port_id ID of tie up port UUID
- tie_up_location_id ID of tie up location UUID
- landed_date_time Landed date/time ISO8601 date/time
- landing_port_id ID of landing port UUID
- landing_location_id ID of landing location UUID
- final Final Boolean
- monitor_disembarked Monitor disembarked Boolean
- comments Comments Text
- metadata Metadata JSON
- created_date_time Created date/time ISO8601 date/time
- created_by_user_name Name of creating user String
- updated_date_time Updated date/time ISO8601 date/time
- updated_by_user_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 3b56dd6f-1629-42c1-89e5-c1e9480d391c

Body

{
  "data": {
    "id": "878426f8-38d8-44cf-b0e7-911081738096",
    "html_url": "/management/fisheries/27f12b35180b/trips/6506ae7ed0e7",
    "fishery_id": "7c485bbb-abf9-4963-901b-b84f0b40ba2a",
    "fishery_period_id": "4526a476-48ee-4ddb-ac41-cf1738ba4ed2",
    "departed_date_time": null,
    "reference": "39810011",
    "fisherman_id": null,
    "vessel_id": "edb9e2fe-35b3-46f7-8348-654bab3bc146",
    "type_id": "316e7884-01cc-43d7-aa69-58c342c3c89d",
    "comments": "Weather looking good, going to head out",
    "metadata": {
      "color": "silver"
    },
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Rosalva Vandervort",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Rosalva Vandervort",
    "hails": [
      {
        "id": "ce8473ef-4a86-49c8-be42-7990784313e4",
        "html_url": "/management/fisheries/27f12b35180b/trips/6506ae7ed0e7/hails/3ccb4696050d",
        "type": "hail_in",
        "hail_number": "S6217294J",
        "fisherman_id": "a8861150-8110-441b-bffb-64ab0744c2ba",
        "monitor_id": null,
        "tied_up_date_time": "2020-03-30T18:52:24Z",
        "tie_up_port_id": "25fb38c3-bac9-47e9-afae-928d026c1d67",
        "tie_up_location_id": "bd7aaf41-f99b-413f-9993-c89c0d175d7c",
        "landed_date_time": "2020-03-31T05:15:12Z",
        "landing_port_id": "25fb38c3-bac9-47e9-afae-928d026c1d67",
        "landing_location_id": "bd7aaf41-f99b-413f-9993-c89c0d175d7c",
        "final": null,
        "monitor_disembarked": null,
        "comments": "Voluptas nesciunt architecto maiores.",
        "metadata": {
        },
        "created_date_time": "2020-06-22T19:38:24Z",
        "created_by_user_name": "Rosalva Vandervort",
        "updated_date_time": "2020-06-22T19:38:24Z",
        "updated_by_user_name": "Rosalva Vandervort"
      },
      {
        "id": "33e4e5f4-ea6d-441e-bb13-15501a767c91",
        "html_url": "/management/fisheries/27f12b35180b/trips/6506ae7ed0e7/hails/bd319509abce",
        "type": "hail_out",
        "hail_number": "S9260515I",
        "fisherman_id": "a8861150-8110-441b-bffb-64ab0744c2ba",
        "monitor_id": null,
        "departed_date_time": "2020-06-18T19:12:24Z",
        "departure_port_id": "4c9128b0-1c7d-41aa-b681-381a50f8aad1",
        "departure_location_id": "89c1d9ea-0311-4c90-8594-415964f9ab7e",
        "landed_date_time": null,
        "landing_port_id": null,
        "landing_location_id": null,
        "comments": "Cumque sunt adipisci quia.",
        "metadata": {
        },
        "created_date_time": "2020-06-22T19:38:24Z",
        "created_by_user_name": "Rosalva Vandervort",
        "updated_date_time": "2020-06-22T19:38:24Z",
        "updated_by_user_name": "Rosalva Vandervort"
      }
    ]
  }
}

Update an existing Trip

Endpoint

PUT /api/v1/trips/:id

Parameters

Name Description Type
departed_date_time required Departure date/time ISO8601 date/time
reference Reference of trip UUID
fisherman_id ID of fisherman UUID
vessel_id ID of vessel UUID
type_id ID of type UUID
comments Comments String
metadata Metadata JSON
hail_out Hail Out (Required for Advanced Trips) JSON
- hail_number Hail number String
- fisherman_id ID of fisherman UUID
- departed_date_time Departure date/time ISO8601 date/time
- departure_port_id ID of departure port UUID
- departure_location_id ID of departure location UUID
- landed_at Landed date/time ISO8601 date/time
- landing_port_id ID of landing port UUID
- landing_location_id ID of landing location UUID
- comments Comments Text
- metadata Metadata JSON

Request

Route

PUT /api/v1/trips/4342bdb5-32b9-42d9-a7ed-412f29d60a91

Headers

Authorization: Bearer 68ece9d72455b6cf05c29fbb676f1de2186229b1
Content-Type: application/json

Body

{
  "departed_date_time": "2018-08-03T11:12Z",
  "reference": "39810182",
  "fisherman_id": "87ed40bf-3358-43f1-9a0c-5e88c533e21c",
  "vessel_id": "d55347c2-803e-4dba-a01b-576103f69194",
  "type_id": "7137f7db-fa5d-4566-bebb-dc18565875c7",
  "comments": "Moving departure date of trip out to tomorrow",
  "metadata": {
  }
}

cURL

curl "https://fisheriesapp.com/api/v1/trips/4342bdb5-32b9-42d9-a7ed-412f29d60a91" -d '{"departed_date_time":"2018-08-03T11:12Z","reference":"39810182","fisherman_id":"87ed40bf-3358-43f1-9a0c-5e88c533e21c","vessel_id":"d55347c2-803e-4dba-a01b-576103f69194","type_id":"7137f7db-fa5d-4566-bebb-dc18565875c7","comments":"Moving departure date of trip out to tomorrow","metadata":{}}' -X PUT \
	-H "Authorization: Bearer 68ece9d72455b6cf05c29fbb676f1de2186229b1"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
fishery_id ID of fishery UUID
fishery_period_id ID of fishery period UUID
departed_date_time Departure date/time ISO8601 date/time
reference Reference of trip UUID
fisherman_id ID of fisherman UUID
vessel_id ID of vessel UUID
type_id ID of type UUID
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String
hail_out Hail Out (Required for Advanced Trips) JSON
- id ID UUID
- html_url Management URL String
- type Type of hail String
- hail_number Hail number String
- fisherman_id ID of fisherman UUID
- monitor_id ID of monitor UUID
- departed_date_time Departed date/time ISO8601 date/time
- departure_port_id ID of departure port UUID
- departure_location_id ID of departure location UUID
- landed_date_time Landed date/time ISO8601 date/time
- landing_port_id ID of landing port UUID
- landing_location_id ID of landing location UUID
- comments Comments Text
- metadata Metadata JSON

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 47f571ec-0646-4620-9770-ce48eb40dc82

Body

{
  "data": {
    "id": "4342bdb5-32b9-42d9-a7ed-412f29d60a91",
    "html_url": "/management/fisheries/c02c94406b17/trips/9712069cb627",
    "fishery_id": "93b32b57-b4fa-4e5c-8181-6814bc73ec6f",
    "fishery_period_id": "96c06cf4-47b5-4054-8429-cf44cb0f94de",
    "departed_date_time": "2018-08-03T11:12:00Z",
    "reference": "39810182",
    "fisherman_id": "87ed40bf-3358-43f1-9a0c-5e88c533e21c",
    "vessel_id": "d55347c2-803e-4dba-a01b-576103f69194",
    "type_id": "7137f7db-fa5d-4566-bebb-dc18565875c7",
    "comments": "Moving departure date of trip out to tomorrow",
    "metadata": {
    },
    "created_date_time": "2018-08-01T00:00:00Z",
    "created_by_name": "Rosalva Vandervort",
    "updated_date_time": "2020-06-22T19:38:24Z",
    "updated_by_name": "Rosalva Vandervort",
    "hails": [

    ]
  }
}

Vessels

Create a new Vessel

Endpoint

POST /api/v1/vessels

Parameters

Name Description Type
name Name String
registration_number Registration number String
code Code String
active Status Boolean
fisherman Owner String
imo IMO String
official_number Official number String
year_built Year built Integer
flag Flag ISO3166-1 Alpha 3 code
port_of_registry Port of registry String
gross_tonnage Gross tonnage (GT) Decimal
length_overall Length overall (LOA, in meters) Decimal
beam Beam (in meters) Decimal
deadweight_tonnage Deadweight tonnage (DT) Decimal
horsepower Horsepower (HP) Integer
comments Comments String
metadata Metadata JSON

Request

Route

POST /api/v1/vessels

Headers

Authorization: Bearer 8500d4d0ed3091b952b33c627e3bde3479da283b
Content-Type: application/json

Body

{
  "name": "Ocean King",
  "registration_number": "K229182",
  "code": "025",
  "active": true,
  "fisherman": "John",
  "imo": "IMO.7612",
  "official_number": "9988",
  "year_built": 2003,
  "flag": "CAN",
  "port_of_registry": "Port of Vancouver",
  "gross_tonnage": 1.5,
  "length_overall": 9.2,
  "beam": 1.8,
  "deadweight_tonnage": 0.43,
  "horsepower": 90,
  "comments": "Added on behalf of client",
  "metadata": {
    "foo": "bar"
  }
}

cURL

curl "https://fisheriesapp.com/api/v1/vessels" -d '{"name":"Ocean King","registration_number":"K229182","code":"025","active":true,"fisherman":"John","imo":"IMO.7612","official_number":"9988","year_built":2003,"flag":"CAN","port_of_registry":"Port of Vancouver","gross_tonnage":1.5,"length_overall":9.2,"beam":1.8,"deadweight_tonnage":0.43,"horsepower":90,"comments":"Added on behalf of client","metadata":{"foo":"bar"}}' -X POST \
	-H "Authorization: Bearer 8500d4d0ed3091b952b33c627e3bde3479da283b"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
registration_number Registration number String
code Code String
active Status Boolean
fisherman Owner String
imo IMO String
official_number Official number String
year_built Year built Integer
flag Flag ISO3166-1 Alpha 3 code
port_of_registry Port of registry String
gross_tonnage Gross tonnage (GT) Decimal
length_overall Length overall (LOA, in meters) Decimal
beam Beam (in meters) Decimal
deadweight_tonnage Deadweight tonnage (DT) Decimal
horsepower Horsepower (HP) Integer
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

201

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: c40285e2-d161-401d-a632-42ca086b3a13

Body

{
  "data": {
    "id": "07f41c9e-df12-4821-abc0-109b757dd5f5",
    "html_url": "/management/account/vessels/f7066be994c9",
    "name": "Ocean King",
    "registration_number": "K229182",
    "code": "025",
    "active": true,
    "fisherman": "John",
    "imo": "IMO.7612",
    "official_number": "9988",
    "year_built": 2003,
    "flag": "CAN",
    "port_of_registry": "Port of Vancouver",
    "gross_tonnage": 1.5,
    "length_overall": 9.2,
    "beam": 1.8,
    "deadweight_tonnage": 0.43,
    "horsepower": 90,
    "comments": "Added on behalf of client",
    "metadata": {
      "foo": "bar"
    },
    "created_date_time": "2020-06-22T19:38:19Z",
    "created_by_name": "Ronnie Pfannerstill",
    "updated_date_time": "2020-06-22T19:38:19Z",
    "updated_by_name": "Ronnie Pfannerstill"
  }
}

Delete an existing Vessel

Endpoint

DELETE /api/v1/vessels/:id

Request

Route

DELETE /api/v1/vessels/366dce86-e567-4bb9-b777-055164974a5e

Headers

Authorization: Bearer 8500d4d0ed3091b952b33c627e3bde3479da283b
Content-Type: application/json

cURL

curl "https://fisheriesapp.com/api/v1/vessels/366dce86-e567-4bb9-b777-055164974a5e" -d '' -X DELETE \
	-H "Authorization: Bearer 8500d4d0ed3091b952b33c627e3bde3479da283b"

Response

Simulated Response

Status

204

Headers

X-Request-Id: 8048d73f-faa7-4e51-a329-8a1640c89604

Return a list of Vessels

Endpoint

GET /api/v1/vessels

Parameters

Name Description Type
modified_on_or_after Optionally specify a date/time to return items changed since that date ISO8601 date/time

Request

Route

GET /api/v1/vessels

Headers

Authorization: Bearer 8500d4d0ed3091b952b33c627e3bde3479da283b
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/vessels" -X GET \
	-H "Authorization: Bearer 8500d4d0ed3091b952b33c627e3bde3479da283b"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
registration_number Registration number String
code Code String
active Status Boolean
fisherman Owner String
imo IMO String
official_number Official number String
year_built Year built Integer
flag Flag ISO3166-1 Alpha 3 code
port_of_registry Port of registry String
gross_tonnage Gross tonnage (GT) Decimal
length_overall Length overall (LOA, in meters) Decimal
beam Beam (in meters) Decimal
deadweight_tonnage Deadweight tonnage (DT) Decimal
horsepower Horsepower (HP) Integer
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: de78324d-aae6-4207-a9db-76242e69d3ef

Body

{
  "data": [
    {
      "id": "07f41c9e-df12-4821-abc0-109b757dd5f5",
      "html_url": "/management/account/vessels/f7066be994c9",
      "name": "Ocean King",
      "registration_number": "K229182",
      "code": "025",
      "active": true,
      "fisherman": "John",
      "imo": "IMO.7612",
      "official_number": "9988",
      "year_built": 2003,
      "flag": "CAN",
      "port_of_registry": "Port of Vancouver",
      "gross_tonnage": 1.5,
      "length_overall": 9.2,
      "beam": 1.8,
      "deadweight_tonnage": 0.43,
      "horsepower": 90,
      "comments": "Added on behalf of client",
      "metadata": {
        "foo": "bar"
      },
      "created_date_time": "2020-06-22T19:38:19Z",
      "created_by_name": "Ronnie Pfannerstill",
      "updated_date_time": "2020-06-22T19:38:19Z",
      "updated_by_name": "Ronnie Pfannerstill"
    },
    {
      "id": "a5e747f5-ebaa-48d7-a1e2-b4d8bd5694f6",
      "html_url": "/management/account/vessels/0288a6381b7f",
      "name": "Viking Two",
      "registration_number": "W11490",
      "code": "006",
      "active": true,
      "fisherman": "John Haris",
      "imo": "IMO123",
      "official_number": "5423",
      "year_built": 2005,
      "flag": "CAN",
      "port_of_registry": "Port of Vancouver",
      "gross_tonnage": 20.0,
      "length_overall": 15.0,
      "beam": 4.0,
      "deadweight_tonnage": 4.22,
      "horsepower": 500,
      "comments": "Velit aliquam ad id.",
      "metadata": {
        "color": "white"
      },
      "created_date_time": "2018-09-01T00:00:00Z",
      "created_by_name": "Ronnie Pfannerstill",
      "updated_date_time": "2018-09-02T00:00:00Z",
      "updated_by_name": "Ronnie Pfannerstill"
    },
    {
      "id": "e735e069-eb3a-4ae4-a83c-070bbcba4a67",
      "html_url": "/management/account/vessels/cb96c9e5d24b",
      "name": "Ventura",
      "registration_number": "S88131",
      "code": "006",
      "active": true,
      "fisherman": "Kim Lee",
      "imo": "IMO.1231",
      "official_number": "9912",
      "year_built": 2010,
      "flag": "CAN",
      "port_of_registry": "Port of NY",
      "gross_tonnage": 5.5,
      "length_overall": 8.2,
      "beam": 3.0,
      "deadweight_tonnage": 5.22,
      "horsepower": null,
      "comments": "Ex error culpa sed.",
      "metadata": {
      },
      "created_date_time": "2018-08-01T00:00:00Z",
      "created_by_name": "Ronnie Pfannerstill",
      "updated_date_time": "2018-08-02T00:00:00Z",
      "updated_by_name": "Ronnie Pfannerstill"
    }
  ],
  "objects": 3,
  "pages": 1
}

Return a single Vessel

Endpoint

GET /api/v1/vessels/:id

Request

Route

GET /api/v1/vessels/a5e747f5-ebaa-48d7-a1e2-b4d8bd5694f6

Headers

Authorization: Bearer 8500d4d0ed3091b952b33c627e3bde3479da283b
Content-Type: application/json

cURL

curl -g "https://fisheriesapp.com/api/v1/vessels/a5e747f5-ebaa-48d7-a1e2-b4d8bd5694f6" -X GET \
	-H "Authorization: Bearer 8500d4d0ed3091b952b33c627e3bde3479da283b"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
registration_number Registration number String
code Code String
active Status Boolean
fisherman Owner String
imo IMO String
official_number Official number String
year_built Year built Integer
flag Flag ISO3166-1 Alpha 3 code
port_of_registry Port of registry String
gross_tonnage Gross tonnage (GT) Decimal
length_overall Length overall (LOA, in meters) Decimal
beam Beam (in meters) Decimal
deadweight_tonnage Deadweight tonnage (DT) Decimal
horsepower Horsepower (HP) Integer
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 64c86c5f-0bbc-4a25-b618-62319015214f

Body

{
  "data": {
    "id": "a5e747f5-ebaa-48d7-a1e2-b4d8bd5694f6",
    "html_url": "/management/account/vessels/0288a6381b7f",
    "name": "Viking Two",
    "registration_number": "W11490",
    "code": "006",
    "active": true,
    "fisherman": "John Haris",
    "imo": "IMO123",
    "official_number": "5423",
    "year_built": 2005,
    "flag": "CAN",
    "port_of_registry": "Port of Vancouver",
    "gross_tonnage": 20.0,
    "length_overall": 15.0,
    "beam": 4.0,
    "deadweight_tonnage": 4.22,
    "horsepower": 500,
    "comments": "Velit aliquam ad id.",
    "metadata": {
      "color": "white"
    },
    "created_date_time": "2018-09-01T00:00:00Z",
    "created_by_name": "Ronnie Pfannerstill",
    "updated_date_time": "2018-09-02T00:00:00Z",
    "updated_by_name": "Ronnie Pfannerstill"
  }
}

Update an existing Vessel

Endpoint

PUT /api/v1/vessels/:id

Parameters

Name Description Type
name Name String
registration_number Registration number String
code Code String
active Status Boolean
fisherman Owner String
imo IMO String
official_number Official number String
year_built Year built Integer
flag Flag ISO3166-1 Alpha 3 code
port_of_registry Port of registry String
gross_tonnage Gross tonnage (GT) Decimal
length_overall Length overall (LOA, in meters) Decimal
beam Beam (in meters) Decimal
deadweight_tonnage Deadweight tonnage (DT) Decimal
horsepower Horsepower (HP) Integer
comments Comments String
metadata Metadata JSON

Request

Route

PUT /api/v1/vessels/e735e069-eb3a-4ae4-a83c-070bbcba4a67

Headers

Authorization: Bearer 8500d4d0ed3091b952b33c627e3bde3479da283b
Content-Type: application/json

Body

{
  "name": "Freeport",
  "registration_number": "K133902",
  "code": "072",
  "active": true,
  "fisherman": "John",
  "imo": "IMO.1234",
  "official_number": "9988",
  "year_built": 2003,
  "flag": "CAN",
  "port_of_registry": "Port of Vancouver",
  "gross_tonnage": 12.25,
  "length_overall": 15.2,
  "beam": 4.1,
  "deadweight_tonnage": 2.55,
  "horsepower": 250,
  "comments": null,
  "metadata": {
    "foo": "baaar"
  }
}

cURL

curl "https://fisheriesapp.com/api/v1/vessels/e735e069-eb3a-4ae4-a83c-070bbcba4a67" -d '{"name":"Freeport","registration_number":"K133902","code":"072","active":true,"fisherman":"John","imo":"IMO.1234","official_number":"9988","year_built":2003,"flag":"CAN","port_of_registry":"Port of Vancouver","gross_tonnage":12.25,"length_overall":15.2,"beam":4.1,"deadweight_tonnage":2.55,"horsepower":250,"comments":null,"metadata":{"foo":"baaar"}}' -X PUT \
	-H "Authorization: Bearer 8500d4d0ed3091b952b33c627e3bde3479da283b"

Response

Simulated Response

Response Fields

Name Description Type
id ID UUID
html_url Management URL String
name Name String
registration_number Registration number String
code Code String
active Status Boolean
fisherman Owner String
imo IMO String
official_number Official number String
year_built Year built Integer
flag Flag ISO3166-1 Alpha 3 code
port_of_registry Port of registry String
gross_tonnage Gross tonnage (GT) Decimal
length_overall Length overall (LOA, in meters) Decimal
beam Beam (in meters) Decimal
deadweight_tonnage Deadweight tonnage (DT) Decimal
horsepower Horsepower (HP) Integer
comments Comments String
metadata Metadata JSON
created_date_time Created date/time ISO8601 date/time
created_by_name Name of creating user String
updated_date_time Updated date/time ISO8601 date/time
updated_by_name Name of updating user String

Status

200

Headers

Content-Type: application/json; charset=utf-8
X-Request-Id: 226c4e3b-e705-4c06-ac23-084725957e85

Body

{
  "data": {
    "id": "e735e069-eb3a-4ae4-a83c-070bbcba4a67",
    "html_url": "/management/account/vessels/cb96c9e5d24b",
    "name": "Freeport",
    "registration_number": "K133902",
    "code": "072",
    "active": true,
    "fisherman": "John",
    "imo": "IMO.1234",
    "official_number": "9988",
    "year_built": 2003,
    "flag": "CAN",
    "port_of_registry": "Port of Vancouver",
    "gross_tonnage": 12.25,
    "length_overall": 15.2,
    "beam": 4.1,
    "deadweight_tonnage": 2.55,
    "horsepower": 250,
    "comments": null,
    "metadata": {
      "foo": "baaar"
    },
    "created_date_time": "2018-08-01T00:00:00Z",
    "created_by_name": "Ronnie Pfannerstill",
    "updated_date_time": "2020-06-22T19:38:19Z",
    "updated_by_name": "Ronnie Pfannerstill"
  }
}