Resource index

resources index

NIKI API Resources

Resource	Description	Content-type

about
`GET /about/version`	Returns the current version information of the Niki API	text/plain
direct
`GET /direct/housetype/{lnp_housetype_id}? ...`	Shortcut for identical method /projects/{developer_id}/{project_id}/{housetype_id}?	{application/json, application/xml}
`GET /direct/housetype/{lnp_housetype_id}/{housemodel_id}? ...`	Shortcut for identical method /projects/{developer_id}/{project_id}/{housetype_id}/{housemodel_id}?	{application/json, application/xml}
`GET /direct/project/{lnp_project_id}? ...`	NIKI data of a specific project	{application/json, application/xml}
`GET /direct/project/{lnp_project_id}/brokers? ...`	All brokers for specific project	{application/json, application/xml}
`GET /direct/project/{lnp_project_id}/developers? ...`	All developers for specific project	{application/json, application/xml}
`GET /direct/project/{lnp_project_id}/housetypes? ...`	Collection of houseTypes available for given project	{application/json, application/xml}
`GET /direct/project/{lnp_project_id}/interest? ...`	Validates and completes an interest, if it's validates correctly the interest is stored in de NIKI database.	{application/json, application/xml}
`GET /direct/project/{lnp_project_id}/interest/typeModelCombis? ...`	All possible houseModel_houseType combinations, used in the saveInterest method.	{application/json, application/xml}
`GET /direct/project/{lnp_project_id}/involvedparties? ...`	All involvedparties for specific project	{application/json, application/xml}
`GET /direct/project/{lnp_project_id}/{housetype_id}? ...`	NIKI data of a specific house type.	{application/json, application/xml}
`GET /direct/project/{lnp_project_id}/{housetype_id}/{housemodel_id}? ...`	Info about specific house type.	{application/json, application/xml}
files
`GET /files/{file_id}`	NIKI Document e.g. brochure (pdf), floor plan (pdf)	*
images
`GET /images/{image_id}/{predefined_size}`	NIKI image of specified size, size can be one of following: normal, thumb, mini, medium or large	*
language
`GET /language/all`	Display which languages can be used by the system	{application/json, application/xml}
projects
`GET /projects/developer/{developer_id}`	Information of specified developer, containing: name, email, website, street, streetNumber, zipcode and city	{application/json, application/xml}
`GET /projects/developers`	All developers in the Niki database.	{application/json, application/xml}
`GET /projects/mine`	List of all NIKI projects of the authenticated consumer.	{application/json, application/xml}
`GET /projects/statusList`	A list of all project statuses	{application/json, application/xml}
`GET /projects/{developer_id}? ...`	Collection of all projects of specified developer, which the consumer is allowed to access.	{application/json, application/xml}
`GET /projects/{developer_id}/{project_id}? ...`	NIKI data of a specific project	{application/json, application/xml}
`GET /projects/{developer_id}/{project_id}/brokers? ...`	All brokers for specific project	{application/json, application/xml}
`GET /projects/{developer_id}/{project_id}/developers? ...`	All developers for specific project	{application/json, application/xml}
`GET /projects/{developer_id}/{project_id}/housetypes? ...`	Collection of houseTypes available for given project	{application/json, application/xml}
`GET /projects/{developer_id}/{project_id}/interest? ...`	Validates and completes an interest, if it's validates correctly the interest is stored in de NIKI database.	{application/json, application/xml}
`GET /projects/{developer_id}/{project_id}/interest/typeModelCombis? ...`	All possible houseModel_houseType combinations, used in the saveInterest method.	{application/json, application/xml}
`GET /projects/{developer_id}/{project_id}/involvedparties? ...`	All involvedparties for specific project	{application/json, application/xml}
`GET /projects/{developer_id}/{project_id}/{housetype_id}? ...`	NIKI data of a specific house type.	{application/json, application/xml}
`GET /projects/{developer_id}/{project_id}/{housetype_id}/{housemodel_id}? ...`	Info about specific house type.	{application/json, application/xml}
search
`GET /search/all? ...`	Get combined types matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/characteristics? ...`	Get characteristics of houses matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/cities? ...`	Get collection of cities matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/communities? ...`	Get collection of communities matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/count? ...`	Get house count matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/customregions? ...`		{application/json, application/xml}
`GET /search/districts? ...`	Get collection of districts matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/groundsurface? ...`	Get groundsurface range of houses matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/groundsurfacelist? ...`	Get groundsurface list of houses matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/grouped/{source}? ...`	Allows the retrieval of {source} objects grouped by their parent	{application/json, application/xml}
`GET /search/housemodels? ...`	Get collection of housemodels matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/livingsurface? ...`	Get livingsurface range of houses matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/livingsurfacelist? ...`	Get livingsurface list of houses matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/modeltypes? ...`	Get modeltypes matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/neighbourhoods? ...`	Get collection of neighbourhoods matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/places? ...`	Get places near the given location(lat/lon) or matching the give search string	{application/json, application/xml}
`GET /search/price? ...`	Get price range of houses matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/progress? ...`	Get date range as list of quarter year objects for piv projects mathing the given paramters limited by access of the current account	{application/json, application/xml}
`GET /search/projects? ...`	Get collection of projects matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/projects.geojson? ...`	Allows the paged retrieval of project locations	application/json
`GET /search/regions? ...`	Get collection of regions matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/rooms? ...`	Get rooms range of houses matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/roomslist? ...`	Get rooms list of houses matching the given parameters limited by access of the current account	{application/json, application/xml}
`GET /search/startsale? ...`	Get date range as list of quarter year objects for piv projects mathing the given paramters limited by access of the current account	{application/json, application/xml}
`GET /search/types? ...`	Get collection of project types matching the given parameters limited by access of the current account	{application/json, application/xml}
statistics
`GET /statistics/house-data? ...`		*
`GET /statistics/involved-party-data? ...`		*
visitor
`GET /visitor/characteristics`	Get all possible characteristics for use in a profile selection	{application/json, application/xml}
`GET /visitor/cities? ...`	Get the list of cities within the restricted context of the oauthconsumer	{application/json, application/xml}
`GET /visitor/communities? ...`	Get the list of communities within the restricted context of the oauthconsumer	{application/json, application/xml}
`GET /visitor/customregions? ...`	Get the list of custom regions within the restricted context of the oauthconsumer	{application/json, application/xml}
`GET /visitor/districts? ...`	Get the list of districts within the restricted context of the oauthconsumer	{application/json, application/xml}
`GET /visitor/housemodels`	Get all possible house models for use in a profile selection	{application/json, application/xml}
`GET /visitor/neighbourhoods? ...`	Get the list of neighbourhoods within the restricted context of the oauthconsumer	{application/json, application/xml}
`GET /visitor/places? ...`	Search places within the restricted context of the oauthconsumer	{application/json, application/xml}
`POST /visitor/profile/create`	Create a visitor profile	{application/json, application/xml}
`POST /visitor/profile/createNewsletter`	Create a visitor profile with newsletter option	{application/json, application/xml}
`POST /visitor/profile/delete`	Delete the visitor profile fields conform AVG law	application/json
`GET /visitor/profile/fields`	Get the visitor profile fields for the user matching the provided usertoken	{application/json, application/xml}
`POST /visitor/profile/fields`	Update the visitor profile fields for the user matching the provided usertoken	{application/json, application/xml}
`GET /visitor/profile/partner`	Get the visitor profile partner for the user matching the provided usertoken	{application/json, application/xml}
`POST /visitor/profile/partner`	Update the visitor profile partner for the user matching the provided usertoken	{application/json, application/xml}
`POST /visitor/profile/reset`	Request profile password reset	{application/json, application/xml}
`POST /visitor/profile/reset/{token}`	Reset the profile password validated by the given reset token	{application/json, application/xml}
`GET /visitor/profile/search`	Get the visitor profile for the user matching the provided usertoken	{application/json, application/xml}
`POST /visitor/profile/search`	Update the visitor profile for the user matching the provided usertoken	{application/json, application/xml}
`POST /visitor/profile/signin`	Use the provided credentials to sign in a visitor profile	{application/json, application/xml}
`GET /visitor/profile/subscriber`	Get the visitor profile subscriber for the user matching the provided usertoken	{application/json, application/xml}
`POST /visitor/profile/subscriber`	Update the visitor profile subscriber for the user matching the provided usertoken	{application/json, application/xml}
`POST /visitor/profile/validate`	Validate the provided e-mail address	{application/json, application/xml}
`POST /visitor/profile/validate/{token}`	Validate the provided e-mail address	{application/json, application/xml}
`GET /visitor/progress`	Get all possible progresses for use in a profile selection	{application/json, application/xml}
`GET /visitor/regions? ...`	Get the list of regions within the restricted context of the oauthconsumer	{application/json, application/xml}
`GET /visitor/subdivisions? ...`	Get all possible house models for use in a profile selection	{application/json, application/xml}
webhook
`POST /webhook/mandrill`	This webhook is meant to be called by Mandrill to provide profiles information about open and click event in sent messages	application/json