logo

Back to Help Home Page.

GET Api/Reports/{reportId}/Contacts

Gets the contacts linked to the provided report.

Request Information

URI Parameters

NameDescriptionTypeAdditional information

reportId

The identifier of the report.

integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of contacts.

Collection of ChappReport.Site.Areas.Api.Models.V1.ReportContactV1ModelResponse
NameDescriptionTypeAdditional information

Id

The contact Id of the reportContact.

integer

None.

Url

Returns a direct link where the contact detail information can be retrieved.

string

None.

Firstname

The first name of the contact.

string

Max length: 50

Lastname

The lastname of the contact.

string

Max length: 50

Email

The email of the contact.

string

Max length: 100

Telephone

The primary telephone of the contact.

string

Max length: 50

Language

The communication language of the contact. List of ISO 2 DIGIT Language Codes (ISO 639-1)

string

String length: inclusive between 2 and 2

Address

The address of the contact.

ChappReport.Site.Areas.Api.Models.V1.AddressV1Model

None.

Type

The way the contact is linked to the report. Possible values are: Tenant, Landlord

string

Required

ContactCategoryType

Business or Person

string

Required

CompanyName

The name of the company, required if ContactType is of type Business

string

None.

BusinessNumber

The business number if the contactType is of type Business

string

None.

IsMandated

Whether the executor is by default mandated to sign the documents

boolean

None.

NationalRegistrationNumber

National registration number / Rijksregisterennummer

string

None.

DateOfBirth

date

None.

PlaceOfBirth

string

String length: inclusive between 2 and 50

Response Formats

application/json, text/json

Sample:
[
  {
    "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
  }
]

application/xml, text/xml

Sample:
<ArrayOfReportContactV1ModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
  <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>
</ArrayOfReportContactV1ModelResponse>