Kolibri API
v2.0
by RonaldEvers

Kolibri API

Operations
AgendaItemCategories
AgendaItemCategories_Read
GET /v2/AgendaItemCategories
AgendaItemCategories_Search
POST /v2/AgendaItemCategories/Search
AgendaItemCategories_Read
GET /v2/AgendaItemCategories

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

AgendaItem category details are in message body. or

Body
SingleAgendaItemCategoryResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested agendaItem category could not be found.

Body
HttpError
POST /v2/AgendaItemCategories/Search

Authentication

Bearer

Request body

SearchRequest

Responses

200 200

Search results are in message body. or

Body
SearchResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
ObjectTypeAssignments
ObjectTypeAssignments_DefineNew
POST /v2/ObjectTypeAssignments/DefineNew
ObjectTypeAssignments_Read
GET /v2/ObjectTypeAssignments
ObjectTypeAssignments_Save
POST /v2/ObjectTypeAssignments
ObjectTypeAssignments_Delete
DELETE /v2/ObjectTypeAssignments
ObjectTypeAssignments_Undelete
POST /v2/ObjectTypeAssignments/Undelete
ObjectTypeAssignments_DefineNew
POST /v2/ObjectTypeAssignments/DefineNew

Authentication

Bearer

Request body

DefineNewRequest

Responses

200 200

ObjectTypeAssignment succesfully defined (not saved!). or

Body
SingleObjectTypeAssignmentResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ObjectTypeAssignments_Read
GET /v2/ObjectTypeAssignments

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

ObjectTypeAssignment details are in message body. or

Body
SingleObjectTypeAssignmentResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested objectTypeAssignment could not be found.

Body
HttpError
ObjectTypeAssignments_Save
POST /v2/ObjectTypeAssignments

Authentication

Bearer

Request body

SaveRequest2

Responses

200 200

ObjectTypeAssignment succesfully saved. or

Body
SingleObjectTypeAssignmentResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested objectTypeAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ObjectTypeAssignments_Delete
DELETE /v2/ObjectTypeAssignments

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

ObjectTypeAssignment succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested objectTypeAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ObjectTypeAssignments_Undelete
POST /v2/ObjectTypeAssignments/Undelete

Authentication

Bearer

Request body

UndeleteRequest

Responses

200 200

ObjectTypeAssignment succesfully undeleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested objectTypeAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ProjectAssignments
ProjectAssignments_DefineNew
POST /v2/ProjectAssignments/DefineNew
ProjectAssignments_Read
GET /v2/ProjectAssignments
ProjectAssignments_Save
POST /v2/ProjectAssignments
ProjectAssignments_Delete
DELETE /v2/ProjectAssignments
ProjectAssignments_Undelete
POST /v2/ProjectAssignments/Undelete
ProjectAssignments_DefineNew
POST /v2/ProjectAssignments/DefineNew

Authentication

Bearer

Request body

DefineNewRequest2

Responses

200 200

ProjectAssignment succesfully defined (not saved!). or

Body
SingleProjectAssignmentResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ProjectAssignments_Read
GET /v2/ProjectAssignments

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

ProjectAssignment details are in message body. or

Body
SingleProjectAssignmentResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested projectAssignment could not be found.

Body
HttpError
ProjectAssignments_Save
POST /v2/ProjectAssignments

Authentication

Bearer

Request body

SaveRequest3

Responses

200 200

ProjectAssignment succesfully saved. or

Body
SingleProjectAssignmentResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested projectAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ProjectAssignments_Delete
DELETE /v2/ProjectAssignments

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

ProjectAssignment succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested projectAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ProjectAssignments_Undelete
POST /v2/ProjectAssignments/Undelete

Authentication

Bearer

Request body

UndeleteRequest

Responses

200 200

ProjectAssignment succesfully undeleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested projectAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
RelationGroups
RelationGroups_Read
GET /v2/RelationGroups
RelationGroups_Save
POST /v2/RelationGroups
RelationGroups_Delete
DELETE /v2/RelationGroups
RelationGroups_Search
POST /v2/RelationGroups/Search
RelationGroups_DefineNew
POST /v2/RelationGroups/DefineNew
RelationGroups_Undelete
POST /v2/RelationGroups/Undelete
RelationGroups_Link
POST /v2/RelationGroups/Link
RelationGroups_Unlink
POST /v2/RelationGroups/Unlink
RelationGroups_Read
GET /v2/RelationGroups

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

RelationGroup details are in message body. or

Body
SingleRelationGroupResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested relationGroup could not be found.

Body
HttpError
RelationGroups_Save
POST /v2/RelationGroups

Authentication

Bearer

Request body

SaveRequest4

Responses

200 200

RelationGroup succesfully saved. or

Body
SingleRelationGroupResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested relationGroup could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
RelationGroups_Delete
DELETE /v2/RelationGroups

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

RelationGroup succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested relationGroup could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/RelationGroups/Search

Authentication

Bearer

Request body

SearchRequest3

Responses

200 200

Search results are in message body. or

Body
SearchResponse2
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
RelationGroups_DefineNew
POST /v2/RelationGroups/DefineNew

Authentication

Bearer

Request body

DefineNewRequest3

Responses

200 200

RelationGroup succesfully defined (not saved!). or

Body
SingleRelationGroupResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
RelationGroups_Undelete
POST /v2/RelationGroups/Undelete

Authentication

Bearer

Request body

UndeleteRequest

Responses

200 200

RelationGroup succesfully undeleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested relationGroup could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/RelationGroups/Link

Authentication

Bearer

Request body

LinkRequest

Responses

200 200

RelationGroup succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested relationGroup could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/RelationGroups/Unlink

Authentication

Bearer

Request body

UnlinkRequest

Responses

200 200

RelationGroup succesfully undeleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested relationGroup could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
AgendaItems
AgendaItems_Read
GET /v2/AgendaItems
AgendaItems_Save
POST /v2/AgendaItems
AgendaItems_Delete
DELETE /v2/AgendaItems
AgendaItems_Search
POST /v2/AgendaItems/Search
AgendaItems_SearchAndExport
GET /v2/AgendaItems/SearchAndExport
AgendaItems_DefineNew
POST /v2/AgendaItems/DefineNew
AgendaItems_Undelete
POST /v2/AgendaItems/Undelete
AgendaItems_Move
POST /v2/AgendaItems/Move
AgendaItems_Confirm
POST /v2/AgendaItems/Confirm
AgendaItems_Cancel
POST /v2/AgendaItems/Cancel
AgendaItems_AddRecurrenceException
POST /v2/AgendaItems/AddRecurrenceException
AgendaItems_Read
GET /v2/AgendaItems

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

AgendaItem details are in message body. or

Body
SingleAgendaItemResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested agendaItem could not be found.

Body
HttpError
AgendaItems_Save
POST /v2/AgendaItems

Authentication

Bearer

Request body

SaveRequest5

Responses

200 200

AgendaItem succesfully saved. or

Body
SingleAgendaItemResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested agendaItem could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
AgendaItems_Delete
DELETE /v2/AgendaItems

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

AgendaItem succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested agendaItem could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/AgendaItems/Search

Authentication

Bearer

Request body

SearchRequest4

Responses

200 200

Search results are in message body. or

Body
SearchResponse3
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
AgendaItems_SearchAndExport
GET /v2/AgendaItems/SearchAndExport

Authentication

Bearer

Request parameters

agendaItemId
string guid optional
categoryIds
array of string optional
Collection format: multi
employeeIds
array of string optional
Collection format: multi
orderBy
string optional
startDateTimeMax
string date-time required
startDateTimeMin
string date-time required
termFields
array of AgendaItemTermField optional
Collection format: multi
filterByActive
string optional
order
string optional
skip
integer int32 optional
Min: 0
Max: 2,147,483,647
take
integer int32 optional
Min: 0
Max: 2,147,483,647
term
string optional
Min length: 0
Max length: 50
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

Search results are returned in an Excel file.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
AgendaItems_DefineNew
POST /v2/AgendaItems/DefineNew

Authentication

Bearer

Request body

DefineNewRequest4

Responses

200 200

AgendaItem succesfully defined (not saved!). or

Body
SingleAgendaItemResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
AgendaItems_Undelete
POST /v2/AgendaItems/Undelete

Authentication

Bearer

Request body

UndeleteRequest

Responses

200 200

AgendaItem succesfully undeleted.

Body
SingleAgendaItemResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested agendaItem could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
AgendaItems_Move
POST /v2/AgendaItems/Move

Authentication

Bearer

Request body

MoveAgendaItemRequest

Responses

200 200

AgendaItem updated succesfully.

Body
SingleAgendaItemResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested agendaItem could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
AgendaItems_Confirm
POST /v2/AgendaItems/Confirm

Authentication

Bearer

Request body

ConfirmRequest

Responses

200 200

AgendaItem succesfully confirmed.

Body
SingleAgendaItemResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested task could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
AgendaItems_Cancel
POST /v2/AgendaItems/Cancel

Authentication

Bearer

Request body

CancelRequest

Responses

200 200

AgendaItem succesfully cancelled.

Body
SingleAgendaItemResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested task could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
AgendaItems_AddRecurrenceException
POST /v2/AgendaItems/AddRecurrenceException

Authentication

Bearer

Request body

AddRecurrencyExceptionRequest

Responses

200 200

Exception agendaItem succesfully created.

Body
AddRecurrencyExceptionResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Recurring agendaitem could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Assignments
Assignments_Search
POST /v2/Assignments/Search
Assignments_SearchAndExport
GET /v2/Assignments/SearchAndExport
POST /v2/Assignments/Search

Authentication

Bearer

Request body

SearchRequest5

Responses

200 200

Search results are in message body. or

Body
SearchResponse4
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
Assignments_SearchAndExport
GET /v2/Assignments/SearchAndExport

Authentication

Bearer

Request parameters

assignmentIds
array of string optional
Collection format: multi
assignmentPhases
array of AssignmentPhase optional
Collection format: multi
availabiltyStatuses
array of AvailabilityStatus optional
Collection format: multi
countryCode
string optional
employeeIds
array of string optional
Collection format: multi
filterByAssignmentTypes
array of AssignmentType optional
Collection format: multi
filterByRealEstateGroups
array of RealEstateGroup2 optional
Collection format: multi
forRent
boolean optional
forSale
boolean optional
includeStatistics
boolean optional
listingTypes
array of ListingType optional
Collection format: multi
localities
array of string optional
Collection format: multi
officeIds
array of string optional
Collection format: multi
orderBy
string optional
relationIds
array of string optional
Collection format: multi
termFields
array of AssignmentTermField optional
Collection format: multi
filterByActive
string optional
order
string optional
skip
integer int32 optional
Min: 0
Max: 2,147,483,647
take
integer int32 optional
Min: 0
Max: 2,147,483,647
term
string optional
Min length: 0
Max length: 50
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

Search results are returned in an Excel file.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
Blobs
Blobs_Download
GET /v2/Blobs/Download/{filedataid}/{filenameandextension}
Blobs_Download2
GET /Download/{filedataid}/{filenameandextension}
Blobs_Upload
POST /v2/Blobs/Upload
Blobs_Download
GET /v2/Blobs/Download/{filedataid}/{filenameandextension}

Authentication

Bearer

Path variables

fileDataId
string guid required
fileNameAndExtension
string required

Responses

200 200
Blobs_Download2
GET /Download/{filedataid}/{filenameandextension}

Authentication

Bearer

Path variables

fileDataId
string guid required
fileNameAndExtension
string required

Responses

200 200
Blobs_Upload
POST /v2/Blobs/Upload

Authentication

Bearer

Responses

200 200

Task succesfully defined (not saved!). or

Body
UploadResponse
BusinessPartners
BusinessPartners_Read
GET /v2/BusinessPartners
BusinessPartners_Search
POST /v2/BusinessPartners/Search
BusinessPartners_Read
GET /v2/BusinessPartners

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

Business Partner details are in message body. or

Body
SingleBusinessPartnerResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested Business Partner could not be found.

Body
HttpError
POST /v2/BusinessPartners/Search

Authentication

Bearer

Request body

SearchRequest6

Responses

200 200

Search results are in message body. or

Body
SearchResponse5
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
Cadastres
Cadastres_Archive
POST /v2/Cadastres/Archive
Cadastres_BuyAndSave
POST /v2/Cadastres/BuyAndSave
Cadastres_BuyAndSaveMunicipalities
POST /v2/Cadastres/BuyAndSaveMunicipalities
Cadastres_DefineNew
POST /v2/Cadastres/DefineNew
Cadastres_Read
GET /v2/Cadastres
Cadastres_Save
POST /v2/Cadastres
Cadastres_Delete
DELETE /v2/Cadastres
Cadastres_Search
POST /v2/Cadastres/Search
Cadastres_Unarchive
POST /v2/Cadastres/Unarchive
Cadastres_Undelete
POST /v2/Cadastres/Undelete
Cadastres_Archive
POST /v2/Cadastres/Archive

Authentication

Bearer

Request body

ArchiveRequest

Responses

200 200

Cadastre succesfully archived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested cadastre could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Cadastres_BuyAndSave
POST /v2/Cadastres/BuyAndSave

Authentication

Bearer

Request body

BuyAndSaveRequest

Responses

200 200

Cadastres successfully bought and saved. or

Body
BuyAndSaveResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested cadastre could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Cadastres_BuyAndSaveMunicipalities
POST /v2/Cadastres/BuyAndSaveMunicipalities

Authentication

Bearer

Request body

BuyAndSaveMunicipalitiesRequest

Responses

200 200

Municipalities to be used when calling the BuyAndSave cadastres endpoint. or

Body
BuyAndSaveMunicipalitiesResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested cadastre could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Cadastres_DefineNew
POST /v2/Cadastres/DefineNew

Authentication

Bearer

Request body

DefineNewRequest5

Responses

200 200

Cadastre succesfully defined (not saved!). or

Body
SingleCadastreResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Cadastres_Read
GET /v2/Cadastres

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

Cadastre details are in message body. or

Body
SingleCadastreResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested cadastre could not be found.

Body
HttpError
Cadastres_Save
POST /v2/Cadastres

Authentication

Bearer

Request body

SaveRequest6

Responses

200 200

Cadastre succesfully saved. or

Body
SingleCadastreResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested cadastre could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Cadastres_Delete
DELETE /v2/Cadastres

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

Cadastre succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested cadastre could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/Cadastres/Search

Authentication

Bearer

Request body

SearchRequest7

Responses

200 200

Search results are in message body. or

Body
SearchResponse6
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
Cadastres_Unarchive
POST /v2/Cadastres/Unarchive

Authentication

Bearer

Request body

UnarchiveRequest

Responses

200 200

Cadastre succesfully unarchived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested cadastre could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Cadastres_Undelete
POST /v2/Cadastres/Undelete

Authentication

Bearer

Request body

UndeleteRequest

Responses

200 200

Cadastre succesfully undeleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested cadastre could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
CompanySettings
CompanySettings_Read
GET /v2/CompanySettings
CompanySettings_Read
GET /v2/CompanySettings

Authentication

Bearer

Request parameters

venumCompanyId
string guid required

Responses

200 200

Company settings details are in message body. or

Body
SingleCompanySettingsResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested task could not be found.

Body
HttpError
ContactCompanies
ContactCompanies_Archive
POST /v2/ContactCompanies/Archive
ContactCompanies_DefineNew
POST /v2/ContactCompanies/DefineNew
ContactCompanies_Read
GET /v2/ContactCompanies
ContactCompanies_Save
POST /v2/ContactCompanies
ContactCompanies_Delete
DELETE /v2/ContactCompanies
ContactCompanies_Unarchive
POST /v2/ContactCompanies/Unarchive
ContactCompanies_Archive
POST /v2/ContactCompanies/Archive

Authentication

Bearer

Request body

ArchiveRequest

Responses

200 200

ContactCompany succesfully archived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested ContactCompany could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ContactCompanies_DefineNew
POST /v2/ContactCompanies/DefineNew

Authentication

Bearer

Request body

DefineNewRequest6

Responses

200 200

ContactCompany succesfully defined (not saved!). or

Body
SingleContactCompanyResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ContactCompanies_Read
GET /v2/ContactCompanies

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

ContactCompany details are in message body. or

Body
SingleContactCompanyResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested ContactCompany could not be found.

Body
HttpError
ContactCompanies_Save
POST /v2/ContactCompanies

Authentication

Bearer

Request body

SaveRequest7

Responses

200 200

ContactCompany succesfully saved. or

Body
SingleContactCompanyResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested ContactCompany could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ContactCompanies_Delete
DELETE /v2/ContactCompanies

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

ContactCompany succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested ContactCompany could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ContactCompanies_Unarchive
POST /v2/ContactCompanies/Unarchive

Authentication

Bearer

Request body

UnarchiveRequest

Responses

200 200

ContactCompany succesfully unarchived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested ContactCompany could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ContactLinks_Save
POST /v2/ContactLinks
ContactLinks_Delete
DELETE /v2/ContactLinks
ContactLinks_Search
POST /v2/ContactLinks/Search
ContactLinks_Undelete
POST /v2/ContactLinks/Undelete
POST /v2/ContactLinks

Authentication

Bearer

Request body

SaveRequest8

Responses

200 200

ContactLink succesfully saved. or

Body
SingleContactLinkSnapShotResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested contactLink could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
DELETE /v2/ContactLinks

Authentication

Bearer

Request parameters

sourceRelationId
string guid required
targetRelationId
string guid required
realEstateAgencyId
string guid required

Responses

200 200

ContactLink succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested contactLink could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/ContactLinks/Search

Authentication

Bearer

Request body

SearchRequest8

Responses

200 200

Search results are in message body. or

Body
SearchResponse7
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/ContactLinks/Undelete

Authentication

Bearer

Request body

UndeleteRequest2

Responses

200 200

ContactLink succesfully undeleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested contactLink could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ContactPersons
ContactPersons_Archive
POST /v2/ContactPersons/Archive
ContactPersons_DefineNew
POST /v2/ContactPersons/DefineNew
ContactPersons_Read
GET /v2/ContactPersons
ContactPersons_Save
POST /v2/ContactPersons
ContactPersons_Delete
DELETE /v2/ContactPersons
ContactPersons_Unarchive
POST /v2/ContactPersons/Unarchive
ContactPersons_Archive
POST /v2/ContactPersons/Archive

Authentication

Bearer

Request body

ArchiveRequest

Responses

200 200

ContactPerson succesfully archived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested ContactPerson could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ContactPersons_DefineNew
POST /v2/ContactPersons/DefineNew

Authentication

Bearer

Request body

DefineNewRequest7

Responses

200 200

ContactPerson succesfully defined (not saved!). or

Body
SingleContactPersonResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ContactPersons_Read
GET /v2/ContactPersons

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

ContactPerson details are in message body. or

Body
SingleContactPersonResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested ContactPerson could not be found.

Body
HttpError
ContactPersons_Save
POST /v2/ContactPersons

Authentication

Bearer

