FishServe - ERS Master Data APIs in Production

ERS Master Data APIs in Production

Below is the technical information required for submitting ERS Master Data APIs in our production environment.

Our production URL is: https://ers.kupe.fishserve.co.nz/

All of these APIs are available for testing and developing against in our UAT environment. Do not use the production environment for testing your applications.

Our UAT URL is: https://ers.uat.kupe.fishserve.co.nz/

ERS Master Data APIs

Fishing Methods
Species Codes
Stock Codes
Non Fish Protected Species
Conversion Factors
Product States
Landing Codes
Mitigation Devices
Disposal Codes
Container Types
Shark Fin Ratios
Seabird Capture Codes
Breath Mode Codes
Secondary Validation Rules
PAUA Statistical Areas Master Data
SPRFMO VME organisms Master Data
Mitigation Device Codes for Fishing Methods Master Data

Fishing Methods Master Data

The sections below describe the information necessary to retrieve the Fishing Methods Master Data.

FishCarrier (FC) is returned in the list of fishing methods, but has no associated event type start date, so should not be considered as a valid fishing method.

**Change history**
Date	Change
03/04/2019	Add end_date example to fishing method master data. Added 'require_hook_space' parameter. Added Breath Mode Codes master data.
28/06/2018	Added 'require_fyke_nets_baited' parameter. Added 'require_autolining' parameter. Added 'require_number_of_fish' parameter.

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

 GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/fishing-methods/min

Request URL – ERS Data Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/fishing-methods/min?modifiedAfter={datefromlogbookapp}

Example:

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/fishing-methods/min?modifiedAfter=2017-04-10T16:57%2B12:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
code	String	Fishing method short code
name	String	The name of the fishing method
modified	String	Date last modified
require_net_details	Boolean	Indicates the fishing methods that has to provide the parameter 'Total Net Length and Warps Metres'. Used for the Seining fishing events.
require_spotter_used	Boolean	Indicates the fishing method that has to provide the parameter 'Is Spotter Used' . Used for the Seining fishing events.
require_rope_details	Boolean	Indicates the fishing method that has to provide the parameter 'Ground Rope Length Metres'. Used for Seining fishing events.
require_lines_hauled	Boolean	Indicates the fishing method that has to provide the parameter 'Number of Lines Hauled'. Used for Lining fishing events.
require_dredging_details	Boolean	Indicates the fishing method that has to provide the parameters 'Dredge Width Metres' and 'Number of Tows Completed' . Used for Dredging fishing events.
require_number_of_lifts	Boolean	Indicates the fishing method that has to provide the parameter 'Number of Lifts'. Used for Seining fishing events.
require_seabird_capture_details	Boolean	Indicates the fishing methods that have to provide the parameter 'Seabird Capture Details'. Can be used in all fishing events.
require_vessel_number	Boolean	Indicates the fishing methods that have to provide the parameter 'Vessel Number'. Can be used in all fishing events.
require_fyke_nets_baited	Boolean	Indicates the fishing methods that have to provide the parameter 'Fyke Nets Baited'. Used for Potting fishing events.
require_autolining	Boolean	Indicates the fishing methods that have to provide the parameter 'Autolining'. Used for Lining fishing events.
require_number_of_fish	Boolean	Indicates the fishing methods that have to provide the parameter 'Number of Fish'. Used for Other-lining fishing events.
require_hook_space	Boolean	Indicates the fishing methods that have to provide the parameter 'Hook Space Metres'. Used for Lining fishing events.
[method name]_start_date	String	Start date of the approved fishing method
[method name]_end_date	String	End date of the approved fishing method

Fishing Methods Get Request Body Example:

  {    "type-code": "fishing-methods",
        "items": [
    
        {
         "code": "BS",
         "name": "Beach Seine / Drag Net",
         "modified": "2017-05-15T12:00:37+12:00",
         "require_net_details": "true",
         "seining_start_date": "2017-03-01T00:00:00+13:00"
        },
    
        {
        "code": "D",   
        "name": "Dredge",
        "modified": "2017-05-15T12:00:37+12:00",
        "require_dredging_details": "true",
        "dredging_start_date": "2017-03-01T00:00:00+13:00"
        },   
    
        {
        "code": "DL",
        "name": "Dahn Line",
        "modified": "2017-05-15T12:00:37+12:00",
        "require_lines_hauled": "true",
        "require_seabird_capture_details": "true", 
        "require_vessel_number": "true", 
        "lining_start_date": "2017-03-01T00:00:00+13:00"
        },
     
        {
        "code": "DPN", 
        "name": "Dip Net",
        "modified": "2017-05-15T12:00:37+12:00",
        "require_number_of_lifts": "true",
        "seining_start_date": "2017-03-01T00:00:00+13:00"
        },
     
        { 
        "code": "DS",
        "name": "Danish Seine",
        "modified": "2017-05-15T12:00:37+12:00",
        "require_net_details": "true",
        "require_rope_details": "true",
        "require_vessel_number": "true",
        "seining_start_date": "2017-03-01T00:00:00+13:00"
         },

        {
        "code": "DI",
        "name": "Diving",
        "modified": "2018-12-12T14:18:42+13:00",
        "diving_start_date": "2018-07-01T00:00:00+00:00",
        "diving_end_date": "2019-01-10T00:00:00+13:00"
        },    

        {
        "code": "BLL",
        "name": "Bottom Long Line",
        "require_autolining": "true",
        "require_hook_space": "true",
        "require_seabird_capture_details": "true", 
        "require_vessel_number": "true", 
        "modified": "2017-05-15T12:00:37+12:00",
        "lining_start_date": "2017-03-01T00:00:00+13:00"
        },
    
        {
        "code": "BPT", 
        "name": "Bottom Pair Trawl",
        "require_seabird_capture_details": "true", 
        "require_vessel_number": "true",  
        "modified": "2017-05-15T12:00:37+12:00",
        "trawl_start_date": "2017-03-01T00:00:00+13:00"
         }
      ]  
  }

Fish Species Codes Master Data

The sections below describe the information necessary to retrieve a list of available fish species codes.

Change History

Date	Change
04/07/2018	Add new parameter Related_stock.

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/fish-species/min?datetype=ers

Request URL – ERS Date Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/fish-species/min?modifiedAfter={datefromlogbookapp}&datetype=ers

