submission-details

Submission details

Details about the submitted payload, including reference information, application types, specification profile, destination, documents, and fees

Fields

• Submission reference submission-reference:

  A unique reference for the submission

  Required: True

  Datatype: string

  Expected number: 1

• Application types application-types:

  A list of planning application types that define the nature of the planning application

  Required: True

  Datatype: enum

  Expected number: 1 or more

• Specification profile specification-profile:

  The specification profile used to determine context-specific allowed codelist values for the application

  Required: True

  Datatype: enum

  Expected number: 1

• Planning authority planning-authority:

  A reference of the planning authority the application has been submitted to, e.g. local-authority:CMD for London borough of Camden

  Required: True

  Datatype: enum

  Expected number: 1

• Submitted at submitted-at:

  The date and time the application was submitted

  Required: True

  Datatype: datetime

  Expected number: 1

• Created at created-at:

  The date and time the submission payload was created

  Required: True

  Datatype: datetime

  Expected number: 1

• Documents documents:

  List of submitted documents with references and details

  Required: True

  Datatype: object

  Expected number: 1 or more

  Document component

  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

• 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

• 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

• Fee fee:

  The fee payable for the application including amounts and transaction details

  Required: False

  Datatype: object

  Expected number: 1

  Fee component

  Amount

  amount

  The total amount due for the application fee

  Required: True

  Datatype: number

  Expected number: 1

  Amount paid

  amount-paid

  The amount paid towards the application fee

  Required: True

  Datatype: number

  Expected number: 1

  Transactions

  transactions

  References to payments or financial transactions related to this application

  Required: False

  Datatype: string

  Expected number: 1 or more

• Amount amount:

  The total amount due for the application fee

  Required: True

  Datatype: number

  Expected number: 1

• Amount paid amount-paid:

  The amount paid towards the application fee

  Required: True

  Datatype: number

  Expected number: 1

• Transactions transactions:

  References to payments or financial transactions related to this application

  Required: False

  Datatype: string

  Expected number: 1 or more