System API (1.0)

Download OpenAPI specification:Download

Performs a system health check

Responses

Response samples

200
500

Content type

application/json

{"health": "OK"
}

Get list of allowed values for a field

Authorizations:

CognitoUserPool

path Parameters

domain

required

string

Example: role

Name of the domain to get

Responses

Response samples

200

Content type

application/json

[{"code": "SYSADMIN",
"label": "System Administrator",
"sequence": 1
}
]

Request a location to upload a file

Authorizations:

CognitoUserPool

Request Body schema: application/json

name required	string
mimeType	string
entity	string
entityId	string

Responses

Request samples

Payload

Content type

application/json

{"name": "Some file name",
"mimeType": "application/pdf",
"entity": "Upload",
"entityId": 123
}

Response samples

200

Content type

application/json

{"id": 234,
"key": "location/2020/08/28/abcde-1234-adfg-12-asdfasd",
"method": "PUT",
"url": "https://s3.amazon.com/location/2020/08/28/abcde-1234-adfg-12-asdfasd"
}

Retrieve an uploaded file

Retrieves, and possibly transforms, an uploaded file

Authorizations:

CognitoUserPool

path Parameters

fileId

required

integer

Numeric ID of the file to get

query Parameters

transform required	string Enum: "shp2json" "kmz2json" "mitab2json" "shp2db" "kmz2db" "mitab2db"
outFormat	string Value: "arcgis" Used if returning JSON to request it in ArcGIS format, otherwise comes as GeoJSON
geometryType	string Enum: "Point" "LineString" "Polygon" Used to describe the uploaded spatial data geometry type
bufferDistance	integer Used to describe the distance of a buffer when convert a LineString to Polygon

Responses

Response samples

200

Content type

application/json

{ }

Fetches a file

Retrieves a file

Authorizations:

CognitoUserPool

path Parameters

fileId

required

integer

Numeric ID of the file to get

query Parameters

format

string

Value: "url"

Used to describe the required response format

Responses

Response samples

200

Content type

application/json

{"url": "https://swx/filepath/file?securitykeys"
}

Get system job status

Get the status of a system job

Authorizations:

CognitoUserPool

path Parameters

jobId

required

integer

Numeric ID of the job to get

Responses

Response samples

200

Content type

application/json

{"type": "GENERATE_PDF",
"status": "CREATED",
"request": { },
"response": { },
"scheduledAt": "2020-08-01T03:36:00.000Z",
"runCount": 0,
"userId": 123
}

Get the latest terms and conditions

Authorizations:

CognitoUserPool

Responses

Response samples

200

Content type

application/json

{"text": "<p>Here are some terms</p>"
}

Accept the terms and conditions

Authorizations:

CognitoUserPool

path Parameters

termsId

required

integer

Numeric ID of the terms to get

Responses

Response samples

200

Content type

application/json

{"id": 12
}

Update system parameters

Authorizations:

CognitoUserPool

Request Body schema: application/json

property

integer

Responses

Request samples

Payload

Content type

application/json

{"property": 0
}

Response samples

200

Content type

application/json

{"property": 0
}

Fetches a token to be used with the reports server

Authorizations:

CognitoUserPool

Responses

Response samples

200

Content type

application/json

{"token": "zsd98cxv98zsd9f8s7v9xzcv9xczv97zsdv9807sdv9"
}

List LGAs

Authorizations:

CognitoUserPool

query Parameters

returnGeometry	boolean Example: returnGeometry=false Includes geometry in response
filter	string Example: filter=name:Moreland%,createdAfter:2020-08-06 Filters to apply to records
limit	integer [ 1 .. 1000 ] Example: limit=50 Max number of records to return
offset	integer >= 0 Example: offset=100 Used for paging - offset from start
order	string Example: order=name,-createdAt Sort order for results - hyphen prefix reverses order

Responses

Response samples

200

Content type

application/json

{"LocalGovernmentArea": [{"id": 1,
"name": "CENTRAL COAST COUNCIL",
"state": "NSW",
"shape": {"type": "Polygon",
"coordinates": [[[0,
0
],
[0,
0
],
[0,
0
],
[0,
0
]
]
],
"bbox": [0,
0,
0,
0
]
}
}
],
"Info": {"offset": 10,
"limit": 50,
"count": 67
}
}