Example:

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/fish-species/min?modifiedAfter=2017-04-05T12:43:47%2B12:00&datetype=ers

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
code	String	Species code
name	String	Name of the species
modified	String	Date last modified
cf_category	String	Category of fish species. e.g. FinFish, shark.
related_stock	String	Indicates which fish stock the fish species should be reported as in disposals and landings. If the species code does not have a matching Quota Management Area stock code the related stock field will be populated. Example: when 'Yellowfoot Paua' caught in area 1 it is reported in estimated catches or processing events as fish species code 'PAA' it must be reported as fish stock 'PAU1' on disposals and landings.
require_boat_person_used	Boolean	Indicates if the parameter 'Was Boat Person Used' must be provided for the fish species.
not_allowed_for_diving	Boolean	Indicates whether or not the fish species may be used for a Diving event.
ers_start_date	String	Date from when this species code can be used for electronic reporting
ers_end_date	String	Date from when this species code can no longer be used for electronic reporting

Fish Species Codes Get Request Body Example:

   {
    "type-code": "fish-species",
    "items": [
        {
            "code": "CRA",
            "name": "Spiny Red Rock Lobster",
            "modified": "2017-06-26T15:06:01+12:00",
            "ers_start_date": "1996-10-01T00:00:00+12:00"
        },
        {
            "code": "DPO",
            "name": "Dealfish",
            "modified": "2017-06-26T15:06:01+12:00",
            "ers_start_date": "2016-12-30T00:00:00+13:00"
        },
        {
            "code": "ELE",
            "name": "Elephant Fish",
            "modified": "2017-06-26T15:06:01+12:00",
            "cf_category": "Shark",
            "ers_start_date": "1996-10-01T00:00:00+12:00"
        },
        {
            "code": "GSH",
            "name": "Ghost Shark",
            "modified": "2017-06-26T15:06:01+12:00",
            "cf_category": "Shark",
            "ers_start_date": "1996-10-01T00:00:00+12:00"
        },
        {
            "code": "PAI",
            "name": "Blackfoot Paua",
            "modified": "2017-06-26T15:06:02+12:00",
            "related_stock": "PAU",
            "require_boat_person_used": "true",
            "ers_start_date": "1996-10-01T00:00:00+12:00"
        },
        {
            "code": "PAU",
            "name": "Black Paua & Yellowfoot Paua",
            "modified": "2017-06-26T15:06:02+12:00",
            "not_allowed_for_diving": "true",
            "require_boat_person_used": "true",
            "ers_start_date": "1996-10-01T00:00:00+12:00"
        },
        {
            "code": "SPO",
            "name": "Rig",
            "modified": "2017-06-26T15:06:02+12:00",
            "cf_category": "Shark",
            "ers_start_date": "1996-10-01T00:00:00+12:00"
        },
        {
            "code": "YBF",
            "name": "Yellowbelly Flounder",
            "modified": "2017-06-26T15:06:02+12:00",
            "cf_category": "Finfish",
            "related_stock": "FLA",
            "ers_start_date": "1996-10-01T00:00:00+12:00"
        },
    ]
}

Fish Stock Codes Master Data

The sections below describe the information necessary to retrieve a list of available fish stock codes

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/fish-stock/min?datetype=ers

Request URL – ERS Data Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/fish-stock/min?modifiedAfter={datefromlogbookapp}&datetype=ers

Example:

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/fish-stock/min?modifiedAfter=2017-04-05T12:43:47%2B12:00&datetype=ers

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
code	String	Stock code
name	String	Name of the stock
parent_code	String	Species code of the stock
modified	String	Date last modified
ers_start_date	String	Date from when this stock code can be used for electronic reporting
ers_end_date	String	Date from when this stock code can no longer be used for electronic reporting
quota_start_date	String	Date when this stock code became a quota stock
quota_end_date	String	Date when this stock code is no longer a quota stock

Fish Stock Codes Get Request Body Example:

 {
        "type-code": "fish-stock",
	"items": [
                 {
                 "code": "ABR1",
                 "name": "Shortsnouted Lancetfish Fishery Management Area 1",
                 "parent_code": "ABR",
                 "modified": "2017-08-25T14:08:58+12:00",
                 "ers_start_date": "2004-07-13T00:00:00+12:00"
                 },                 
                 {
                 "code": "ANC1",
                 "name": "Anchovy Fishery Management Area 1",
                 "parent_code": "ANC",
                 "modified": "2017-08-25T14:08:58+12:00",
                 "ers_start_date": "1986-10-01T00:00:00+12:00",
                 "quota_start_date": "2002-10-01T00:00:00+12:00"
                },
                {
                "code": "BAN9",
                "name": "Borostomias Antarcticus Fishery Management Area 9",
                "parent_code": "BAN",
                "modified": "2017-08-25T14:09:00+12:00",
                "ers_start_date": "2001-05-10T00:00:00+12:00"
                },
                {
                "code": "CRA1",
                "name": "Spiny Red Rock Lobster Quota Management Area 1",
                "parent_code": "CRA",
                "modified": "2017-08-25T14:09:09+12:00",
                "ers_start_date": "1986-10-01T00:00:00+12:00",
                "quota_start_date": "1990-04-01T00:00:00+12:00"
                },
                {
                "code": "CRA10",
                "name": "Spiny Red Rock Lobster Quota Management Area 10",
                "parent_code": "CRA",
                "modified": "2017-08-25T14:09:09+12:00",
                "ers_start_date": "1986-10-01T00:00:00+12:00",
                "quota_start_date": "1990-04-01T00:00:00+12:00"
                },
                {
                "code": "HOK1",
                "name": "Hoki Fishery Management Areas 1-9",
                "parent_code": "HOK",
                "modified": "2017-08-25T14:09:20+12:00",
                "ers_start_date": "1986-10-01T00:00:00+12:00",
                "quota_start_date": "1986-10-01T00:00:00+12:00"
                }
	]
 }

Non-Fish Protected Species Master Data

Used to retrieve a list of non-fish/protected species codes.

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/nfps/min

Request URL – ERS Data Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/nfps/min?modifiedAfter={datefromlogbookapp}

Example:

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/nfps/min?modifiedAfter=2017-04-10T16:57%2B12:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
code	String	Non-fish/protected species code
name	String	Non-fish/protected species name
modified	String	Date last modified
is_seabird	Boolean	Indicates for which codes the seabird capture details are required to be provided in trawl events If is_seabird is 'Yes' then 'Seabird Capture Details' is mandatory.
measured_by	String	Indicates which unit of measurement (count or weight) needs to be provided for the NFPS species code reported.
start_date_time	String	Date from when this non-fish/protected species code can be used in fishing or non-fish/protected species events
end_date_time	String	Date from when this non-fish/protected species code can no longer be used in fishing or non-fish/protected species events

