POST Api/Estates/{estateId}/Reports

Inserts a new report.

Remarks

Some properties are no longer modifiable after posting a new report (for example: the language of the report, the checklist (see PUT for information on the updatable properties)).

Request Information

URI Parameters

Name	Description	Type	Additional information
estateId	The Id of the estate for which a report will be created.	integer	Required

Body Parameters

The report.

ChappReport.Site.Areas.Api.Models.V1.ReportV1ModelPostRequest

Name	Description	Type	Additional information
Type	Type of the report. Possible values: Initialization, MovingIn, CheckUp, PreMoveOut, MovingOut, Renovation, VacancyCheckUp, PreWork, ConcessionMovingIn, ConcessionMovingOut* (*Only available if the user has the required product)	string	Required
ChecklistId	This is the id of the checklist on which the report will be based.	integer	Range: inclusive between 1 and 2147483647
Furnished	Indicating whether the object to inspect is furnished.	boolean	None.
Language	The language in which the report is executed. List of ISO 2 DIGIT Language Codes (ISO 639-1)	string	Required String length: inclusive between 2 and 2
BasedOnPreviousReport	This report will inherit its structure, photos etc from the logical previous report of the provided estate. a MovingIn report will be based on the last completed report of type: Initialization, VacancyCheckUp, MovingOut a MovingOut report will be based on the last completed MovingIn, Renovation, PreMoveOut (If no such reports are found, then it's based on the last completed CheckUp) a CheckUp report will be based on the last completed report of type: CheckUp, MovingIn, Renovation (If no such reports are found, then it's based on the last completed PreMoveOut) a VacancyCheckUp report will be based on the last completed report of type: VacancyCheckUp, MovingOut a PreMoveOut report will be based on the last completed MovingIn (If no such reports are found, then it's based on the last completed CheckUp Or Renovation) a Renovation report will be based on the last completed report of type: MovingIn, Renovation a ConcessionMovingIn report will be based on the last completed ConcessionMovingOut report a ConcessionMovingOut report will be based on the last completed ConcessionMovingIn report	boolean	None.
Reference	The reference of the broker,expert,... This will be shown on the report.	string	Required Max length: 100
PreferredOn	DateTime indicating the preferred time of the execution of the report.	date	None.
PreferredOnComment	Comment on the preferred time.	string	Max length: 500
ScheduledOn	The scheduled date of execution of the inspection.	date	None.
AllowExecutorToEmailReport	Indicating whether the executor is allowed to send the reports by email immediately after execution.	boolean	None.
ExecutorId	The id of the executor of the report.	integer	Range: inclusive between 1 and 2147483647
MoveDate	Date when the tenant will move in or out (depending on report type).	date	None.
AccessKey	Information about the key to access the estate (key number, ..).	string	Max length: 100
AccessAlarmCode	Alarm code instructions in order to enter the estate.	string	Max length: 100
AccessComment	General comment about how to access the estate.	string	Max length: 200
CommentToExecutor	Comment from the operator or customer only visible for the executor.	string	None.
ContractStartDate	Start date of the rental contract.	date	None.
ContractEndDate	Stop date of the rental contract.	date	None.

Request Formats

application/json, text/json

Sample:

{
  "Type": "Initialization",
  "ChecklistId": 1,
  "Furnished": true,
  "Language": "NL",
  "BasedOnPreviousReport": false,
  "Reference": "ReportRef1",
  "PreferredOn": "2024-04-27T22:18:45",
  "PreferredOnComment": "Verhuurder kan onmogelijk vroeger.",
  "ScheduledOn": "2024-04-28T22:18:45",
  "AllowExecutorToEmailReport": true,
  "ExecutorId": 2
}

application/xml, text/xml

Sample:

<ReportV1ModelPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
  <AccessAlarmCode i:nil="true" />
  <AccessComment i:nil="true" />
  <AccessKey i:nil="true" />
  <AllowExecutorToEmailReport>true</AllowExecutorToEmailReport>
  <CommentToExecutor i:nil="true" />
  <ContractEndDate i:nil="true" />
  <ContractStartDate i:nil="true" />
  <ExecutorId>2</ExecutorId>
  <MoveDate i:nil="true" />
  <PreferredOn>2024-04-27T22:18:45</PreferredOn>
  <PreferredOnComment>Verhuurder kan onmogelijk vroeger.</PreferredOnComment>
  <Reference>ReportRef1</Reference>
  <ScheduledOn>2024-04-28T22:18:45</ScheduledOn>
  <BasedOnPreviousReport>false</BasedOnPreviousReport>
  <ChecklistId>1</ChecklistId>
  <Furnished>true</Furnished>
  <Language>NL</Language>
  <Type>Initialization</Type>
</ReportV1ModelPostRequest>

Response Information

Resource Description

The id of the created report. In the location header is a uri where the report can be retrieved.

ChappReport.Site.Areas.Api.Models.V1.CreatedResponse

Name	Description	Type	Additional information
Id		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1
}

application/xml, text/xml

Sample:

<CreatedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
  <Id>1</Id>
</CreatedResponse>