Get LGAs

Authorizations:

CognitoUserPool

query Parameters

returnGeometry

boolean

Example: returnGeometry=false

Includes geometry in response

Responses

Response samples

200

Content type

application/json

{"id": 1,
"name": "CENTRAL COAST COUNCIL",
"state": "NSW",
"shape": {"type": "Polygon",
"coordinates": [[[0,
0
],
[0,
0
],
[0,
0
],
[0,
0
]
]
],
"bbox": [0,
0,
0,
0
]
}
}

List States

Authorizations:

CognitoUserPool

query Parameters

returnGeometry	boolean Example: returnGeometry=false Includes geometry in response
filter	string Example: filter=name:Moreland%,createdAfter:2020-08-06 Filters to apply to records
order	string Example: order=name,-createdAt Sort order for results - hyphen prefix reverses order

Responses

Response samples

200

Content type

application/json

{"State": [{"id": 1,
"name": "New South Wales",
"abbrev": "NSW",
"shape": {"type": "Polygon",
"coordinates": [[[0,
0
],
[0,
0
],
[0,
0
],
[0,
0
]
]
],
"bbox": [0,
0,
0,
0
]
}
}
],
"Info": {"count": 67
}
}

Get selected State

Authorizations:

CognitoUserPool

query Parameters

returnGeometry

boolean

Example: returnGeometry=false

Includes geometry in response

Responses

Response samples

200

Content type

application/json

{"id": 1,
"name": "New South Wales",
"abbrev": "NSW",
"shape": {"type": "Polygon",
"coordinates": [[[0,
0
],
[0,
0
],
[0,
0
],
[0,
0
]
]
],
"bbox": [0,
0,
0,
0
]
}
}

Raise a support ticket

Authorizations:

CognitoUserPool

Request Body schema: application/json

summary required	string <= 40 characters
description required	string <= 250 characters
category required	string [ 5 .. 40 ] characters
isApplicationAccessible	boolean
isDataCorrupted	boolean
isResponseHandlingIssue	boolean
name required	string <= 50 characters
email required	string <email>
phoneNumber required	string <= 16 characters \+[1-9]\d{1,14}$
recaptcha required	string

Responses

Request samples

Payload

Content type

application/json

{"summary": "This is a short description of my issue.",
"description": "This is a long description of my issue.",
"category": "Data issue",
"isApplicationAccessible": false,
"isDataCorrupted": false,
"isResponseHandlingIssue": false,
"name": "Gary Johnson",
"email": "gary@smarterwx.com.au",
"phoneNumber": "+61393213444",
"recaptcha": "asdf9876asdf9867asd"
}

Get the GML style descriptor file for referral GML

Get the GML style descriptor file for referral GML attachments

Authorizations:

CognitoUserPool

Responses

Get the XML style descriptor file for referral XML

Get the XML style descriptor file for referral XML attachments

Authorizations:

CognitoUserPool

Responses

Return a list of notices

Authorizations:

CognitoUserPool

query Parameters

returnActiveOnly	boolean Example: returnActiveOnly=true Only return notices that should be displayed
filter	string Example: filter=startAfter:2021-05-30 A filter to be applied to returned results
limit	number Example: limit=5
offset	number Example: offset=0
fields	string Example: fields=startAt,endAt,title List of fields to be returned for each item
include	string Example: include=User List of additional data to be returned
order	string Example: order=-createdAt Describes how to sort the results
noticeType	string Example: noticeType=GENERAL Type of notices to be return
organisations	string Example: organisations=11,23,1423 ID of organisations separated by comma
withHidden	boolean Example: withHidden=false Return notice that is already mark as hidden

Responses

Response samples

200

Content type

application/json

{"Notices": [{"category": "IMPORTANT",
"targetRoles": ["SYSADMIN"
],
"isUserAbleToHide": false,
"title": "Something big is coming",
"text": "Get ready for the big thing that is coming",
"callToActionLabel": "Press the button",
"callToActionLink": "https://www.smarterwx.com/something-big-is-coming",
"startAt": "2021-05-30",
"endAt": "2021-06-30",
"icon": "info",
"noticeType": "GENERAL",
"organisations": [{"id": 11
},
{"id": 435
},
{"id": 1002
}
]
}
],
"Info": {"offset": 0,
"limit": 10,
"count": 3
}
}

Create a new notice

Authorizations:

CognitoUserPool

Request Body schema: application/json

category required	string Enum: "IMPORTANT" "NOTICE" "INFORMATION"
targetRoles required	Array of strings Items Enum: "SYSADMIN" "DBYDADMIN" "AOADMIN" "ENQUIRER" "UNAUTHENTICATED"
isUserAbleToHide	boolean
title required	string <= 50 characters
text	string <= 250 characters
callToActionLabel	string <= 30 characters
callToActionLink	string <= 250 characters
startAt required	string
endAt required	string
icon required	string <= 50 characters
noticeType	string <= 10 characters Enum: "GENERAL" "MEMBER"
organisations	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"category": "IMPORTANT",
"targetRoles": ["SYSADMIN"
],
"isUserAbleToHide": false,
"title": "Something big is coming",
"text": "Get ready for the big thing that is coming",
"callToActionLabel": "Press the button",
"callToActionLink": "https://www.smarterwx.com/something-big-is-coming",
"startAt": "2021-05-30",
"endAt": "2021-06-30",
"icon": "info",
"noticeType": "GENERAL",
"organisations": [{"id": 11
},
{"id": 435
},
{"id": 1002
}
]
}

Response samples

200

Content type

application/json

{"category": "IMPORTANT",
"targetRoles": ["SYSADMIN"
],
"isUserAbleToHide": false,
"title": "Something big is coming",
"text": "Get ready for the big thing that is coming",
"callToActionLabel": "Press the button",
"callToActionLink": "https://www.smarterwx.com/something-big-is-coming",
"startAt": "2021-05-30",
"endAt": "2021-06-30",
"icon": "info",
"noticeType": "GENERAL",
"organisations": [{"id": 11
},
{"id": 435
},
{"id": 1002
}
]
}

Return a list of notices

Authorizations:

CognitoUserPool

query Parameters

limit	number Example: limit=5
offset	number Example: offset=0
fields	string Example: fields=startAt,endAt,title List of fields to be returned for each item
order	string Example: order=-createdAt Describes how to sort the results

Responses

Response samples

200

Content type

application/json

{"Notices": [{"category": "IMPORTANT",
"targetRoles": ["SYSADMIN"
],
"isUserAbleToHide": false,
"title": "Something big is coming",
"text": "Get ready for the big thing that is coming",
"callToActionLabel": "Press the button",
"callToActionLink": "https://www.smarterwx.com/something-big-is-coming",
"startAt": "2021-05-30",
"endAt": "2021-06-30",
"icon": "info",
"noticeType": "GENERAL",
"organisations": [{"id": 11
},
{"id": 435
},
{"id": 1002
}
]
}
],
"Info": {"offset": 0,
"limit": 10,
"count": 3
}
}

Returns one particular notice

Authorizations:

CognitoUserPool

Responses

Response samples

200

Content type

application/json

{"category": "IMPORTANT",
"targetRoles": ["SYSADMIN"
],
"isUserAbleToHide": false,
"title": "Something big is coming",
"text": "Get ready for the big thing that is coming",
"callToActionLabel": "Press the button",
"callToActionLink": "https://www.smarterwx.com/something-big-is-coming",
"startAt": "2021-05-30",
"endAt": "2021-06-30",
"icon": "info",
"noticeType": "GENERAL",
"organisations": [{"id": 11
},
{"id": 435
},
{"id": 1002
}
]
}

Delete a notice

Authorizations:

CognitoUserPool

Responses

Update a notice

Authorizations:

CognitoUserPool

Request Body schema: application/json