Request body

SaveRequest9

Responses

200 200

ContactPerson succesfully saved. or

Body
SingleContactPersonResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested ContactPerson could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ContactPersons_Delete
DELETE /v2/ContactPersons

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

ContactPerson succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested ContactPerson could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ContactPersons_Unarchive
POST /v2/ContactPersons/Unarchive

Authentication

Bearer

Request body

UnarchiveRequest

Responses

200 200

ContactPerson succesfully unarchived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested ContactPerson could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
DossierItems
DossierItems_Save
POST /v2/DossierItems
DossierItems_Delete
DELETE /v2/DossierItems
DossierItems_Search
POST /v2/DossierItems/Search
DossierItems_Undelete
POST /v2/DossierItems/Undelete
DossierItems_Save
POST /v2/DossierItems

Authentication

Bearer

Request body

SaveRequest10

Responses

200 200

Dossier succesfully saved. or

Body
SingleDossierItemSnapShotResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested dossier could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
DossierItems_Delete
DELETE /v2/DossierItems

Authentication

Bearer

Request parameters

id
integer int32 required
parentId
string guid required
realEstateAgencyId
string guid required

Responses

200 200

Dossier succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested dossier could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/DossierItems/Search

Authentication

Bearer

Request body

SearchRequest9

Responses

200 200

Search results are in message body. or

Body
SearchResponse8
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
DossierItems_Undelete
POST /v2/DossierItems/Undelete

Authentication

Bearer

Request body

UndeleteRequest3

Responses

200 200

Dossier succesfully undeleted. or

Body
SingleDossierItemSnapShotResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested dossier could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Employees
Employees_Archive
POST /v2/Employees/Archive
Employees_DefineNew
POST /v2/Employees/DefineNew
Employees_Read
GET /v2/Employees
Employees_Save
POST /v2/Employees
Employees_Delete
DELETE /v2/Employees
Employees_Unarchive
POST /v2/Employees/Unarchive
Employees_Archive
POST /v2/Employees/Archive

Authentication

Bearer

Request body

ArchiveRequest

Responses

200 200

Employee succesfully archived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested Employee could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Employees_DefineNew
POST /v2/Employees/DefineNew

Authentication

Bearer

Request body

DefineNewRequest8

Responses

200 200

Employee succesfully defined (not saved!). or

Body
SingleEmployeeResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Employees_Read
GET /v2/Employees

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

Employee details are in message body. or

Body
SingleEmployeeResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested Employee could not be found.

Body
HttpError
Employees_Save
POST /v2/Employees

Authentication

Bearer

Request body

SaveRequest11

Responses

200 200

Employee succesfully saved. or

Body
SingleEmployeeResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested Employee could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Employees_Delete
DELETE /v2/Employees

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

Employee succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested Employee could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Employees_Unarchive
POST /v2/Employees/Unarchive

Authentication

Bearer

Request body

UnarchiveRequest

Responses

200 200

Employee succesfully unarchived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested Employee could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
FinancialAdministrations
FinancialAdministrations_Read
GET /v2/FinancialAdministrations
FinancialAdministrations_Save
POST /v2/FinancialAdministrations
FinancialAdministrations_Search
POST /v2/FinancialAdministrations/Search
FinancialAdministrations_Read
GET /v2/FinancialAdministrations

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

FinancialAdministration details are in message body. or

Body
SingleFinancialAdministrationResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested financialAdministration could not be found.

Body
HttpError
FinancialAdministrations_Save
POST /v2/FinancialAdministrations

Authentication

Bearer

Request body

SaveRequest12

Responses

200 200

FinancialAdministration succesfully saved. or

Body
SingleFinancialAdministrationResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested financialAdministration could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/FinancialAdministrations/Search

Authentication

Bearer

Request body

SearchRequest10

Responses

200 200

Search results are in message body. or

Body
SearchResponse9
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
Geo
Geo_AddressSearch
POST /v2/Geo/AddressSearch
Geo_AdminAreaLevel1
GET /v2/Geo/AdminAreaLevel1
Geo_AdminAreaLevel2
GET /v2/Geo/AdminAreaLevel2
Geo_AdminAreaLevel3
GET /v2/Geo/AdminAreaLevel3
Geo_Locality
GET /v2/Geo/Locality
Geo_Street
GET /v2/Geo/Street
Geo_Sublocality
GET /v2/Geo/Sublocality
Geo_AddressSearch
POST /v2/Geo/AddressSearch

Authentication

Bearer

Request body

SearchRequest11

Responses

200 200

Geo address details are in message body. or

Body
SearchResponse10
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
Geo_AdminAreaLevel1
GET /v2/Geo/AdminAreaLevel1

Authentication

Bearer

Request parameters

countryIso2
string optional
Min length: 0
Max length: 2
culture
string optional
Min length: 0
Max length: 5

Responses

200 200

Get geo admin area level 1’s; details are in message body. or

Body
AdminAreaLevel1SearchResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
Geo_AdminAreaLevel2
GET /v2/Geo/AdminAreaLevel2

Authentication

Bearer

Request parameters

adminAreaLevel1Id
integer int32 optional
culture
string optional
Min length: 0
Max length: 5

Responses

200 200

Get geo admin area level 2’s; details are in message body. or

Body
AdminAreaLevel2SearchResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
Geo_AdminAreaLevel3
GET /v2/Geo/AdminAreaLevel3

Authentication

Bearer

Request parameters

adminAreaLevel2Id
integer int32 optional
culture
string optional
Min length: 0
Max length: 5

Responses

200 200

Get geo admin area level 3’s; details are in message body. or

Body
AdminAreaLevel3SearchResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
Geo_Locality
GET /v2/Geo/Locality

Authentication

Bearer

Request parameters

adminAreaLevel1Id
integer int32 optional
adminAreaLevel2Id
integer int32 optional
adminAreaLevel3Id
integer int32 optional
culture
string optional
Min length: 0
Max length: 5

Responses

200 200

Get Localities; details are in message body. or

Body
LocalitySearchResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
Geo_Street
GET /v2/Geo/Street

Authentication

Bearer

Request parameters

culture
string optional
Min length: 0
Max length: 5
localityId
integer int32 optional

Responses

200 200

Get Streets; details are in message body. or

Body
StreetSearchResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
Geo_Sublocality
GET /v2/Geo/Sublocality

Authentication

Bearer

Request parameters

culture
string optional
Min length: 0
Max length: 5
localityId
integer int32 optional

Responses

200 200

Get Sublocalities; details are in message body. or

Body
SublocalitySearchResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
GlobalSearch
GlobalSearch_Search
POST /v2/GlobalSearch/Search
POST /v2/GlobalSearch/Search

Authentication

Bearer

Request body

SearchRequest12

Responses

200 200

Search results are in message body. or

Body
SearchResponse11
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
Keys
Keys_Search
POST /v2/Keys/Search
POST /v2/Keys/Search

Authentication

Bearer

Request body

SearchRequest13

Responses

200 200

Search results are in message body. or

Body
SearchResponse12
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
MasterTable
MasterTable_Index
GET /v2/MasterTable
MasterTable_Index
GET /v2/MasterTable

Authentication

Bearer

Request parameters

culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

Master table is in message body. or

Body
TableResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
Notes
Notes_Save
POST /v2/Notes
Notes_Delete
DELETE /v2/Notes
Notes_Search
POST /v2/Notes/Search
Notes_Undelete
POST /v2/Notes/Undelete
Notes_Save
POST /v2/Notes

Authentication

Bearer

Request body

SaveRequest13

Responses

200 200

Note succesfully saved. or

Body
SaveResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested note could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Notes_Delete
DELETE /v2/Notes

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

Note succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested note could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/Notes/Search

Authentication

Bearer

Request body

SearchRequest14

Responses

200 200

Search results are in message body. or

Body
SearchResponse13
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
Notes_Undelete
POST /v2/Notes/Undelete

Authentication

Bearer

Request body

UndeleteRequest

Responses

200 200

Note succesfully undeleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested note could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ObjectAssignments
ObjectAssignments_Clone
POST /v2/ObjectAssignments/Clone
ObjectAssignments_DefineNew
POST /v2/ObjectAssignments/DefineNew
ObjectAssignments_Read
GET /v2/ObjectAssignments
ObjectAssignments_Save
POST /v2/ObjectAssignments
ObjectAssignments_Delete
DELETE /v2/ObjectAssignments
ObjectAssignments_Undelete
POST /v2/ObjectAssignments/Undelete
ObjectAssignments_UpdateAvailability
POST /v2/ObjectAssignments/UpdateAvailability
ObjectAssignments_Clone
POST /v2/ObjectAssignments/Clone

Authentication

Bearer

Request body

CloneRequest

Responses

200 200

ObjectAssignment succesfully cloned.

Body
SingleObjectAssignmentResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested objectAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ObjectAssignments_DefineNew
POST /v2/ObjectAssignments/DefineNew

Authentication

Bearer

Request body

DefineNewRequest9

Responses

200 200

ObjectAssignment succesfully defined (not saved!). or

Body
SingleObjectAssignmentResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ObjectAssignments_Read
GET /v2/ObjectAssignments

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

ObjectAssignment details are in message body. or

Body
SingleObjectAssignmentResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested objectAssignment could not be found.

Body
HttpError
ObjectAssignments_Save
POST /v2/ObjectAssignments

Authentication

Bearer

Request body

SaveRequest14

Responses

200 200

ObjectAssignment succesfully saved. or

Body
SingleObjectAssignmentResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested objectAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ObjectAssignments_Delete
DELETE /v2/ObjectAssignments

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

ObjectAssignment succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested objectAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ObjectAssignments_Undelete
POST /v2/ObjectAssignments/Undelete

Authentication

Bearer

Request body

UndeleteRequest

Responses

200 200

ObjectAssignment succesfully undeleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested objectAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
ObjectAssignments_UpdateAvailability
POST /v2/ObjectAssignments/UpdateAvailability

Authentication

Bearer

Request body

UpdateAvailabilityRequest

Responses

200 200

ObjectAssignment availability updated succesfully.

Body
SingleObjectAssignmentResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested objectAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Offices
Offices_Archive
POST /v2/Offices/Archive
Offices_DefineNew
POST /v2/Offices/DefineNew
Offices_Read
GET /v2/Offices
Offices_Save
POST /v2/Offices
Offices_Delete
DELETE /v2/Offices
Offices_Unarchive
POST /v2/Offices/Unarchive
Offices_Archive
POST /v2/Offices/Archive

Authentication

Bearer

Request body

ArchiveRequest2

Responses

200 200

Office succesfully archived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested Office could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Offices_DefineNew
POST /v2/Offices/DefineNew

Authentication

Bearer

Request body

DefineNewRequest10

Responses

200 200

Office succesfully defined (not saved!). or

Body
SingleOfficeResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Offices_Read
GET /v2/Offices

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

Office details are in message body. or

Body
SingleOfficeResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested Office could not be found.

Body
HttpError
Offices_Save
POST /v2/Offices

Authentication

Bearer

Request body

SaveRequest15

Responses

200 200

Office succesfully saved. or

Body
SingleOfficeResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested Office could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Offices_Delete
DELETE /v2/Offices

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

Office succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested Office could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Offices_Unarchive
POST /v2/Offices/Unarchive

Authentication

Bearer

Request body

UnarchiveRequest

Responses

200 200

Office succesfully unarchived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Requested Office could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Publications
Publications_Activate
POST /v2/Publications/Activate
Publications_Deactivate
POST /v2/Publications/Deactivate
Publications_Search
POST /v2/Publications/Search
Publications_Activate
POST /v2/Publications/Activate

Authentication

Bearer

Request body

ActivateRequest

Responses

200 200

Publication succesfully activated.

Body
OkResult
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Media Partner or Assignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Publications_Deactivate
POST /v2/Publications/Deactivate

Authentication

Bearer

Request body

DeactivateRequest

Responses

200 200

Publication succesfully deactivated.

Body
OkResult
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
404 404

Media Partner or Assignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/Publications/Search

Authentication

Bearer

Request body

SearchRequest15

Responses

200 200

Search results are in message body. or

Body
SearchResponse14
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
RealEstateAgencies
RealEstateAgencies_Read
GET /v2/RealEstateAgencies
RealEstateAgencies_Update
PUT /v2/RealEstateAgencies
RealEstateAgencies_Read
GET /v2/RealEstateAgencies

Authentication

Bearer

Request parameters

culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

Real Estate Agency details are in message body. or

Body
SingleRealEstateAgencyResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested task could not be found.

Body
HttpError
RealEstateAgencies_Update
PUT /v2/RealEstateAgencies

Authentication

Bearer

Request body

UpdateRequest

Responses

200 200

Real Estate Agency succesfully saved. or

Body
SingleRealEstateAgencyResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested task could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Relations
Relations_Search
POST /v2/Relations/Search
Relations_SearchAndExport
GET /v2/Relations/SearchAndExport
POST /v2/Relations/Search

Authentication

Bearer

Request body

SearchRequest16

Responses

200 200

Search results are in message body. or

Body
SearchResponse15
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
Relations_SearchAndExport
GET /v2/Relations/SearchAndExport

Authentication

Bearer

Request parameters

filterByRelationGroupIds
array of string optional
Collection format: multi
filterByRelationTypes
array of RelationType optional
Collection format: multi
includeStatistics
boolean optional
orderBy
string optional
relationId
string guid optional
termFields
array of RelationTermField optional
Collection format: multi
filterByActive
string optional
order
string optional
skip
integer int32 optional
Min: 0
Max: 2,147,483,647
take
integer int32 optional
Min: 0
Max: 2,147,483,647
term
string optional
Min length: 0
Max length: 50
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

Search results are returned in an Excel file.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
Security
Security_EndSession
POST /v2/Security/EndSession
Security_RecoverPassword
POST /v2/Security/RecoverPassword
Security_Refresh
POST /v2/Security/Refresh
Security_RequestRecoveryCode
POST /v2/Security/RequestRecoveryCode
Security_StartSession
POST /v2/Security/StartSession
Security_UpdatePassword
POST /v2/Security/UpdatePassword
Security_EndSession
POST /v2/Security/EndSession

Authentication

Bearer

Responses

200 200

Session was succesfully ended.

401 401

Authorization has been denied for request.

Body
HttpError
404 404

Session not found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Security_RecoverPassword
POST /v2/Security/RecoverPassword

Request body

RecoverPasswordRequest

Responses

200 200

Password was successfully updated.

Body
RecoverPasswordResponse
401 401

Invalid userName and/or recovery code.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Security_Refresh
POST /v2/Security/Refresh

Authentication

Bearer

Responses

200 200

Session succesfully refreshed. New token is given.

Body
RefreshResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
404 404

Session not found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Security_RequestRecoveryCode
POST /v2/Security/RequestRecoveryCode

Request body

RequestRecoveryCodeRequest

Responses

200 200

Recovery code has been requested.

Body
RequestRecoveryCodeResponse
404 404

Account not found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Security_StartSession
POST /v2/Security/StartSession

Request body

StartSessionRequest

Responses

200 200

Login succesfull.

Body
StartSessionResponse
401 401

Unauthorized: Invalid username and/or password.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Security_UpdatePassword
POST /v2/Security/UpdatePassword

Authentication

Bearer

Request body

UpdatePasswordRequest

Responses

200 200

Password was successfully updated.

Settings
Settings_HasAcceptedTerms
GET /v2/Settings/HasAcceptedTerms
Settings_HasSeenContactForm
GET /v2/Settings/HasSeenContactform
Settings_SetHasAcceptedTerms
POST /v2/Settings/SetHasAcceptedTerms
Settings_SetHasSeenContactForm
POST /v2/Settings/SetHasSeenContactform
Settings_HasAcceptedTerms
GET /v2/Settings/HasAcceptedTerms

Authentication

Bearer

Request parameters

employeeId
string guid required
realEstateAgencyId
string guid required

Responses

200 200

Request processed successfully; result is in message content. or

Body
HasAcceptedTermsResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Employee could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Settings_HasSeenContactForm
GET /v2/Settings/HasSeenContactform

Authentication

Bearer

Request parameters

employeeId
string guid required
realEstateAgencyId
string guid required

Responses

200 200

Request processed successfully; result is in message content. or

Body
HasSeenContactFormResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Employee could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Settings_SetHasAcceptedTerms
POST /v2/Settings/SetHasAcceptedTerms

Authentication

Bearer

Request body

SetHasAcceptedTermsRequest

Responses

200 200

Request processed successfully.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Employee could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Settings_SetHasSeenContactForm
POST /v2/Settings/SetHasSeenContactform

Authentication

Bearer

Request body

SetHasSeenContactFormRequest

Responses

200 200

Request processed successfully.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Employee could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Statistics
Statistics_Read
GET /v2/Statistics
Statistics_Read
GET /v2/Statistics

Authentication

Bearer

Request parameters

employeeId
string guid optional
realEstateAgencyId
string guid required

Responses

200 200

Statistics are in message body. or

Body
SingleStatisticsResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested statistics could not be found.

Body
HttpError
Invoices
Invoices_Read
GET /v2/Invoices
Invoices_Save
POST /v2/Invoices
Invoices_Delete
DELETE /v2/Invoices
Invoices_Search
POST /v2/Invoices/Search
Invoices_DefineNew
POST /v2/Invoices/DefineNew
Invoices_Undelete
POST /v2/Invoices/Undelete
Invoices_Read
GET /v2/Invoices

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

Invoice details are in message body. or

Body
SingleInvoiceResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested invoice could not be found.

Body
HttpError
Invoices_Save
POST /v2/Invoices

Authentication

Bearer

Request body

SaveRequest16

Responses

200 200

Invoice succesfully saved. or

Body
SingleInvoiceResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested invoice could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Invoices_Delete
DELETE /v2/Invoices

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

Invoice succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested invoice could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/Invoices/Search

Authentication

Bearer

Request body

SearchRequest17

Responses

200 200

Search results are in message body. or

Body
SearchResponse16
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
Invoices_DefineNew
POST /v2/Invoices/DefineNew

Authentication

Bearer

Request body

DefineNewRequest11

Responses

200 200

Invoice succesfully defined (not saved!). or

Body
SingleInvoiceResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Invoices_Undelete
POST /v2/Invoices/Undelete

Authentication

Bearer

Request body

UndeleteRequest

Responses

200 200

Invoice succesfully undeleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested invoice could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Tasks
Tasks_Archive
POST /v2/Tasks/Archive
Tasks_DefineNew
POST /v2/Tasks/DefineNew
Tasks_Read
GET /v2/Tasks
Tasks_Save
POST /v2/Tasks
Tasks_Delete
DELETE /v2/Tasks
Tasks_Search
POST /v2/Tasks/Search
Tasks_Unarchive
POST /v2/Tasks/Unarchive
Tasks_Undelete
POST /v2/Tasks/Undelete
Tasks_UpdateStatus
POST /v2/Tasks/UpdateStatus
Tasks_Archive
POST /v2/Tasks/Archive

Authentication

Bearer

Request body

ArchiveRequest

Responses

200 200

Task succesfully archived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested task could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Tasks_DefineNew
POST /v2/Tasks/DefineNew

Authentication

Bearer

Request body

DefineNewRequest12

Responses

200 200

Task succesfully defined (not saved!). or

Body
SingleTaskResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Tasks_Read
GET /v2/Tasks

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

Task details are in message body. or

Body
SingleTaskResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested task could not be found.

Body
HttpError
Tasks_Save
POST /v2/Tasks

Authentication

Bearer

Request body

SaveRequest17

Responses

200 200

Task succesfully saved. or

Body
SingleTaskResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested task could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Tasks_Delete
DELETE /v2/Tasks

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

Task succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested task could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/Tasks/Search

Authentication

Bearer

Request body

SearchRequest18

Responses

200 200

Search results are in message body. or

Body
SearchResponse17
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
Tasks_Unarchive
POST /v2/Tasks/Unarchive

Authentication

Bearer

Request body

UnarchiveRequest

Responses

200 200

Task succesfully unarchived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested task could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Tasks_Undelete
POST /v2/Tasks/Undelete

Authentication

Bearer

Request body

UndeleteRequest

Responses

200 200

Task succesfully undeleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested task could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Tasks_UpdateStatus
POST /v2/Tasks/UpdateStatus

Authentication

Bearer

Request body

UpdateStatusRequest

Responses

200 200

Task status succesfully updated.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested task could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
TimelineEvents
TimelineEvents_Search
POST /v2/TimelineEvent/Search
POST /v2/TimelineEvent/Search

Authentication

Bearer

Request body

SearchRequest19

Responses

200 200

Search results are in message body. or

Body
SearchResponse18
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
Version
Version_Index
GET /v2/Version
Version_Index
GET /v2/Version

Responses

200 200

Returns the current API version. or

Body
VersionResponse
SearchAssignments
SearchAssignments_Archive
POST /v2/SearchAssignments/Archive
SearchAssignments_DefineNew
POST /v2/SearchAssignments/DefineNew
SearchAssignments_Read
GET /v2/SearchAssignments
SearchAssignments_Save
POST /v2/SearchAssignments
SearchAssignments_Delete
DELETE /v2/SearchAssignments
SearchAssignments_Search
POST /v2/SearchAssignments/Search
SearchAssignments_Unarchive
POST /v2/SearchAssignments/Unarchive
SearchAssignments_Undelete
POST /v2/SearchAssignments/Undelete
SearchAssignments_Archive
POST /v2/SearchAssignments/Archive

Authentication

Bearer

Request body

ArchiveRequest

Responses

200 200

SearchAssignment succesfully archived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested searchAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
SearchAssignments_DefineNew
POST /v2/SearchAssignments/DefineNew

Authentication

Bearer

Request body

DefineNewRequest13

Responses

200 200

SearchAssignment succesfully defined (not saved!). or

Body
SingleSearchAssignmentResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
SearchAssignments_Read
GET /v2/SearchAssignments

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

SearchAssignment details are in message body. or

Body
SingleSearchAssignmentResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested searchAssignment could not be found.

Body
HttpError
SearchAssignments_Save
POST /v2/SearchAssignments

Authentication

Bearer

Request body

SaveRequest18

Responses

200 200

SearchAssignment succesfully saved. or

Body
SingleSearchAssignmentResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested searchAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
SearchAssignments_Delete
DELETE /v2/SearchAssignments

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

SearchAssignment succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested searchAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/SearchAssignments/Search

Authentication

Bearer

Request body

SearchRequest20

Responses

200 200

Search results are in message body. or

Body
SearchResponse19
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
SearchAssignments_Unarchive
POST /v2/SearchAssignments/Unarchive

Authentication

Bearer

Request body

UnarchiveRequest

Responses

200 200

SearchAssignment succesfully unarchived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested searchAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
SearchAssignments_Undelete
POST /v2/SearchAssignments/Undelete

Authentication

Bearer

Request body

UndeleteRequest

Responses

200 200

SearchAssignment succesfully undeleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested searchAssignment could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
AssignmentRequests
AssignmentRequests_Archive
POST /v2/AssignmentRequests/Archive
AssignmentRequests_DefineNew
POST /v2/AssignmentRequests/DefineNew
AssignmentRequests_Read
GET /v2/AssignmentRequests
AssignmentRequests_Save
POST /v2/AssignmentRequests
AssignmentRequests_Delete
DELETE /v2/AssignmentRequests
AssignmentRequests_Search
POST /v2/AssignmentRequests/Search
AssignmentRequests_Unarchive
POST /v2/AssignmentRequests/Unarchive
AssignmentRequests_Undelete
POST /v2/AssignmentRequests/Undelete
AssignmentRequests_Archive
POST /v2/AssignmentRequests/Archive

Authentication

Bearer

Request body

ArchiveRequest

Responses

200 200

AssignmentRequest succesfully archived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested assignmentRequest could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
AssignmentRequests_DefineNew
POST /v2/AssignmentRequests/DefineNew

Authentication

Bearer

Request body

DefineNewRequest14

Responses

200 200

AssignmentRequest succesfully defined (not saved!). or

Body
SingleAssignmentRequestResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
AssignmentRequests_Read
GET /v2/AssignmentRequests

Authentication

Bearer

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

AssignmentRequest details are in message body. or

Body
SingleAssignmentRequestResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested assignmentRequest could not be found.

Body
HttpError
AssignmentRequests_Save
POST /v2/AssignmentRequests

Authentication

Bearer

Request body

SaveRequest19

Responses

200 200

AssignmentRequest succesfully saved. or

Body
SingleAssignmentRequestResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested assignmentRequest could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
AssignmentRequests_Delete
DELETE /v2/AssignmentRequests

Authentication

Bearer

Request parameters

id
string guid required
realEstateAgencyId
string guid required

Responses

200 200

AssignmentRequest succesfully deleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested assignmentRequest could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
POST /v2/AssignmentRequests/Search

Authentication

Bearer

Request body

SearchRequest21

Responses

200 200

Search results are in message body. or

Body
SearchResponse20
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
500 500

Unexpected error. See message content for more details.

Body
HttpError
AssignmentRequests_Unarchive
POST /v2/AssignmentRequests/Unarchive

Authentication

Bearer

Request body

UnarchiveRequest

Responses

200 200

AssignmentRequest succesfully unarchived.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested assignmentRequest could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
AssignmentRequests_Undelete
POST /v2/AssignmentRequests/Undelete

Authentication

Bearer

Request body

UndeleteRequest

Responses

200 200

AssignmentRequest succesfully undeleted.

401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested assignmentRequest could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
Type Definitions
SingleAccountSettingsResponse
All of
ApiResponse
Methods: AccountSettings_Read AccountSettings_ReadByEmployeeId AccountSettings_Save
AccountSettings
All of
RootEntity
RootEntity
All of
Entity
Types: AccountSettings AgendaItem AgendaItemCategory AssignmentRequest BaseAssignment Building Cadastre Company CompanySettings FinancialAdministration Invoice InvoiceLine Person RealEstateAgency RelationGroup SearchAssignment Task
LinkedEmployee
All of
Entity
Gender
string
Enumeration:
Unknown
Male
Female
Other
Types: BaseOptionOfGender
Entity
Object
id
string guid
Types: AgendaItemCategorySnapShot AgendaItemSnapShot AssignmentRequestSnapShot AssignmentSnapShot BusinessPartnerSnapShot CadastreSnapShot ContactPersonFinancialAdministration ContactPersonPartner FinancialAdministrationSnapShot InvoiceSnapShot LinkedAgendaItemCategory LinkedAssignment LinkedCadastre LinkedEmployee LinkedInvoice LinkedOffice LinkedRelation LinkedRelationGroup NoteSnapShot RelationGroupSnapShot RelationSnapShot RootEntity SearchAssignmentSnapShot TaskSnapShot TimelineEvent
ApiResponse
Object
Types: AddRecurrencyExceptionResponse HasAcceptedTermsResponse HasSeenContactFormResponse NewSessionResponse SaveResponse SearchResponse SearchResponse11 SearchResponse12 SearchResponse13 SearchResponse14 SearchResponse15 SearchResponse16 SearchResponse17 SearchResponse18 SearchResponse19 SearchResponse2 SearchResponse20 SearchResponse3 SearchResponse4 SearchResponse5 SearchResponse6 SearchResponse7 SearchResponse8 SearchResponse9 SingleAccountSettingsResponse SingleAgendaItemCategoryResponse SingleAgendaItemResponse SingleAssignmentRequestResponse SingleBusinessPartnerResponse SingleCadastreResponse SingleCompanySettingsResponse SingleContactPersonResponse SingleDossierItemSnapShotResponse SingleEmployeeResponse SingleFinancialAdministrationResponse SingleInvoiceResponse SingleOfficeResponse SingleRealEstateAgencyResponse SingleRelationGroupResponse SingleSearchAssignmentResponse SingleTaskResponse TableResponse UploadResponse
ErrorResponse
Object
brokenBusinessRules
Object
errorCode
ErrorCode
message
string
Methods: AccountSettings_Read AccountSettings_ReadByEmployeeId AccountSettings_Save AgendaItemCategories_Read AgendaItemCategories_Search AgendaItems_AddRecurrenceException AgendaItems_Cancel AgendaItems_Confirm AgendaItems_Delete AgendaItems_Move AgendaItems_Read AgendaItems_Save AgendaItems_Search AgendaItems_SearchAndExport AgendaItems_Undelete AssignmentRequests_Archive AssignmentRequests_Delete AssignmentRequests_Read AssignmentRequests_Save AssignmentRequests_Search AssignmentRequests_Unarchive AssignmentRequests_Undelete Assignments_Search Assignments_SearchAndExport BusinessPartners_Read BusinessPartners_Search Cadastres_Archive Cadastres_BuyAndSave Cadastres_BuyAndSaveMunicipalities Cadastres_Delete Cadastres_Read Cadastres_Save Cadastres_Search Cadastres_Unarchive Cadastres_Undelete CompanySettings_Read ContactCompanies_Read ContactLinks_Delete ContactLinks_Save ContactLinks_Search ContactLinks_Undelete ContactPersons_Archive ContactPersons_Delete ContactPersons_Read ContactPersons_Save ContactPersons_Unarchive DossierItems_Delete DossierItems_Save DossierItems_Search DossierItems_Undelete Employees_Archive Employees_Delete Employees_Read Employees_Save Employees_Unarchive FinancialAdministrations_Read FinancialAdministrations_Save FinancialAdministrations_Search Geo_AddressSearch Geo_AdminAreaLevel1 Geo_AdminAreaLevel2 Geo_AdminAreaLevel3 Geo_Locality Geo_Street Geo_Sublocality GlobalSearch_Search Invoices_Delete Invoices_Read Invoices_Save Invoices_Search Invoices_Undelete Keys_Search MasterTable_Index Notes_Delete Notes_Save Notes_Search Notes_Undelete ObjectAssignments_Clone ObjectAssignments_Read ObjectAssignments_UpdateAvailability ObjectTypeAssignments_Read Offices_Read ProjectAssignments_Read RealEstateAgencies_Read RealEstateAgencies_Update RelationGroups_Delete RelationGroups_Link RelationGroups_Read RelationGroups_Save RelationGroups_Search RelationGroups_Undelete RelationGroups_Unlink Relations_Search Relations_SearchAndExport SearchAssignments_Archive SearchAssignments_Delete SearchAssignments_Read SearchAssignments_Save SearchAssignments_Search SearchAssignments_Unarchive SearchAssignments_Undelete Settings_HasAcceptedTerms Settings_HasSeenContactForm Settings_SetHasAcceptedTerms Settings_SetHasSeenContactForm Statistics_Read Tasks_Archive Tasks_Delete Tasks_Read Tasks_Save Tasks_Search Tasks_Unarchive Tasks_Undelete Tasks_UpdateStatus TimelineEvents_Search
ErrorCode
string
Enumeration:
SessionInvalid
SessionExpired
OtherSessionAlreadyExists
Other
NotFound
InvalidModelState
BrokenBusinessRules
InvalidCredentials
UnauthorizedDataAccess
NullModelState
Types: ErrorResponse
HttpError

Defines a serializable container for storing error information. This information is stored as key/value pairs. The dictionary keys to look up standard error information are available on the type.

Unknown
Methods: AccountSettings_Read AccountSettings_ReadByEmployeeId AccountSettings_Save AgendaItemCategories_Read AgendaItemCategories_Search AgendaItems_AddRecurrenceException AgendaItems_Cancel AgendaItems_Confirm AgendaItems_DefineNew AgendaItems_Delete AgendaItems_Move AgendaItems_Read AgendaItems_Save AgendaItems_Search AgendaItems_SearchAndExport AgendaItems_Undelete AssignmentRequests_Archive AssignmentRequests_DefineNew AssignmentRequests_Delete AssignmentRequests_Read AssignmentRequests_Save AssignmentRequests_Search AssignmentRequests_Unarchive AssignmentRequests_Undelete Assignments_Search Assignments_SearchAndExport BusinessPartners_Read BusinessPartners_Search Cadastres_Archive Cadastres_BuyAndSave Cadastres_BuyAndSaveMunicipalities Cadastres_DefineNew Cadastres_Delete Cadastres_Read Cadastres_Save Cadastres_Search Cadastres_Unarchive Cadastres_Undelete CompanySettings_Read ContactCompanies_Archive ContactCompanies_DefineNew ContactCompanies_Delete ContactCompanies_Read ContactCompanies_Save ContactCompanies_Unarchive ContactLinks_Delete ContactLinks_Save ContactLinks_Search ContactLinks_Undelete ContactPersons_Archive ContactPersons_DefineNew ContactPersons_Delete ContactPersons_Read ContactPersons_Save ContactPersons_Unarchive DossierItems_Delete DossierItems_Save DossierItems_Search DossierItems_Undelete Employees_Archive Employees_DefineNew Employees_Delete Employees_Read Employees_Save Employees_Unarchive FinancialAdministrations_Read FinancialAdministrations_Save FinancialAdministrations_Search Geo_AddressSearch Geo_AdminAreaLevel1 Geo_AdminAreaLevel2 Geo_AdminAreaLevel3 Geo_Locality Geo_Street Geo_Sublocality GlobalSearch_Search Invoices_DefineNew Invoices_Delete Invoices_Read Invoices_Save Invoices_Search Invoices_Undelete Keys_Search MasterTable_Index Notes_Delete Notes_Save Notes_Search Notes_Undelete ObjectAssignments_Clone ObjectAssignments_DefineNew ObjectAssignments_Delete ObjectAssignments_Read ObjectAssignments_Save ObjectAssignments_Undelete ObjectAssignments_UpdateAvailability ObjectTypeAssignments_DefineNew ObjectTypeAssignments_Delete ObjectTypeAssignments_Read ObjectTypeAssignments_Save ObjectTypeAssignments_Undelete Offices_Archive Offices_DefineNew Offices_Delete Offices_Read Offices_Save Offices_Unarchive ProjectAssignments_DefineNew ProjectAssignments_Delete ProjectAssignments_Read ProjectAssignments_Save ProjectAssignments_Undelete Publications_Activate Publications_Deactivate Publications_Search RealEstateAgencies_Read RealEstateAgencies_Update RelationGroups_DefineNew RelationGroups_Delete RelationGroups_Link RelationGroups_Read RelationGroups_Save RelationGroups_Search RelationGroups_Undelete RelationGroups_Unlink Relations_Search Relations_SearchAndExport SearchAssignments_Archive SearchAssignments_DefineNew SearchAssignments_Delete SearchAssignments_Read SearchAssignments_Save SearchAssignments_Search SearchAssignments_Unarchive SearchAssignments_Undelete Security_EndSession Security_RecoverPassword Security_Refresh Security_RequestRecoveryCode Security_StartSession Settings_HasAcceptedTerms Settings_HasSeenContactForm Settings_SetHasAcceptedTerms Settings_SetHasSeenContactForm Statistics_Read Tasks_Archive Tasks_DefineNew Tasks_Delete Tasks_Read Tasks_Save Tasks_Search Tasks_Unarchive Tasks_Undelete Tasks_UpdateStatus TimelineEvents_Search
SaveRequest
All of
Request
Methods: AccountSettings_Save
Request
Object
realEstateAgencyId
string guid
Types: ActivateRequest AddRecurrencyExceptionRequest ArchiveRequest ArchiveRequest2 BuyAndSaveMunicipalitiesRequest BuyAndSaveRequest CancelRequest CloneRequest ConfirmRequest CultureRequest DeactivateRequest LinkRequest MoveAgendaItemRequest ReadByEmployeeIdRequest SaveRequest SaveRequest10 SaveRequest4 SaveRequest6 SaveRequest8 SearchRequest12 SearchRequest13 SearchRequest15 SetHasAcceptedTermsRequest SetHasSeenContactFormRequest UnarchiveRequest UndeleteRequest UndeleteRequest2 UndeleteRequest3 UnlinkRequest UpdateAvailabilityRequest UpdateStatusRequest
ReadByEmployeeIdRequest
All of
Request
Methods: AccountSettings_ReadByEmployeeId
SingleAgendaItemCategoryResponse
All of
ApiResponse
Methods: AgendaItemCategories_Read
AgendaItemCategory
All of
RootEntity
Priority
string
Enumeration:
Low
Medium
High
Types: BaseOptionOfPriority
AgendaStandardDuration
string
Enumeration:
FifteenMinutes
ThirtyMinutes
FortyFiveMinutes
OneHour
OneAndAHalfHours
TwoHours
ThreeHours
FourHours
AllDay
Types: BaseOptionOfAgendaStandardDuration
AgendaItemTimeMarker
string
Enumeration:
None
Busy
Free
OutOfOffice
Tentative
SearchRequest
All of
SearchRequest2
Methods: AgendaItemCategories_Search
AgendaItemCategoryOrderByField
string
Enumeration:
DisplayName
AgendaItemCategoryTermField
string
Enumeration:
DisplayName
SearchRequest2
All of
CultureRequest
Types: SearchRequest SearchRequest10 SearchRequest14 SearchRequest16 SearchRequest17 SearchRequest18 SearchRequest19 SearchRequest20 SearchRequest21 SearchRequest3 SearchRequest4 SearchRequest5 SearchRequest6 SearchRequest7 SearchRequest8 SearchRequest9
ActiveFilter
string
Enumeration:
ActiveOrInactive
ActiveOnly
InactiveOnly
SortOrder
string
Enumeration:
Ascending
Descending
CultureRequest
All of
Request
Types: DefineNewRequest DefineNewRequest10 DefineNewRequest11 DefineNewRequest12 DefineNewRequest13 DefineNewRequest14 DefineNewRequest2 DefineNewRequest3 DefineNewRequest4 DefineNewRequest5 DefineNewRequest6 DefineNewRequest7 DefineNewRequest8 DefineNewRequest9 SaveRequest11 SaveRequest12 SaveRequest13 SaveRequest14 SaveRequest15 SaveRequest16 SaveRequest17 SaveRequest18 SaveRequest19 SaveRequest2 SaveRequest3 SaveRequest5 SaveRequest7 SaveRequest9 SearchRequest2
SearchResponse
All of
ApiResponse
Methods: AgendaItemCategories_Search
AgendaItemCategorySnapShot
All of
Entity
DefineNewRequest
All of
CultureRequest
Methods: ObjectTypeAssignments_DefineNew
RealEstateGroup
string
Enumeration:
Residential
Commercial
Agricultural
ProductionRight
TypePART
string
Enumeration:
None
Apartment
BuildingGround
Other
Parking
SummerCottage
ResidentialBuilding
Types: SearchProfile
SingleObjectTypeAssignmentResponse
Object
objectTypeAssignment
ObjectTypeAssignment
Methods: ObjectTypeAssignments_DefineNew ObjectTypeAssignments_Read ObjectTypeAssignments_Save
ObjectTypeAssignment
All of
BaseAssignment
Types: SingleObjectTypeAssignmentResponse
TranslatedText
Object
language
Language
text
string
Types: AcceptanceDetails BusinessLaw Floor Maintenance Offer OpenHouse OwnershipDetails Part Roof Space YearOfConstruction
Language
string
Enumeration:
Dutch
English
Georgian
German
French
Spanish
Italian
Croatian
Russian
Estonian
Finnish
Polish
Turkish
Swedish
Types: AssignmentRequestTranslation BaseOptionOfLanguage SocialMediaTranslation TestimonialTranslation TranslatedText Translation
BuildingType
string
Enumeration:
None
Existing
New
Types: SearchProfile
InsulationType
string
Enumeration:
RoofInsulation
WallInsulation
FloorInsulation
FullyInsulated
CavityWall
AnchorlessCavityWall
EcoBuilding
DoubleGlazing
PartialDoubleGlazing
Sash
Types: BaseOptionOfInsulationType
LocationPlace
string
Enumeration:
ForestEdge
Waterside
Park
OnBusyStreet
OnQuietStreet
CentralCityCenter
ResidentialArea
UnobstructedView
ShelteredLocation
OpenArea
OutsideVillage
OnWaterway
ForestedArea
NearRailwayStation
Suburb
BusinessPark
Other
LRTE
HarborArea
IndustrialArea
OfficePark
PRTE
ShoppingCenter
Countryside
NearHighway
NearPublicTransport
NearSchool
Seaside
SecludedLocation
Standalone
SubDivision
Types: BaseOptionOfLocationPlace SearchProfile
Maintenance
Object
conditionType
ConditionType
description
Array of TranslatedText
rating
Condition
ConditionType
string
Enumeration:
EssentialRepairsDone
Foundation
Framework
NeedsRenovation
NeedsDecoration
NewBuilding
NewlyDecorated
Ready
Renovated
UnderConstruction
Types: BaseOptionOfConditionType Maintenance SearchProfile
Condition
string
Enumeration:
Poor
PoorToModerate
Moderate
ModerateToHabitable
Habitable
HabitableToGood
Good
GoodToExcellent
Excellent
Types: BaseOptionOfCondition Maintenance
TypeOfParkingFacility
string
Enumeration:
PublicParking
PaidParking
CarPark
PermitParking
Types: BaseOptionOfTypeOfParkingFacility
Roof
Object
description
Array of TranslatedText
roofMaterials
Array of RoofMaterial
roofType
RoofType
RoofMaterial
string
Enumeration:
Leisteen
Cane
Asbestos
Plastic
Tiles
BituminousRoofing
Metal
Other
Ceramic
Slate
Tinplate
RolledMaterial
Stone
Lath
PVC
Galvanized
Types: BaseOptionOfRoofMaterial Roof
RoofType
string
Enumeration:
GableRoof
FlatRoof
PentRoof
MansardRoof
SideGabledRoof
CompositeRoof
HipRoof
PavilionRoof
RoofWithOwlBoards
HelmRoof
SawtoothRoof
CanopyRoof
Kapmetplat
VaultedRoof
Curved
ShellRoof
Types: BaseOptionOfRoofType Roof
BaseAssignment
All of
RootEntity
Types: ObjectAssignment ObjectTypeAssignment ProjectAssignment
AcceptanceDetails
Object
acceptance
Acceptance
date
string date-time
description
Array of TranslatedText
Acceptance
string
Enumeration:
InConsultation
PerDate
Directly
Types: AcceptanceDetails BaseOptionOfAcceptance
AssignmentPhase
string
Enumeration:
Concept
Initiated
Completed
Methods: Assignments_SearchAndExport
Types: BaseOptionOfAssignmentPhase
AvailabilityStatus
string
Enumeration:
Available
UnderBid
UnderOption
SoldUnderCondition
RentedUnderCondition
Sold
Rented
Withdrawn
FarmedUnderCondition
Farmed
LeasedUnderCondition
Leased
Methods: Assignments_SearchAndExport
Types: BaseOptionOfAvailabilityStatus
BrochureBlob
All of
FileMetaData
BrochureType
string
Enumeration:
Brochure
Conversheet
WindowPresentation
Other
FileMetaData
Object
contentType
string
dateTimeCreated
string date-time
dateTimeModified
string date-time
description
string
fileDataId
string guid
fileExtension
string
fileName
string
fileSize
integer int64
md5Hash
string
name
string
urlOriginal
string
urlPreview
string
Types: BrochureBlob CadastralBlob DossierBlob ImageBlob MapBlob PhotoBlob ThirdPartyMedia VideoBlob
AssignmentBusinessPartner
Object
associationInfo
RealEstateAssociationInfo
associationInfoAlt
RealEstateAssociationInfo
displayName
string
emailAddress
string
phoneNumber
string
postalAddress
Address
visitAddress
Address
webAddress
string
RealEstateAssociationInfo
Object
association
RealEstateAssociation
membershipNumber
string
Types: AssignmentBusinessPartner BusinessPartner
RealEstateAssociation
string
Enumeration:
Independent
Vbo
VastgoedPro
Nvm
Types: BaseOptionOfRealEstateAssociation RealEstateAssociationInfo
Address
Object
adminAreaLevel1
AddressDetail
adminAreaLevel2
AddressDetail
adminAreaLevel3
AddressDetail
cadastralCode
string
claimInProgress
boolean
countryIso2
string
endOfHouseNumberRange
integer int32
houseNumber
integer int32
houseNumberPostfix
string
locality
AddressDetail
geoLocation
GeoLocation
postalCode
string
startOfHouseNumberRange
integer int32
street
AddressDetail
sublocality
AddressDetail
usesHouseNumberRange
boolean
Types: AssignmentBusinessPartner BusinessPartner SearchResponse10
AddressDetail
Object
id
integer int32
name
string
Types: Address AddressDetailResponseBase SearchProfile
GeoLocation
Object
latitude
number double
longitude
number double
Types: Address SearchProfile
PartialChange
Object
dateTimeModified
string date-time
mutationValue
number decimal
ConfidentialityLevel
string
Enumeration:
None
LimitedAudience
Public
Confidential
ContractReason
string
Enumeration:
ForSale
ForRent
ForSalesRental
Sold
Lease
ThirdPartySale
ThirdPartyLease
SalesAuction
Registration
ContractSource
string
Enumeration:
None
Colleague
Housenet3
WalkIn
Internet
Friend
Other
DossierBlob
All of
FileMetaData
DossierItemType
string
Enumeration:
Other
AgreementToSell
AgreementToRent
CopyOfPassport
CopyDrivingLicense
LinkedRelation
All of
Entity
Types: ContactLinkSnapShot UpdateAvailabilityAvailableSettings UpdateAvailabilityRentedSettings UpdateAvailabilitySoldSettings
RelationType
string
Enumeration:
Employee
ContactPerson
ContactCompany
Office
Methods: Relations_SearchAndExport
Types: BaseOptionOfRelationType
LinkedCadastre
All of
Entity
LinkedOffice
All of
Entity
BusinessToTakeOver
Object
business
BusinessSpecification
takeOver
TakeOverSpecification
takeOverAmount
number decimal
BusinessSpecification
string
Enumeration:
None
Goodwill
Inventory
Staff
Types: BusinessToTakeOver
TakeOverSpecification
string
Enumeration:
None
StaysBehind
GoesAlong
DoesNotApply
ForAcquisition
Types: BusinessToTakeOver
MapBlob
All of
FileMetaData
OpenHouse
Object
openHouseDate
string date-time
openHouseEndTime
string date-time
openHouseStartTime
string date-time
openHouseText
Array of TranslatedText
option
OpenHouseRecurrence
OpenHouseRecurrence
string
Enumeration:
Date
Weekly
Types: BaseOptionOfOpenHouseRecurrence OpenHouse
Part
Object
description
Array of TranslatedText
Types: Garage Garden
PhotoBlob
All of
FileMetaData
Types: Testimonial
ProductToPassOn
All of
NotifiableObject
NotifiableObject
All of
WazzupObject
Types: ProductToPassOn
WazzupObject
Object
Types: NotifiableObject
RentOffer
All of
Offer
LeaseTerm
Object
isApplicable
boolean
numberOfUnits
integer int32
unit
LeaseTermUnit
LeaseTermUnit
string
Enumeration:
Day
Week
Month
Quarter
Year
Types: LeaseTerm LeaseTermUnitOption
RentCondition
string
Enumeration:
PricePerDay
PricePerWeek
PricePerMonth
PricePerQuarter
PricePerHalfYear
PricePerYear
PricePerContract
Types: BaseOptionOfRentCondition Offer
UnitSize
string
Enumeration:
M2
Hectare
Types: BaseOptionOfUnitSize
RentSpecification
string
Enumeration:
ServiceCharges
Gas
Water
Electricity
Furnished
Upholstered
Internet
Television
Types: BaseOptionOfRentSpecification
Offer
Object
btwPercentage
number decimal
buyPricePerParkingLot
number decimal
commissionContactGross
number decimal
commissionContactNote
Array of TranslatedText
commissionContactPercent
number decimal
commissionContactType
CommissionType
commissionCustomerGross
number decimal
commissionCustomerNote
Array of TranslatedText
commissionCustomerPercent
number decimal
commissionOwnerGross
number decimal
commissionOwnerNote
Array of TranslatedText
commissionOwnerPercent
number decimal
commissionPaidBy
CommissionPaidBy
commissionType
CommissionType
customerBudget
number decimal
excludingCapitalizedInterest
boolean
furnishing
Furnishing
hasRetailersContribution
boolean
indicationElectra
number decimal
indicationGas
number decimal
indicationHeatingCosts
number decimal
indicationIncentives
boolean
indicationInternet
number decimal
indicationTelevision
number decimal
indicationWater
number decimal
internalBudget
number decimal
priceCode
PriceCode
priceHistory
Array of PriceHistory
rendPricePerParkingLot
number decimal
rentConditionParkingPlace
RentCondition
retailersContribution
number decimal
saleConditionParkingPlace
SaleCondition
serviceCosts
number decimal
sewerageCharges
number decimal
valuationOfImmovablePropertyAct
ValuationOfImmovablePropertyAct
vatCondition
VatCondition
waterAuthorityCharges
number decimal
Types: RentOffer SaleOffer
CommissionType
string
Enumeration:
Fixed
Percentage
FixedAndPercentage
Types: BaseOptionOfCommissionType Offer
CommissionPaidBy
string
Enumeration:
Owner
Customer
OwnerAndCustomer
Types: BaseOptionOfCommissionPaidBy Offer
Furnishing
string
Enumeration:
Furnished
Upholstered
AsShell
OptionForFurnished
Types: BaseOptionOfFurnishing Offer
PriceCode
string
Enumeration:
HigherBudget
PublicAuction
InConsultation
ToBeNegotiated
OnRequest
AnyPlausibleBid
FixedPrice
ByTender
AskingPrice
Types: BaseOptionOfPriceCode Offer
PriceHistory
Object
dateTimeModified
string date-time
event
PriceHistoryEvent
newPrice
number decimal
newPriceMax
number decimal
oldPrice
number decimal
oldPriceMax
number decimal
Types: Offer
PriceHistoryEvent
string
Enumeration:
Registered
Changed
Types: BaseOptionOfPriceHistoryEvent PriceHistory
SaleCondition
string
Enumeration:
CostsBuyer
FreeOnName
CostsSplit
Types: BaseOptionOfSaleCondition Offer
ValuationOfImmovablePropertyAct
Object
dateOfIssue
string date-time
value
number decimal
Types: Offer
VatCondition
string
Enumeration:
Included
Excluded
Types: BaseOptionOfVatCondition Offer
SaleOffer
All of
Offer
IntermediateForm
string
Enumeration:
HomeSaleGuarantee
Mge
UnitBasedSales
IntermediateFormBuyRent
Types: BaseOptionOfIntermediateForm
ThirdPartyMedia
All of
FileMetaData
VideoBlob
All of
FileMetaData
WaitingTime
string
Enumeration:
None
Direct
HalfYear
InConsultation
Year
Quarter
WithdrawReason
string
Enumeration:
ReasonForMovingExpired
AskingPriceNotMet
RenewObjectInMedia
ChoseOtherRealEstateAgent
PurchasedByOwner
SoldByOtherRealEstateAgent
Types: BaseOptionOfWithdrawReason UpdateAvailabilityWithdrawnSettings
SaveRequest2
All of
CultureRequest
Methods: ObjectTypeAssignments_Save
UndeleteRequest
All of
Request
Methods: AgendaItems_Undelete AssignmentRequests_Undelete Cadastres_Undelete Invoices_Undelete Notes_Undelete ObjectAssignments_Undelete ObjectTypeAssignments_Undelete ProjectAssignments_Undelete RelationGroups_Undelete SearchAssignments_Undelete Tasks_Undelete
DefineNewRequest2
All of
CultureRequest
Methods: ProjectAssignments_DefineNew
ListingType
string
Enumeration:
House
Apartment
Parking
Plot
SummerCottage
Other
ProductionHall
OutdoorArea
HotelRestaurantCafe
Office
Lot
PracticeSpace
ShowRoom
RetailSpace
Warehouse
WarehouseProduction
Services
Garage
ArableCompany
LooseSoil
DairyFarmingCompany
PoultryCompany
HorsesCompany
ProductionRights
Horticultural
PigHolding
VealCalvesFarming
AgriculturalHouse
CattleFarming
BusinessSpace
Ammoniac
AvebeShares
BeetQuota
MilkQuota
PoultryRights
PaymentEntitlements
PigRights
Methods: Assignments_SearchAndExport
Types: BaseOptionOfListingType Statistics
SingleProjectAssignmentResponse
Object
projectAssignment
ProjectAssignment
Methods: ProjectAssignments_DefineNew ProjectAssignments_Read ProjectAssignments_Save
ProjectAssignment
All of
BaseAssignment
Types: SingleProjectAssignmentResponse
DimensionsRange
Object
maxArea
number decimal
maxHeight
number decimal
maxLength
number decimal
maxVolume
number decimal
maxWidth
number decimal
minArea
number decimal
minHeight
number decimal
minLength
number decimal
minVolume
number decimal
minWidth
number decimal
unitOfMeasurement
UnitOfMeasurement
unitOfVolume
UnitOfVolume
UnitOfMeasurement
string
Enumeration:
Meter
Inch
Types: BaseOptionOfUnitOfMeasurement DimensionsRange Size
UnitOfVolume
string
Enumeration:
CubicMeter
Types: BaseOptionOfUnitOfVolume DimensionsRange Size
ComfortQuality
string
Enumeration:
Luxury
Normal
Simple
Types: BaseOptionOfComfortQuality
YearOfConstruction
Object
constructionYear
integer int32
description
Array of TranslatedText
isUnderConstruction
boolean
period
ConstructionPeriod
Types: BusinessHouse
ConstructionPeriod
string
Enumeration:
Before1906
Between1906And1930
Between1931And1944
Between1945And1959
Between1960And1970
Between1971And1980
Between1981And1990
Between1991And2000
Between2001And2010
After2010
Types: BaseOptionOfConstructionPeriod YearOfConstruction
SaveRequest3
All of
CultureRequest
Methods: ProjectAssignments_Save
SingleRelationGroupResponse
All of
ApiResponse
Methods: RelationGroups_DefineNew RelationGroups_Read RelationGroups_Save
RelationGroup
All of
RootEntity
RelationGroupType
string
Enumeration:
UserDefined
HouseHunters
WebsiteVisitors
Notaries
Tenants
Purchasers
Lessors
Vendors
SearchRequest3
All of
SearchRequest2
Methods: RelationGroups_Search
RelationGroupOrderByField
string
Enumeration:
Name
RelationGroupTermField
string
Enumeration:
Name
SearchResponse2
All of
ApiResponse
Methods: RelationGroups_Search
RelationGroupSnapShot
All of
Entity
DefineNewRequest3
All of
CultureRequest
Methods: RelationGroups_DefineNew
SaveRequest4
All of
Request
Methods: RelationGroups_Save
LinkRequest
All of
Request
Methods: RelationGroups_Link
UnlinkRequest
All of
Request
Methods: RelationGroups_Unlink
SingleAgendaItemResponse
All of
ApiResponse
Methods: AgendaItems_Cancel AgendaItems_Confirm AgendaItems_DefineNew AgendaItems_Move AgendaItems_Read AgendaItems_Save AgendaItems_Undelete
AgendaItem
All of
RootEntity
LinkedAgendaItemCategory
All of
Entity
LinkedAssignment
All of
Entity
RealEstateGroup2
string
Enumeration:
Residential
Commercial
Agricultural
ProductionRight
Methods: Assignments_SearchAndExport
Types: BaseOptionOfRealEstateGroup SearchProfile
AssignmentType
string
Enumeration:
Object
ObjectType
Project
Methods: Assignments_SearchAndExport
Types: BaseOptionOfAssignmentType
SearchRequest4
All of
SearchRequest2
Methods: AgendaItems_Search
AgendaItemOrderByField
string
Enumeration:
StartDateTime
AgendaItemTermField
string
Enumeration:
Subject
Methods: AgendaItems_SearchAndExport
SearchResponse3
All of
ApiResponse
Methods: AgendaItems_Search
AgendaItemSnapShot
All of
Entity
DefineNewRequest4
All of
CultureRequest
Methods: AgendaItems_DefineNew
SaveRequest5
All of
CultureRequest
Methods: AgendaItems_Save
MoveAgendaItemRequest
All of
Request
Methods: AgendaItems_Move
ConfirmRequest
All of
Request
Methods: AgendaItems_Confirm
CancelRequest
All of
Request
Methods: AgendaItems_Cancel
AddRecurrencyExceptionRequest
All of
Request
Methods: AgendaItems_AddRecurrenceException
AddRecurrencyExceptionResponse
All of
ApiResponse
Methods: AgendaItems_AddRecurrenceException
SearchRequest5
All of
SearchRequest2
Methods: Assignments_Search
AssignmentOrderByField
string
Enumeration:
LocalityStreetNameAndNumber
AssignmentTermField
string
Enumeration:
PublicReference
StreetNameAndNumber
PostalCode
Locality
Methods: Assignments_SearchAndExport
SearchResponse4
All of
ApiResponse
Methods: Assignments_Search
AssignmentSnapShot
All of
Entity
Statistics
Object
commissionTotal
number decimal
listingTypes
Array of ListingType
localities
Array of string
UploadResponse
All of
ApiResponse
Methods: Blobs_Upload
SingleBusinessPartnerResponse
All of
ApiResponse
Methods: BusinessPartners_Read
BusinessPartner
Object
associationInfo
RealEstateAssociationInfo
associationInfoAlt
RealEstateAssociationInfo
dateTimeCreated
string date-time
dateTimeModified
string date-time
displayName
string
emailAddress
string
id
string guid
phoneNumber
string
postalAddress
Address
visitAddress
Address
webAddress
string
SearchRequest6
All of
SearchRequest2
Methods: BusinessPartners_Search
BusinessPartnerOrderByField
string
Enumeration:
DisplayName
BusinessPartnerTermField
string
Enumeration:
DisplayName
StreetNameAndNumber
PostalCode
Locality
SearchResponse5
All of
ApiResponse
Methods: BusinessPartners_Search
BusinessPartnerSnapShot
All of
Entity
ArchiveRequest
All of
Request
Methods: AssignmentRequests_Archive Cadastres_Archive ContactCompanies_Archive ContactPersons_Archive Employees_Archive SearchAssignments_Archive Tasks_Archive
BuyAndSaveRequest
All of
Request
Methods: Cadastres_BuyAndSave
BuyAndSaveResponse
Object
cadastres
Array of Cadastre
Methods: Cadastres_BuyAndSave
Cadastre
All of
RootEntity
Types: BuyAndSaveResponse
CadastralApartmentRights
Object
complex
string
hasOwnersAssociation
boolean
head
string
isOriginatedFromMultipleBusinesses
boolean
municipalityByDevision
string
parcelNumberByDevision
string
sectionByDevision
string
CadastralDetails
Object
cadastralLotSize
CadastralLotSize
indexNumber
string
indicationEstimatedSize
boolean
letter
string
municipalCode
string
parcel
string
referenceNumber
string
section
string
share
string
surface
integer int64
xCoordinate
string
yCoordinate
string
CadastralLotSize
string
Enumeration:
PerpetualLease
Condominium
MembershipRights
EntireLot
PartialLot
Types: CadastralDetails
CadastralBlob
All of
FileMetaData
OwnershipDetails
Object
boughtOutUntil
string date-time
description
Array of TranslatedText
endDate
string date-time
fixedVariable
FixedVariable
groundLeasePeriod
GroundLeasePeriod
hasBuyoutOption
boolean
hasLeasehold
boolean
leaseholdOwner
string
leaseholdPrice
number decimal
leaseTerm
LeaseholdPeriod
multiplicityLeasehold
string
ownershipType
OwnershipType
purchasePrice
number decimal
FixedVariable
string
Enumeration:
Fixed
Variable
Types: OwnershipDetails
GroundLeasePeriod
string
Enumeration:
Permanent
Temporary
Ongoing
Types: BaseOptionOfGroundLeasePeriod OwnershipDetails
LeaseholdPeriod
string
Enumeration:
Month
Quarter
HalfYear
Year
Types: OwnershipDetails
OwnershipType
string
Enumeration:
FullOwnership
Leasehold
LeaseholdPropertyTax
UnderLeasehold
LeaseholdEstate
PropertyEncumberedWithSuperstructure
LeaseholdSuperstructure
PropertyEncumberedWithLeaseholdSuperstructure
PerpetualGroundRent
PropertyEncumberedWithPerpetualGroundRent
CityLaw
PropertyEncumberedWithCityLaw
UnderRightOfAppeal
Usufruct
PropertyEncumberedWithUsufruct
Occupancy
PropertyEncumberedWithOccupancy
PropertyEncumberedWithLimitedRights
LeaseholdEncumberedWithUsufruct
SuperstructureEncumberedWithUsufruct
LeaseholdSuperstructureEncumberedWithUsufruct
RightOfAppealEncumberedWithUsufruct
LeaseholdEncumberedWithOccupancy
SuperstructureEncumberedWithOccupancy
LeaseholdSuperstructureEncumberedWithOccupancy
RightOfAppealEncumberedWithOccupancy
SeeDeed
Types: BaseOptionOfOwnershipType OwnershipDetails
BuyAndSaveMunicipalitiesRequest
All of
Request
Methods: Cadastres_BuyAndSaveMunicipalities
BuyAndSaveMunicipalitiesResponse
Object
resultCount
integer int32
results
Array of BuyAndSaveMunicipality
totalResults
integer int32
Methods: Cadastres_BuyAndSaveMunicipalities
BuyAndSaveMunicipality
Object
municipalityId
string
municipalityName
string
Types: BuyAndSaveMunicipalitiesResponse
DefineNewRequest5
All of
CultureRequest
Methods: Cadastres_DefineNew
SingleCadastreResponse
All of
ApiResponse
Methods: Cadastres_DefineNew Cadastres_Read Cadastres_Save
SaveRequest6
All of
Request
Methods: Cadastres_Save
SearchRequest7
All of
SearchRequest2
Methods: Cadastres_Search
CadastreOrderByField
string
Enumeration:
CreationDateTime
CadastreTermField
string
Enumeration:
DisplayName
SearchResponse6
All of
ApiResponse
Methods: Cadastres_Search
CadastreSnapShot
All of
Entity
UnarchiveRequest
All of
Request
Methods: AssignmentRequests_Unarchive Cadastres_Unarchive ContactCompanies_Unarchive ContactPersons_Unarchive Employees_Unarchive Offices_Unarchive SearchAssignments_Unarchive Tasks_Unarchive
SingleCompanySettingsResponse
All of
ApiResponse
Methods: CompanySettings_Read
CompanySettings
All of
RootEntity
DefineNewRequest6
All of
CultureRequest
Methods: ContactCompanies_DefineNew
SingleContactCompanyResponse
Object
contactCompany
ContactCompany
Methods: ContactCompanies_DefineNew ContactCompanies_Read ContactCompanies_Save
ContactCompany
All of
Company
Types: SingleContactCompanyResponse
ContactCompanyFinancialAdministration
Object
debtorNumber
string
displayName
string
id
string guid
LinkedRelationGroup
All of
Entity
SocialMediaTranslation
Object
account
string
language
Language
type
SocialMediaType
SocialMediaType
string
Enumeration:
Facebook
Twitter
TwitterWidget
YouTube
LinkedIn
GooglePlus
Pinterest
Video
Types: BaseOptionOfSocialMediaType SocialMediaTranslation
Company
All of
RootEntity
Types: ContactCompany
BankAccount
Object
countryIso2
string
localityName
string
name
string
number
string
EmailAddress
Object
address
string
type
EmailAddressType
EmailAddressType
string
Enumeration:
Other
Home
Work
Types: BaseOptionOfEmailAddressType EmailAddress
LegalRegistration
Object
countryIso2
string
date
string date-time
locality
string
name
string
number
string
PhoneNumber
Object
number
string
type
PhoneNumberType
PhoneNumberType
string
Enumeration:
Other
Home
Work
Mobile
Types: BaseOptionOfPhoneNumberType PhoneNumber
SaveRequest7
All of
CultureRequest
Methods: ContactCompanies_Save
SaveRequest8
All of
Request
Methods: ContactLinks_Save
SingleContactLinkSnapShotResponse
Object
contactLinkSnapShot
ContactLinkSnapShot
Methods: ContactLinks_Save
ContactLinkSnapShot
Object
isPartnerLink
boolean
linkDescription
string
linkType
string
sourceRelation
LinkedRelation
targetRelation
LinkedRelation
venumCompanyId
string guid
Types: SingleContactLinkSnapShotResponse
SearchRequest8
All of
SearchRequest2
Methods: ContactLinks_Search
ContactLinkOrderByField
string
Enumeration:
DisplayName
ContactLinkTermField
string
Enumeration:
LinkType
SearchResponse7
All of
ApiResponse
Methods: ContactLinks_Search
UndeleteRequest2
All of
Request
Methods: ContactLinks_Undelete
DefineNewRequest7
All of
CultureRequest
Methods: ContactPersons_DefineNew
SingleContactPersonResponse
All of
ApiResponse
Methods: ContactPersons_DefineNew ContactPersons_Read ContactPersons_Save
ContactPerson
All of
Person
ContactPersonFinancialAdministration
All of
Entity
ContactPersonPartner
All of
Entity
Person
All of
RootEntity
Types: ContactPerson Employee
CivilState
string
Enumeration:
Unknown
Single
Unmarried
MarriedWithConditions
MarriedInCommunityOfProperty
LivingTogetherInCivilPartnership
LivingTogetherWithoutCivilPartnership
PartnerRegistrationInCommunityOfProperty
PartnerRegistrationWithTermLifeInsurance
PartnerRegistrationPartnershipWithConditions
Widower
Widow
Divorced
Married
Types: BaseOptionOfCivilState
IdentificationCard
Object
number
string
type
IdentificationType
validUntilDate
string date-time
IdentificationType
string
Enumeration:
Unknown
Passport
IdentityCard
DriverLicense
ResidenceDocument
RefugeePassport
StrangerPassport
ForeignPassport
ElectronicWDocument
Types: BaseOptionOfIdentificationType IdentificationCard
SaveRequest9
All of
CultureRequest
Methods: ContactPersons_Save
SaveRequest10
All of
Request
Methods: DossierItems_Save
SingleDossierItemSnapShotResponse
All of
ApiResponse
Methods: DossierItems_Save DossierItems_Undelete
DossierItemSnapShot
Object
dateTimeCreated
string date-time
dateTimeModified
string date-time
description
string
fileDataId
string guid
fileExtension
string
fileName
string
fileSize
integer int64
id
integer int32
md5Hash
string
name
string
parentId
string guid
url
string
venumCompanyId
string guid
SearchRequest9
All of
SearchRequest2
Methods: DossierItems_Search
DossierItemOrderByField
string
Enumeration:
CreationDateTime
DossierItemTermField
string
Enumeration:
FileName
SearchResponse8
All of
ApiResponse
Methods: DossierItems_Search
UndeleteRequest3
All of
Request
Methods: DossierItems_Undelete
DefineNewRequest8
All of
CultureRequest
Methods: Employees_DefineNew
SingleEmployeeResponse
All of
ApiResponse
Methods: Employees_DefineNew Employees_Read Employees_Save
Employee
All of
Person
Translation
Object
language
Language
text
string
CertificationDetails
Object
certification
AppraisalCertification
date
string date-time
isActiveAppraiser
boolean
isAppraiser
boolean
locality
string
number
string
AppraisalCertification
string
Enumeration:
Unknown
Scvm
VastGoedCert
Types: BaseOptionOfAppraisalCertification CertificationDetails
EmployeeRole
string
Enumeration:
Appraiser
Coach
BackOffice
SaveRequest11
All of
CultureRequest
Methods: Employees_Save
SingleFinancialAdministrationResponse
All of
ApiResponse
Methods: FinancialAdministrations_Read FinancialAdministrations_Save
FinancialAdministration
All of
RootEntity
ImageBlob
All of
FileMetaData
FinancialAdministrationGroup
Object
budgetedAmount
number decimal
budgetedNumberOfProducts
number decimal
id
integer int32
name
string
Min length: 0
Max length: 50
SoftwareAdministration
All of
DescriptorPatternBase
DescriptorPatternBase
Object
id
integer int32
name
string
Types: MatchMailTrigger MeasurementUnit SoftwareAdministration TypeALV TypeBOG TypePART2
FinancialAdministrationProduct
Object
description
string
Min length: 0
Max length: 500
descriptionShort
string
Min length: 0
Max length: 50
exportLedgerAccountCode
string
Min length: 0
Max length: 10
groupId
integer int32
id
integer int32
isActive
boolean
isMarketingProduct
boolean
taxRateId
integer int32
unitPriceNet
number decimal
FinancialAdministrationTaxRate
Object
description
string
Min length: 0
Max length: 500
descriptionShort
string
Min length: 0
Max length: 10
exportLedgerAccountCode
string
Min length: 0
Max length: 10
exportTaxCode
string
Min length: 0
Max length: 10
id
integer int32
isActive
boolean
taxPercentage
number decimal
SaveRequest12
All of
CultureRequest
Methods: FinancialAdministrations_Save
SearchRequest10
All of
SearchRequest2
Methods: FinancialAdministrations_Search
FinancialAdministrationOrderByField
string
Enumeration:
Name
FinancialAdministrationTermField
string
Enumeration:
Name
SearchResponse9
All of
ApiResponse
Methods: FinancialAdministrations_Search
FinancialAdministrationSnapShot
All of
Entity
SearchRequest11
Object
countryIso2
string
Min length: 0
Max length: 2
culture
string
Min length: 0
Max length: 5
location
string
Min length: 0
Max length: 100
Methods: Geo_AddressSearch
SearchResponse10
Object
results
Address
Methods: Geo_AddressSearch
AdminAreaLevel1SearchResponse
All of
AddressDetailResponseBase
Methods: Geo_AdminAreaLevel1
AddressDetailResponseBase
Object
results
Array of AddressDetail
Types: AdminAreaLevel1SearchResponse AdminAreaLevel2SearchResponse AdminAreaLevel3SearchResponse LocalitySearchResponse StreetSearchResponse SublocalitySearchResponse
AdminAreaLevel2SearchResponse
All of
AddressDetailResponseBase
Methods: Geo_AdminAreaLevel2
AdminAreaLevel3SearchResponse
All of
AddressDetailResponseBase
Methods: Geo_AdminAreaLevel3
LocalitySearchResponse
All of
AddressDetailResponseBase
Methods: Geo_Locality
StreetSearchResponse
All of
AddressDetailResponseBase
Methods: Geo_Street
SublocalitySearchResponse
All of
AddressDetailResponseBase
Methods: Geo_Sublocality
SearchRequest12
All of
Request
Methods: GlobalSearch_Search
GlobalSearchType
string
Enumeration:
Relations
Assignments
SearchResponse11
All of
ApiResponse
Methods: GlobalSearch_Search
AssignmentsSearchResult
All of
SearchResultBase
SearchResultBase
Object
resultCount
integer int32
totalResults
integer int32
Types: AssignmentsSearchResult RelationsSearchResult
RelationsSearchResult
All of
SearchResultBase
RelationSnapShot
All of
Entity
SearchRequest13
All of
Request
Methods: Keys_Search
AvailableFilter
string
Enumeration:
Available
InUse
SearchResponse12
All of
ApiResponse
Methods: Keys_Search
TableResponse
All of
ApiResponse
Methods: MasterTable_Index
AcceptanceOption
All of
BaseOptionOfAcceptance
BaseOptionOfAcceptance
Object
displayName
string
id
integer int32
value
Acceptance
Types: AcceptanceOption
AgendaStandardDurationOption
All of
BaseOptionOfAgendaStandardDuration
BaseOptionOfAgendaStandardDuration
Object
displayName
string
id
integer int32
value
AgendaStandardDuration
Types: AgendaStandardDurationOption
AgriculturalSubtypeOtherOption
All of
BaseOptionOfAgriculturalSubtypeOther
BaseOptionOfAgriculturalSubtypeOther
Object
displayName
string
id
integer int32
value
AgriculturalSubtypeOther
Types: AgriculturalSubtypeOtherOption
AgriculturalSubtypeOther
string
Enumeration:
SheepFarm
GoatFarm
WormsFarm
EelFarm
Other
Fishery
Lot
Types: BaseOptionOfAgriculturalSubtypeOther
AirTreatmentOption
All of
BaseOptionOfAirTreatment
BaseOptionOfAirTreatment
Object
displayName
string
id
integer int32
value
AirTreatment
Types: AirTreatmentOption
AirTreatment
string
Enumeration:
AC
MechanicalVentilation
TopCooling
Types: BaseOptionOfAirTreatment
ApartmentCharacteristicOption
All of
BaseOptionOfApartmentCharacteristic
BaseOptionOfApartmentCharacteristic
Object
displayName
string
id
integer int32
value
ApartmentCharacteristic
Types: ApartmentCharacteristicOption
ApartmentCharacteristic
string
Enumeration:
ServiceFlat
CommonApartment
CorridorFlat
Beletage
Basement
DoubleUpperHouse
NurseryFlat
Penthouse
Duplex
Triplex
Other
Kavlashvili
Lvovi
Khrushovi
Tukhareli
Chekhuri
Kalakuri
Moscow
Nonstandard
Types: BaseOptionOfApartmentCharacteristic SearchProfile
ApartmentSortOption
All of
BaseOptionOfApartmentSort
BaseOptionOfApartmentSort
Object
displayName
string
id
integer int32
value
ApartmentSort
Types: ApartmentSortOption
ApartmentSort
string
Enumeration:
UpstairsApartment
GroundFloorApartment
Maisonette
GalleryFlat
PorticoFlat
UpstairsGroundFloorApartment
Penthouse
PorchApartment
StudentRoom
DoubleGroundFloorApartment
Mezzanine
ModernApartment
SovietStyleApartment
ItalianYardApartment
Types: BaseOptionOfApartmentSort SearchProfile
AppraisalCertificationOption
All of
BaseOptionOfAppraisalCertification
BaseOptionOfAppraisalCertification
Object
displayName
string
id
integer int32
value
AppraisalCertification
Types: AppraisalCertificationOption
AssignmentPhaseOption
All of
BaseOptionOfAssignmentPhase
BaseOptionOfAssignmentPhase
Object
displayName
string
id
integer int32
value
AssignmentPhase
Types: AssignmentPhaseOption
AssignmentTypeOption
All of
BaseOptionOfAssignmentType
BaseOptionOfAssignmentType
Object
displayName
string
id
integer int32
value
AssignmentType
Types: AssignmentTypeOption
AtticOptionOption
All of
BaseOptionOfAtticOption
BaseOptionOfAtticOption
Object
displayName
string
id
integer int32
value
AtticOption
Types: AtticOptionOption
AtticOption
string
Enumeration:
OptionForRoom
Staircase
Types: BaseOptionOfAtticOption Floor
AvailabilityStatusOption
All of
BaseOptionOfAvailabilityStatus
BaseOptionOfAvailabilityStatus
Object
displayName
string
id
integer int32
value
AvailabilityStatus
Types: AvailabilityStatusOption
BalconyTypeOption
All of
BaseOptionOfBalconyType
BaseOptionOfBalconyType
Object
displayName
string
id
integer int32
value
BalconyType
Types: BalconyTypeOption
BalconyType
string
Enumeration:
ClosedBalcony
GlazedBalcony
FrenchBalcony
Balcony
Terrace
Types: BaseOptionOfBalconyType Space
BathroomFacilityOption
All of
BaseOptionOfBathroomFacility
BaseOptionOfBathroomFacility
Object
displayName
string
id
integer int32
value
BathroomFacility
Types: BathroomFacilityOption
BathroomFacility
string
Enumeration:
Bath
HalfBath
Toilet
Shower
Urinal
Bidet
SteamCabin
Jacuzzi
DoubleSink
Sink
Types: BaseOptionOfBathroomFacility Space
CertificationOption
All of
BaseOptionOfCertification
BaseOptionOfCertification
Object
displayName
string
id
integer int32
value
Certification
Types: CertificationOption
Certification
string
Enumeration:
AdaptedProperty
Police
FireSafety
GeneralHomeInspection
EnergyPerformanceCertificate
BuildingInspection
HomeWarranty
HomeWarrantyCertificate
Security
CertificateOfOccupancy
EnergyLabel
NeighborhoodWatch
StairwellLocked
SecurityGuard
SecuritySystem
SecurityDoor
VideoCamera
Types: BaseOptionOfCertification
CivilStateOption
All of
BaseOptionOfCivilState
BaseOptionOfCivilState
Object
displayName
string
id
integer int32
value
CivilState
Types: CivilStateOption
ComfortQualityOption
All of
BaseOptionOfComfortQuality
BaseOptionOfComfortQuality
Object
displayName
string
id
integer int32
value
ComfortQuality
Types: ComfortQualityOption
CommissionPaidByOption
All of
BaseOptionOfCommissionPaidBy
BaseOptionOfCommissionPaidBy
Object
displayName
string
id
integer int32
value
CommissionPaidBy
Types: CommissionPaidByOption
CommissionTypeOption
All of
BaseOptionOfCommissionType
BaseOptionOfCommissionType
Object
displayName
string
id
integer int32
value
CommissionType
Types: CommissionTypeOption
ConditionOption
All of
BaseOptionOfCondition
BaseOptionOfCondition
Object
displayName
string
id
integer int32
value
Condition
Types: ConditionOption
ConditionTypeOption
All of
BaseOptionOfConditionType
BaseOptionOfConditionType
Object
displayName
string
id
integer int32
value
ConditionType
Types: ConditionTypeOption
ConstructionOptionOption
All of
BaseOptionOfConstructionOption
BaseOptionOfConstructionOption
Object
displayName
string
id
integer int32
value
ConstructionOption
Types: ConstructionOptionOption
ConstructionOption
string
Enumeration:
ProductionHall
Office
HotelRestaurantCafe
RetailSpace
CommercialOthers
Types: BaseOptionOfConstructionOption
ConstructionPeriodOption
All of
BaseOptionOfConstructionPeriod
BaseOptionOfConstructionPeriod
Object
displayName
string
id
integer int32
value
ConstructionPeriod
Types: ConstructionPeriodOption
ContactLinkTypeSuggestion
Object
displayName
string
isPartnerLink
boolean
ContactPersonTitleSuggestionOption
Object
displayName
string
usedForFemales
boolean
usedForMales
boolean
usedForUnknownGender
boolean
CountryOption
Object
countryCallingCodes
Array of string
displayName
string
iso2CodeValue
string
value
string
EmailAddressTypeOption
All of
BaseOptionOfEmailAddressType
BaseOptionOfEmailAddressType
Object
displayName
string
id
integer int32
value
EmailAddressType
Types: EmailAddressTypeOption
EnergyClassOption
All of
BaseOptionOfEnergyClass
BaseOptionOfEnergyClass
Object
displayName
string
id
integer int32
value
EnergyClass
Types: EnergyClassOption
EnergyClass
string
Enumeration:
Aplusplus
Aplus
A
B
C
D
E
F
G
Types: BaseOptionOfEnergyClass EnergyLabel SearchProfile
EnergySourceOption
All of
BaseOptionOfEnergySource
BaseOptionOfEnergySource
Object
displayName
string
id
integer int32
value
EnergySource
Types: EnergySourceOption
EnergySource
string
Enumeration:
Gas
Oil
Electric
Types: BaseOptionOfEnergySource
ExclusiveStatusOption
All of
BaseOptionOfExclusiveStatus
BaseOptionOfExclusiveStatus
Object
displayName
string
id
integer int32
value
ExclusiveStatus
Types: ExclusiveStatusOption
ExclusiveStatus
string
Enumeration:
Exclusive
NonExclusive
Types: BaseOptionOfExclusiveStatus
FacilityOption
All of
BaseOptionOfFacility
BaseOptionOfFacility
Object
displayName
string
id
integer int32
value
Facility
Types: FacilityOption
Facility
string
Enumeration:
InstallationFixtures
Elevators
OpenableWindows
Types: BaseOptionOfFacility
FurnishingOption
All of
BaseOptionOfFurnishing
BaseOptionOfFurnishing
Object
displayName
string
id
integer int32
value
Furnishing
Types: FurnishingOption
GarageTypeOption
All of
BaseOptionOfGarageType
BaseOptionOfGarageType
Object
displayName
string
id
integer int32
value
GarageType
Types: GarageTypeOption
GarageType
string
Enumeration:
NoGarage
AttachedStone
AttachedWood
DetachedStone
DetachedWood
Indoor
GarageBox
UndergroundParking
OptionForGarage
CarPort
ParkingSpace
GarageWithCarPort
Garage
ParkingFee
NoParking
FreeParking
Types: BaseOptionOfGarageType
GardenQualityOption
All of
BaseOptionOfGardenQuality
BaseOptionOfGardenQuality
Object
displayName
string
id
integer int32
value
GardenQuality
Types: GardenQualityOption
GardenQuality
string
Enumeration:
ToConstruct
Derelict
Normal
BeautifullyLandscaped
Groomed
ConstructedByArchitect
Types: BaseOptionOfGardenQuality
GardenTypeOption
All of
BaseOptionOfGardenType
BaseOptionOfGardenType
Object
displayName
string
id
integer int32
value
GardenType
Types: GardenTypeOption
GardenType
string
Enumeration:
BackGarden
FrontGarden
SideGarden
SurroundingGarden
PatioAtrium
Place
SunTerrace
EnclosedYard
Types: BaseOptionOfGardenType
GenderOption
All of
BaseOptionOfGender
BaseOptionOfGender
Object
displayName
string
id
integer int32
value
Gender
Types: GenderOption
GroundLeasePeriodOption
All of
BaseOptionOfGroundLeasePeriod
BaseOptionOfGroundLeasePeriod
Object
displayName
string
id
integer int32
value
GroundLeasePeriod
Types: GroundLeasePeriodOption
GroundOwnershipTypeOption
All of
BaseOptionOfGroundOwnershipType
BaseOptionOfGroundOwnershipType
Object
displayName
string
id
integer int32
value
GroundOwnershipType
Types: GroundOwnershipTypeOption
GroundOwnershipType
string
Enumeration:
OwnLand
LeaseholdWithoutPropertyAllowance
LeaseholdWithPropertyAllowance
Types: BaseOptionOfGroundOwnershipType GroundProperty
GroundUsageOption
All of
BaseOptionOfGroundUsage
BaseOptionOfGroundUsage
Object
displayName
string
id
integer int32
value
GroundUsage
Types: GroundUsageOption
GroundUsage
string
Enumeration:
Asparagus
Forestland
AgriculturalFarmland
Fruit
Grassland
Nursery
Horticulture
Types: BaseOptionOfGroundUsage
HeatingMethodOption
All of
BaseOptionOfHeatingMethod
BaseOptionOfHeatingMethod
Object
displayName
string
id
integer int32
value
HeatingMethod
Types: HeatingMethodOption
HeatingMethod
string
Enumeration:
Boiler
CoalStove
BlockHeating
DistrictHeating
Hearth
HotAirHeating
AirConditioning
GasStoves
Fireplace
FireplaceOption
HeatedFloors
PartialHeatedFloors
SolarPanels
NoHeating
ElectricHeating
WallHeating
HeatPump
HeatRecoveryInstallation
GeothermalEnergy
WoodStove
GasStove
FreeStandingHeating
AutomaticHeating
Stove
CombinedHeating
GroundSourceHeatPump
SolidFuel
Ion
WaterHeater
Types: BaseOptionOfHeatingMethod
HeatingWaterMethodOption
All of
BaseOptionOfHeatingWaterMethod
BaseOptionOfHeatingWaterMethod
Object
displayName
string
id
integer int32
value
HeatingWaterMethod
Types: HeatingWaterMethodOption
HeatingWaterMethod
string
Enumeration:
Boiler
CentralHeating
WaterHeaterRental
WaterHeaterOwnership
GasBoilerRental
GasBoilerOwnership
ElectricBoilerRental
ElectricBoilerOwnership
SolarWaterHeater
SolarPanels
None
DistrictHeating
Types: BaseOptionOfHeatingWaterMethod
HorseCompanySubtypeOption
All of
BaseOptionOfHorseCompanySubtype
BaseOptionOfHorseCompanySubtype
Object
displayName
string
id
integer int32
value
HorseCompanySubtype
Types: HorseCompanySubtypeOption
HorseCompanySubtype
string
Enumeration:
RidingSchool
Pension
TrainingFarm
Other
StudFarm
Types: BaseOptionOfHorseCompanySubtype
HorseTroughLocationOption
All of
BaseOptionOfHorseTroughLocation
BaseOptionOfHorseTroughLocation
Object
displayName
string
id
integer int32
value
HorseTroughLocation
Types: HorseTroughLocationOption
HorseTroughLocation
string
Enumeration:
Indoor
Outdoor
Types: BaseOptionOfHorseTroughLocation
HorticulturalCompanyTypeOption
All of
BaseOptionOfHorticulturalCompanyType
BaseOptionOfHorticulturalCompanyType
Object
displayName
string
id
integer int32
value
HorticulturalCompanyType
Types: HorticulturalCompanyTypeOption
HorticulturalCompanyType
string
Enumeration:
Greenhouse
Ground
FruitGrowing
MushroomCultivation
TreeNursery
FlowerBulbs
Types: BaseOptionOfHorticulturalCompanyType
HospitalityIndustryTypeOption
All of
BaseOptionOfHospitalityIndustryType
BaseOptionOfHospitalityIndustryType
Object
displayName
string
id
integer int32
value
HospitalityIndustryType
Types: HospitalityIndustryTypeOption HospitalityTypeOption
HospitalityIndustryType
string
Enumeration:
CascoHospitalityRoom
CafeBar
Eatery
DiscoDancing
Restaurant
TruckStop
DayOperation
Hotel
PartyCenterHalls
AdditionalHospitality
Cafeteria
Types: BaseOptionOfHospitalityIndustryType
HospitalityTypeOption
All of
BaseOptionOfHospitalityIndustryType
HouseCharacteristicOption
All of
BaseOptionOfHouseCharacteristic
BaseOptionOfHouseCharacteristic
Object
displayName
string
id
integer int32
value
HouseCharacteristic
Types: HouseCharacteristicOption
HouseCharacteristic
string
Enumeration:
DikeHouse
SplitLevelHouse
DriveInHouse
SemiBungalow
PatioHouse
PileHouse
CourtyardHouse
BusinessServiceHouse
WaterHouse
WindWaterMill
QuadrantHouse
Types: BaseOptionOfHouseCharacteristic SearchProfile
HouseSortOption
All of
BaseOptionOfHouseSort
BaseOptionOfHouseSort
Object
displayName
string
id
integer int32
value
HouseSort
Types: HouseSortOption
HouseSort
string
Enumeration:
SingleFamilyHouse
Mansion
Villa
CountryHouse
Bungalow
ResidentialFarm
CanalHouse
HouseBoat
MobileHome
House
SharedHouse
SmallHouse
Farmhouse
Other
Types: BaseOptionOfHouseSort
HouseTypeOption
All of
BaseOptionOfHouseType
BaseOptionOfHouseType
Object
displayName
string
id
integer int32
value
HouseType
Types: HouseTypeOption
HouseType
string
Enumeration:
DetachedHouse
LinkedHouse
SemiDetachedHouseOneRoof
RowHouseMiddle
RowHouseCorner
RowHouseEnd
SemiDetachedHouse
SemiDetachedLinkedHouseOneRoof
OffsetHouse
Types: BaseOptionOfHouseType BusinessHouse
IdentificationTypeOption
All of
BaseOptionOfIdentificationType
BaseOptionOfIdentificationType
Object
displayName
string
id
integer int32
value
IdentificationType
Types: IdentificationTypeOption
IndustrialBuildingFacilityOption
All of
BaseOptionOfIndustrialBuildingFacility
BaseOptionOfIndustrialBuildingFacility
Object
displayName
string
id
integer int32
value
IndustrialBuildingFacility
Types: IndustrialBuildingFacilityOption
IndustrialBuildingFacility
string
Enumeration:
Skylights
LoadingDocks
OverheadDoors
Types: BaseOptionOfIndustrialBuildingFacility
InvoiceStatusOption
All of
BaseOptionOfInvoiceStatus
BaseOptionOfInvoiceStatus
Object
displayName
string
id
integer int32
value
InvoiceStatus
Types: InvoiceStatusOption
InvoiceStatus
string
Enumeration:
Draft
Open
OpenFirstReminder
OpenSecondReminder
OpenCollectionAgency
Paid
Notary
OfferedForFactoring
WaitingForFactoring
AcceptedForFactoring
DeniedForFactoring
OpenPaymentArrangement
Credited
Types: BaseOptionOfInvoiceStatus
IsolationTypeOption
All of
BaseOptionOfInsulationType
BaseOptionOfInsulationType
Object
displayName
string
id
integer int32
value
InsulationType
Types: IsolationTypeOption
KitchenTypeOption
All of
BaseOptionOfKitchenType
BaseOptionOfKitchenType
Object
displayName
string
id
integer int32
value
KitchenType
Types: KitchenTypeOption
KitchenType
string
Enumeration:
Open
Dining
Appliances
Closed
SemiOpen
Types: BaseOptionOfKitchenType Space
LandPropertySubTypeOption
All of
BaseOptionOfLandPropertySubType
BaseOptionOfLandPropertySubType
Object
displayName
string
id
integer int32
value
LandPropertySubType
Types: LandPropertySubTypeOption
LandPropertySubType
string
Enumeration:
Commercial
Industrial
MixedUse
Forestland
LandByWater
LandWithoutPurpose
ProfitYieldingLand
ResidentialLand
SocialLand
TransportationLand
Types: BaseOptionOfLandPropertySubType
LanguageSpokenOption
All of
BaseOptionOfLanguage
BaseOptionOfLanguage
Object
displayName
string
id
integer int32
value
Language
Types: LanguageSpokenOption
LeaseTermUnitOption
Object
displayNamePlural
string
displayNameSingular
string
id
integer int32
value
LeaseTermUnit
LegalStatusOption
All of
BaseOptionOfLegalStatus
BaseOptionOfLegalStatus
Object
displayName
string
id
integer int32
value
LegalStatus
Types: LegalStatusOption
LegalStatus
string
Enumeration:
EntireLot
PartialLot
ApartmentRights
CooperativeOwnership
Existing
NewBuild
FreeSimple
SharedOwnership
ApartmentOwnership
CooperativeHousing
ImmovableProperty
JointEstate
MovableProperty
RightOfSuperficies
Types: BaseOptionOfLegalStatus BusinessLaw
ListingTypeOption
All of
BaseOptionOfListingType
BaseOptionOfListingType
Object
displayName
string
id
integer int32
value
ListingType
Types: ListingTypeOption
LivingRoomTypeOption
All of
BaseOptionOfLivingRoomType
BaseOptionOfLivingRoomType
Object
displayName
string
id
integer int32
value
LivingRoomType
Types: LivingRoomTypeOption
LivingRoomType
string
Enumeration:
LivingRoom
TRoom
ZRoom
URoom
LRoom
RoomEnSuite
FormerRoomEnSuite
SunRoom
GardenRoom
Conservatory
Study
Office
Types: BaseOptionOfLivingRoomType Space
LocationPlaceOption
All of
BaseOptionOfLocationPlace
BaseOptionOfLocationPlace
Object
displayName
string
id
integer int32
value
LocationPlace
Types: LocationPlaceOption
MediaPartnerCategoryOption
All of
BaseOptionOfMediaPartnerCategory
BaseOptionOfMediaPartnerCategory
Object
displayName
string
id
integer int32
value
MediaPartnerCategory
Types: MediaPartnerCategoryOption
MediaPartnerCategory
string
Enumeration:
Other
Portal
Printing
PhotoAndVideo
PresentationColumn
Maps
SocialMedia
Types: BaseOptionOfMediaPartnerCategory PublicationSnapShot
MixedFormOption
All of
BaseOptionOfIntermediateForm
BaseOptionOfIntermediateForm
Object
displayName
string
id
integer int32
value
IntermediateForm
Types: MixedFormOption
OpenHouseRecurrenceOption
All of
BaseOptionOfOpenHouseRecurrence
BaseOptionOfOpenHouseRecurrence
Object
displayName
string
id
integer int32
value
OpenHouseRecurrence
Types: OpenHouseRecurrenceOption
OrientationOption
All of
BaseOptionOfOrientation
BaseOptionOfOrientation
Object
displayName
string
id
integer int32
value
Orientation
Types: OrientationOption
Orientation
string
Enumeration:
North
NorthEast
East
SouthEast
South
SouthWest
West
NorthWest
Types: BaseOptionOfOrientation SearchProfile Space
OwnershipOption
All of
BaseOptionOfOwnership
BaseOptionOfOwnership
Object
displayName
string
id
integer int32
value
Ownership
Types: OwnershipOption
Ownership
string
Enumeration:
Property
Rent
Lease
Types: BaseOptionOfOwnership
OwnershipTypeOption
All of
BaseOptionOfOwnershipType
BaseOptionOfOwnershipType
Object
displayName
string
id
integer int32
value
OwnershipType
Types: OwnershipTypeOption
ParkingFacilityOption
All of
BaseOptionOfTypeOfParkingFacility
BaseOptionOfTypeOfParkingFacility
Object
displayName
string
id
integer int32
value
TypeOfParkingFacility
Types: ParkingFacilityOption
ParkingTypeOption
All of
BaseOptionOfParkingType
BaseOptionOfParkingType
Object
displayName
string
id
integer int32
value
ParkingType
Types: ParkingTypeOption
ParkingType
string
Enumeration:
Garage
IndoorGarage
ParkingCellar
ParkingSpace
Types: BaseOptionOfParkingType SearchProfile
PeculiarityOption
All of
BaseOptionOfPeculiarity
BaseOptionOfPeculiarity
Object
displayName
string
id
integer int32
value
Peculiarity
Types: PeculiarityOption
Peculiarity
string
Enumeration:
MonumentalBuilding
Monument
Padded
PartiallyFurnished
PartiallyLeased
Furnished
DoubleOccupancyPossible
DoubleOccupancyAvailable
ProtectedTownOrVillageConservation
AccessibleForTheElderly
AccessibleToDisabledPeople
NeedsRenovation
Types: BaseOptionOfPeculiarity
PhoneNumberTypeOption
All of
BaseOptionOfPhoneNumberType
BaseOptionOfPhoneNumberType
Object
displayName
string
id
integer int32
value
PhoneNumberType
Types: PhoneNumberTypeOption
PigCompanyTypeOption
All of
BaseOptionOfPigCompanyType
BaseOptionOfPigCompanyType
Object
displayName
string
id
integer int32
value
PigCompanyType
Types: PigCompanyTypeOption
PigCompanyType
string
Enumeration:
Sows
Meat
SowsAndMeat
Breeding
Types: BaseOptionOfPigCompanyType
PointOfInterestTypeOption
All of
BaseOptionOfPointOfInterestType
BaseOptionOfPointOfInterestType
Object
displayName
string
id
integer int32
value
PointOfInterestType
Types: PointOfInterestTypeOption
PointOfInterestType
string
Enumeration:
HighwayExit
RailwayStation
NsContent
BusHub
TramHub
MetroHub
BusStop
TramStop
MetroStop
BankBranch
ATM
Recreation
Supermarket
Shop
Restaurant
Types: BaseOptionOfPointOfInterestType PointOfInterest
PollutionTypeOption
All of
BaseOptionOfPollutionType
BaseOptionOfPollutionType
Object
displayName
string
id
integer int32
value
PollutionType
Types: PollutionTypeOption
PollutionType
string
Enumeration:
Removed
Certified
Filled
Types: BaseOptionOfPollutionType
PoultryFarmingSubtypeOption
All of
BaseOptionOfPoultryFarmingSubtype
BaseOptionOfPoultryFarmingSubtype
Object
displayName
string
id
integer int32
value
PoultryFarmingSubtype
Types: PoultryFarmingSubtypeOption
PoultryFarmingSubtype
string
Enumeration:
Hens
Broilers
BreedingHens
BreedingBroiler
TurkeysGeeseDucksOstriches
Types: BaseOptionOfPoultryFarmingSubtype
PriceCodeOption
All of
BaseOptionOfPriceCode
BaseOptionOfPriceCode
Object
displayName
string
id
integer int32
value
PriceCode
Types: PriceCodeOption
PriceHistoryEventOption
All of
BaseOptionOfPriceHistoryEvent
BaseOptionOfPriceHistoryEvent
Object
displayName
string
id
integer int32
value
PriceHistoryEvent
Types: PriceHistoryEventOption
PriorityOption
All of
BaseOptionOfPriority
BaseOptionOfPriority
Object
displayName
string
id
integer int32
value
Priority
Types: PriorityOption
PublicationStatusOption
All of
BaseOptionOfPublicationStatus
BaseOptionOfPublicationStatus
Object
displayName
string
id
integer int32
value
PublicationStatus
Types: PublicationStatusOption
PublicationStatus
string
Enumeration:
Inactive
PublishRequestEnqueued
WaitingForExchangeEntityContract
WaitingForObligatoryPublications
Published
Rejected
Withdrawn
Types: BaseOptionOfPublicationStatus PublicationSnapShot
RealEstateAssociationOption
All of
BaseOptionOfRealEstateAssociation
BaseOptionOfRealEstateAssociation
Object
displayName
string
id
integer int32
value
RealEstateAssociation
Types: RealEstateAssociationOption
RealEstateGroupOption
All of
BaseOptionOfRealEstateGroup
BaseOptionOfRealEstateGroup
Object
displayName
string
id
integer int32
value
RealEstateGroup2
Types: RealEstateGroupOption
RelationRoleOption
All of
BaseOptionOfRelationRole
BaseOptionOfRelationRole
Object
displayName
string
id
integer int32
value
RelationRole
Types: RelationRoleOption
RelationRole
string
Enumeration:
Vendor
Applicant
Notary
Types: BaseOptionOfRelationRole
RelationTypeOption
All of
BaseOptionOfRelationType
BaseOptionOfRelationType
Object
displayName
string
id
integer int32
value
RelationType
Types: RelationTypeOption
ReminderMinutesOption
Object
nrOfMinutes
integer int32
displayName
string
RentConditionOption
All of
BaseOptionOfRentCondition
BaseOptionOfRentCondition
Object
displayName
string
id
integer int32
value
RentCondition
Types: RentConditionOption
RentSpecificationOption
All of
BaseOptionOfRentSpecification
BaseOptionOfRentSpecification
Object
displayName
string
id
integer int32
value
RentSpecification
Types: RentSpecificationOption
ResidentialSubtypeOtherOption
All of
BaseOptionOfResidentialSubtypeOther
BaseOptionOfResidentialSubtypeOther
Object
displayName
string
id
integer int32
value
ResidentialSubtypeOther
Types: ResidentialSubtypeOtherOption
ResidentialSubtypeOther
string
Enumeration:
StoreRoom
Berth
MobileHomePitch
GypsyCartPitch
ResidentialShopPremises
LowerSection
StorageSpace
ParkingSpace
Garage
Types: BaseOptionOfResidentialSubtypeOther
RoofMaterialOption
All of
BaseOptionOfRoofMaterial
BaseOptionOfRoofMaterial
Object
displayName
string
id
integer int32
value
RoofMaterial
Types: RoofMaterialOption
RoofTypeOption
All of
BaseOptionOfRoofType
BaseOptionOfRoofType
Object
displayName
string
id
integer int32
value
RoofType
Types: RoofTypeOption
SaleConditionOption
All of
BaseOptionOfSaleCondition
BaseOptionOfSaleCondition
Object
displayName
string
id
integer int32
value
SaleCondition
Types: SaleConditionOption
SituatedTypeOption
All of
BaseOptionOfSituatedType
BaseOptionOfSituatedType
Object
displayName
string
id
integer int32
value
SituatedType
Types: SituatedTypeOption
SituatedType
string
Enumeration:
Indoor
Extension
Detached
Types: BaseOptionOfSituatedType BusinessHouse
SpaceTypeOption
All of
BaseOptionOfSpaceType
BaseOptionOfSpaceType
Object
displayName
string
id
integer int32
value
SpaceType
Types: SpaceTypeOption
SpaceType
string
Enumeration:
Kitchen
Bathroom
Balcony
RoofTerrace
Bedroom
LivingRoom
UtilityRoom
Shower
Toilet
Corridor
EnclosedPorch
Hall
BoilerRoom
StoreRoom
Storage
Dormer
Loggia
Vestibule
LaundryRoom
Types: BaseOptionOfSpaceType Space
StorageRoomTypeOption
All of
BaseOptionOfStorageRoomType
BaseOptionOfStorageRoomType
Object
displayName
string
id
integer int32
value
StorageRoomType
Types: StorageRoomTypeOption
StorageRoomType
string
Enumeration:
AttachedStone
AttachedWood
DetachedStone
DetachedWood
Indoor
Box
Internal
External
InTheYard
Types: BaseOptionOfStorageRoomType
StoveOption
All of
BaseOptionOfStove
BaseOptionOfStove
Object
displayName
string
id
integer int32
value
Stove
Types: StoveOption
Stove
string
Enumeration:
Electric
Gas
Wood
Types: BaseOptionOfStove Space
TaskCategoryOption
Object
categoryBackColor
string
categoryFrontColor
string
displayName
string
value
string guid
TaskFollowUpOption
All of
BaseOptionOfTaskFollowUp
BaseOptionOfTaskFollowUp
Object
displayName
string
id
integer int32
value
TaskFollowUp
Types: TaskFollowUpOption
TaskFollowUp
string
Enumeration:
None
Today
Tomorrow
ThisWeek
NextWeek
NoDate
Types: BaseOptionOfTaskFollowUp
TaskStatusOption
All of
BaseOptionOfTaskStatus
BaseOptionOfTaskStatus
Object
displayName
string
id
integer int32
value
TaskStatus
Types: TaskStatusOption
TaskStatus
string
Enumeration:
NotStarted
InProgress
Waiting
Deferred
Completed
Canceled
Types: BaseOptionOfTaskStatus
TimelineActionTypeOption
All of
BaseOptionOfTimelineActionType
BaseOptionOfTimelineActionType
Object
displayName
string
id
integer int32
value
TimelineActionType
Types: TimelineActionTypeOption
TimelineActionType
string
Enumeration:
Unknown
AgendaItem
Invoice
Task
Email
SearchProfile
ContactMe
Website
Transaction
Types: BaseOptionOfTimelineActionType
TypeOfFloorOption
All of
BaseOptionOfTypeOfFloor
BaseOptionOfTypeOfFloor
Object
displayName
string
id
integer int32
value
TypeOfFloor
Types: TypeOfFloorOption
TypeOfFloor
string
Enumeration:
Wood
Concrete
Other
Types: BaseOptionOfTypeOfFloor
TypeOfWindowFrameOption
All of
BaseOptionOfTypeOfWindowFrame
BaseOptionOfTypeOfWindowFrame
Object
displayName
string
id
integer int32
value
TypeOfWindowFrame
Types: TypeOfWindowFrameOption
TypeOfWindowFrame
string
Enumeration:
Plastic
PartialWood
Wood
Aluminum
Types: BaseOptionOfTypeOfWindowFrame
UnitOfMeasurementOption
All of
BaseOptionOfUnitOfMeasurement
BaseOptionOfUnitOfMeasurement
Object
displayName
string
id
integer int32
value
UnitOfMeasurement
Types: UnitOfMeasurementOption
UnitOfVolumeOption
All of
BaseOptionOfUnitOfVolume
BaseOptionOfUnitOfVolume
Object
displayName
string
id
integer int32
value
UnitOfVolume
Types: UnitOfVolumeOption
UnitSizeOption
All of
BaseOptionOfUnitSize
BaseOptionOfUnitSize
Object
displayName
string
id
integer int32
value
UnitSize
Types: UnitSizeOption
VatConditionOption
All of
BaseOptionOfVatCondition
BaseOptionOfVatCondition
Object
displayName
string
id
integer int32
value
VatCondition
Types: VatConditionOption
VealCalvesFarmingSubtypeOption
All of
BaseOptionOfVealCalvesFarmingSubtype
BaseOptionOfVealCalvesFarmingSubtype
Object
displayName
string
id
integer int32
value
VealCalvesFarmingSubtype
Types: VealCalvesFarmingSubtypeOption
VealCalvesFarmingSubtype
string
Enumeration:
DairyCattle
SucklerCows
VealBulls
BreedingYoungCattle
VealCalves
RoseCalves
Types: BaseOptionOfVealCalvesFarmingSubtype
WelfareStateOption
All of
BaseOptionOfWelfareState
BaseOptionOfWelfareState
Object
displayName
string
id
integer int32
value
WelfareState
Types: WelfareStateOption
WelfareState
string
Enumeration:
A1
A2
B1
B2
C1
C2
Types: BaseOptionOfWelfareState
WithdrawReasonOption
All of
BaseOptionOfWithdrawReason
BaseOptionOfWithdrawReason
Object
displayName
string
id
integer int32
value
WithdrawReason
Types: WithdrawReasonOption
SocialMediaTypeOption
All of
BaseOptionOfSocialMediaType
BaseOptionOfSocialMediaType
Object
displayName
string
id
integer int32
value
SocialMediaType
Types: SocialMediaTypeOption
SaveRequest13
All of
CultureRequest
Methods: Notes_Save
SaveResponse
All of
ApiResponse
Methods: Notes_Save
NoteSnapShot
All of
Entity
SearchRequest14
All of
SearchRequest2
Methods: Notes_Search
NoteOrderByField
string
Enumeration:
CreationDateTime
NoteTermField
string
Enumeration:
Description
SearchResponse13
All of
ApiResponse
Methods: Notes_Search
CloneRequest
All of
Request
Methods: ObjectAssignments_Clone
SingleObjectAssignmentResponse
Object
objectAssignment
ObjectAssignment
Methods: ObjectAssignments_Clone ObjectAssignments_DefineNew ObjectAssignments_Read ObjectAssignments_Save ObjectAssignments_UpdateAvailability
ObjectAssignment
All of
BaseAssignment
Types: SingleObjectAssignmentResponse
Size
Object
area
number decimal
height
number decimal
length
number decimal
unitOfMeasurement
UnitOfMeasurement
unitOfVolume
UnitOfVolume
volume
number decimal
width
number decimal
Types: BusinessHouse ResidentialBuilding Space
BusinessExpenses
Object
landConsolidationRent
number decimal
oZBBusinessShare
number decimal
oZBOccupiersShare
number decimal
sewerageCharges
number decimal
waterAuthorityCharges
number decimal
BusinessHouse
Object
bedroomNumber
integer int32
buildingLayerNumber
integer int32
content
Size
garage
Garage
garden
Garden
houseType
HouseType
parcelSurface
Size
roomNumber
integer int32
situatedType
SituatedType
useSurface
Size
yearOfConstruction
YearOfConstruction
Garage
All of
Part
Types: BusinessHouse
Amenities
string
Enumeration:
CentralHeating
Electricity
Water
Attic
ElectricDoor
Garden
All of
Part
Types: BusinessHouse
BusinessLaw
Object
businessLawType
Array of TypeOfBusinessLaw
description
Array of TranslatedText
legalStatus
LegalStatus
TypeOfBusinessLaw
string
Enumeration:
BpRights
Horizontal
Cooperative
LeaseholdEstate
Easements
ProtectedMonument
ProtectedCityVillageScape
Types: BusinessLaw
DocumentData
Object
citySigningBroker
string
citySigningBuyers
string
citySigningSellers
string
dateSigningBroker
string date-time
dateSigningBuyers
string date-time
dateSigningSellers
string date-time
listOfBusinessCategoryDto
Array of string
mergeFields
Object
nameOfBrokersEmployee
string
nameOfBrokersOffice
string
numberOfSignings
integer int32
onBehalfOfBuyers
string
onBehalfOfSellers
string
serializedListOfBusiness
string
serializedMergeFieldValues
string
serializedUserControlValues
string
userControlValues
Object
Drainage
string
Enumeration:
Sanitary
DownspoutAfvoer
FranseDrain
HellingType
EnergyLabel
Object
certificateNumber
string
endDate
string date-time
energyClass
EnergyClass
energyIndex
number decimal
isCertificateAvailable
boolean
OutdoorAreaFacility
string
Enumeration:
None
Closeable
Fence
FeatureCategory
Object
features
Array of Feature
name
string
Feature
Object
label
string
value
string
Types: FeatureCategory
Floor
Object
atticOptions
Array of AtticOption
description
Array of TranslatedText
floorNumber
integer int32
floorType
FloorType
name
string
numberOfBedrooms
integer int32
numberOfSpaces
integer int32
spaces
Array of Space
FloorType
string
Enumeration:
GroundFloor
Basement
Floor
Attic
TopFloor
Types: Floor
Space
Object
balconyType
BalconyType
bathroomFacilities
Array of BathroomFacility
description
Array of TranslatedText
hasStairway
boolean
isRenewed
boolean
kitchenType
Array of KitchenType
livingRoomTypes
Array of LivingRoomType
name
string
orientation
Orientation
size
Size
stove
Stove
type
SpaceType
Types: Floor
GroundProperty
Object
endDate
string date-time
groundOwnershipType
GroundOwnershipType
yearlyAmount
number decimal
ImportDetails
Object
importTags
string
importUniqueId
string
importUniqueObjectTypeId
string
importUniqueProjectId
string
PavementType
string
Enumeration:
None
Bitumen
Other
Pavers
Slabs
StelconConcreteSlabs
PointOfInterest
Object
distanceFrom
number decimal
distanceTo
number decimal
type
PointOfInterestType
ProductOrder
Object
chargeToCustomerBudget
boolean
dateTime
string date-time
description
string
financialAdministrationId
string guid
financialAdministrationProductId
integer int32
id
string guid
linkedInvoice
LinkedInvoice
unitPriceNet
number decimal
LinkedInvoice
All of
Entity
Types: ProductOrder
ResidentialBuilding
Object
effectiveArea
Size
revenuePerYear
number decimal
SoilType
string
Enumeration:
None
Clay
Loam
Peat
Sand
SabulousClay
MarineClay
Loose
ConcreteFloor
RiverClay
StatusRented
Object
isPartiallyRented
boolean
percentageRented
integer int32
pricePerYear
number decimal
SubTypeAlvPlot
string
Enumeration:
None
Arable
Lake
MixUse
Orchards
Pasture
Vineyards
Other
Testimonial
Object
dateTimeOffMarket
string date-time
dateTimeOnMarket
string date-time
isForRent
boolean
isForSale
boolean
listingPhoto
PhotoBlob
showFrom
string date-time
showNrOfDaysOnMarket
boolean
showUntil
string date-time
testimonialPhoto
PhotoBlob
iList
Array of TestimonialTranslation
TestimonialTranslation
Object
customerName
string
description
string
language
Language
title
string
Types: Testimonial
TypeCodeHouse
string
Enumeration:
None
A_SpecialArchitecturalResidence
A_Bungalow
A_DykeHouse
A_DriveinResidence
A_EndHouse
A_ConnectedBungalow
A_ConnectedSemiDetached
A_ConnectedHouse
A_Mansion
A_CornerHouse
A_AlmsHouse
A_KwadrantWoning
A_PatioBungalow
A_PatioHouse
A_PracticeHouse
A_SemiBungalow
A_SplitlevelHouse
A_IntermediateHouse
A_SemiDetachedHouse
A_Villa
A_DetachedHouse
A_MobileHome
B_BussinessOrProfitHouse
B_Farm
B_Bungalow
B_DykeHouse
B_EndHouse
B_ConnectedSemiDetached
B_ConnectedHouse
B_CanalHouse
B_HalfDetachedHouse
B_Mansion
B_CornerHouse
B_Estate
B_CountryHouse
B_Berth
B_Mill
B_PractiseHouse
B_SemiBungalow
B_IntermediateHouse
B_SemiDetachedHouse
B_Villa
B_DetachedHouse
B_WaterHouse
B_FarmHouse
B_HouseBoat
B_MobileHome
B_MobileHomePitch
B_LivingShop
C_Bungalow
C_EndHouse
C_ConnectedBungalow
C_ConnectedSemiDetached
C_ConnectedHouse
C_CornerHouse
C_SemiBungalow
C_IntermediateHouse
C_SemiDetached
C_Villa
C_DetachedHouse
C_MobileHouse
D_Bungalow
D_HalfDetachedHouse
D_Berth
D_SemiBungalow
D_SemiDetachedHouse
D_Villa
D_DetachedHouse
D_WaterHouse
D_HouseBoat
D_MobileHouse
D_MobileHousePitch
E_IntermediateHouse
G_Apartment
G_DownstairsHouse
G_Storagte
G_BuildingPlot
G_UpstairsHouse
G_CollectiveParkingSpotWithResidences
G_CorridorFlat
G_GalleryFlat
G_Garage
G_Maisonnette
G_ParkingSpotUsableByResidences
G_Penthouse
G_PorchFlat
H_Apartment
H_BelEtage
H_DownstairsHouse
H_UpstairsHouse
H_PorchHouse
H_Souterrain
I_Apartment
I_Penthouse
K_Apartment
K_DownstairsHouse
K_CorridorFlat
K_GalleryFlat
K_ServiceFlat
TypeOfCommunualArea
string
Enumeration:
None
Cafeteria
ConferenceRoom
Pantry
Reception
Sanitary
DefineNewRequest9
All of
CultureRequest
Methods: ObjectAssignments_DefineNew
SaveRequest14
All of
CultureRequest
Methods: ObjectAssignments_Save
UpdateAvailabilityRequest
All of
Request
Methods: ObjectAssignments_UpdateAvailability
UpdateAvailabilityAvailableSettings
Object
linkedVendors
Array of LinkedRelation
UpdateAvailabilityRentedSettings
Object
dateRentedFrom
string date-time
dateRentedUntil
string date-time
dateReservation
string date-time
linkedApplicants
Array of LinkedRelation
transactionPrice
number decimal
UpdateAvailabilitySoldSettings
Object
dateOfTransfer
string date-time
dateReservation
string date-time
dateSold
string date-time
endDateBankWarranty
string date-time
linkedApplicants
Array of LinkedRelation
linkedNotaries
Array of LinkedRelation
transactionPrice
number decimal
UpdateAvailabilityAction
string
Enumeration:
ToRented
ToSold
ToWithdrawn
ToAvailable
UpdateAvailabilityWithdrawnSettings
Object
withdrawnDateTime
string date-time
withdrawReason
WithdrawReason
ArchiveRequest2
All of
Request
Methods: Offices_Archive
DefineNewRequest10
All of
CultureRequest
Methods: Offices_DefineNew
SingleOfficeResponse
All of
ApiResponse
Methods: Offices_DefineNew Offices_Read Offices_Save
Office
All of
Building
Building
All of
RootEntity
Types: Office
SaveRequest15
All of
CultureRequest
Methods: Offices_Save
ActivateRequest
All of
Request
Methods: Publications_Activate
OkResult

