Skip to content

Commit ade8776

Browse files
actions-useractions-user
committed
Latest generated outputs 2025-08-22
1 parent 9c697f0 commit ade8776

24 files changed

+1355
-106
lines changed

‎generated/info_model/application/advertising.md‎

Lines changed: 60 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,65 @@ An application for all types of advertisements and signs
2525
* [Site details](#site-details)
2626
* [Site Visit Details](#site-visit-details)
2727

28-
## Application data specification
28+
# Application fields
2929

30-
| field | description | data-type | required | notes |
30+
Core planning application structure containing reference information,
31+
application types, submission details, modules, documents, and fees
32+
33+
34+
| reference | name | description | requirement | notes |
3135
| --- | --- | --- | --- | --- |
32-
| application | The details of the application payload to be submitted | object | MUST | |
36+
| reference | Reference | A unique reference for the data item | MUST | |
37+
| application-types | Application types[] | A list of planning application types that define the nature of the planning application | MUST | Select from the **application-type** enum |
38+
| application-sub-type | Application sub type | Further classification of the application type for specific variations within the main application type | MAY | Select from the **application-sub-type** enum |
39+
| planning-authority | Planning authority | The reference of the planning authority the application has been submitted to, e.g. local-authority:CMD | MUST | |
40+
| submission-date | Submission date | Date the application is submitted in YYYY-MM-DD format | MUST | |
41+
| modules | Modules[] | List of required modules for this application that can be used to validate the application | MUST | |
42+
| documents | Documents[]{} | List of submitted documents with references and details | MUST | |
43+
| fee | Fee{} | The fee payable for the application including amounts and transaction details | MAY | |
44+
45+
46+
**Document model**
47+
48+
field | name | description | required | notes
49+
-- | -- | -- | -- | --
50+
reference | Reference | A unique reference for the data item | MUST |
51+
name | Name | A name of a person | MUST |
52+
description | Description | A text description providing details about the subject. For parking changes, this describes how the proposed works affect existing car parking arrangements. | MAY |
53+
document-types | Document types[] | List of codelist references that the document covers | MUST | Select from the **planning-requirement** enum
54+
file | File{} | The digital file or a reference to where the file is stored | MUST |
55+
56+
57+
**Fee model**
58+
59+
field | name | description | required | notes
60+
-- | -- | -- | -- | --
61+
amount | Amount | The total amount due for the application fee | MUST |
62+
amount-paid | Amount paid | The amount paid towards the application fee | MUST |
63+
transactions | Transactions[] | References to payments or financial transactions related to this application | MAY |
64+
65+
66+
**File model**
67+
68+
field | name | description | required | notes
69+
-- | -- | -- | -- | --
70+
url | URL | A URL pointing to the stored file for previously uploaded or hosted files | MAY |
71+
base64-content | Base64 | Base64-encoded content of the file for inline file uploads | MAY |
72+
filename | Filename | Name of the file being uploaded useful for identifying and preserving the file | MUST |
73+
mime-type | MIME type | The file's MIME type such as application/pdf or image/jpeg | MAY |
74+
checksum | Checksum | Hash of the file contents used for file validation and checking files have not been tampered with | MAY |
75+
file-size | File size | Size of the file in bytes that can be used to enforce limits | MAY |
76+
77+
**Validation rules**
78+
79+
- reference must be a valid UUID format
80+
- application-types must reference valid application type codelist values
81+
- application-sub-type must reference valid application sub-type codelist values
82+
- planning-authority must be a valid organisation reference
83+
- modules must reference existing module definitions
84+
- document references must be unique within the application
85+
- file must contain either url or base64, but not both
86+
- document-types must reference valid planning requirement codelist values
3387

3488
## Advertisement location
3589

@@ -455,7 +509,7 @@ email | Email | The email address that can be used for electronic correspondence
455509

456510
This are the codelist required to support this specification:
457511

458-
- user-role-type
459512
- illumination-type
460-
- contact-priority
461-
- advertisement-type
513+
- advertisement-type
514+
- user-role-type
515+
- contact-priority

‎generated/info_model/application/approval-condition.md‎

Lines changed: 59 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,65 @@ An application to have conditions approved which have been applied at the time o
2222
* [Site details](#site-details)
2323
* [Site Visit Details](#site-visit-details)
2424

25-
## Application data specification
25+
# Application fields
2626

27-
| field | description | data-type | required | notes |
27+
Core planning application structure containing reference information,
28+
application types, submission details, modules, documents, and fees
29+
30+
31+
| reference | name | description | requirement | notes |
2832
| --- | --- | --- | --- | --- |
29-
| application | The details of the application payload to be submitted | object | MUST | |
33+
| reference | Reference | A unique reference for the data item | MUST | |
34+
| application-types | Application types[] | A list of planning application types that define the nature of the planning application | MUST | Select from the **application-type** enum |
35+
| application-sub-type | Application sub type | Further classification of the application type for specific variations within the main application type | MAY | Select from the **application-sub-type** enum |
36+
| planning-authority | Planning authority | The reference of the planning authority the application has been submitted to, e.g. local-authority:CMD | MUST | |
37+
| submission-date | Submission date | Date the application is submitted in YYYY-MM-DD format | MUST | |
38+
| modules | Modules[] | List of required modules for this application that can be used to validate the application | MUST | |
39+
| documents | Documents[]{} | List of submitted documents with references and details | MUST | |
40+
| fee | Fee{} | The fee payable for the application including amounts and transaction details | MAY | |
41+
42+
43+
**Document model**
44+
45+
field | name | description | required | notes
46+
-- | -- | -- | -- | --
47+
reference | Reference | A unique reference for the data item | MUST |
48+
name | Name | A name of a person | MUST |
49+
description | Description | A text description providing details about the subject. For parking changes, this describes how the proposed works affect existing car parking arrangements. | MAY |
50+
document-types | Document types[] | List of codelist references that the document covers | MUST | Select from the **planning-requirement** enum
51+
file | File{} | The digital file or a reference to where the file is stored | MUST |
52+
53+
54+
**Fee model**
55+
56+
field | name | description | required | notes
57+
-- | -- | -- | -- | --
58+
amount | Amount | The total amount due for the application fee | MUST |
59+
amount-paid | Amount paid | The amount paid towards the application fee | MUST |
60+
transactions | Transactions[] | References to payments or financial transactions related to this application | MAY |
61+
62+
63+
**File model**
64+
65+
field | name | description | required | notes
66+
-- | -- | -- | -- | --
67+
url | URL | A URL pointing to the stored file for previously uploaded or hosted files | MAY |
68+
base64-content | Base64 | Base64-encoded content of the file for inline file uploads | MAY |
69+
filename | Filename | Name of the file being uploaded useful for identifying and preserving the file | MUST |
70+
mime-type | MIME type | The file's MIME type such as application/pdf or image/jpeg | MAY |
71+
checksum | Checksum | Hash of the file contents used for file validation and checking files have not been tampered with | MAY |
72+
file-size | File size | Size of the file in bytes that can be used to enforce limits | MAY |
73+
74+
**Validation rules**
75+
76+
- reference must be a valid UUID format
77+
- application-types must reference valid application type codelist values
78+
- application-sub-type must reference valid application sub-type codelist values
79+
- planning-authority must be a valid organisation reference
80+
- modules must reference existing module definitions
81+
- document references must be unique within the application
82+
- file must contain either url or base64, but not both
83+
- document-types must reference valid planning requirement codelist values
3084

3185
## Agent contact details
3286

@@ -342,5 +396,5 @@ email | Email | The email address that can be used for electronic correspondence
342396

343397
This are the codelist required to support this specification:
344398

345-
- contact-priority
346-
- user-role-type
399+
- user-role-type
400+
- contact-priority

‎generated/info_model/application/consent-under-tpo.md‎

Lines changed: 59 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,65 @@ An application that will affect a protected tree including those covered by a Tr
2020
* [Trees additional information](#trees-additional-information)
2121
* [Trees ownership](#trees-ownership)
2222

23-
## Application data specification
23+
# Application fields
2424

25-
| field | description | data-type | required | notes |
25+
Core planning application structure containing reference information,
26+
application types, submission details, modules, documents, and fees
27+
28+
29+
| reference | name | description | requirement | notes |
2630
| --- | --- | --- | --- | --- |
27-
| application | The details of the application payload to be submitted | object | MUST | |
31+
| reference | Reference | A unique reference for the data item | MUST | |
32+
| application-types | Application types[] | A list of planning application types that define the nature of the planning application | MUST | Select from the **application-type** enum |
33+
| application-sub-type | Application sub type | Further classification of the application type for specific variations within the main application type | MAY | Select from the **application-sub-type** enum |
34+
| planning-authority | Planning authority | The reference of the planning authority the application has been submitted to, e.g. local-authority:CMD | MUST | |
35+
| submission-date | Submission date | Date the application is submitted in YYYY-MM-DD format | MUST | |
36+
| modules | Modules[] | List of required modules for this application that can be used to validate the application | MUST | |
37+
| documents | Documents[]{} | List of submitted documents with references and details | MUST | |
38+
| fee | Fee{} | The fee payable for the application including amounts and transaction details | MAY | |
39+
40+
41+
**Document model**
42+
43+
field | name | description | required | notes
44+
-- | -- | -- | -- | --
45+
reference | Reference | A unique reference for the data item | MUST |
46+
name | Name | A name of a person | MUST |
47+
description | Description | A text description providing details about the subject. For parking changes, this describes how the proposed works affect existing car parking arrangements. | MAY |
48+
document-types | Document types[] | List of codelist references that the document covers | MUST | Select from the **planning-requirement** enum
49+
file | File{} | The digital file or a reference to where the file is stored | MUST |
50+
51+
52+
**Fee model**
53+
54+
field | name | description | required | notes
55+
-- | -- | -- | -- | --
56+
amount | Amount | The total amount due for the application fee | MUST |
57+
amount-paid | Amount paid | The amount paid towards the application fee | MUST |
58+
transactions | Transactions[] | References to payments or financial transactions related to this application | MAY |
59+
60+
61+
**File model**
62+
63+
field | name | description | required | notes
64+
-- | -- | -- | -- | --
65+
url | URL | A URL pointing to the stored file for previously uploaded or hosted files | MAY |
66+
base64-content | Base64 | Base64-encoded content of the file for inline file uploads | MAY |
67+
filename | Filename | Name of the file being uploaded useful for identifying and preserving the file | MUST |
68+
mime-type | MIME type | The file's MIME type such as application/pdf or image/jpeg | MAY |
69+
checksum | Checksum | Hash of the file contents used for file validation and checking files have not been tampered with | MAY |
70+
file-size | File size | Size of the file in bytes that can be used to enforce limits | MAY |
71+
72+
**Validation rules**
73+
74+
- reference must be a valid UUID format
75+
- application-types must reference valid application type codelist values
76+
- application-sub-type must reference valid application sub-type codelist values
77+
- planning-authority must be a valid organisation reference
78+
- modules must reference existing module definitions
79+
- document references must be unique within the application
80+
- file must contain either url or base64, but not both
81+
- document-types must reference valid planning requirement codelist values
2882

2983
## Agent contact details
3084

@@ -323,5 +377,5 @@ contact-priority | Contact priority | The priority of a number | MAY | Select fr
323377

324378
This are the codelist required to support this specification:
325379

326-
- contact-priority
327-
- user-role-type
380+
- user-role-type
381+
- contact-priority

‎generated/info_model/application/demolition-con-area.md‎

Lines changed: 59 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,65 @@ An application for proposals involving substantial demolition of any unlisted bu
2525
* [Site details](#site-details)
2626
* [Site Visit Details](#site-visit-details)
2727

28-
## Application data specification
28+
# Application fields
2929

30-
| field | description | data-type | required | notes |
30+
Core planning application structure containing reference information,
31+
application types, submission details, modules, documents, and fees
32+
33+
34+
| reference | name | description | requirement | notes |
3135
| --- | --- | --- | --- | --- |
32-
| application | The details of the application payload to be submitted | object | MUST | |
36+
| reference | Reference | A unique reference for the data item | MUST | |
37+
| application-types | Application types[] | A list of planning application types that define the nature of the planning application | MUST | Select from the **application-type** enum |
38+
| application-sub-type | Application sub type | Further classification of the application type for specific variations within the main application type | MAY | Select from the **application-sub-type** enum |
39+
| planning-authority | Planning authority | The reference of the planning authority the application has been submitted to, e.g. local-authority:CMD | MUST | |
40+
| submission-date | Submission date | Date the application is submitted in YYYY-MM-DD format | MUST | |
41+
| modules | Modules[] | List of required modules for this application that can be used to validate the application | MUST | |
42+
| documents | Documents[]{} | List of submitted documents with references and details | MUST | |
43+
| fee | Fee{} | The fee payable for the application including amounts and transaction details | MAY | |
44+
45+
46+
**Document model**
47+
48+
field | name | description | required | notes
49+
-- | -- | -- | -- | --
50+
reference | Reference | A unique reference for the data item | MUST |
51+
name | Name | A name of a person | MUST |
52+
description | Description | A text description providing details about the subject. For parking changes, this describes how the proposed works affect existing car parking arrangements. | MAY |
53+
document-types | Document types[] | List of codelist references that the document covers | MUST | Select from the **planning-requirement** enum
54+
file | File{} | The digital file or a reference to where the file is stored | MUST |
55+
56+
57+
**Fee model**
58+
59+
field | name | description | required | notes
60+
-- | -- | -- | -- | --
61+
amount | Amount | The total amount due for the application fee | MUST |
62+
amount-paid | Amount paid | The amount paid towards the application fee | MUST |
63+
transactions | Transactions[] | References to payments or financial transactions related to this application | MAY |
64+
65+
66+
**File model**
67+
68+
field | name | description | required | notes
69+
-- | -- | -- | -- | --
70+
url | URL | A URL pointing to the stored file for previously uploaded or hosted files | MAY |
71+
base64-content | Base64 | Base64-encoded content of the file for inline file uploads | MAY |
72+
filename | Filename | Name of the file being uploaded useful for identifying and preserving the file | MUST |
73+
mime-type | MIME type | The file's MIME type such as application/pdf or image/jpeg | MAY |
74+
checksum | Checksum | Hash of the file contents used for file validation and checking files have not been tampered with | MAY |
75+
file-size | File size | Size of the file in bytes that can be used to enforce limits | MAY |
76+
77+
**Validation rules**
78+
79+
- reference must be a valid UUID format
80+
- application-types must reference valid application type codelist values
81+
- application-sub-type must reference valid application sub-type codelist values
82+
- planning-authority must be a valid organisation reference
83+
- modules must reference existing module definitions
84+
- document references must be unique within the application
85+
- file must contain either url or base64, but not both
86+
- document-types must reference valid planning requirement codelist values
3387

3488
## Applicant contact details
3589

@@ -467,6 +521,6 @@ email | Email | The email address that can be used for electronic correspondence
467521

468522
This are the codelist required to support this specification:
469523

524+
- user-role-type
470525
- bng-exemption-type
471-
- contact-priority
472-
- user-role-type
526+
- contact-priority

0 commit comments

Comments
 (0)