category required	string Enum: "IMPORTANT" "NOTICE" "INFORMATION"
targetRoles required	Array of strings Items Enum: "SYSADMIN" "DBYDADMIN" "AOADMIN" "ENQUIRER" "UNAUTHENTICATED"
isUserAbleToHide	boolean
title required	string <= 50 characters
text	string <= 250 characters
callToActionLabel	string <= 30 characters
callToActionLink	string <= 250 characters
startAt required	string
endAt required	string
icon required	string <= 50 characters
noticeType	string <= 10 characters Enum: "GENERAL" "MEMBER"
organisations	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"category": "IMPORTANT",
"targetRoles": ["SYSADMIN"
],
"isUserAbleToHide": false,
"title": "Something big is coming",
"text": "Get ready for the big thing that is coming",
"callToActionLabel": "Press the button",
"callToActionLink": "https://www.smarterwx.com/something-big-is-coming",
"startAt": "2021-05-30",
"endAt": "2021-06-30",
"icon": "info",
"noticeType": "GENERAL",
"organisations": [{"id": 11
},
{"id": 435
},
{"id": 1002
}
]
}

Response samples

200

Content type

application/json

{"category": "IMPORTANT",
"targetRoles": ["SYSADMIN"
],
"isUserAbleToHide": false,
"title": "Something big is coming",
"text": "Get ready for the big thing that is coming",
"callToActionLabel": "Press the button",
"callToActionLink": "https://www.smarterwx.com/something-big-is-coming",
"startAt": "2021-05-30",
"endAt": "2021-06-30",
"icon": "info",
"noticeType": "GENERAL",
"organisations": [{"id": 11
},
{"id": 435
},
{"id": 1002
}
]
}

Hides a notice

Authorizations:

CognitoUserPool

Responses

Create a web launch request

Authorizations:

CognitoUserPool

Request Body schema: application/json

requestType	string Value: "WEB_ENQUIRY_AUTOMATION"
	object
isDryRun	boolean Indicates is only for testing and not create any records in database

Responses

Request samples

Payload

Content type

application/json

{"requestType": "WEB_ENQUIRY_AUTOMATION",
"data": {"userReference": "NBN Job Ref 124",
"digStartAt": "2020-08-08",
"digEndAt": "2020-08-15",
"shape": {"type": "Polygon",
"coordinates": [[[0,
0
],
[0,
0
],
[0,
0
],
[0,
0
]
]
],
"bbox": [0,
0,
0,
0
]
},
"isPlanningJob": true,
"activityTypes": ["MANUAL_EXCAVATION",
"HORIZ_BORING"
],
"authorityId": 134,
"otherAuthorityName": "Jim Digs",
"notes": "We are digging a hole.",
"locationTypes": ["Road Reserve"
],
"locationsInRoad": ["Road",
"Nature Strip"
],
"addressLine1": "613 King St",
"autoRenewUntil": "2021-06-01",
"isAutoSubmit": true
},
"isDryRun": true
}

Response samples

200

Content type

application/json

{"uuid": "fd07b9f3-dd85-4615-a1e8-8fced35ef2e5",
"enquiryCreateUrl": "https://smarterwx.1100.com.au/landing/fd07b9f3-dd85-4615-a1e8-8fced35ef2e5/enquirycreate",
"enquiryDetailUrl": "https://smarterwx.1100.com.au/landing/fd07b9f3-dd85-4615-a1e8-8fced35ef2e5//enquirydetail"
}

Get a web launch request

Authorizations:

CognitoUserPool

path Parameters

webLaunchRequestId

required

string <uuid>

Example: fd07b9f3-dd85-4615-a1e8-8fced35ef2e5

UUID of the web launch request to retrieve

Responses

Response samples

200

Content type

application/json

{"id": 234,
"uuid": "fd07b9f3-dd85-4615-a1e8-8fced35ef2e5",
"requestType": "WEB_ENQUIRY_AUTOMATION",
"payload": { },
"response": { },
"userId": 123,
"createdAt": "2020-08-01T03:36:00.000Z",
"updatedAt": "2020-08-01T03:36:00.000Z"
}

Proxy external image as base64

Authorizations:

CognitoUserPool

query Parameters

imageUrl

required

string <url>

Example: imageUrl=https://www.example.com/image/car.jpg

Image url of the image that need to be proxied

Responses

Response samples

200

Content type

application/json

"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAUFBQUFBQUGBgUICA..."