Skip to content
ONLINE STRA SERVICE APIs V1
/
ePlanning STRA Management API
/
SubmitBulkBooking

ePlanning STRA Management API (v1)

ePlanning STRA Management API

Download OpenAPI description
STRAMgmtInboundAPI.json
STRAMgmtInboundAPI.yaml
Overview
E-mail

api@environment.nsw.gov.au

License

Apache 2.0

Terms of Service

Languages
Servers

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

PropertyDetails

Request

This operation will enable the booking platforms to know the current status and day limit count (current year and next year) of a particular property on the STRA register.

Path
PropertyIDstringrequired

Property ID in STRA example PID-STRA-NumericValue

Postcodestringrequired

Postcode of the property in STRA

Headers
BookingProviderstring

Name of the booking provider

curl -i -X GET \
  'https://api-uat.apps1.nsw.gov.au/planning/STRAMgmt/v1/PropertyDetails/{PropertyID}/{Postcode}' \
  -H 'BookingProvider: string'

Responses

OK

Body*/*
StatusMessagestring

Indicates if property is present in STRA.Sample values are Property found in STRA ,Property not found in STRA

DayLimCoutCurRenYrinteger

Total number of STRA days booked in current renewal year

DayLimCoutCurRenYrBalanceinteger

Total number of days available to book in current renewal year

DwellingNumberstring

Dwelling Number when a lot of land contains more than one dwelling

DayLimCoutNxtRenYrBalanceinteger

Total number of days available to book in next renewal year

DayLimCoutNxtRenYrinteger

Total number of STRA days booked in next renewal year

HostingTypestring

Indicates if property is hosted in STRA or not. Sample values are Hosted,Non-Hosted

EndDateNxtRenYrstring(date)

End date for the next renewal year. Example "19-05-2022"

Example: "19-05-2022"
StatusValuestring

HTTP status code

PropertyStatusstring

Current status of the property in STRA. Sample values are Registered,De-registered,Blocked,Excluded

AddressIDstring

AddressID of property in STRA example PID-STRA-NumericValue

FULLADDRESSstring

Full address of property in STRA Example "53 533-539 KENT STREET SYDNEY 2000"

EndDateCurRenYrstring(date)

End date for current renewal year.Example "19-05-2021"

Example: "19-05-2021"
DayLimCoutLstRenYrinteger

Total number of STRA days booked in last renewal year

DayLimCoutLstRenYrBalanceinteger

Total number of days available to book in last renewal year

EndDateLstRenYrstring(date)

End date for last(third) renewal year.Example "19-05-2023"

Example: "19-05-2023"

SubmitBulkBooking

Request

This operation will enable the consumer of the API to submit NEW,MODIFY and CANCEL booking requests in STRA.

Headers
BookingProviderstringrequired

Name of the booking provider

Bodyapplication/jsonrequired

Body of the request

filenamestring

Specifies the name of the file should be uniquely identifiable

Example: "BulkbookingRequest_Timestamp"
filecontentstring

Specifies the base64 content of the file

curl -i -X POST \
  https://api-uat.apps1.nsw.gov.au/planning/STRAMgmt/v1/SubmitBulkBooking \
  -H 'BookingProvider: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "filename": "BulkbookingRequest_Timestamp",
    "filecontent": "string"
  }'

Responses

OK

Body*/*
StatusMessagestring

Status of the submit booking request

Example: "Request has been processed"

ResponseBulkBooking

Request

This operation will enable the booking providers to get the status of previous Bulk Booking call.

Headers
BookingProviderstringrequired

Name of the booking provider

Bodyapplication/jsonrequired

Body of the request

filenamestring

Specifies the name of the file for which response is to being requested

curl -i -X POST \
  https://api-uat.apps1.nsw.gov.au/planning/STRAMgmt/v1/ResponseBulkBooking \
  -H 'BookingProvider: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "filename": "string"
  }'

Responses

OK

Body*/*
filenamestring

Specifies the name of the response file

filecontentstring

Specifies the base 64 content of the response file

GetBulkPropertyDetails

Request

This operation will return all property details stored in STRA register.

curl -i -X GET \
  https://api-uat.apps1.nsw.gov.au/planning/STRAMgmt/v1/GetBulkPropertyDetails

Responses

OK

Body*/*
filenamestring

Specifies the name of the file

filecontentstring

Specifies the base64 content of the file

timestampstring

Timestamp of the generated file

ManageBooking

Request

This operation will enable the booking platforms to update the STRA register with new bookings or modifications of existing bookings (including cancellations).

Path
PropertyIDstringrequired

Property ID in STRA example PID-STRA-NumericValue

Headers
BookingProviderstring

Name of the booking provider

Bodyapplication/jsonrequired
RequestTypestring<= 21 charactersrequired

Specifies if the request is of which type Example:New,Modify,Cancel

BookingRefNostringrequired

Mandatory for Modify/Cancel Booking - ID field returned in response for New Booking

TransactionIDstringrequired

Mandatory ( Unique Transaction identifier)-Must be an unique ID

StartDatestring(date)required

Booking start date in dd-mm-yyyy format

Example: "21-05-2021"
EndDatestring(date)required

Booking end date in dd-mm-yyyy format

Example: "24-05-2021"
curl -i -X POST \
  'https://api-uat.apps1.nsw.gov.au/planning/STRAMgmt/v1/ManageBooking/{PropertyID}' \
  -H 'BookingProvider: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "RequestType": "string",
    "BookingRefNo": "string",
    "TransactionID": "string",
    "StartDate": "21-05-2021",
    "EndDate": "24-05-2021"
  }'

Responses

OK

Body*/*
DayLimCoutCurRenYrinteger

Total number of STRA days booked in current renewal year

StatusMessagestring

Indicates if property is present in STRA.Sample values are Property found in STRA ,Property not found in STRA

DayLimCoutCurRenYrBalanceinteger

Total number of days available to book in current renewal year

DwellingNumberstring

Dwelling Number when a lot of land contains more than one dwelling

DayLimCoutNxtRenYrBalanceinteger

Total number of days available to book in next renewal year

DayLimCoutNxtRenYrinteger

Total number of STRA days booked in next renewal year

DayLimCoutLstRenYrinteger

Total number of STRA days booked in last renewal year

DayLimCoutLstRenYrBalanceinteger

Total number of days available to book in last renewal year

EndDateLstRenYrstring(date)

End date for last(third) renewal year.Example "19-05-2022"

Example: "19-05-2021"
HostingTypestring

Indicates if property is hosted in STRA or not. Example Hosted/Non-Hosted

EndDateNxtRenYrstring(date)

End date for current renewal year.Example "19-05-2022"

Example: "19-05-2022"
PropertyStatusstring

Current status of the property in STRA. Sample values are Registered,De-registered,Blocked,Excluded

BookingRefNostring

Booking reference number

AddressIDstring

AddressID of property in STRA example PID-STRA-NumericValue

FULLADDRESSstring

Full address of property in STRA Example "53 533-539 KENT STREET SYDNEY 2000"

EndDateCurRenYrstring(date)

End date for current renewal year.Example "19-05-2021"

Example: "19-05-2021"
© 2025 Your Company. All Rights Reserved.