Kolibri API V3
{RealEstateAgencyId}/AccountSettings{RealEstateAgencyId}/AccountSettings{RealEstateAgencyId}/AccountSettings/ReadByEmployeeId{RealEstateAgencyId}/AccountSettingsAuthentication
Path variables
Request parameters
Responses
AccountSettings details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested accountSettings could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/AccountSettingsAuthentication
Path variables
Request body
Responses
AccountSettings succesfully saved. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested accountSettings could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/AccountSettings/ReadByEmployeeIdAuthentication
Path variables
Request body
Responses
AccountSettings details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested accountSettings could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/AgendaItemCategories{RealEstateAgencyId}/AgendaItemCategories/Search{RealEstateAgencyId}/AgendaItemCategoriesAuthentication
Path variables
Request parameters
Responses
AgendaItem category details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested agendaItem category could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/AgendaItemCategories/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/AgendaItems{RealEstateAgencyId}/AgendaItems{RealEstateAgencyId}/AgendaItems{RealEstateAgencyId}/AgendaItems/Search{RealEstateAgencyId}/AgendaItems/SearchAndExport{RealEstateAgencyId}/AgendaItems/DefineNew{RealEstateAgencyId}/AgendaItems/Undelete{RealEstateAgencyId}/AgendaItems/Move{RealEstateAgencyId}/AgendaItems/Confirm{RealEstateAgencyId}/AgendaItems/Cancel{RealEstateAgencyId}/AgendaItems/AddRecurrenceException{RealEstateAgencyId}/AgendaItemsAuthentication
Path variables
Request parameters
Responses
AgendaItem details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested agendaItem could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/AgendaItemsAuthentication
Path variables
Request body
Responses
AgendaItem succesfully saved. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested agendaItem could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/AgendaItemsAuthentication
Path variables
Request parameters
Responses
AgendaItem succesfully deleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested agendaItem could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/AgendaItems/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/AgendaItems/SearchAndExportAuthentication
Path variables
Request parameters
Responses
Search results are returned in an Excel file.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/AgendaItems/DefineNewAuthentication
Path variables
Request body
Responses
AgendaItem succesfully defined (not saved!). or
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/AgendaItems/UndeleteAuthentication
Path variables
Request body
Responses
AgendaItem succesfully undeleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested agendaItem could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/AgendaItems/MoveAuthentication
Path variables
Request body
Responses
AgendaItem updated succesfully.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested agendaItem could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/AgendaItems/ConfirmAuthentication
Path variables
Request body
Responses
AgendaItem succesfully confirmed.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested task could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/AgendaItems/CancelAuthentication
Path variables
Request body
Responses
AgendaItem succesfully cancelled.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested task could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/AgendaItems/AddRecurrenceExceptionAuthentication
Path variables
Request body
Responses
Exception agendaItem succesfully created.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Recurring agendaitem could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Assignments/Search{RealEstateAgencyId}/Assignments/SearchAndExport{RealEstateAgencyId}/Assignments/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Assignments/SearchAndExportAuthentication
Path variables
Request parameters
Responses
Search results are returned in an Excel file.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Blobs/Download/{filedataid}/{filenameandextension}{RealEstateAgencyId}/Blobs/Upload{RealEstateAgencyId}/Blobs/UploadAuthentication
Path variables
Responses
Task succesfully defined (not saved!). or
Body
{RealEstateAgencyId}/BusinessPartners{RealEstateAgencyId}/BusinessPartners/Search{RealEstateAgencyId}/BusinessPartnersAuthentication
Path variables
Request parameters
Responses
Business Partner details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested Business Partner could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/BusinessPartners/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Cadastres/Archive{RealEstateAgencyId}/Cadastres/BuyAndSave{RealEstateAgencyId}/Cadastres/BuyAndSaveMunicipalities{RealEstateAgencyId}/Cadastres/DefineNew{RealEstateAgencyId}/Cadastres{RealEstateAgencyId}/Cadastres{RealEstateAgencyId}/Cadastres{RealEstateAgencyId}/Cadastres/Search{RealEstateAgencyId}/Cadastres/Unarchive{RealEstateAgencyId}/Cadastres/Undelete{RealEstateAgencyId}/Cadastres/ArchiveAuthentication
Path variables
Request body
Responses
Cadastre succesfully archived.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested cadastre could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Cadastres/BuyAndSaveAuthentication
Path variables
Request body
Responses
Cadastres successfully bought and saved. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested cadastre could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Cadastres/BuyAndSaveMunicipalitiesAuthentication
Path variables
Request body
Responses
Municipalities to be used when calling the BuyAndSave cadastres endpoint. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested cadastre could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Cadastres/DefineNewAuthentication
Path variables
Request body
Responses
Cadastre succesfully defined (not saved!). or
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/CadastresAuthentication
Path variables
Request parameters
Responses
Cadastre details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested cadastre could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/CadastresAuthentication
Path variables
Request body
Responses
Cadastre succesfully saved. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested cadastre could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/CadastresAuthentication
Path variables
Request parameters
Responses
Cadastre succesfully deleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested cadastre could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Cadastres/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Cadastres/UnarchiveAuthentication
Path variables
Request body
Responses
Cadastre succesfully unarchived.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested cadastre could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Cadastres/UndeleteAuthentication
Path variables
Request body
Responses
Cadastre succesfully undeleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested cadastre could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/CompanySettings{RealEstateAgencyId}/CompanySettingsAuthentication
Path variables
Responses
Company settings details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested task could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/ContactCompanies/Archive{RealEstateAgencyId}/ContactCompanies/DefineNew{RealEstateAgencyId}/ContactCompanies{RealEstateAgencyId}/ContactCompanies{RealEstateAgencyId}/ContactCompanies{RealEstateAgencyId}/ContactCompanies/Unarchive{RealEstateAgencyId}/ContactCompanies/UpdateLogo{RealEstateAgencyId}/ContactCompanies/RemoveLogo{RealEstateAgencyId}/ContactCompanies/ArchiveAuthentication
Path variables
Request body
Responses
ContactCompany succesfully archived.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested ContactCompany could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactCompanies/DefineNewAuthentication
Path variables
Request body
Responses
ContactCompany succesfully defined (not saved!). or
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactCompaniesAuthentication
Path variables
Request parameters
Responses
ContactCompany details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested ContactCompany could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/ContactCompaniesAuthentication
Path variables
Request body
Responses
ContactCompany succesfully saved. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested ContactCompany could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactCompaniesAuthentication
Path variables
Request parameters
Responses
ContactCompany succesfully deleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested ContactCompany could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactCompanies/UnarchiveAuthentication
Path variables
Request body
Responses
ContactCompany succesfully unarchived.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested ContactCompany could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactCompanies/UpdateLogoAuthentication
Path variables
Request body
Responses
Logo succesfully changed.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
ContactCompany could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactCompanies/RemoveLogoAuthentication
Path variables
Request body
Responses
Logo succesfully removed.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
ContactPerson could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactLinks{RealEstateAgencyId}/ContactLinks{RealEstateAgencyId}/ContactLinks/Search{RealEstateAgencyId}/ContactLinks/Undelete{RealEstateAgencyId}/ContactLinksAuthentication
Path variables
Request body
Responses
ContactLink succesfully saved. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested contactLink could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactLinksAuthentication
Path variables
Request parameters
Responses
ContactLink succesfully deleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested contactLink could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactLinks/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactLinks/UndeleteAuthentication
Path variables
Request body
Responses
ContactLink succesfully undeleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested contactLink could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactPersons/Archive{RealEstateAgencyId}/ContactPersons/DefineNew{RealEstateAgencyId}/ContactPersons{RealEstateAgencyId}/ContactPersons{RealEstateAgencyId}/ContactPersons{RealEstateAgencyId}/ContactPersons/Unarchive{RealEstateAgencyId}/ContactPersons/UpdatePassportPhoto{RealEstateAgencyId}/ContactPersons/RemovePassportPhoto{RealEstateAgencyId}/ContactPersons/ArchiveAuthentication
Path variables
Request body
Responses
ContactPerson succesfully archived.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested ContactPerson could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactPersons/DefineNewAuthentication
Path variables
Request body
Responses
ContactPerson succesfully defined (not saved!). or
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactPersonsAuthentication
Path variables
Request parameters
Responses
ContactPerson details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested ContactPerson could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/ContactPersonsAuthentication
Path variables
Request body
Responses
ContactPerson succesfully saved. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested ContactPerson could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactPersonsAuthentication
Path variables
Request parameters
Responses
ContactPerson succesfully deleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested ContactPerson could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactPersons/UnarchiveAuthentication
Path variables
Request body
Responses
ContactPerson succesfully unarchived.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested ContactPerson could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactPersons/UpdatePassportPhotoAuthentication
Path variables
Request body
Responses
Passport photo succesfully changed.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
ContactPerson could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ContactPersons/RemovePassportPhotoAuthentication
Path variables
Request body
Responses
Passport photo succesfully removed.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
ContactPerson could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/DossierItems{RealEstateAgencyId}/DossierItems{RealEstateAgencyId}/DossierItems/Search{RealEstateAgencyId}/DossierItems/Undelete{RealEstateAgencyId}/DossierItemsAuthentication
Path variables
Request body
Responses
Dossier succesfully saved. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested dossier could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/DossierItemsAuthentication
Path variables
Request parameters
Responses
Dossier succesfully deleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested dossier could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/DossierItems/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/DossierItems/UndeleteAuthentication
Path variables
Request body
Responses
Dossier succesfully undeleted. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested dossier could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Employees/Archive{RealEstateAgencyId}/Employees/DefineNew{RealEstateAgencyId}/Employees{RealEstateAgencyId}/Employees{RealEstateAgencyId}/Employees{RealEstateAgencyId}/Employees/Unarchive{RealEstateAgencyId}/Employees/ArchiveAuthentication
Path variables
Request body
Responses
Employee succesfully archived.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested Employee could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Employees/DefineNewAuthentication
Path variables
Request body
Responses
Employee succesfully defined (not saved!). or
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/EmployeesAuthentication
Path variables
Request parameters
Responses
Employee details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested Employee could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/EmployeesAuthentication
Path variables
Request body
Responses
Employee succesfully saved. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested Employee could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/EmployeesAuthentication
Path variables
Request parameters
Responses
Employee succesfully deleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested Employee could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Employees/UnarchiveAuthentication
Path variables
Request body
Responses
Employee succesfully unarchived.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested Employee could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/FinancialAdministrations{RealEstateAgencyId}/FinancialAdministrations{RealEstateAgencyId}/FinancialAdministrations/Search{RealEstateAgencyId}/FinancialAdministrationsAuthentication
Path variables
Request parameters
Responses
FinancialAdministration details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested financialAdministration could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/FinancialAdministrationsAuthentication
Path variables
Request body
Responses
FinancialAdministration succesfully saved. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested financialAdministration could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/FinancialAdministrations/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Geo/AddressSearch{RealEstateAgencyId}/Geo/AdminAreaLevel1Search{RealEstateAgencyId}/Geo/AdminAreaLevel2Search{RealEstateAgencyId}/Geo/AdminAreaLevel3Search{RealEstateAgencyId}/Geo/LocalitySearch{RealEstateAgencyId}/Geo/StreetSearch{RealEstateAgencyId}/Geo/SublocalitySearch{RealEstateAgencyId}/Geo/AddressSearchAuthentication
Path variables
Request body
Responses
Geo address details are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/Geo/AdminAreaLevel1SearchAuthentication
Path variables
Request body
Responses
Get geo admin area level 1’s; details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/Geo/AdminAreaLevel2SearchAuthentication
Path variables
Request body
Responses
Get geo admin area level 2’s; details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/Geo/AdminAreaLevel3SearchAuthentication
Path variables
Request body
Responses
Get geo admin area level 3’s; details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/Geo/LocalitySearchAuthentication
Path variables
Request body
Responses
Get Localities; details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/Geo/StreetSearchAuthentication
Path variables
Request body
Responses
Get Streets; details are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/Geo/SublocalitySearchAuthentication
Path variables
Request body
Responses
Get Sublocalities; details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/GlobalSearch/Search{RealEstateAgencyId}/GlobalSearch/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Keys/Search{RealEstateAgencyId}/Keys/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/MasterTable{RealEstateAgencyId}/MasterTableAuthentication
Path variables
Request parameters
Responses
Master table is in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Notes{RealEstateAgencyId}/Notes{RealEstateAgencyId}/Notes/Search{RealEstateAgencyId}/Notes/Undelete{RealEstateAgencyId}/NotesAuthentication
Path variables
Request body
Responses
Note succesfully saved. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested note could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/NotesAuthentication
Path variables
Request parameters
Responses
Note succesfully deleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested note could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Notes/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Notes/UndeleteAuthentication
Path variables
Request body
Responses
Note succesfully undeleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested note could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ObjectAssignments/Clone{RealEstateAgencyId}/ObjectAssignments/DefineNew{RealEstateAgencyId}/ObjectAssignments{RealEstateAgencyId}/ObjectAssignments{RealEstateAgencyId}/ObjectAssignments{RealEstateAgencyId}/ObjectAssignments/Undelete{RealEstateAgencyId}/ObjectAssignments/UpdateAvailability{RealEstateAgencyId}/ObjectAssignments/CloneAuthentication
Path variables
Request body
Responses
ObjectAssignment succesfully cloned.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested objectAssignment could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ObjectAssignments/DefineNewAuthentication
Path variables
Request body
Responses
ObjectAssignment succesfully defined (not saved!). or
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ObjectAssignmentsAuthentication
Path variables
Request parameters
Responses
ObjectAssignment details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested objectAssignment could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/ObjectAssignmentsAuthentication
Path variables
Request body
Responses
ObjectAssignment succesfully saved. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested objectAssignment could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ObjectAssignmentsAuthentication
Path variables
Request parameters
Responses
ObjectAssignment succesfully deleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested objectAssignment could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ObjectAssignments/UndeleteAuthentication
Path variables
Request body
Responses
ObjectAssignment succesfully undeleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested objectAssignment could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/ObjectAssignments/UpdateAvailabilityAuthentication
Path variables
Request body
Responses
ObjectAssignment availability updated succesfully.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested objectAssignment could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Offices/Archive{RealEstateAgencyId}/Offices/DefineNew{RealEstateAgencyId}/Offices{RealEstateAgencyId}/Offices{RealEstateAgencyId}/Offices{RealEstateAgencyId}/Offices/Unarchive{RealEstateAgencyId}/Offices/ArchiveAuthentication
Path variables
Request body
Responses
Office succesfully archived.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested Office could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Offices/DefineNewAuthentication
Path variables
Request body
Responses
Office succesfully defined (not saved!). or
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/OfficesAuthentication
Path variables
Request parameters
Responses
Office details are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested Office could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/OfficesAuthentication
Path variables
Request body
Responses
Office succesfully saved. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested Office could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/OfficesAuthentication
Path variables
Request parameters
Responses
Office succesfully deleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested Office could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Offices/UnarchiveAuthentication
Path variables
Request body
Responses
Office succesfully unarchived.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested Office could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Publications/Activate{RealEstateAgencyId}/Publications/Deactivate{RealEstateAgencyId}/Publications/Search{RealEstateAgencyId}/Publications/ActivateAuthentication
Path variables
Request body
Responses
Publication succesfully activated.
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Media Partner or Assignment could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Publications/DeactivateAuthentication
Path variables
Request body
Responses
Publication succesfully deactivated.
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Media Partner or Assignment could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Publications/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/RealEstateAgencies{RealEstateAgencyId}/RealEstateAgencies{RealEstateAgencyId}/RealEstateAgenciesAuthentication
Path variables
Responses
Real Estate Agency details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested task could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/RealEstateAgenciesAuthentication
Path variables
Request body
Responses
Real Estate Agency succesfully saved. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested task could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/RelationGroups{RealEstateAgencyId}/RelationGroups{RealEstateAgencyId}/RelationGroups{RealEstateAgencyId}/RelationGroups/Search{RealEstateAgencyId}/RelationGroups/DefineNew{RealEstateAgencyId}/RelationGroups/Undelete{RealEstateAgencyId}/RelationGroups/Link{RealEstateAgencyId}/RelationGroups/Unlink{RealEstateAgencyId}/RelationGroupsAuthentication
Path variables
Request parameters
Responses
RelationGroup details are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested relationGroup could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/RelationGroupsAuthentication
Path variables
Request body
Responses
RelationGroup succesfully saved. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested relationGroup could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/RelationGroupsAuthentication
Path variables
Request parameters
Responses
RelationGroup succesfully deleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested relationGroup could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/RelationGroups/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/RelationGroups/DefineNewAuthentication
Path variables
Request body
Responses
RelationGroup succesfully defined (not saved!). or
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/RelationGroups/UndeleteAuthentication
Path variables
Request body
Responses
RelationGroup succesfully undeleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested relationGroup could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/RelationGroups/LinkAuthentication
Path variables
Request body
Responses
RelationGroup succesfully deleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested relationGroup could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/RelationGroups/UnlinkAuthentication
Path variables
Request body
Responses
RelationGroup succesfully undeleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested relationGroup could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Relations/Search{RealEstateAgencyId}/Relations/SearchAndExport{RealEstateAgencyId}/Relations/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Relations/SearchAndExportAuthentication
Path variables
Request parameters
Responses
Search results are returned in an Excel file.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Statistics{RealEstateAgencyId}/StatisticsAuthentication
Path variables
Request parameters
Responses
Statistics are in message body. or
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested statistics could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/Tasks/Archive{RealEstateAgencyId}/Tasks/DefineNew{RealEstateAgencyId}/Tasks{RealEstateAgencyId}/Tasks{RealEstateAgencyId}/Tasks{RealEstateAgencyId}/Tasks/Search{RealEstateAgencyId}/Tasks/Unarchive{RealEstateAgencyId}/Tasks/Undelete{RealEstateAgencyId}/Tasks/UpdateStatus{RealEstateAgencyId}/Tasks/ArchiveAuthentication
Path variables
Request body
Responses
Task succesfully archived.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested task could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Tasks/DefineNewAuthentication
Path variables
Request body
Responses
Task succesfully defined (not saved!). or
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/TasksAuthentication
Path variables
Request parameters
Responses
Task details are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Forbidden: session was ended before.
Body
Requested task could not be found.
Body
Session started elsewhere.
Body
{RealEstateAgencyId}/TasksAuthentication
Path variables
Request body
Responses
Task succesfully saved. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested task could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/TasksAuthentication
Path variables
Request parameters
Responses
Task succesfully deleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested task could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Tasks/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Tasks/UnarchiveAuthentication
Path variables
Request body
Responses
Task succesfully unarchived.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested task could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Tasks/UndeleteAuthentication
Path variables
Request body
Responses
Task succesfully undeleted.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested task could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/Tasks/UpdateStatusAuthentication
Path variables
Request body
Responses
Task status succesfully updated.
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Requested task could not be found.
Body
Unexpected error. See message content for more details.
Body
{RealEstateAgencyId}/TimelineEvents/Search{RealEstateAgencyId}/TimelineEvents/SearchAuthentication
Path variables
Request body
Responses
Search results are in message body. or
Body
Invalid input. See message content for more details.
Body
Unauthorized: Invalid/expired idToken.
Body
Unexpected error. See message content for more details.
Body
Authentication
Responses
Returns the current API version. or
Body
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.
Represents an action result that returns an empty HttpStatusCode.OK response.