The sections below describe the information necessary to create, get and update a NFPS event.

Change history
Date Change Schema Schema Valid From Schema Valid To
21/12/2018

Released to production

11/06/2018

nfpsDateTime field is now outside the location array

nfpsCatchLocation is renamed nfpsLocation

nfpsLocation is now mandatory if FishingEventID is not provided

v2 01/07/2018
18/05/2017 Initial publication v1 01/10/2017 30/09/2018

For UAT schema valid dates click here.

Create

Request URL:

POST https://ers.uat.kupe.fishserve.co.nz/api/{clientNumber}/event/{schemaEdition}/non-fish-or-protected-species/{eventID}

Example:

POST https://ers.uat.kupe.fishserve.co.nz/api/1234567/event/v1/non-fish-or-protected-species/5ba04c30-c81a-4618-898e-e832da93cf91

Create URL Parameters:

ParameterRequiredData typeValidation and Additional Notes
Client Number Mandatory String The main permit holder client number that the event is submitted against.
Schema Edition Mandatory String The API schema used for the format of the submitted data. For example, v1 or v2.
Event ID Mandatory String Unique logbook generated ID for an event.

Request Header:

Content-Type: application/json
Signature: signature generated from the digital signature algorithm using the request body and private key.

Request Body Parameters:

ParameterRequiredData TypeValidation and Additional Notes
Event Header Mandatory Event Header Set See Event Header Properties below.
Fishing Event ID Optional String The ID of the fishing event where the NFPS were caught.
NFPS Date Time Mandatory String Date 24 hr + UTC Offset.
NFPS Catch Location Mandatory Geolocation Set See Geolocation Set Parameters below.
Non Fish or Protected Species Catches Mandatory Array of NFPS catches records See Non Fish or Protected Species Catches Parameters below.

Must provide at least one non fish or protected species catch.

Event Header Properties:

ParameterRequiredData TypeValidation and Additional Notes
Event ID Mandatory String Unique logbook generated ID for an event.

The same event ID as defined in the URL.

Trip ID Mandatory String
Software Vendor Mandatory String Your software vendor name. For example, e-logbook.
Software Version Mandatory String Your software version number. For example, 1.0.0.0
Software Installation Id Mandatory String

Your software installation ID. For example, a13afab2-c409-4622-b8f8-146996587809

Must be the Software Installation Id that was registered with the user and public key.

Completer User Id Mandatory String The user ID retrieved from registering the logbook.
Client Number Mandatory String Must be a valid client number. Must be the same client number as specified in the URL.
Is Vessel Used Mandatory Boolean Identifies if the fishing took place on a vessel or not.
Vessel Number Mandatory String

Must be a valid Vessel number.

Must be provided if 'Is Vessel Used' = True.

Must be provided if 'Fishing Methods' master data property 'require_vessel_number = true'.

If 'Is Vessel Used' = False and Vessel Number provided, ERS will not accept the event.

Notes Optional String The Fisher may record additional information relating to the event.
Completed Date Time Conditional String Must be provided for Create. Must be null for Update. ERS will not accept the event if provided for update.

Date 24hr + UTC offset.

Amendment Reason Conditional String Must be provided for Update.

Must be null for Create. ERS will not accept the event if provided for create.

Geolocation Set Parameters:

ParameterRequiredData TypeValidation and Additional Notes
System Date Time Mandatory String Date 24 hr + UTC Offset.
Manual Date Time Optional String Date 24 hr + UTC Offset.
System Location Conditional Geolocation At least one group of system or manual location parameters must be provided if fishing event Id is not provided, otherwise optional.

See Geolocation parameters below.

Manual Location Conditional Geolocation

Geolocation Parameters:

ParameterRequiredData TypeValidation and Additional Notes
Latitude Mandatory decimal degrees

System Location: Minimum of 4dp required.

Manual Location: Minimum of 3dp required.

Longitude Mandatory decimal degrees 

System Location: Minimum of 4dp required.

Manual Location: Minimum of 3dp required.

Non Fish or Protected Species Catches Parameters:

ParameterRequiredData TypeValidation and Additional Notes
Species Code Mandatory String Must be a valid species NFPS species code.

Validated against the NFPS master data.

Seabird Capture Code Optional String

Validated againt Seabird Capture Codes master data property 'Seabird_Capture_Code'.

Must not be provided if NFPS master data property 'is_seabird' is not true.

Estimated Weight Kg Conditional Number

Decimal to 2dp.

Must be greater than 0.

Must be provided if 'NFPS' master data property 'measured_by = weight'.

Number Uninjured Conditional Number

Must be a whole number.

Must be provided if 'NFPS' master data property 'measured_by = count'.

At least one of Number Uninjured, Number Injured or Number Dead must be provided.
Number Injured Conditional Number
Number Dead Conditional Number
Tag Optional Array of Strings NFPS tag number.

NFPS Create Request Body Example:

{
  "eventHeader": {
    "eventId": "NFPS111",
    "vesselNumber": "1",
    "isVesselUsed": true,
    "completedDateTime": "2017-03-28T09:15:00+11:00",
    "tripId": "123",
"softwareVendor": "ERS-FishServe",
"softwareVersion": "1.1.2",
"softwareInstallationId": "a13afab2-c409-4622-b8f8-146996587809",
"clientNumber": "1234567",
"completerUserId": "1234" }, "fishingEventId": "12345", "nfpsDateTime": "2018-05-08T10:10:23+13:00", "nfpsCatchLocation": { "systemDateTime": "2017-10-29T10:10:23+13:00", "systemLocation": { "longitude": 171.547517, "latitude": -41.587613 }, "manualDateTime": "2017-10-29T10:11:11+13:00", "manualLocation": { "longitude": 171.643363, "latitude": -41.551760 } }, "nonFishOrProtectedSpeciesCatches": [ { "speciesCode": "ACN", "estimatedWeightKg": 182.23, "numberUninjured": null, "numberInjured": null, "numberDead": null, "tags": null }, { "speciesCode": "XYP",
"seabirdCaptureCode": "W", "estimatedWeightKg": null, "numberUninjured": 0, "numberInjured": 0, "numberDead": 1, "tags": ["SG101"] } ] }

Response

Response Status:

StatusDescription
201 Created Status when event has been accepted successfully.
400 Bad Request Status when there are missing headers, missing event parameters, duplicate event ID.
401 Unauthorised Status when the user does not have the appropriate authorisation to perform the action.

Response Parameters:

The response parameters includes all the fields that have been included in the request body and the following additional parameters.

ParameterData TypeValidation and Additional Notes
Errors Array List of errors, if any. See Errors Parameters below.

Errors Parameters:

ParameterData TypeValidation and Additional Notes
Property Name String The name of the property that has an error.
Attempted Value String The attempted value used.
Error Code String The type of error.
Error Message String The description of the error.

Example 1:

The following example of the response body is returned when there are no errors and the event is accepted (Status Code – 201).

{
 "errors": []
}

Example 2:

The following example of the response body is returned when there are errors and the event is rejected (Status Code – 400).

{
  "errors": [
    {
      "propertyName": "EventId",
      "attemptedValue": "5ba04c30-c81a-4618-898e-e832da93cf91",
      "errorCode": "DuplicateValue",
      "errorMessage": "EventId already exists."
    }
  ]
}

Get

Request URL:

GET https://ers.uat.kupe.fishserve.co.nz/api/{clientNumber}/event/{schemaEdition}/non-fish-or-protected-species/{eventID}?softwareInstallationId={softwareInstallationId}&CompleterUserId={completerUserId}

Example:

GET https://ers.uat.kupe.fishserve.co.nz/api/1234567/event/v1/non-fish-or-protected-species/EventId099?softwareInstallationId=74be4716-cd8f-4264-83e4-5b1249082900&CompleterUserId=8979

Get URL Parameters:

ParameterRequiredData typeValidation and Additional Notes
Client Number Mandatory String The main permit holder client number that the event is submitted against.
Schema Edition Mandatory String The API schema used for the format of the submitted data. For example, v1 or v2.
Event ID Mandatory String Unique logbook generated ID for an event.
Software Installation Id Mandatory String

Your software installation ID. For example, a13afab2-c409-4622-b8f8-146996587809

Must be the Software Installation Id that was registered with the user and public key.

Completer User Id Mandatory String The user ID retrieved from registering the logbook.

Request Header:

Content-Type: application/json
Signature: signature generated from the digital signature algorithm using the request body and private key.

Response

Response Status:

StatusDescription
200 Ok Status when event has been retrieved successfully.
404 Not Found Status when event cannot be found.
401 Unauthorised Status when the user does not have the appropriate authorisation to perform the action.

Response Body Parameters:

Properties are returned within an Event parameter. Please see the example provided.

ParameterData Type
Event ID String
Trip ID String
Schema Edition Number
Event Version Number
Is Vessel Used Boolean
Vessel Number String
Notes String
Completed By Name String
NFPS Date Time String
NFPS Catch Location

See Geolocation Set Parameters below.

Geolocation Set
Completed Date Time String
Errors Array
Amendment Reason String

Fishing Event ID

String

Non Fish or Protected Species Catches

See Non Fish or Protected Species Catches Parameters below.

Array of NFPS catches records

Geolocation Set Parameters:

ParameterData Type
System Date Time String
Manual Date Time String

System Location

See Geolocation Parameters below.

Geolocation

Manual Location

See Geolocation Parameters below.

Geolocation

Geolocation Parameters:

ParameterData Type
Latitude decimal degrees
Longitude decimal degrees

Non Fish or Protected Species Catches Parameters:

ParameterData Type
Species Code String
Seabird Capture Code String
Estimated Weight Kg Number
Number Uninjured Number
Number Injured Number
Number Dead Number
Tag Array of Strings

