basePath: /v1/maritime
consumes:
- '*/*'
definitions:
ErrorDetails:
description: Error response
example:
ErrorDetails:
ErrorDateTime: XXXXXXXXXX
Message: XXXXXXXXXX
RequestedMethod: XXXXXXXXXX
RequestedUrl: XXXXXXXXXX
TransactionId: XXXXXXXXXX
properties:
ErrorDateTime:
type: string
Message:
type: string
RequestedMethod:
type: string
RequestedUrl:
type: string
TransactionId:
type: string
required:
- TransactionId
- ErrorDateTime
- Message
- RequestedUrl
- RequestedMethod
type: object
host: api.transport.nsw.gov.au
info:
title: Maritime No Towing Zone API
version: '1.0'
paths:
/spatial:
get:
description: "Standard SQL is accepted including aggrate functions such\
\ as count, max, min. \n Order by and limit is also supported
\
\
\n \n Some example queries are:
\n SELECT * FROM\
\ maritime_no_towing_zones LIMIT 50 \n
\n Current tables offered\
\ to users are:
\n maritime_no_towing_zones
\n \
\ \n This API is based on PostgreSQL. \n You can view the official documentation\
\ for further details on query syntax.\n"
parameters:
- default: geojson
description: Select format of the return data
enum:
- csv
- kml
- geojson
- shp
format: int32
in: query
name: format
required: false
type: string
- default: 'select * from maritime_no_towing_zones limit 50 '
description: Sql query you wish to execute
in: query
name: q
required: false
type: string
produces:
- application/json
- csv
- kml
- shp
responses:
'200':
description: The request has been processed successfully.
examples: {}
schema:
type: file
'401':
description: The application calling the API has not been authenticated.
examples: {}
schema:
$ref: '#/definitions/ErrorDetails'
'404':
description: The requested resource could not be found.
examples: {}
schema:
$ref: '#/definitions/ErrorDetails'
'500':
description: An internal error has occured.
examples: {}
schema:
$ref: '#/definitions/ErrorDetails'
'503':
description: The server is currently unavailable.
examples: {}
schema:
$ref: '#/definitions/ErrorDetails'
summary: Execute various queries on the Maritime No Towing Zone API
produces:
- application/zip
schemes:
- https
security:
- APIKey: []
securityDefinitions:
APIKey:
description: 'Expected Format: apikey [TOKEN]'
in: header
name: Authorization
type: apiKey
swagger: '2.0'
tags:
- name: gtfs