Non-Fish Protected Species Get Request Body Example:

	{ 	"type-code": "nfps",
		"items": [
		{
		"code": "ACN",
		"name": "Bushy bamboo coral",
		"modified": "2017-05-17T19:42:59+12:00",
		"measured_by": "weight",
		"start_date_time": "2015-04-01T00:00:00+13:00"
		},
		{
		"code": "FUG",
		"name": "Fungiacyathus spp.",
		"modified": "2017-05-17T19:42:59+12:00",
		"measured_by": "weight",
		"start_date_time": "2015-04-01T00:00:00+13:00"
		},
		{
		"code": "FUR",
		"name": "New Zealand fur seal",
		"modified": "2017-05-17T19:42:59+12:00",
		"measured_by": "count",
		"start_date_time": "2015-04-01T00:00:00+13:00"
		},
		{
		"code": "HDM",
		"name": "Maui's dolphin",
		"modified": "2017-05-17T19:42:59+12:00",
		"measured_by": "count",
		"start_date_time": "2015-04-01T00:00:00+13:00"
		},
		{
		"code": "ORT",
		"name": "Olive ridley turtle",
		"modified": "2017-05-17T19:42:59+12:00",
		"measured_by": "count",
		"start_date_time": "2015-04-01T00:00:00+13:00"
		},
		{
		"code": "SRW",
		"name": "Southern right whale",
		"modified": "2017-05-17T19:42:59+12:00",
		"measured_by": "count",
		"start_date_time": "2015-04-01T00:00:00+13:00"
		},
		{
		"code": "XWM",
		"name": "White-capped albatross",
		"modified": "2017-05-17T19:42:59+12:00",
		"is_seabird": "true",
		"measured_by": "count",
		"start_date_time": "2015-04-01T00:00:00+13:00"
		},
		{
		"code": "XWP",
		"name": "Westland petrel",
		"modified": "2017-05-17T19:42:59+12:00",
		"is_seabird": "true",
		"measured_by": "count",
		"start_date_time": "2015-04-01T00:00:00+13:00"
		},
		{
		"code": "YSS",
		"name": "Yellow-bellied sea snake",
		"modified": "2017-05-17T19:42:59+12:00",
		"measured_by": "count",
		"start_date_time": "2015-04-01T00:00:00+13:00"
		}
	  ]
	}

Conversion Factors Master Data

Used to retrieve a list of available conversion factors.

GET

Request

Request URL – ERS Data Set:

Use this URL to retrieve the ERS master data list of all species conversion factors.

GET https://ers.uat.kupe.fishserve.co.nz/api/lookup/conversion-factors

A {date-as-at} parameter can be added to the end of the URL to return conversion factors valid at the specified date.

If no {date-as-at} parameter is provided, then the current date is used to retrieve the result set.

Request URL - ERS Data Set, {date-as-at}:

GET https://ers.uat.kupe.fishserve.co.nz/api/lookup/conversion-factors/{date-as-at}

Request URL - ERS Data Set Modified After:

Use the following query, if you would only like to retrieve all species conversion factors that have been changed since the last time the master data list was requested.

GET http://ers.uat.kupe.fishserve.co.nz/api/lookup/conversion-factors/{date-as-at}/?modifiedAfter={datefromlogbookapp}

Example:

GET https://ers.uat.kupe.fishserve.co.nz/api/lookup/conversion-factors/2017-06-20/?modifiedAfter=2017-06-26T15:09:13

Species Specific

Request URL – ERS Data Set for a Species:

Use this URL to retrieve the ERS master data list of conversion factors for a specific species only.

GET https://ers.uat.kupe.fishserve.co.nz/api/lookup/conversion-factors/{date-as-at}/{speciescode}

Example:

GET https://ers.uat.kupe.fishserve.co.nz/api/lookup/conversion-factors/2017-05-19/hok

Request URL –ERS Data Set Modified After for a Species:

Use the following query, if you would only like to retrieve conversion factors that have changed for a specific species since the last time the master data list was requested.

GET https://ers.uat.kupe.fishserve.co.nz/api/lookup/conversion-factors/{date-as-at}/{speciescode}?modifiedAfter={datefromlogbookapp}

Example:

GET https://ers.uat.kupe.fishserve.co.nz/api/lookup/conversion-factors/2017-06-20/spo?modifiedAfter=2017-06-19T19:49:54%2B12:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
Species Code	String	Species short code.
Product State Code	String	Product state short code. The state of the product following any processing event.
Conversion Factor	Number	Decimal, 2dp Used to convert the weight of a product from a processed state to the original green weight. If a conversion factor does not exist for a species/product state combination then the combination is not valid.
Start Date Time	String	Date from when this species conversion factor is valid.
Modified	String	Date last modified.
End Date Time	String	Date from when this species conversion factor is no longer valid.

Conversion Factors Get Request Body Example:

 [
    {
        "species_code": "ALB",
        "product_state_code": "GGO",
        "start_date_time": "2014-09-27T00:00:00+12:00",
        "conversion_factor": 1.1,
        "modified": "2017-06-29T08:48:07+12:00"
    },
    {
        "species_code": "ALB",
        "product_state_code": "GGT",
        "start_date_time": "2014-09-27T00:00:00+12:00",
        "conversion_factor": 1.15,
        "modified": "2017-06-29T08:48:07+12:00"
    },
    {
        "species_code": "BNS",
        "product_state_code": "DRE",
        "start_date_time": "2014-09-27T00:00:00+12:00",
        "conversion_factor": 1.7,
        "modified": "2017-06-29T08:48:06+12:00"
    },
    {
        "species_code": "BNS",
        "product_state_code": "FIL",
        "start_date_time": "2014-09-27T00:00:00+12:00",
        "conversion_factor": 2.25,
        "modified": "2017-06-29T08:48:06+12:00"
    },
    {
        "species_code": "CHC",
        "product_state_code": "LEG",
        "start_date_time": "2014-09-27T00:00:00+12:00",
        "conversion_factor": 2.8,
        "modified": "2017-06-29T08:48:07+12:00"
    },
    {
        "species_code": "JDO",
        "product_state_code": "DRE",
        "start_date_time": "2014-09-27T00:00:00+12:00",
        "conversion_factor": 1.85,
        "modified": "2017-06-29T08:48:06+12:00"
    },
    {
        "species_code": "JDO",
        "product_state_code": "FIL",
        "start_date_time": "2014-09-27T00:00:00+12:00",
        "conversion_factor": 2.6,
        "modified": "2017-06-29T08:48:06+12:00"
    },
    {
        "species_code": "JDO",
        "product_state_code": "SKF",
        "start_date_time": "2014-09-27T00:00:00+12:00",
        "conversion_factor": 3.2,
        "modified": "2017-06-29T08:48:06+12:00"
    },
    {
        "species_code": "YBF",
        "product_state_code": "GUT",
        "start_date_time": "2017-03-01T00:00:00+13:00",
        "conversion_factor": 1.1,
        "modified": "2017-06-29T08:48:07+12:00"
    },
    {
        "species_code": "YBF",
        "product_state_code": "SKF",
        "start_date_time": "2014-09-27T00:00:00+12:00",
        "conversion_factor": 2.25,
        "modified": "2017-06-29T08:48:07+12:00"
    },
    {
        "species_code": "YFN",
        "product_state_code": "GGT",
        "start_date_time": "2014-09-27T00:00:00+12:00",
        "conversion_factor": 1.15,
        "modified": "2017-06-29T08:48:07+12:00"
    }
]

