ISC Developer Portal

Overview

Third-party systems can communicate with the NLIS Database:

  • to retrieve information from the database, and/or
  • to update information on the database.

For the majority of users, the NLIS Database website https://www.nlis.com.au will provide the primary mechanism for interacting with the database: for submitting updates to data, and for requesting data from NLIS. This document details those inquiry/update processes that can be initiated/integrated from outside that website. It provides all the information required for third-party software vendors/developers to integrate their systems with the NLIS Database.

The first example use case is a PIC register search. A cattle management software package can allow producers, agents, feedlot operators or abattoirs to find a PIC:

  • By providing the 8 character PIC (Propetry Identification Code)
  • By providing keywords which will be matched against any of the searchable fields (manager name, town, state, etc)
  • By providing the internal identifier

API BASE URI

Features

Various users of NLIS systems use different and separate features. Sofware companies are encouraged to build software products targetted to specific user groups.

Producers

Producers must record information on the database to comply with state regulations relating to biosecurity and traceability

GET
Title Description API Call
Search the PIC register When you want to find information about other properties GET /api/v2/PICRegister

Agents

GET
Title Description API Call
PICRegister Search PIC Register GET api/v2/PICRegister

Feedlots

GET
Title Description API Call
PICRegister Search PIC Register GET api/v2/PICRegister

Saleyards

GET
Title Description API Call
PICRegister Search PIC Register GET api/v2/PICRegister

Processors

GET
Title Description API Call
PICRegister Search PIC Register GET api/v2/PICRegister

Tag Manufacturers

GET
Title Description API Call
PICRegister Search PIC Register GET api/v2/PICRegister

3rd Party Accounts

GET
Title Description API Call
PICRegister Search PIC Register GET /api/v2/PICRegister

Search parameters


Name Description Match Types
SearchText Words match any of the following fields:
PIC, PICName, LastName, Town, State

Either use SearchText , or use a combination of the specific search parameters listed below
PIC Exact Match
FirstName (of Manager) Fuzzy Match
LastName (of Manager) Fuzzy Match
BusinessName Fuzzy Match
PropertyName Fuzzy Match
Brand Fuzzy Match
Town Fuzzy Match
State NSW, QLD, VIC, WA etc Exact Match
Exact Match 2000, 2060, 4000 etc Exact Match
PICStatus Active, Disbanded, Inactive, Amalgamated, Blocked Exact Match
PICType PR, FL, SA, SY etc (See all PIC Types) Exact Match

Other parameters

Name Description
pageindex Identify which page of results to return. Allows pagination through many records.
pagesize Identify the number of records to return. Allows pagination through many records.
Sample PICRegister Requests
Wildcard search
/PICRegister?SearchText=nsw&Pagesize=2&PageIndex=1
 
Field Search/ Advanced search 
/PICRegister?BusinessName=Holding&State=NSW&FirstName=George&Lastname=Basha&pageindex=1&pagesize=10
 
/PICRegister?PIC=PICTEST1&PropertyName=Holding&Brand=5040
 
/PICRegister?Town=BROKEN HILL&State=NSW&Postcode=2880
 
Note: PICStatus used as short-codes. for example: Active/Inactive/Blocked/Disbanded/Blocked.. -> A/I/D/B
/PICRegister?PICStatus=A&PICType=AB
 
Query PICRegister API by PIC 

/PICRegister/(PIC=WZ100013)
			
Sample PICRegister Response
  {
    "Value": {
      "Offset": 0,
      "Limit": 1,
      "Total": 1,
      "SubSet": [
        {
          "PIC": "PICTEST3",
          "PICName": "NLIS TestPIC",
          "PICRegisterId": 1,
          "BusinessName": "",
          "FirstName": "JOHN",
          "LastName": "DOE",
          "Town": "NORTH SYDNEY",
          "Species": [
            {
              "ShortCode": "C"
            },
            {
              "ShortCode": "S"
            }
          ],
          "PropertyTypes": [
            {
              "ShortCode": "PR"
            }
          ],
          "Brands": [
            {
              "ShortCode": "5UA0"                           
            }],
          "RegisteredState": "NSW",
          "AdminStatus": {
            "ShortCode": "A",
            "Description": "Active"
          },
          "ShireCode": "CT",
          "ContactDetails": [
            {
              "FirstName": "JOHN",
              "LastName": "DOE",
              "ContactTypeShortCode": "PICMANAGERCONTACT"
            }
          ]
        }
      ]
    }
  }
         
logo Integrity Systems Company