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

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

PAUA Statistical Areas

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:

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 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" 

    } 

}         

Back to top