Gets the specified report.
| Name | Description | Type | Additional information |
|---|---|---|---|
id |
The identifier of the report. |
integer |
Required |
includeMeters |
If present, the meters will be returned. |
boolean |
Default value is False |
includeStatistics |
If present, statistical data will be returned. |
boolean |
Default value is False |
None.
The requested report.
ChappReport.Site.Areas.Api.Models.V1.ReportV1ModelResponse| Name | Description | Type | Additional information |
|---|---|---|---|
Contacts |
A list of contacts linked to the report. |
Collection of ChappReport.Site.Areas.Api.Models.V1.ReportContactV1ModelResponse |
None. |
Language |
The language in which the report is executed. List of ISO 2 DIGIT Language Codes (ISO 639-1) |
string |
None. |
AllowExecutorToEmailReport |
Indicating whether the executor is allowed to send the reports by email immediately after execution. |
boolean |
None. |
PreferredOn |
DateTime indicating the preferred time of the execution of the report. |
date |
None. |
PreferredOnComment |
Comment on the preferred time. |
string |
None. |
ScheduledOn |
The scheduled date of execution of the inspection. |
date |
None. |
Meters |
A list of meters |
Collection of ChappReport.Site.Areas.Api.Models.V1.ReportMeterV1ModelResponse |
None. |
Statistics |
An object containing the statistics of the report (when completed). |
None. |
|
ContractStartDate |
The start date of the rental contract. |
date |
None. |
ContractEndDate |
The stop date of the rental contract. |
date |
None. |
Id |
The Chapps identifier of the report. |
integer |
None. |
Reference |
The reference of the broker,expert,... This will be shown on the report. |
string |
None. |
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 |
None. |
Url |
Returns a direct link where the report detail information can be retrieved. |
string |
None. |
FlowStatus |
The current status of the report. Possible values are ToBeAssigned, Initiated, ReadyForSyncToApp, ReceivedByApp, InProgress, CancelledByExecutor, RecallByOperator, BlockedBySignature, PostProcessing, Completed |
string |
None. |
Estate |
The estate of the report |
None. |
|
ExecutedOn |
The date of execution of the inspection. |
date |
None. |
ExecutorId |
The ID of the executor of the inspection |
integer |
None. |
Modified |
The last modification date of the report. |
date |
None. |
History |
Collection of ChappReport.Site.Areas.Api.Models.V1.ReportHistoryItemV1Model |
None. |
{
"Contacts": [
{
"Id": 1,
"Url": "http://rental.chapps.com/api/Reports/10/Contacts/1",
"Firstname": "Tenny",
"Lastname": "Tenant",
"Email": "TennyTenant@email.com",
"Telephone": "+31 477 12 45 89",
"Language": "NL",
"Address": {
"Street": "Leidse Plein",
"HouseNumber": 286,
"ZipCode": "1000 AA",
"City": "Amsterdam",
"Country": "NL"
},
"Type": "Tenant",
"IsMandated": false
},
{
"Id": 2,
"Url": "http://rental.chapps.com/api/Reports/10/Contacts/2",
"Firstname": "Landy",
"Lastname": "Lord",
"Email": "LandyLord@email.com",
"Telephone": "+33 6 7812 45 78",
"Language": "FR",
"Address": {
"Street": "Avenue Rachel",
"HouseNumber": 16,
"ZipCode": "75018",
"City": "Paris",
"Country": "FR"
},
"Type": "Landlord",
"IsMandated": false
}
],
"Language": "FR",
"AllowExecutorToEmailReport": true,
"PreferredOn": "2024-05-23T02:29:51",
"PreferredOnComment": "The landlord is unable to attend earlier.",
"ScheduledOn": "2024-05-23T02:29:51",
"Meters": [
{
"Id": 7529,
"Label": "Electricity meter - day",
"RecordingDate": "2024-04-23T02:29:51",
"Value": "48613.75",
"Code": "EAN489765163",
"Reference": "JI814EDEZ7832",
"PreviousRecordingDate": "2014-07-20T00:00:00",
"PreviousValue": "4814378",
"EnergySupplier": "Electro Supplier"
}
],
"Statistics": {
"ReportId": 1,
"ReportSubType": "MovingOut",
"NumberOfSpaces": 3,
"NumberOfFurnishedSpaces": 2,
"NumberOfFloors": 1,
"NumberOfIssues": 5,
"Spaces": [
{
"ReportItemId": 451,
"Label": "Kitchen",
"LocationPath": "/ 154 Highstreet / Interior / Kitchen",
"Furnished": true,
"NumberOfIssues": 1,
"TotalTime": 678.0
},
{
"ReportItemId": 452,
"Label": "Bathroom",
"LocationPath": "/ 154 Highstreet / Interior / Bathroom",
"Furnished": true,
"NumberOfIssues": 2,
"TotalTime": 512.0
},
{
"ReportItemId": 453,
"Label": "Living room",
"LocationPath": "/ 154 Highstreet / Interior / Living room",
"Furnished": true,
"NumberOfIssues": 2,
"TotalTime": 374.0
}
]
},
"Id": 1,
"Reference": "MyReportRef1",
"Type": "MovingIn",
"Url": "http://rental.chapps.com/api/Reports/1",
"FlowStatus": "Completed",
"Estate": {
"Id": 1,
"Url": "https://rental.chapps.com/api/Estates/1",
"Reference": "MyObjectRef1",
"Address": {
"Street": "Stadsplein",
"HouseNumber": 1,
"HouseNumberExtension": "a",
"ZipCode": "8800",
"City": "Roeselare",
"Country": "BE"
},
"Type": "Studio"
},
"ExecutedOn": "2024-04-20T02:29:51",
"ExecutorId": 1,
"Modified": "2024-04-22T02:29:51",
"History": [
{
"FlowStatus": "Draft",
"CreatedOn": "2024-04-18T02:29:51.3345752+02:00"
},
{
"FlowStatus": "ReadyForSyncToApp",
"CreatedOn": "2024-04-19T02:29:51.3345752+02:00"
},
{
"FlowStatus": "InProgress",
"CreatedOn": "2024-04-20T02:29:51.3345752+02:00"
},
{
"FlowStatus": "PostProcessing",
"CreatedOn": "2024-04-21T02:29:51.3345752+02:00"
},
{
"FlowStatus": "Completed",
"CreatedOn": "2024-04-22T02:29:51.3345752+02:00"
}
]
}
<ReportV1ModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
<Estate>
<Address>
<City>Roeselare</City>
<Country>BE</Country>
<HouseNumber>1</HouseNumber>
<HouseNumberExtension>a</HouseNumberExtension>
<Mailbox i:nil="true" />
<State i:nil="true" />
<Street>Stadsplein</Street>
<ZipCode>8800</ZipCode>
</Address>
<EstateGroupId i:nil="true" />
<OfficeId i:nil="true" />
<PartnerReference i:nil="true" />
<Reference>MyObjectRef1</Reference>
<Type>Studio</Type>
<Id>1</Id>
<Url>https://rental.chapps.com/api/Estates/1</Url>
</Estate>
<ExecutedOn>2024-04-20T02:29:51</ExecutedOn>
<ExecutorId>1</ExecutorId>
<FlowStatus>Completed</FlowStatus>
<History>
<ReportHistoryItemV1Model>
<CreatedOn>2024-04-18T02:29:51.3345752+02:00</CreatedOn>
<FlowStatus>Draft</FlowStatus>
</ReportHistoryItemV1Model>
<ReportHistoryItemV1Model>
<CreatedOn>2024-04-19T02:29:51.3345752+02:00</CreatedOn>
<FlowStatus>ReadyForSyncToApp</FlowStatus>
</ReportHistoryItemV1Model>
<ReportHistoryItemV1Model>
<CreatedOn>2024-04-20T02:29:51.3345752+02:00</CreatedOn>
<FlowStatus>InProgress</FlowStatus>
</ReportHistoryItemV1Model>
<ReportHistoryItemV1Model>
<CreatedOn>2024-04-21T02:29:51.3345752+02:00</CreatedOn>
<FlowStatus>PostProcessing</FlowStatus>
</ReportHistoryItemV1Model>
<ReportHistoryItemV1Model>
<CreatedOn>2024-04-22T02:29:51.3345752+02:00</CreatedOn>
<FlowStatus>Completed</FlowStatus>
</ReportHistoryItemV1Model>
</History>
<Id>1</Id>
<Modified>2024-04-22T02:29:51</Modified>
<Reference>MyReportRef1</Reference>
<Type>MovingIn</Type>
<Url>http://rental.chapps.com/api/Reports/1</Url>
<AllowExecutorToEmailReport>true</AllowExecutorToEmailReport>
<Contacts>
<ReportContactV1ModelResponse>
<Address>
<City>Amsterdam</City>
<Country>NL</Country>
<HouseNumber>286</HouseNumber>
<HouseNumberExtension i:nil="true" />
<Mailbox i:nil="true" />
<State i:nil="true" />
<Street>Leidse Plein</Street>
<ZipCode>1000 AA</ZipCode>
</Address>
<BusinessNumber i:nil="true" />
<CompanyName i:nil="true" />
<ContactCategoryType i:nil="true" />
<DateOfBirth i:nil="true" />
<Email>TennyTenant@email.com</Email>
<Firstname>Tenny</Firstname>
<IsMandated>false</IsMandated>
<Language>NL</Language>
<Lastname>Tenant</Lastname>
<NationalRegistrationNumber i:nil="true" />
<PlaceOfBirth i:nil="true" />
<Telephone>+31 477 12 45 89</Telephone>
<Type>Tenant</Type>
<Id>1</Id>
<Url>http://rental.chapps.com/api/Reports/10/Contacts/1</Url>
</ReportContactV1ModelResponse>
<ReportContactV1ModelResponse>
<Address>
<City>Paris</City>
<Country>FR</Country>
<HouseNumber>16</HouseNumber>
<HouseNumberExtension i:nil="true" />
<Mailbox i:nil="true" />
<State i:nil="true" />
<Street>Avenue Rachel</Street>
<ZipCode>75018</ZipCode>
</Address>
<BusinessNumber i:nil="true" />
<CompanyName i:nil="true" />
<ContactCategoryType i:nil="true" />
<DateOfBirth i:nil="true" />
<Email>LandyLord@email.com</Email>
<Firstname>Landy</Firstname>
<IsMandated>false</IsMandated>
<Language>FR</Language>
<Lastname>Lord</Lastname>
<NationalRegistrationNumber i:nil="true" />
<PlaceOfBirth i:nil="true" />
<Telephone>+33 6 7812 45 78</Telephone>
<Type>Landlord</Type>
<Id>2</Id>
<Url>http://rental.chapps.com/api/Reports/10/Contacts/2</Url>
</ReportContactV1ModelResponse>
</Contacts>
<ContractEndDate i:nil="true" />
<ContractStartDate i:nil="true" />
<Language>FR</Language>
<Meters>
<ReportMeterV1ModelResponse>
<Code>EAN489765163</Code>
<EnergySupplier>Electro Supplier</EnergySupplier>
<Id>7529</Id>
<Label>Electricity meter - day</Label>
<PreviousRecordingDate>2014-07-20T00:00:00</PreviousRecordingDate>
<PreviousValue>4814378</PreviousValue>
<RecordingDate>2024-04-23T02:29:51</RecordingDate>
<Reference>JI814EDEZ7832</Reference>
<Url i:nil="true" />
<Value>48613.75</Value>
</ReportMeterV1ModelResponse>
</Meters>
<PreferredOn>2024-05-23T02:29:51</PreferredOn>
<PreferredOnComment>The landlord is unable to attend earlier.</PreferredOnComment>
<ScheduledOn>2024-05-23T02:29:51</ScheduledOn>
<Statistics xmlns:d2p1="http://schemas.datacontract.org/2004/07/ChappReport.OM">
<d2p1:NumberOfFloors>1</d2p1:NumberOfFloors>
<d2p1:NumberOfFurnishedSpaces>2</d2p1:NumberOfFurnishedSpaces>
<d2p1:NumberOfIssues>5</d2p1:NumberOfIssues>
<d2p1:NumberOfSpaces>3</d2p1:NumberOfSpaces>
<d2p1:ReportId>1</d2p1:ReportId>
<d2p1:ReportSubType>MovingOut</d2p1:ReportSubType>
<d2p1:Spaces>
<d2p1:ReportStatistic.Space>
<d2p1:Furnished>true</d2p1:Furnished>
<d2p1:Label>Kitchen</d2p1:Label>
<d2p1:LocationPath>/ 154 Highstreet / Interior / Kitchen</d2p1:LocationPath>
<d2p1:NumberOfIssues>1</d2p1:NumberOfIssues>
<d2p1:ReportItemId>451</d2p1:ReportItemId>
<d2p1:TotalTime>678</d2p1:TotalTime>
</d2p1:ReportStatistic.Space>
<d2p1:ReportStatistic.Space>
<d2p1:Furnished>true</d2p1:Furnished>
<d2p1:Label>Bathroom</d2p1:Label>
<d2p1:LocationPath>/ 154 Highstreet / Interior / Bathroom</d2p1:LocationPath>
<d2p1:NumberOfIssues>2</d2p1:NumberOfIssues>
<d2p1:ReportItemId>452</d2p1:ReportItemId>
<d2p1:TotalTime>512</d2p1:TotalTime>
</d2p1:ReportStatistic.Space>
<d2p1:ReportStatistic.Space>
<d2p1:Furnished>true</d2p1:Furnished>
<d2p1:Label>Living room</d2p1:Label>
<d2p1:LocationPath>/ 154 Highstreet / Interior / Living room</d2p1:LocationPath>
<d2p1:NumberOfIssues>2</d2p1:NumberOfIssues>
<d2p1:ReportItemId>453</d2p1:ReportItemId>
<d2p1:TotalTime>374</d2p1:TotalTime>
</d2p1:ReportStatistic.Space>
</d2p1:Spaces>
<d2p1:TotalTime i:nil="true" />
</Statistics>
</ReportV1ModelResponse>