NFPS Get Request Body Example:

  {
    "event": {
"fishingEventID": "12345", "nfpsDateTime": "2018-05-08T10:10:23+13:00", "nfpsCatchLocation": { "systemDateTime": "2017-05-01T08:00:00+13:00", "systemLocation": { "longitude": -175.5423, "latitude": -45.9880 }, "manualDateTime": "2017-05-01T08:00:00+13:00", "manualLocation": { "longitude": -175.542, "latitude": -45.988 } }, "nonFishOrProtectedSpeciesCatches": [ { "speciesCode": "ACN", "seabirdCaptureCode": null, "estimatedWeightKg": 182.23, "numberUninjured": null, "numberInjured": null, "numberDead": null, "tags": null }, { "speciesCode": "atp", "seabirdCaptureCode": null, "estimatedWeightKg": 1.4, "numberUninjured": 2, "numberInjured": 3, "numberDead": 5, "tags": [ "SG101", "SG105", "SG305", "SG501", "SG111" ] } ], "tripId": "123", "vesselNumber": "1", "isVesselUsed": true, "eventId": "NFPS111", "schemaEdition": 1, "eventVersion": 1, "clientNumber": "8491346", "completedDateTime": "2017-03-28T09:15:00+11:00", "notes": null, "amendmentReason": null,
"completedByName": "Dirk Munroe" }, "errors": [] }

Update

Request URL:

PUT https://ers.uat.kupe.fishserve.co.nz/api/{clientNumber}/event/{schemaEdition}/non-fish-or-protected-species/{eventID}

Example:

PUT https://ers.uat.kupe.fishserve.co.nz/api/1234567/event/v1/non-fish-or-protected-species/5ba04c30-c81a-4618-898e-e832da93cf91

Update URL Parameters:

ParameterRequiredData typeValidation and Additional Notes
Client Number Mandatory String The main permit holder client number that the event is submitted against.
Schema Edition Mandatory String The API schema used for the format of the submitted data. For example, v1 or v2.
Event ID Mandatory String Unique logbook generated ID for an event.

Request Header:

Content-Type: application/json
Signature: signature generated from the digital signature algorithm using the request body and private key.

Request Body Parameters:

The request body parameters includes all those fields that have been defined in the create event and the following additional parameter.

This parameter is a property of the Event Header Set.

The amended value of the fields that need to be updated will be passed in the request body.

ParameterRequiredData TypeValidation and Additional Notes
Event Version Mandatory Number

The version of the event that the fisher is wanting to update.

Can only update the latest version of an event.

NFPS Update Request Body Example:

  
{
  "eventHeader": {
    "eventId": "NFPS1",
    "vesselNumber": "1",
    "isVesselUsed": true,
    "eventVersion": 1,
    "tripId": "TS1",
    "amendmentReason": "Estimated weight for ACN recorded incorrectly",
    "notes":"NFPS Update",
"softwareVendor": "ERS-FishServe",
"softwareVersion": "1.1.2",
"softwareInstallationId": "a13afab2-c409-4622-b8f8-146996587809",
"clientNumber": "1234567",
"completerUserId": "1234" }, "fishingEventId": "12345", "nfpsDateTime": "2018-05-08T10:10:23+13:00", "nfpsCatchLocation": { "systemDateTime": "2017-05-01T08:00:00+13:00", "systemLocation": { "longitude": -175.5423, "latitude": -45.9880 }, "manualDateTime": "2017-05-01T08:00:00+13:00", "manualLocation": { "longitude": -175.542, "latitude": -45.988 } }, "nonFishOrProtectedSpeciesCatches": [ { "speciesCode": "ACN", "estimatedWeightKg": 187.23, "numberUninjured": null, "numberInjured": null, "numberDead": null, "tags": null }, { "speciesCode": "XYP",
"seabirdCaptureCode": "W", "estimatedWeightKg": null, "numberUninjured": 0, "numberInjured": 0, "numberDead": 1, "tags": ["SG101"] } ] }

Response

Response Status:

StatusDescription
200 Ok Status when event has been updated successfully.
400 Bad Request Status when event failed to update. This can be as a result of the event version not matching the correct version of the message in the update request or missing headers, missing event parameters.
401 Unauthorised Status when the user does not have the appropriate authorisation to perform the action.

Response Parameters:

The response parameters includes all the fields that have been included in the request body and the following additional parameters.

ParameterData TypeValidation and Additional Notes
Errors Array List of errors, if any. See Errors Parameters below.

Errors Parameters:

ParameterData TypeValidation and Additional Notes
Property Name String The name of the property that has an error.
Attempted Value String The attempted value used.
Error Code String The type of error.
Error Message String The description of the error.

Example 1:

{
 "errors": []
}

Example 2:

{
  "errors": [
  {
   "propertyName": "EventVersion",
   "attemptedValue": "2",
   "errorCode": "InvalidValue",
   "errorMessage": "You are not amending the most recent version for this event. Please get the latest version and try again."
  }
 ]
}

Back to top