Represents an action result that returns an empty HttpStatusCode.OK response.

Object
request
HttpRequestMessage

Gets a HTTP request message for the results.

Methods: Publications_Activate Publications_Deactivate
HttpRequestMessage
Object
version
Version
content
HttpContent
method
HttpMethod
requestUri
string uri
headers
HttpRequestHeaders
properties
Object
Types: OkResult
Version
Object
major
integer int32
minor
integer int32
build
integer int32
revision
integer int32
majorRevision
integer
minorRevision
integer
Types: HttpRequestMessage
HttpContent
Object
headers
HttpContentHeaders
Types: HttpRequestMessage
HttpContentHeaders
Unknown
Types: HttpContent
ContentDispositionHeaderValue
Object
dispositionType
string
parameters
Array of NameValueHeaderValue
name
string
fileName
string
fileNameStar
string
creationDate
string date-time
modificationDate
string date-time
readDate
string date-time
size
integer int64
NameValueHeaderValue
Object
name
string
value
string
Types: CacheControlHeaderValue ContentDispositionHeaderValue MediaTypeHeaderValue NameValueWithParametersHeaderValue TransferCodingHeaderValue
ContentRangeHeaderValue
Object
unit
string
from
integer int64
to
integer int64
length
integer int64
hasLength
boolean
hasRange
boolean
MediaTypeHeaderValue
Object
charSet
string
parameters
Array of NameValueHeaderValue
mediaType
string
Types: MediaTypeWithQualityHeaderValue
KeyValuePairOfStringAndIEnumerableOfString
All of
ValueType
ValueType
Object
Types: KeyValuePairOfStringAndIEnumerableOfString
HttpMethod
Object
method
string
Types: HttpRequestMessage
HttpRequestHeaders
Unknown
Types: HttpRequestMessage
MediaTypeWithQualityHeaderValue
All of
MediaTypeHeaderValue
StringWithQualityHeaderValue
Object
value
string
quality
number double
AuthenticationHeaderValue
Object
scheme
string
parameter
string
NameValueWithParametersHeaderValue
All of
NameValueHeaderValue
EntityTagHeaderValue
Object
tag
string
isWeak
boolean
Types: RangeConditionHeaderValue
RangeConditionHeaderValue
Object
date
string date-time
entityTag
EntityTagHeaderValue
RangeHeaderValue
Object
unit
string
ranges
Array of RangeItemHeaderValue
RangeItemHeaderValue
Object
from
integer int64
to
integer int64
Types: RangeHeaderValue
TransferCodingWithQualityHeaderValue
All of
TransferCodingHeaderValue
TransferCodingHeaderValue
Object
value
string
parameters
Array of NameValueHeaderValue
Types: TransferCodingWithQualityHeaderValue
ProductInfoHeaderValue
Object
product
ProductHeaderValue
comment
string
ProductHeaderValue
Object
name
string
version
string
Types: ProductInfoHeaderValue
CacheControlHeaderValue
Object
noCache
boolean
noCacheHeaders
Array of string
noStore
boolean
maxAge
string time-span
sharedMaxAge
string time-span
maxStale
boolean
maxStaleLimit
string time-span
minFresh
string time-span
noTransform
boolean
onlyIfCached
boolean
public
boolean
private
boolean
privateHeaders
Array of string
mustRevalidate
boolean
proxyRevalidate
boolean
extensions
Array of NameValueHeaderValue
ViaHeaderValue
Object
protocolName
string
protocolVersion
string
receivedBy
string
comment
string
WarningHeaderValue
Object
code
integer int32
agent
string
text
string
date
string date-time
DeactivateRequest
All of
Request
Methods: Publications_Deactivate
SearchRequest15
All of
Request
Methods: Publications_Search
SearchResponse14
All of
ApiResponse
Methods: Publications_Search
PublicationSnapShot
Object
category
MediaPartnerCategory
dateTimeConfirmed
string date-time
detailsUrl
string
isFavorite
boolean
isObligatory
boolean
isPaidService
boolean
logoUrl
string
mediaPartnerId
string guid
mediaPartnerIsActive
boolean
mediaPartnerName
string
publicationStatus
PublicationStatus
publicationWithdrawalAllowed
boolean
statusMessage
string
SingleRealEstateAgencyResponse
All of
ApiResponse
Methods: RealEstateAgencies_Read RealEstateAgencies_Update
RealEstateAgency
All of
RootEntity
Types: UpdateRequest
UpdateRequest
Object
realEstateAgency
RealEstateAgency
Methods: RealEstateAgencies_Update
SearchRequest16
All of
SearchRequest2
Methods: Relations_Search
RelationOrderByField
string
Enumeration:
DateTimeCreated
DisplayName
UpcomingBirthday
RelationTermField
string
Enumeration:
DisplayName
StreetNameAndNumber
PostalCode
Locality
PhoneNumber
MobilePhoneNumber
EmailAddress
Methods: Relations_SearchAndExport
SearchResponse15
All of
ApiResponse
Methods: Relations_Search
Statistics2
Object
localities
Array of string
RecoverPasswordRequest
Object
newPassword
string
Min length: 2
Max length: 100
recoveryCode
string
Min length: 2
Max length: 100
userName
string
Min length: 2
Max length: 100
Methods: Security_RecoverPassword
RecoverPasswordResponse
All of
NewSessionResponse
Methods: Security_RecoverPassword
NewSessionResponse
All of
ApiResponse
Types: RecoverPasswordResponse RefreshResponse StartSessionResponse
RefreshResponse
All of
NewSessionResponse
Methods: Security_Refresh
RequestRecoveryCodeRequest
Object
culture
string
Min length: 0
Max length: 5
userName
string
Min length: 2
Max length: 100
Methods: Security_RequestRecoveryCode
RequestRecoveryCodeResponse
Object
emailAddressHint
string
Methods: Security_RequestRecoveryCode
StartSessionRequest
Object
abortExistingSession
boolean
password
string
Min length: 2
Max length: 100
userName
string
Min length: 2
Max length: 100
Methods: Security_StartSession
StartSessionResponse
All of
NewSessionResponse
Methods: Security_StartSession
UpdatePasswordRequest
Object
newPassword
string
Min length: 2
Max length: 100
password
string
Min length: 2
Max length: 100
Methods: Security_UpdatePassword
HasAcceptedTermsResponse
All of
ApiResponse
Methods: Settings_HasAcceptedTerms
HasSeenContactFormResponse
All of
ApiResponse
Methods: Settings_HasSeenContactForm
SetHasAcceptedTermsRequest
All of
Request
Methods: Settings_SetHasAcceptedTerms
SetHasSeenContactFormRequest
All of
Request
Methods: Settings_SetHasSeenContactForm
SingleStatisticsResponse
Object
weekStats
Array of WeekStats
monthStats
Array of MonthStats
Methods: Statistics_Read
WeekStats
Object
year
integer int32
weekNr
integer int32
saleCommissionTotal
number decimal
rentCommissionTotal
number decimal
nrOfTransactions
integer int32
Types: SingleStatisticsResponse
MonthStats
Object
year
integer int32
month
integer int32
sumSaleAskingPrice
number decimal
sumRentAskingPrice
number decimal
sumSaleRealisedPrice
number decimal
sumRentRealisedPrice
number decimal
avgProcessingTimeInDays
integer int32
nrOfTransactions
integer int32
Types: SingleStatisticsResponse
SingleInvoiceResponse
All of
ApiResponse
Methods: Invoices_DefineNew Invoices_Read Invoices_Save
Invoice
All of
RootEntity
InvoiceType
string
Enumeration:
None
BusinessToConsumerInvoice
BusinessToBusinessInvoice
InvoiceLine
All of
RootEntity
SearchRequest17
All of
SearchRequest2
Methods: Invoices_Search
SearchResponse16
All of
ApiResponse
Methods: Invoices_Search
InvoiceSnapShot
All of
Entity
Statistics3
Object
noEndDateCount
integer int32
expiredCount
integer int32
expiresTodayCount
integer int32
expiresTomorrowCount
integer int32
expiresNextWeekCount
integer int32
expiresAfterTwoWeeksCount
integer int32
completedCount
integer int32
DefineNewRequest11
All of
CultureRequest
Methods: Invoices_DefineNew
SaveRequest16
All of
CultureRequest
Methods: Invoices_Save
DefineNewRequest12
All of
CultureRequest
Methods: Tasks_DefineNew
SingleTaskResponse
All of
ApiResponse
Methods: Tasks_DefineNew Tasks_Read Tasks_Save
Task
All of
RootEntity
SaveRequest17
All of
CultureRequest
Methods: Tasks_Save
SearchRequest18
All of
SearchRequest2
Methods: Tasks_Search
TaskDelegateFilter
string
Enumeration:
AssignedToMe
Delegated
TaskOrderByField
string
Enumeration:
DefaultOrder
EndDate
TaskTermField
string
Enumeration:
Subject
SearchResponse17
All of
ApiResponse
Methods: Tasks_Search
TaskSnapShot
All of
Entity
Statistics4
Object
completedCount
integer int32
expiredCount
integer int32
expiresAfterTwoWeeksCount
integer int32
expiresNextWeekCount
integer int32
expiresTodayCount
integer int32
expiresTomorrowCount
integer int32
noEndDateCount
integer int32
UpdateStatusRequest
All of
Request
Methods: Tasks_UpdateStatus
SearchRequest19
All of
SearchRequest2
Methods: TimelineEvents_Search
TimelineOrderByField
string
Enumeration:
Date
TimelineTermField
string
Enumeration:
Subject
SearchResponse18
All of
ApiResponse
Methods: TimelineEvents_Search
TimelineEvent
All of
Entity
TimelineActionSubType
string
Enumeration:
Mandate
DateWithdrawn
DateAuction
EnddateReservation
DateAgreementdate
DateSold
DateTransfer
EnddateBankWarranty
DateRented
PriceChange
Statistics5
Object
futureCount
integer int32
noDateCount
integer int32
pastCount
integer int32
todayCount
integer int32
VersionResponse
Object
build
integer int32
environment
string
major
integer int32
minor
integer int32
revision
integer int32
version
string
Methods: Version_Index
DefineNewRequest13
All of
CultureRequest
Methods: SearchAssignments_DefineNew
SingleSearchAssignmentResponse
All of
ApiResponse
Methods: SearchAssignments_DefineNew SearchAssignments_Read SearchAssignments_Save
SearchAssignment
All of
RootEntity
SearchProfile
Object
iD
integer int32
searchAssignmentId
string guid
adminAreaLevel1
AddressDetail
adminAreaLevel2
AddressDetail
adminAreaLevel3
AddressDetail
locality
AddressDetail
sublocality
AddressDetail
street
AddressDetail
searchForLocationType
SearchForLocationType
realEstateGroup
RealEstateGroup2
name
string
hasGarden
boolean
hasGarage
boolean
hasStorage
boolean
hasParkingSpots
boolean
hasElevator
boolean
isRecreationalHouse
boolean
isTargetAudienceHouse
boolean
typesPrivate
Array of TypePART
buildingTypes
BuildingType
buildingCharacteristics
Array of HouseCharacteristic
apartmentTypes
Array of ApartmentSort
apartmentCharacteristics
Array of ApartmentCharacteristic
typeParking
Array of ParkingType
typesPARTOther
Array of TypePARTOther
typesBOG
Array of TypeBOG
typesALV
Array of TypeALV
typesALVOther
Array of TypeALVOther
offerType
OfferType
priceStart
number decimal
priceEnd
number decimal
constructionType
BuildingType
constructionYearBegin
integer int32
constructionYearEnd
integer int32
locationPlaces
Array of LocationPlace
postalCodes
Array of SearchProfilePostalCodeRange
postalCode
string
countryIso2
string
radius
integer int32
hasBath
boolean
hasCentralHeating
boolean
hasFireplace
boolean
hasJacuzzi
boolean
hasSauna
boolean
hasSteamCabin
boolean
hasSwimmingpool
boolean
isFurnished
boolean
isUpholstered
boolean
mustHaveMonumentalProtection
boolean
orientationMainGarden
Orientation
availableFrom
string date-time
minEnergyClass
EnergyClass
measurementUnit
MeasurementUnit
isoCurrencyCode
string
mustBeRecentlyModified
boolean
mustBeNewOnMarket
boolean
mustBeTopper
boolean
mustBeSpecial
boolean
mustHaveOpenHouse
boolean
mustBeWithTimeShare
boolean
minLivableArea
integer int32
maxLivableArea
integer int32
minBuildableArea
integer int32
maxBuildableArea
integer int32
minGardenArea
integer int32
maxGardenArea
integer int32
minNrOfRooms
integer int32
maxNrOfRooms
integer int32
minNrOfBathrooms
integer int32
maxNrOfBathrooms
integer int32
minNrOfBedrooms
integer int32
maxNrOfBedrooms
integer int32
minParkingCapacity
integer int32
maxParkingCapacity
integer int32
hasBalcony
boolean
hasElevatorInBuilding
boolean
hasCellar
boolean
hasGasConnection
boolean
hasWaterConnection
boolean
hasElectricityConnection
boolean
hasSewerConnection
boolean
hasInternetConnection
boolean
hasCableTvConnection
boolean
hasFibreOpticCableConnection
boolean
hasPhoneLineConnection
boolean
mustBeQualifiedForSeniors
boolean
maxEnergyClass
EnergyClass
minConditionInside
ConditionType
maxConditionInside
ConditionType
minConditionOutside
ConditionType
maxConditionOutside
ConditionType
mustBeOnTopFloor
boolean
mustBeOnGroundFloor
boolean
geoLocation
GeoLocation
SearchForLocationType
string
Enumeration:
None
Place
PostalCode
PostalCodeRange
Types: SearchProfile
TypePARTOther
string
Enumeration:
None
Storage
Berth
MobileHousePlace
CaravanPlace
HomeStore
Bottom
StorageSpace
ParkingSpace
Garage
Types: SearchProfile
TypeBOG
All of
DescriptorPatternBase
Types: SearchProfile
TypeALV
All of
DescriptorPatternBase
Types: SearchProfile
TypeALVOther
string
Enumeration:
None
Sheep
Goats
Worms
Eel
Fish
BuildingPlot
Other
Types: SearchProfile
OfferType
string
Enumeration:
None
Rent
Sale
MixingForm
Types: SearchProfile
SearchProfilePostalCodeRange
Object
locationPlaces
integer int32
postalCodes
integer int32
Types: SearchProfile
MeasurementUnit
All of
DescriptorPatternBase
Types: SearchProfile
MatchMailTrigger
All of
DescriptorPatternBase
MatchMailPeriod
string
Enumeration:
None
Never
Daily
Weekly
AssignmentSource
string
Enumeration:
None
Friend
Housenet3
Internet
WalkIn
Colleague
Other
SaveRequest18
All of
CultureRequest
Methods: SearchAssignments_Save
SearchRequest20
All of
SearchRequest2
Methods: SearchAssignments_Search
SearchAssignmentOrderByField
string
Enumeration:
CreationDate
SearchAssignmentTermField
string
Enumeration:
DontKnowYet
SearchResponse19
All of
ApiResponse
Methods: SearchAssignments_Search
SearchAssignmentSnapShot
All of
Entity
DefineNewRequest14
All of
CultureRequest
Methods: AssignmentRequests_DefineNew
SingleAssignmentRequestResponse
All of
ApiResponse
Methods: AssignmentRequests_DefineNew AssignmentRequests_Read AssignmentRequests_Save
AssignmentRequest
All of
RootEntity
AssignmentRequestTranslation
Object
id
integer int32
language
Language
title
string
description
string
TypePART2
All of
DescriptorPatternBase
SaveRequest19
All of
CultureRequest
Methods: AssignmentRequests_Save
SearchRequest21
All of
SearchRequest2
Methods: AssignmentRequests_Search
AssignmentRequestOrderByField
string
Enumeration:
CreationDate
AssignmentRequestTermField
string
Enumeration:
IDontKnowYet
SearchResponse20
All of
ApiResponse
Methods: AssignmentRequests_Search
AssignmentRequestSnapShot
All of
Entity
Statistics6
Object
completedCount
integer int32
expiredCount
integer int32
expiresAfterTwoWeeksCount
integer int32
expiresNextWeekCount
integer int32
expiresTodayCount
integer int32
expiresTomorrowCount
integer int32
noEndDateCount
integer int32
Authorization
string optional
Applied to all operations
Example:
BEARER ...
Account
AccountSettings
AccountSettings_Read
GET /v2/AccountSettings
AccountSettings_Save
POST /v2/AccountSettings
AccountSettings_ReadByEmployeeId
POST /v2/AccountSettings/ReadByEmployeeId
AccountSettings_Read
GET /v2/AccountSettings

Authentication

Bearer

Get the account settings of a specific person.

Request parameters

id
string guid required
culture
string optional
Min length: 0
Max length: 5
realEstateAgencyId
string guid required

Responses

200 200

AccountSettings details are in message body. or

Body
SingleAccountSettingsResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested accountSettings could not be found.

Body
HttpError
AccountSettings_Save
POST /v2/AccountSettings

Authentication

Bearer

Request body

SaveRequest

Responses

200 200

AccountSettings succesfully saved. or

Body
SingleAccountSettingsResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
404 404

Requested accountSettings could not be found.

Body
HttpError
500 500

Unexpected error. See message content for more details.

Body
HttpError
AccountSettings_ReadByEmployeeId
POST /v2/AccountSettings/ReadByEmployeeId

Authentication

Bearer

Request body

ReadByEmployeeIdRequest

Responses

200 200

AccountSettings details are in message body. or

Body
SingleAccountSettingsResponse
400 400

Invalid input. See message content for more details.

Body
ErrorResponse
401 401

Unauthorized: Invalid/expired idToken.

Body
HttpError
403 403

Forbidden: session was ended before.

Body
HttpError
409 409

Session started elsewhere.

Body
HttpError
404 404

Requested accountSettings could not be found.

Body
HttpError