Skip to content

getPhns ​

Retrieves a list of all PHNs (Primary Health Networks) or PHNs for a given state.

Request ​

http
GET /rest/refdata/phns

Query Parameters ​

ParameterTypeRequiredDescription
stateCodestringNoState code, e.g. AU-QLD. If omitted, returns all PHNs.

Examples ​

http
GET /rest/refdata/phns
GET /rest/refdata/phns?stateCode=AU-QLD

Response ​

200 OK ​

json
[
  {
    "phnCode": "PHN301",
    "phnName": "Brisbane North"
  },
  {
    "phnCode": "PHN302",
    "phnName": "Brisbane South"
  }
]
FieldTypeDescription
phnCodestringPHN code identifier
phnNamestringPHN name

Errors ​

ExceptionCause
WSRefDataServiceExceptionService error while fetching PHNs

Version ​

http
GET /rest/refdata/phns/version
json
{ "version": 1 }