Inserts a new contact.
| Name | Description | Type | Additional information |
|---|---|---|---|
reportId |
The id of report where the contact will be linked to. |
integer |
Required |
The contact.
ChappReport.Site.Areas.Api.Models.V1.ReportContactV1ModelRequest| Name | Description | Type | Additional information |
|---|---|---|---|
Firstname |
The first name of the contact. |
string |
Max length: 50 |
Lastname |
The lastname of the contact. |
string |
Max length: 50 |
|
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. |
None. |
|
Type |
The way the contact is linked to the report. Possible values are: Tenant, TenantRepresentative, Landlord, LandlordRepresentative, Other, Owner, RealEstateManager, Architect, Bailiff, CourtClerk, Notary, Resident, Seller, Buyer, ConstructionCompany, Contractor, Insurer, Judge, Expert, SafetyCoordinator, CommissioningParty |
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 |
{
"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",
"ContactCategoryType": "Person",
"IsMandated": false
}
<ReportContactV1ModelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
<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>Person</ContactCategoryType>
<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>
</ReportContactV1ModelRequest>
The id of the created contact. In the location header is a uri where the contact can be retrieved.
ChappReport.Site.Areas.Api.Models.V1.CreatedResponse| Name | Description | Type | Additional information |
|---|---|---|---|
Id |
integer |
None. |
{
"Id": 1
}
<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>