logo

Back to Help Home Page.

PUT Api/Reports/{id}

Updates the specified report.

Remarks

The type of the report can not be changed.

Request Information

URI Parameters

NameDescriptionTypeAdditional information

id

The identifier of the report to update.

integer

Required

Body Parameters

The report.

ChappReport.Site.Areas.Api.Models.V1.ReportV1ModelRequest
NameDescriptionTypeAdditional information

ReadyForSyncToApp

Indicates whether the app (on Android tablet or Ipad) is allowed to retrieve the report. This can only happen if all required properties for syncing are filled in.

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:
{
  "ReadyForSyncToApp": true,
  "Reference": "ReportRef1",
  "PreferredOn": "2024-03-29T19:03:35",
  "PreferredOnComment": "Verhuurder kan onmogelijk vroeger.",
  "ScheduledOn": "2024-03-30T19:03:35",
  "AllowExecutorToEmailReport": true,
  "ExecutorId": 1
}

application/xml, text/xml

Sample:
<ReportV1ModelRequest 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>1</ExecutorId>
  <MoveDate i:nil="true" />
  <PreferredOn>2024-03-29T19:03:35</PreferredOn>
  <PreferredOnComment>Verhuurder kan onmogelijk vroeger.</PreferredOnComment>
  <Reference>ReportRef1</Reference>
  <ScheduledOn>2024-03-30T19:03:35</ScheduledOn>
  <ReadyForSyncToApp>true</ReadyForSyncToApp>
</ReportV1ModelRequest>

Response Information

Resource Description

None.