Products States Master Data

Used to retrieve a list of available product states.

GET

Request

Request URL –ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/product-states/min

Request URL - ERS Data Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/product-states/min?modifiedAfter={datefromlogbookapp}

Example:

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/product-states/min?modifiedAfter=2017-04-28T16:57%2B12:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
Code	String	Product state short code.
Name	String	Description of the product state.
Product State Type	String	Whether the product state is a principal or additional state type.
Start Date Time	String	Date from when this product state is valid.
Modified	String	Date last modified.
End Date Time	String	Date from when this product state is no longer valid.
Allow Multiple Fish Codes	Boolean	Indicates the product state codes which allow multiple species codes within the species array in the Processing API.
Require Conversion Factor	Boolean	Indicates the product state codes which require conversion factors in the Processing API.
Require Greenweight	Boolean	Indicates the product state codes which require a greenweight value in the Processing & Landing API.
Require Shark Fins Weight	Boolean	Indicates the product state codes which require a greenweight value in the Landing API.

Product States Get Request Body Example:

{
    "type-code": "product-states",
    "items": [
        {
            "code": "BEA",
            "name": "Beak and mouth/Bills",
            "modified": "2017-06-12T13:42:30+12:00",
            "product_state_type": "Additional",
            "start_date_time": "1994-10-01T00:00:00+12:00"
        },
        {
            "code": "DRE",
            "name": "Dressed",
            "modified": "2017-06-12T13:42:30+12:00",
            "product_state_type": "Principal",
            "require_conversion_factor": "true",
            "require_greenweight": "true",
            "start_date_time": "1990-10-01T00:00:00+12:00"
        },
        {
            "code": "FIL",
            "name": "Fillets: skin-on",
            "modified": "2017-06-12T13:42:30+12:00",
            "product_state_type": "Principal",
            "require_conversion_factor": "true",
            "require_greenweight": "true",
            "start_date_time": "1986-10-01T00:00:00+12:00"
        },
        {
            "code": "FIN",
            "name": "Fins",
            "modified": "2017-06-12T13:42:30+12:00",
            "product_state_type": "Principal",
            "require_conversion_factor": "true",
            "require_greenweight": "true",
            "start_date_time": "1993-10-01T00:00:00+12:00"
        },
        {
            "code": "FIT",
            "name": "Fish Tails",
            "modified": "2017-06-12T13:42:30+12:00",
            "product_state_type": "Additional",
            "start_date_time": "2001-04-05T00:00:00+12:00"
        },
	      {
            "code": "SHF",
            "name": "Shark Fins",
            "modified": "2017-06-12T13:42:30+12:00",
            "product_state_type": "Additional",
            "require_shark_fins_weight": "true",
            "start_date_time": "2008-12-26T00:00:00+13:00"
        }
    ]
}

Landing Codes Master Data

Used to retrieve a list of available landing codes.

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/landing-codes/min

Request URL – ERS Data Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/landing-codes/min?modifiedAfter={datefromlogbookapp}

Example:

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/landing-codes/min?modifiedAfter=2017-04-10T16:57%2B12:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
code	String	Landing code
name	String	Description of landing code
modified	String	Date last modified
start_date_time	String	Date from when this landing code can be used in a landing event
end_date_time	String	Date from when this landing code can no longer be used in a landing event
require_LFR_number	Boolean	Indicates the landing code that must provide a 'LFR Client Number' in the Landing API.
require_vessel_number	Boolean	Indicates the landing code that must provide a 'Tranship Vessel Number' in the Landing API.
require_holding_location	Boolean	Indicates the landing code that must provide the Holding Receptacle details in the Landing API.
require_purchase_order	Boolean	Indicates the landing code that must provide a 'Purchase Order Number' in the Landing API.
require_customary_reference	Boolean	Indicates the landing code that must provide a 'Customary Fishing Document Reference Number' in the landing API.
is_used_by_MHR	Boolean	Indicates the landing code(s) where the catch is reported on a Monthly Harvest Return.

Landing Codes Get Request Body Example:

{
    "type-code": "landing-codes",
    "items": [
        {
            "code": "B",
            "name": "Taken for subsequent use as bait for personal use",
            "modified": "2017-06-26T15:09:13+12:00",
            "is_used_by_mhr": "true",
            "start_date_time": "2017-03-01T00:00:00+13:00"
        },
        {
            "code": "F",
            "name": "Recreational catch (s111 approval)",
            "modified": "2017-06-26T15:09:13+12:00",
            "start_date_time": "2017-03-01T00:00:00+13:00"
        },
        {
            "code": "L",
            "name": "Landed to LFR",
            "modified": "2017-06-26T15:09:13+12:00",
            "is_used_by_mhr": "true",
            "require_LFR_number": "true",
            "require_purchase_order": "true",
            "start_date_time": "2017-03-01T00:00:00+13:00"
        },
        {
            "code": "O",
            "name": "Left EEZ under s110 approval",
            "modified": "2017-06-26T15:09:13+12:00",
            "is_used_by_mhr": "true",
            "start_date_time": "2017-03-01T00:00:00+13:00"
        },
        {
            "code": "Q",
            "name": "Placed in holding receptacle on land",
            "modified": "2017-06-26T15:09:13+12:00",
            "require_holding_location": "true",
            "start_date_time": "2017-03-01T00:00:00+13:00"
        },
        {
            "code": "R",
            "name": "Retained on board",
            "modified": "2017-06-26T15:09:13+12:00",
            "start_date_time": "2017-03-01T00:00:00+13:00"
        },
        {
            "code": "S",
            "name": "Seized by FO or observer",
            "modified": "2017-06-26T15:09:13+12:00",
            "is_used_by_mhr": "true",
            "start_date_time": "2017-03-01T00:00:00+13:00"
        },
        {
            "code": "T",
            "name": "Transhipped",
            "modified": "2017-06-26T15:09:13+12:00",
            "require_vessel_number": "true",
            "start_date_time": "2017-03-01T00:00:00+13:00"
        },
        {
            "code": "W",
            "name": "Wharf sales (s191(2) of Act)",
            "modified": "2017-06-26T15:09:13+12:00",
            "is_used_by_mhr": "true",
            "require_purchase_order": "true",
            "start_date_time": "2017-03-01T00:00:00+13:00"
        },
        {   
            "code": "CS",
            "name": "Fish taken under a customary fishing authorisation"
            "modified": "2017-06-26T15:09:13+12:00",
            "require_customary_reference": "true",
            "start_date_time": "2017-03-01T00:00:00+13:00"
        }
    ]
}

Mitigation Device Code Master Data

Used to retrieve a list of available mitigation device codes. This list should only be used for fishing prior to 1 Dec 2021. For fishing after this date you should use the Mitigation Device Codes for Fishing Methods Master Data.

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/mitigation-devices/min

Request URL – ERS Data Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/mitigation-devices/min?modifiedAfter={datefromlogbookapp}

Example:

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/mitigation-devices/min?modifiedAfter=2017-04-10T16:57%2B12:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
code	String	Mitigation Device Code
name	String	Mitigation Device
modified	String	Date last modified
start_date_time	String	Date from when this mitigation device code can be used in a landing event
end_date_time	String	Date from when this mitigation device code can no longer be used in a landing event

Mitigation Device Code Get Request Body Example:

	{ 	"type-code": "mitigation-devices",
		"items": [
		{
		"code": "ACC",
		"name": "Acoustic Cannon",
		"modified": "2017-05-17T19:43:00+12:00",
		"start_date_time": "2017-03-01T00:00:00+13:00"
		},
		{
		"code": "BIB",
		"name": "Bird Baffler",
		"modified": "2017-05-17T19:43:00+12:00",
		"start_date_time": "2017-03-01T00:00:00+13:00"
		},
		{
		"code": "DDD",
		"name": "Dolphin Dissuasive Devices (DDD) a.k.a. pingers",
		"modified": "2017-05-17T19:43:00+12:00",
		"start_date_time": "2017-03-01T00:00:00+13:00"
		},
		{
		"code": "SLE",
		"name": "Sea Lion Exclusion Device (SLED)",
		"modified": "2017-05-17T19:43:00+12:00",
		"start_date_time": "2017-03-01T00:00:00+13:00"
		},
		{
		"code": "WAD",
		"name": "Warp Deflector",
		"modified": "2017-05-17T19:43:00+12:00",
		"start_date_time": "2017-03-01T00:00:00+13:00"
		}
	  ]
	}

Disposal Codes Master Data

The sections below describe the information necessary to retrieve a list of available disposal codes

**Change history**
Date	Change
28/06/2018	Added 'require_number of fish' parameter.

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/disposal-codes/min

Request URL – ERS Data Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/disposal-codes/min?modifiedAfter={datefromlogbookapp}

Example:

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/disposal-codes/min?modifiedAfter=2017-04-10T16:57%2B12:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
code	String	Disposal code
name	String	Name of the disposal method
modified	String	Date last modified
start_date_time	String	Date from when this disposal code can be used for electronic reporting
end_date_time	String	Date from when this disposal code can no longer be used for electronic reporting
require_holding_location	Boolean	Determines whether the place where the receptacle is located is required
is_used_by_MHR	Boolean	Indicates the disposal code(s) where the catch is reported on a Monthly Harvest Return.
require_number_of_fish	Boolean	Determines whether number of fish is required

Disposal Codes Get Request Body Example:

{
    "type-code": "disposal-codes",
    "items": [
        {
            "code": "A",
            "name": "Accidental loss",
            "modified": "2017-06-26T15:09:13+12:00",
            "is_used_by_mhr": "true",
            "start_date_time": "1970-01-01T00:00:00+13:00"
        },
        {
            "code": "D",
            "name": "Discarded (NON-ITQ) species",
            "modified": "2017-06-26T15:09:13+12:00",
            "start_date_time": "1970-01-01T00:00:00+13:00"
        },
        {
            "code": "H",
            "name": "Loss from a holding receptacle",
            "modified": "2017-06-26T15:09:13+12:00",
            "is_used_by_mhr": "true",
            "require_holding_location": "true",
            "start_date_time": "1970-01-01T00:00:00+13:00"
        },
        {
            "code": "J",
            "name": "Observer Authorised Discard of ITQ species",
            "modified": "2017-06-26T15:09:13+12:00",
            "is_used_by_mhr": "true",
            "start_date_time": "2013-10-01T00:00:00+13:00"
        },
        {
            "code": "M",
            "name": "QMS returned to sea (Part 6A)",
            "modified": "2017-06-26T15:09:13+12:00",
            "is_used_by_mhr": "true",
            "start_date_time": "2004-10-01T00:00:00+12:00"
        },
        {
            "code": "X",
            "name": "QMS returned to sea, except 6A",
            "modified": "2017-06-26T15:09:13+12:00",
            "start_date_time": "2006-10-01T00:00:00+12:00"
        },
        {
            "code": "Z",
            "name": "QMS returned to sea (Part 6B)",
            "modified": "2017-06-26T15:09:13+12:00",
            "is_used_by_mhr": "true",
            "start_date_time": "2014-10-01T00:00:00+13:00"
        },
        {
            "code": "E",
            "name": "Eaten",
            "modified": "2017-06-26T15:09:13+12:00",
            "is_used_by_mhr": "true",
            "start_date_time": "1970-01-01T00:00:00+13:00"
        },
        {
            "code": "P",
            "name": "Holding receptacle in the water",
            "modified": "2017-06-26T15:09:13+12:00",
            "require_holding_location": "true",
            "start_date_time": "2000-10-01T00:00:00+12:00"
        },
        {
            "code": "N",
            "name": "Removed from a holding receptacle (at sea)",
            "modified": "2017-06-26T15:09:13+12:00",
            "require_holding_location": "true"
        }
    ]
}

Containers Master Data

Used to retrieve a list of available container types.

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/containers/min

Request URL – ERS Data Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/containers/min?modifiedAfter={datefromlogbookapp}

Example:

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/containers/min?modifiedAfter=2017-04-10T16:57%2B12:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
code	String	Container type short code
name	String	The name of the container type
modified	String	Date last modified
start_date_time	String	Date from when this container type code can be used in a landing event
end_date_time	String	Date from when this container type code can no longer be used in a landing event

Containers Get Request Body Example:

