DISCLAIMER: Please note, this information is subject to change as content is still under development with MPI

Below is the technical information required for setting up the ERS Master Data APIs

Each Master Data list has the API documentation available in pdf format. Select the pdf link under each Master Data API header.

ERS Master Data APIs

Fishing Methods Master Data

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

Change history
Date Change
26/06/2017 Added the fields 'require_seabird_capture_details' and 'require_vessel_number'. 
31/05/2017 Initial publication

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

 GET https://reference.demo.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.demo.kupe.fishserve.co.nz/api/concept-types/fishing-methods/min?modifiedAfter={datefromlogbookapp}

Example:

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

Response

Response Status:

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

Response Parameters

ParameterData TypeDescription
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.

[method name]_start_date String Start date of the approved fishing method

Response 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",
        "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",
        "seining_start_date": "2017-03-01T00:00:00+13:00"
         },
    
        {
        "code": "BLL",
        "name": "Bottom Long Line",
        "modified": "2017-05-15T12:00:37+12:00",
        "lining_start_date": "2017-03-01T00:00:00+13:00"
        },
    
        {
        "code": "BPT", 
        "name": "Bottom Pair Trawl",
        "modified": "2017-05-15T12:00:37+12:00",
        "trawl_start_date": "2017-03-01T00:00:00+13:00"
         }
      ]  
  }
 

Back to top

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
26/06/2017 Added the fields; 'cf_category', 'not_allowed_for_diving', and 'require_boat_person_used'. Updated the Reponse Body Example.
31/05/2017 Initial publication

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.demo.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.demo.kupe.fishserve.co.nz/api/concept-types/fish-species/min?modifiedAfter={datefromlogbookapp}&datetype=ers

Example:

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

Response

Response Status:

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

Response Parameters

ParameterData TypeDescription
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.
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

Response 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",
            "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",
            "ers_start_date": "1996-10-01T00:00:00+12:00"
        },
    ]
}

Back to top

Fish Stock Codes Master Data

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

Change history
Date Change
31/05/2017 Initial publication

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.demo.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.demo.kupe.fishserve.co.nz/api/concept-types/fish-stock/min?modifiedAfter={datefromlogbookapp}&datetype=ers

Example:

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

Response

Response Status:

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

Response Parameters

ParameterData TypeDescription
code String Stock code
name String Name 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

Response Body

Example:

	{"type-code": "fish-stock",
	"items": [
		{
		"code": "ANG11",
		"name": "Freshwater Eels Quota Management Area 11",
		"modified": "2017-03-01T10:00:00+13:00",
		"ers_start_date": "2015-12-30T00:00:00+13:00",
		"ers_end_date": "2016-09-30T00:00:00+13:00"
		},
		{
		"code": "ANG12",
		"name": "Freshwater Eels Quota Management Area 12",
		"modified": "2017-03-01T10:00:00+13:00",
		"ers_start_date": "2000-10-01T00:00:00+12:00",
		"ers_end_date": "2016-09-30T00:00:00+13:00"
		},
		{
		"code": "ANG13",
		"name": "Freshwater Eels Quota Management Area 13",
		"modified": "2017-03-01T10:00:00+13:00",
		"ers_start_date": "2017-04-01T00:00:00+13:00"
		},
		{
		"code": "BAR1",
		"name": "Barracouta Fishery Management Areas 1-3",
		"modified": "2017-03-01T10:00:00+13:00",
		"ers_start_date": "2001-10-01T00:00:00+12:00"
		},
		{
		"code": "CAR1",
		"name": "Carpet Shark Fishery Management Area 1",
		"modified": "2017-03-01T10:00:00+13:00",
		"ers_start_date": "2001-10-01T00:00:00+12:00"
		},
		{
		"code": "HOK1",
		"name": "Hoki Fishery Management Areas 1-9",
		"modified": "2017-03-01T10:00:00+13:00",
		"ers_start_date": "2001-10-01T00:00:00+12:00"
		},
		{
		"code": "KIN4",
		"name": "Kingfish Fishery Management Area 4",
		"modified": "2017-03-01T10:00:00+13:00",
		"ers_start_date": "2001-10-01T00:00:00+12:00"
		},
		{
		"code": "MAOET",
		"name": "Maomao (Unspecified) High Seas",
		"modified": "2017-03-01T10:00:00+13:00",
		"ers_start_date": "2001-10-01T00:00:00+12:00"
		},
		{
		"code": "PAD6",
		"name": "Paddle Crab Fishery Management Area 6",
		"modified": "2017-03-01T10:00:00+13:00",
		"ers_start_date": "2001-10-01T00:00:00+12:00"
		},
		{
		"code": "PAU3",
		"name": "Black Paua & Yellowfoot Paua Quota Management Area 3",
		"modified": "2017-03-01T10:00:00+13:00",
		"ers_start_date": "2001-10-01T00:00:00+12:00"
		}
	]
 }

