Premise¶
Get Premise Assessment Years¶
HTTP Request
GET /api/premises/{id}/assessment-years
📋 Description: Retrieves the assessment years associated with a specific premise, allowing users to access historical and current evaluation periods for informed decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the response should be paginated, allowing for efficient retrieval of assessment years associated with a specified premise. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "assessmentYears": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "year": 1900,
13 "rollNumber": "string",
14 "referenceNumber": "string",
15 "name": "string",
16 "propertyTypeId": 0,
17 "matriculeNumber": "string",
18 "proShare": 0,
19 "payToId": 0,
20 "rollStartYear": 1900,
21 "rollDuration": "string",
22 "commencementFrom": "2019-08-24",
23 "commencementTo": "2019-08-24",
24 "description": "string",
25 "propertyType": {
26 "createdBy": "string",
27 "lastModifiedBy": "string",
28 "createdDate": "2019-08-24T14:15:22Z",
29 "lastModifiedDate": "2019-08-24T14:15:22Z",
30 "archived": true,
31 "externalId": "string",
32 "id": 0,
33 "priority": 0,
34 "internalId": 0,
35 "pickListCode": "string",
36 "pickListLabel": "string",
37 "label": "string",
38 "cultureId": 0,
39 "labelDtos": [
40 {
41 "createdBy": "string",
42 "lastModifiedBy": "string",
43 "createdDate": "2019-08-24T14:15:22Z",
44 "lastModifiedDate": "2019-08-24T14:15:22Z",
45 "archived": true,
46 "externalId": "string",
47 "id": 0,
48 "cultureId": 0,
49 "value": "string"
50 }
51 ]
52 },
53 "payTo": {
54 "createdBy": "string",
55 "lastModifiedBy": "string",
56 "createdDate": "2019-08-24T14:15:22Z",
57 "lastModifiedDate": "2019-08-24T14:15:22Z",
58 "archived": true,
59 "externalId": "string",
60 "id": 0,
61 "priority": 0,
62 "internalId": 0,
63 "pickListCode": "string",
64 "pickListLabel": "string",
65 "label": "string",
66 "cultureId": 0,
67 "labelDtos": [
68 {
69 "createdBy": "string",
70 "lastModifiedBy": "string",
71 "createdDate": "2019-08-24T14:15:22Z",
72 "lastModifiedDate": "2019-08-24T14:15:22Z",
73 "archived": true,
74 "externalId": "string",
75 "id": 0,
76 "cultureId": 0,
77 "value": "string"
78 }
79 ]
80 },
81 "_links": {
82 "property1": {
83 "href": "string",
84 "hreflang": "string",
85 "title": "string",
86 "type": "string",
87 "deprecation": "string",
88 "profile": "string",
89 "name": "string",
90 "templated": true
91 },
92 "property2": {
93 "href": "string",
94 "hreflang": "string",
95 "title": "string",
96 "type": "string",
97 "deprecation": "string",
98 "profile": "string",
99 "name": "string",
100 "templated": true
101 }
102 }
103 }
104 ]
105 },
106 "_links": {
107 "property1": {
108 "href": "string",
109 "hreflang": "string",
110 "title": "string",
111 "type": "string",
112 "deprecation": "string",
113 "profile": "string",
114 "name": "string",
115 "templated": true
116 },
117 "property2": {
118 "href": "string",
119 "hreflang": "string",
120 "title": "string",
121 "type": "string",
122 "deprecation": "string",
123 "profile": "string",
124 "name": "string",
125 "templated": true
126 }
127 },
128 "page": {
129 "size": 0,
130 "totalElements": 0,
131 "totalPages": 0,
132 "number": 0
133 }
134}
Create Premise Assessment Year¶
HTTP Request
POST /api/premises/{id}/assessment-years
📋 Description: Creates a new assessment year for the specified premises, enabling the management of property evaluations and compliance within the business framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the assessment year details, including relevant metrics and attributes for the specified premises. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "year": 1900,
11 "rollNumber": "string",
12 "referenceNumber": "string",
13 "name": "string",
14 "propertyTypeId": 0,
15 "matriculeNumber": "string",
16 "proShare": 0,
17 "payToId": 0,
18 "rollStartYear": 1900,
19 "rollDuration": "string",
20 "commencementFrom": "2019-08-24",
21 "commencementTo": "2019-08-24",
22 "description": "string",
23 "propertyType": {
24 "createdBy": "string",
25 "lastModifiedBy": "string",
26 "createdDate": "2019-08-24T14:15:22Z",
27 "lastModifiedDate": "2019-08-24T14:15:22Z",
28 "archived": true,
29 "externalId": "string",
30 "id": 0,
31 "priority": 0,
32 "internalId": 0,
33 "pickListCode": "string",
34 "pickListLabel": "string",
35 "label": "string",
36 "cultureId": 0,
37 "labelDtos": [
38 {
39 "createdBy": "string",
40 "lastModifiedBy": "string",
41 "createdDate": "2019-08-24T14:15:22Z",
42 "lastModifiedDate": "2019-08-24T14:15:22Z",
43 "archived": true,
44 "externalId": "string",
45 "id": 0,
46 "cultureId": 0,
47 "value": "string"
48 }
49 ]
50 },
51 "payTo": {
52 "createdBy": "string",
53 "lastModifiedBy": "string",
54 "createdDate": "2019-08-24T14:15:22Z",
55 "lastModifiedDate": "2019-08-24T14:15:22Z",
56 "archived": true,
57 "externalId": "string",
58 "id": 0,
59 "priority": 0,
60 "internalId": 0,
61 "pickListCode": "string",
62 "pickListLabel": "string",
63 "label": "string",
64 "cultureId": 0,
65 "labelDtos": [
66 {
67 "createdBy": "string",
68 "lastModifiedBy": "string",
69 "createdDate": "2019-08-24T14:15:22Z",
70 "lastModifiedDate": "2019-08-24T14:15:22Z",
71 "archived": true,
72 "externalId": "string",
73 "id": 0,
74 "cultureId": 0,
75 "value": "string"
76 }
77 ]
78 }
79 }
80]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "year": 1900,
11 "rollNumber": "string",
12 "referenceNumber": "string",
13 "name": "string",
14 "propertyTypeId": 0,
15 "matriculeNumber": "string",
16 "proShare": 0,
17 "payToId": 0,
18 "rollStartYear": 1900,
19 "rollDuration": "string",
20 "commencementFrom": "2019-08-24",
21 "commencementTo": "2019-08-24",
22 "description": "string",
23 "propertyType": {
24 "createdBy": "string",
25 "lastModifiedBy": "string",
26 "createdDate": "2019-08-24T14:15:22Z",
27 "lastModifiedDate": "2019-08-24T14:15:22Z",
28 "archived": true,
29 "externalId": "string",
30 "id": 0,
31 "priority": 0,
32 "internalId": 0,
33 "pickListCode": "string",
34 "pickListLabel": "string",
35 "label": "string",
36 "cultureId": 0,
37 "labelDtos": [
38 {
39 "createdBy": "string",
40 "lastModifiedBy": "string",
41 "createdDate": "2019-08-24T14:15:22Z",
42 "lastModifiedDate": "2019-08-24T14:15:22Z",
43 "archived": true,
44 "externalId": "string",
45 "id": 0,
46 "cultureId": 0,
47 "value": "string"
48 }
49 ]
50 },
51 "payTo": {
52 "createdBy": "string",
53 "lastModifiedBy": "string",
54 "createdDate": "2019-08-24T14:15:22Z",
55 "lastModifiedDate": "2019-08-24T14:15:22Z",
56 "archived": true,
57 "externalId": "string",
58 "id": 0,
59 "priority": 0,
60 "internalId": 0,
61 "pickListCode": "string",
62 "pickListLabel": "string",
63 "label": "string",
64 "cultureId": 0,
65 "labelDtos": [
66 {
67 "createdBy": "string",
68 "lastModifiedBy": "string",
69 "createdDate": "2019-08-24T14:15:22Z",
70 "lastModifiedDate": "2019-08-24T14:15:22Z",
71 "archived": true,
72 "externalId": "string",
73 "id": 0,
74 "cultureId": 0,
75 "value": "string"
76 }
77 ]
78 }
79 }
80]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the assessment year, encapsulating key details necessary for evaluating performance metrics and strategic planning within the organization.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Indicates whether the assessment year has been archived, reflecting its status in the system for historical reference. |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» year |
integer(int32) |
true |
none |
Represents the assessment year for which the evaluation data is recorded, facilitating accurate year-over-year analysis and reporting. |
» rollNumber |
string |
true |
none |
Unique identifier assigned to each student for tracking their academic assessments within a specified assessment year. |
» referenceNumber |
string |
true |
none |
Unique identifier for the assessment year, facilitating tracking and management of related evaluations within the system. |
» name |
string |
true |
none |
Name of the resource |
» propertyTypeId |
integer(int64) |
false |
none |
Unique identifier for the property type |
» matriculeNumber |
string |
false |
none |
Unique identifier assigned to each individual for tracking and managing assessments within the specified assessment year. |
» proShare |
number |
false |
none |
Represents the proportional share of resources allocated for the specified assessment year, facilitating effective budget management and resource planning. |
» payToId |
integer(int64) |
false |
none |
Unique identifier for the pay to |
» rollStartYear |
integer(int32) |
true |
none |
Indicates the starting year for the assessment period, facilitating accurate tracking and reporting of assessment data. |
» rollDuration |
string |
true |
none |
Specifies the duration of the assessment period in a standardized format, facilitating effective planning and analysis of performance metrics. |
» commencementFrom |
string(date) |
false |
none |
Specifies the starting date for the assessment year, indicating when the evaluation period commences. |
» commencementTo |
string(date) |
false |
none |
Indicates the end date of the assessment period, providing a clear timeframe for evaluation and reporting purposes. |
» description |
string |
false |
none |
Description of the resource |
» propertyType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Indicates whether the pick list option has been archived, allowing for effective management of active and inactive options within the system. |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»» pickListCode |
string |
false |
none |
Code for the pick list |
»» pickListLabel |
string |
false |
none |
Label for the pick list |
»» label |
string |
false |
none |
Label for the resource |
»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»» labelDtos |
false |
none |
An array of pick list options that allows users to select and categorize relevant data points within the application. |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Indicates whether the label has been archived, reflecting its current status within the system. |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»» value |
string |
true |
none |
Represents the textual value associated with the label, providing essential context for categorization and identification within the system. |
» payTo |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |