ReferenceData

Reference Data Management API (v1)

Reference Data Management v1 API.

Download OpenAPI description

ReferenceData v1.0.json

ReferenceData v1.0.yaml

Overview

E-mail

api@environment.nsw.gov.au

Servers

https://api-uat.apps1.nsw.gov.au/planning/OnlineReferenceData/v1/

ReferenceData

Request

This operation retrieves the reference data list for the attributes.

Headers

digitalServicestringrequired

This is to track the name of the digital service for which the reference data values are to be retreived. Following values for the relevant digital services are to be passed in the header. - DA - StateDA - CR - CNR - CDC - S68 - PC10.7 - BIC - PCC

operationstring

This is to track the name of the API operation for which the reference data values are to be retreived. Operation name(as mentioned in the specific YAML) needed to be provided as the input. For example - AcceptReturn is the operation name mentioned in the relevant YAML which should be passed as a value in the header.

attributestring

This is to track the name of the YAML attribute for which the reference data values are to be retreived. Attribute name as mentioned in the relevant YAML should be provided as input. Examples - 'developmentTypes', 'developmentDescription' should be passed as a value in the header.

subtypestring

This is to track the certificate types and is applicable for Post consent certificate service API only. Applicable values are 'CC','OC','SC','SWC' and 'PCA' which denotes certificate types.

dataflowstring

This is to track the direction of the requests. Currently, this is applicable for 'CreateContribution' and 'UpdateContribution' operations of 'DA', 'StateDA' and 'CDC' digital services. Supported values are 'ExternalToEPlanning' & 'EPlanningToExternal'. 'ExternalToEPlanning' is used to fetch values for operations moving from external sources to ePlanning; this is the default dataflow. 'EplanningToExternal' is used for values related to operations flowing from ePlanning to external sources.

curl -i -X GET \
  https://api-uat.apps1.nsw.gov.au/planning/OnlineReferenceData/v1/ReferenceData \
  -H 'attribute: string' \
  -H 'dataflow: string' \
  -H 'digitalService: string' \
  -H 'operation: string' \
  -H 'subtype: string'

Responses

Operation successful, result attached

Body*/*

statusCodeintegerrequired

Example: 200

messagestring

Example: "Operation successful, result attached"

outputArray of objects(ReferenceDataOutput)

Reference Data Management API (v1)

ReferenceData

Request

Responses

Was this helpful?