Skip to main content

Planning permission specifications

This is a proof of concept viewer for the planning permission specifications - your feedback will help us to improve it.

document

Document

Structure for submitted documents including reference, metadata, and file information

Fields

Reference
reference

Unique reference for the document within this application submission, generated by the submitting system

Required: True

Datatype: string

Expected number: 1

Name
name

The name or title of the document

Required: True

Datatype: string

Expected number: 1

Description
description

Brief description of what the document contains

Required: False

Datatype: string

Expected number: 1

Document types
document-types

List of codelist references that the document covers

Required: True

Datatype: enum

Expected number: 1 or more

Uploaded date
uploaded-date

The date the document was uploaded to the application

Required: True

Datatype: datetime

Expected number: 1

File
file

The digital file or a reference to where the file is stored

Required: True

Datatype: object

Expected number: 1

File component

Base64
base64-content

Base64-encoded content of the file for inline file uploads

Required: False

Datatype: string

Expected number: 1

Filename
filename

Name of the file being uploaded

Required: True

Datatype: string

Expected number: 1

MIME type
mime-type

The file's MIME type such as application/pdf or image/jpeg

Required: False

Datatype: string

Expected number: 1

File size
file-size

Size of the file in bytes that can be used to enforce limits

Required: False

Datatype: number

Expected number: 1