Back to top

Non-Fish Protected Species Master Data

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

Change history
Date Change
31/05/2017 Initial publication

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.demo.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.demo.kupe.fishserve.co.nz/api/concept-types/nfps/min?modifiedAfter={datefromlogbookapp}

Example:

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

Response

Response Status:

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

Response Parameters

ParameterData TypeDescription
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

Response 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"
		}
	  ]
	}

Back to top

Conversion Factors Master Data

Used to retrieve a list of available conversion factors.

Change history
Date Change
29/06/2017 Initial publication

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.demo.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.

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

GET https://ers.demo.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.demo.kupe.fishserve.co.nz/api/lookup/conversion-factors/{date-as-at}/?modifiedAfter={datefromlogbookapp}

Example:

GET https://ers.demo.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.demo.kupe.fishserve.co.nz/api/lookup/conversion-factors/{date-as-at}/{speciescode}

Example:

GET https://ers.demo.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.demo.kupe.fishserve.co.nz/api/lookup/conversion-factors/{date-as-at}/{speciescode}?modifiedAfter={datefromlogbookapp}

Example:

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

Response

Response Status:

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

Response Parameters

ParameterData TypeDescription
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.

Response 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"
    }
]

Back to top

Products States Master Data

Used to retrieve a list of available product states.

Change history
Date Change
14/06/2017 Initial publication

GET

Request

Request URL –ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.demo.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.demo.kupe.fishserve.co.nz/api/concept-types/product-states/min?modifiedAfter={datefromlogbookapp}

Example:

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

Response

Response Status:

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

Response Parameters

ParameterData TypeDescription
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 API.

Response 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": "XTO",
            "name": "Tail-off",
            "modified": "2017-06-12T13:42:30+12:00",
            "product_state_type": "Principal",
            "require_conversion_factor": "true",
            "require_greenweight": "true",
            "start_date_time": "2008-12-26T00:00:00+13:00"
        }
    ]
}

Back to top

Landing Codes Master Data

Used to retrieve a list of available landing codes.

Change history
Date Change
26/06/2017 Added the field; 'is_used_by_MHR'. Updated the Response Body Example.
31/05/2017 Initial publication

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.demo.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.demo.kupe.fishserve.co.nz/api/concept-types/landing-codes/min?modifiedAfter={datefromlogbookapp}

Example:

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

Response

Response Status:

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

Response Parameters

ParameterData TypeDescription
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.
is_used_by_MHR Boolean Indicates the landing code(s) where the catch is reported on a Monthly Harvest Return. 

Response 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"
        }
    ]
}

Back to top

Mitigation Device Code Master Data

Used to retrieve a list of available mitigation device codes.

Change history
Date Change
31/05/2017 Initial publication

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.demo.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.demo.kupe.fishserve.co.nz/api/concept-types/mitigation-devices/min?modifiedAfter={datefromlogbookapp}

Example:

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

Response

Response Status:

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

Response Parameters

ParameterData TypeDescription
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

Response 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"
		}
	  ]
	}

Back to top

Disposal Codes Master Data

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

Change history
Date Change
26/06/2017 Added the field; 'is_used_by_MHR'. Updated Response Body Example.
31/05/2017 Initial publication

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.demo.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.demo.kupe.fishserve.co.nz/api/concept-types/disposal-codes/min?modifiedAfter={datefromlogbookapp}

Example:

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

Response

Response Status:

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

Response Parameters

ParameterData TypeDescription
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.

Response 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"
        }
    ]
}

Back to top

Containers Master Data

Used to retrieve a list of available container types.

Change history
Date Change
31/05/2017 Initial publication

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.demo.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.demo.kupe.fishserve.co.nz/api/concept-types/containers/min?modifiedAfter={datefromlogbookapp}

Example:

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

Response

Response Status:

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

Response Parameters

ParameterData TypeDescription
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

Response 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"
	}
  ]
}

Back to top

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.

Change history
Date Change
31/05/2017 Initial publication

GET

Request

Request URL - ERS Data Set:

Use this URL to retrieve the ERS master data list.

GET https://reference.demo.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.demo.kupe.fishserve.co.nz/api/concept-types/shark-fin-ratios/min?modifiedAfter={datefromlogbookapp}

Example:

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

Response

Response Status:

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

Response Parameters

ParameterData TypeDescription
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

Response 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"
		}
	]
 }

Back to top