{ 	"type-code": "containers",
	"items": [
	{
	"code": "BAG",
	"name": "Bag",
	"modified": "2017-05-16T17:44:25+12:00",
	"start_date_time": "2017-03-01T00:00:00+13:00"
	},
	{
	"code": "BAS",
	"name": "Basket",
	"modified": "2017-05-16T17:44:25+12:00",
	"start_date_time": "2017-03-01T00:00:00+13:00"
	},
	{
	"code": "BIN",
	"name": "Bin",
	"modified": "2017-05-16T17:44:25+12:00",
	"start_date_time": "2017-03-01T00:00:00+13:00"
	},
	{
	"code": "SAC",
	"name": "Sack",
	"modified": "2017-05-16T17:44:25+12:00",
	"start_date_time": "2017-03-01T00:00:00+13:00"
	},
	{
	"code": "T0",
	"name": "Tray containing 1-10",
	"modified": "2017-05-16T17:44:25+12:00",
	"start_date_time": "2017-03-01T00:00:00+13:00"
	},
	{
	"code": "T1",
	"name": "Tray containing 11-20",
	"modified": "2017-05-16T17:44:25+12:00",
	"start_date_time": "2017-03-01T00:00:00+13:00"
	},
	{
	"code": "OTH",
	"name": "Other",
	"modified": "2017-05-16T17:44:25+12:00",
	"start_date_time": "2017-03-01T00:00:00+13:00"
	}
  ]
}

Shark Fin Ratio Master Data

The sections below describe the information necessary to retrieve a list of available shark fin ratios for each species type.

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/shark-fin-ratio/min

Request URL – ERS Data Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/shark-fin-ratios/min?modifiedAfter={datefromlogbookapp}

Example:

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/shark-fin-ratios/min?modifiedAfter=2017-04-10T16:57%2B12:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
code	String	Species code
modified	String	Date last modified
ratio	Numerical	Shark fin ratio
start_date_time	String	Date from when this ratio should be used in processing and landing events
end_date_time	String	Date from when this ratio should no longer be used in processing and landing events

Shark Fin Ratio Get Request Body Example:

	{ "type-code": "shark-fin-ratio",
	"items": [
		{
		"code": "ELE",
		"modified": "2017-05-21T16:54:42+12:00",
		"ratio": "6.85",
		"start_date_time": "2017-03-01T00:00:00+13:00"
		},
		{
		"code": "GSH",
		"modified": "2017-05-21T16:54:42+12:00",
		"ratio": "6.85",
		"start_date_time": "2017-03-01T00:00:00+13:00"
		},
		{
		"code": "MAK",
		"modified": "2017-05-21T16:54:42+12:00",
		"ratio": "3.5",
		"start_date_time": "2017-03-01T00:00:00+13:00"
		},
		{
		"code": "GSP",
		"modified": "2017-05-21T16:54:42+12:00",
		"ratio": "6.15",
		"start_date_time": "2017-03-01T00:00:00+13:00"
		},
		{
		"code": "POS",
		"modified": "2017-05-21T16:54:42+12:00",
		"ratio": "4.05",
		"start_date_time": "2017-03-01T00:00:00+13:00"
		},
		{
		"code": "SPO",
		"modified": "2017-05-21T16:54:42+12:00",
		"ratio": "4.35",
		"start_date_time": "2017-03-01T00:00:00+13:00"
		},
		{
		"code": "SCH",
		"modified": "2017-05-21T16:54:42+12:00",
		"ratio": "5.75",
		"start_date_time": "2017-03-01T00:00:00+13:00"
		}
	]
 }

Seabird Capture Codes Master Data

Used to retrieve a list of available seabird capture codes.

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/seabird-capture-codes/min

Request URL – ERS Data Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/seabird-capture-codes/min?modifiedAfter={datefromlogbookapp}

Example:

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/seabird-capture-codes/min?modifiedAfter=2017-05-24T15:31:47%2B12:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
code	String	Unique code made up from a combination of the fishing method code and the separate seabird capture code.
name	String	Description of the seabird capture code.
modified	String	Date last modified.
start_date_time	String	Date from when this seabird capture code can be used.
end_date_time	String	Date from when this seabird capture code can no longer be used.
fishing_method_code	String	The fishing method that the seabird capture code is valid for.
seabird_capture_code	String	The seabird capture code that is valid for the fishing method. For example, the 'N' seabird capture code that is valid for the fishing method 'BT'

Seabird Capture Codes Get Request Body Example:

{
    "type-code": "seabird-capture-codes",
    "items": [
        {
            "code": "BLL-S",
            "name": "Setting",
            "modified": "2017-08-22T10:28:30+12:00",
            "fishing_method_code": "BLL",
            "seabird_capture_code": "S",
            "start_date_time": "2017-08-01T00:00:00+12:00"
        },
        {
            "code": "BPT-W",
            "name": "Warp",
            "modified": "2017-08-22T10:28:30+12:00",
            "fishing_method_code": "BPT",
            "seabird_capture_code": "W",
            "start_date_time": "2017-08-01T00:00:00+12:00"
        },
        {
            "code": "BPT-N",
            "name": "Net",
            "modified": "2017-08-22T10:28:30+12:00",
            "fishing_method_code": "BPT",
            "seabird_capture_code": "N",
            "start_date_time": "2017-08-01T00:00:00+12:00"
        },
        {
            "code": "DL-S",
            "name": "Setting",
            "modified": "2017-08-22T10:28:30+12:00",
            "fishing_method_code": "DL",
            "seabird_capture_code": "S",
            "start_date_time": "2017-08-01T00:00:00+12:00"
        },
        {
            "code": "DL-H",
            "name": "Hauling",
            "modified": "2017-08-22T10:28:30+12:00",
            "fishing_method_code": "DL",
            "seabird_capture_code": "H",
            "start_date_time": "2017-08-01T00:00:00+12:00"
        },
        {
            "code": "DL-O",
            "name": "Other",
            "modified": "2017-08-22T10:28:30+12:00",
            "fishing_method_code": "DL",
            "seabird_capture_code": "O",
            "start_date_time": "2017-08-01T00:00:00+12:00"
        },
        {
            "code": "SLL-H",
            "name": "Hauling",
            "modified": "2017-08-22T10:28:30+12:00",
            "fishing_method_code": "SLL",
            "seabird_capture_code": "H",
            "start_date_time": "2017-08-01T00:00:00+12:00"
        },
        {
            "code": "TL-S",
            "name": "Setting",
            "modified": "2017-08-22T10:28:30+12:00",
            "fishing_method_code": "TL",
            "seabird_capture_code": "S",
            "start_date_time": "2017-08-01T00:00:00+12:00"
        },
        {
            "code": "TL-H",
            "name": "Hauling",
            "modified": "2017-08-22T10:28:30+12:00",
            "fishing_method_code": "TL",
            "seabird_capture_code": "H",
            "start_date_time": "2017-08-01T00:00:00+12:00"
        },
        {
            "code": "TL-O",
            "name": "Other",
            "modified": "2017-08-22T10:28:30+12:00",
            "fishing_method_code": "TL",
            "seabird_capture_code": "O",
            "start_date_time": "2017-08-01T00:00:00+12:00"
        }
    ]
}

Breath Mode Codes Master Data

The sections below describe the information necessary to retrieve the Breath Mode Codes Master Data to be used in the Diving Event .

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

 GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/breath-mode-codes/min

Request URL – ERS Data Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/breath-mode-codes/min?modifiedAfter={datefromlogbookapp}

Example:

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/breath-mode-codes/min?modifiedAfter=2017-04-10T16:57%2B12:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
code	String	Breath mode short code
name	String	The name of the breath mode
modified	String	Date last modified
[method name]_start_date	String	Start date of the approved breath mode code

Breath Mode Codes Get Request Body Example:

  {    "type-code": "breath-mode-codes",
        "items": [
    
        {
         "code": "SK",
         "name": "Snorkel",
         "modified": "2018-11-27T12:00:37+12:00",
         "diving_start_date": "2018-11-28T00:00:00+13:00"
        },
    
        {
        "code": "ST",   
        "name": "Scuba - Steel Tank",
        "modified": "2018-11-27T12:00:37+12:00",
        "diving_start_date": "2018-11-28T00:00:00+13:00"
        },   
    
        {
        "code": "AL",
        "name": "Scuba - Aluminium Tank",
        "modified": "2018-11-27T12:00:37+12:00",
        "diving_start_date": "2018-11-28T00:00:00+13:00"
        },
     
        {
        "code": "SS", 
        "name": "Surface Supplied",
        "modified": "2018-11-27T12:00:37+12:00",
        "diving_start_date": "2018-11-28T00:00:00+13:00"
        },
      ]  
  }

Secondary Validation Rules

The sections below describe the information necessary to retrieve a list of available secondary validation rules.

Where the rule is dependent on a reference data list, the reference list can be retrieved from our reference data API using the relatedReferenceData value from the rule.

For example valid species codes for disposal code Y the relatedReferenceData value is "disposal-y-species" so you would make the API call

https://reference.prod.kupe.fishserve.co.nz/api/concept-types/disposal-y-species/min

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the list of secondary validation rules at a given date/time

 GET https://ers.uat.kupe.fishserve.co.nz/api/rule-version?asAtDate={givendatetime}

Example:

GET https://ers.uat.kupe.fishserve.co.nz/api/rule-version?asAtDate=2019-06-17T11:45:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
ruleNumber	String	Unique code to identify the rule
ruleName	String	Name of the rule
description	String	Plain wording description of rule
remedyDescription	String	Description how this rule's error can be resolved
alertMessageTemplate	String	Template according to which error message is formatted and shown to client
relatedReferenceData
eventFieldName	String	Name of the filed on form, this error is related to
ruleType	String	Whether the rule type is "Event", "Trip" or "Global"
versionNumber	Numerical	Version number of rule
startDateTime	String	Date from when this rule is evaluated
endDateTime	String	Date from when this rule can no longer be evaluated
minimumValue	Numerical	Minimum valid value for this rule
maximumValue	Numerical	Maximum valid value for this rule
alertEffectiveDelayHours	Numerical	Delay after which the error message will be visible to client
valueDataType	String	Data type of above minimumValue and maximumValue
eventTypes	String[]	A list containing types of reports this rule is applicable to

Secondary Validation Rules Get Request Body Example:

[
  {
    "ruleNumber": "1",
    "ruleName": "Event Has No Corresponding Trip Start",
    "description": "An event has been reported, but there is no Trip Start record containing the same Trip ID.",
    "remedyDescription": null,
    "alertMessageTemplate": "This trip has no Trip Start report.",
    "relatedReferenceData": null,
    "eventFieldName": "",
    "ruleType": "Trip",
    "versionNumber": 1,
    "startDateTime": "2019-03-01T16:53:58.803+12:00",
    "endDateTime": null,
    "minimumValue": null,
    "maximumValue": null,
    "alertEffectiveDelayHours": null,
    "valueDataType": null,
    "eventTypes": null
  },
  {
    "ruleNumber": "28",
    "ruleName": "No Vessel Pair Number Provided for Pair Trawl Method",
    "description": "A vessel pair number has not been provided when the reported fishing method indicates a pair trawl method was used.",
    "remedyDescription": null,
    "alertMessageTemplate": "Vessel Pair number is expected for the fishing method {0}.",
    "relatedReferenceData": null,
    "eventFieldName": "VesselPairNumber",
    "ruleType": "Event",
    "versionNumber": 1,
    "startDateTime": "2019-03-01T16:53:58.803+12:00",
    "endDateTime": null,
    "minimumValue": null,
    "maximumValue": null,
    "alertEffectiveDelayHours": null,
    "valueDataType": null,
    "eventTypes": [
      {
        "eventType": "Trawl",
        "minimumSchemaEdition": 1,
        "maximumSchemaEdition": 1,
        "fishingMethodCodes": [
          "BPT",
          "MPT"
        ]
      }
    ]
  },
  {
    "ruleNumber": "35",
    "ruleName": "Disposal Code Y Used for an Invalid Stock",
    "description": "Disposal Code \"Y\" is used for a stock code that is not valid.",
    "remedyDescription": null,
    "alertMessageTemplate": "Stock code {0} should not be used with disposal code Y.",
    "relatedReferenceData": null,
    "eventFieldName": "StockCode",
    "ruleType": "Event",
    "versionNumber": 1,
    "startDateTime": "2019-03-01T16:53:58.803+12:00",
    "endDateTime": null,
    "minimumValue": null,
    "maximumValue": null,
    "alertEffectiveDelayHours": null,
    "valueDataType": null,
    "eventTypes": [
      {
        "eventType": "Disposal",
        "minimumSchemaEdition": 1,
        "maximumSchemaEdition": 1,
        "fishingMethodCodes": null
      }
    ]
  },
]

A complete list of rules along with corresponding names, descriptions and remedies can be found here.

PAUA Statistical Areas Master Data

Used to retrieve a list of available PAUA Statistical Areas.

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/paua-statistical-areas/min

Request URL – ERS Data Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/paua-statistical-areas/min?modifiedAfter={datefromlogbookapp}

Example:

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/paua-statistical-areas/min?modifiedAfter=2017-04-28T16:57%2B12:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
Code	String	PAUA Statistical Area short code.
Name	String	Description of the PAUA Statistical Area.
Start Date Time	String	Date from when this PAUA Statistical Area is valid.
End Date Time	String	Date from when this PAUA Statistical Area is no longer valid.
Modified	String	Date last modified.

PAUA Statistical Areas Get Request Body Example:

  "type-code": "paua-statistical-areas", 

  "items": [ 

    { 

      "code": "P101", 

      "name": "P101", 

      "modified": "2021-07-01T14:30:02+00:00", 

      "start_date_time": "2017-10-01T00:00:00+13:00" 

    }, 

    { 

      "code": "P102", 

      "name": "P102", 

      "modified": "2021-07-01T14:30:02+00:00", 

      "start_date_time": "2017-10-01T00:00:00+13:00" 

    }, 

    { 

      "code": "P103", 

      "name": "P103", 

      "modified": "2021-07-01T14:30:02+00:00", 

      "start_date_time": "2017-10-01T00:00:00+13:00" 

    }, 

    { 

      "code": "P104", 

      "name": "P104", 

      "modified": "2021-07-01T14:30:02+00:00", 

      "start_date_time": "2017-10-01T00:00:00+13:00" 

    } 

}

SPRFMO VME organisms Master Data

Used to retrieve SPRFMO VME organisms (South Pacific Regional Fisheries Management Organisation Vulnerable Marine Ecosystem) codes which should only be recorded if, on the corresponding fish catch report, the fisher has entered that they are fishing under a High Seas Fishing Permit.

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/sprfmo-nfps-species-codes/min

Request URL – ERS Data Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/sprfmo-nfps-species-codes/min?modifiedAfter={datefromlogbookapp}

Example:

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/sprfmo-nfps-species-codes/min?modifiedAfter=2017-04-28T16:57%2B12:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
Code	String	Non-fish/protected species code.
Name	String	Non-fish/protected species name.
Start Date Time	String	Date from when this non-fish/protected species code can be used in fishing or non-fish/protected species events  .
End Date Time	String	Date from when this non-fish/protected species code can no longer be used in fishing or non-fish/protected species events.
Modified	String	Date last modified.
is_seabird		Indicates for which codes the seabird capture details are required to be provided in trawl events If is_seabird is 'Yes' then 'Seabird Capture Details' is mandatory.
measured_by		Indicates which unit of measurement (count or weight) needs to be provided for the NFPS species code reported.

sprfmo-nfps-species-codes Get Request Body Example:

  
 
{ 
    "type-code": "sprfmo-nfps-species-codes", 
    "items": [ 
        { 
            "code": "SIA", 
            "name": "Stony corals", 
            "modified": "2021-06-29T11:54:40+12:00", 
            "measured_by": "weight", 
            "start_date_time": "2021-09-01T00:00:00+12:00" 
        }, 
        { 
            "code": "SOC", 
            "name": "Soft corals (other than those designated as Gorgonian Alcyonacea) ", 
            "modified": "2021-06-29T11:54:40+12:00", 
            "measured_by": "weight", 
            "start_date_time": "2021-09-01T00:00:00+12:00" 
        }, 
        { 
            "code": "GOC", 
            "name": "Includes bamboo corals (Isididae), red / precious corals (Corallidae), bottle brush corals and sea fans (Primnoidae), bubblegum corals (Paragorglidae), and golden corals (Chrysogorglidae)", 
            "modified": "2021-06-29T11:54:40+12:00", 
            "measured_by": "weight", 
            "start_date_time": "2021-09-01T00:00:00+12:00" 
        }, 
    ] 
}

Mitigation Device Codes for Fishing Methods Master Data

Used to retrieve a list of available mitigation device codes for each Fishing Method.

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.uat.kupe.fishserve.co.nz/api/concept-types/method-mitigation-devices/min

Request URL – ERS Data Set Modified After:

Use the following query, if you would only like to retrieve the data that has been changed since the last time the master data list was requested.

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/method-mitigation-devices/min?modifiedAfter={datefromlogbookapp}

Example:

GET http://reference.uat.kupe.fishserve.co.nz/api/concept-types/method-mitigation-devices/min?modifiedAfter=2017-04-10T16:57%2B12:00

Response

Response Status:

Status	Description
200 OK	Status for a successful request.
500 Internal Server Error	Status when something is wrong with the request.

Response Parameters

Parameter	Data Type	Description
mitigation_device_code	String	Mitigation Device Code
mitigation_device_description	String	Mitigation Device Description
fishing_method_code	String	Fishing Method
modified	String	Date last modified
start_date_time	String	Date from when this mitigation device code can be used in a landing event
end_date_time	String	Date from when this mitigation device code can no longer be used in a landing event
filter_by_vessel_length	Boolean	Indicates if mitigation device takes into account vessel length
used_by_vessels_over_28_metres	Boolean	Indicates the mitigation devices that can be used on vessels over 28 metres in length
used_by_vessels_28_metres_or_under	Boolean	Indicates the mitigation devices that can be used on vessels 28 metres or under in length

Mitigation Device Code Get Request Body Example:

	{
	"type-code": "method-mitigation-devices",
	"items": [
		{
			"modified": "2021-07-06T12:49:29+12:00",
			"fishing_method_code": "BS",
			"mitigation_device_code": "ACC",
			"mitigation_device_description": "Acoustic cannon",
			"start_date_time": "2017-10-01T00:00:00+13:00"
		},
		{
			"modified": "2021-07-06T12:49:29+12:00",
			"fishing_method_code": "BS",
			"mitigation_device_code": "BCU",
			"mitigation_device_description": "Brickle curtain",
			"start_date_time": "2017-10-01T00:00:00+13:00"
		},
		{
			"modified": "2021-07-06T12:49:29+12:00",
			"fishing_method_code": "BS",
			"mitigation_device_code": "BIB",
			"mitigation_device_description": "Bird baffler - two booms perpendicular to vessel",
			"start_date_time": "2017-10-01T00:00:00+13:00"
		},
		{
			"modified": "2021-07-06T12:49:29+12:00",
			"fishing_method_code": "BS",
			"mitigation_device_code": "BIF",
			"mitigation_device_description": "Bird baffler - four boom",
			"start_date_time": "2017-10-01T00:00:00+13:00"
		},
{
			"modified": "2021-07-06T12:49:30+12:00",
			"filter_by_vessel_length": "true",
			"fishing_method_code": "BT",
			"mitigation_device_code": "BIB",
			"mitigation_device_description": "Bird baffler - two booms perpendicular to vessel",
			"used_by_vessels_28_metres_or_under": "true",
			"used_by_vessels_over_28_metres": "true",
			"start_date_time": "2021-09-01T00:00:00+12:00"
		},
		{
			"modified": "2021-07-06T12:49:30+12:00",
			"filter_by_vessel_length": "true",
			"fishing_method_code": "BT",
			"mitigation_device_code": "BIF",
			"mitigation_device_description": "Bird baffler - four boom",
			"used_by_vessels_over_28_metres": "true",
			"start_date_time": "2021-09-01T00:00:00+12:00"
		},
		{
			"modified": "2021-07-06T12:49:30+12:00",
			"filter_by_vessel_length": "true",
			"fishing_method_code": "BT",
			"mitigation_device_code": "BIC",
			"mitigation_device_description": "Bird baffler - with curtain between booms",
			"used_by_vessels_over_28_metres": "true",
			"start_date_time": "2021-09-01T00:00:00+12:00"
		}
	]
}