NIKI API Resources

ResourceDescriptionContent-type
about
GET /about/versionReturns the current version information of the Niki APItext/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.*
images
GET /images/{image_id}/{predefined_size}NIKI image of specified size, size can be one of following: normal, thumb, mini, medium or large*
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/developersAll developers in the Niki database.{application/json, application/xml}
GET /projects/mineList of all NIKI projects of the authenticated consumer.{application/json, application/xml}
GET /projects/statusListA 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/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/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}
visitor
GET /visitor/characteristicsGet 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/housemodelsGet 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/createCreate a visitor profile{application/json, application/xml}
POST /visitor/profile/createNewsletterCreate a visitor profile with newsletter option{application/json, application/xml}
GET /visitor/profile/fieldsGet the visitor profile fields for the user matching the provided usertoken{application/json, application/xml}
POST /visitor/profile/fieldsUpdate the visitor profile fields for the user matching the provided usertoken{application/json, application/xml}
GET /visitor/profile/partnerGet the visitor profile partner for the user matching the provided usertoken{application/json, application/xml}
POST /visitor/profile/partnerUpdate the visitor profile partner for the user matching the provided usertoken{application/json, application/xml}
POST /visitor/profile/resetRequest 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/searchGet the visitor profile for the user matching the provided usertoken{application/json, application/xml}
POST /visitor/profile/searchUpdate the visitor profile for the user matching the provided usertoken{application/json, application/xml}
POST /visitor/profile/signinUse the provided credentials to sign in a visitor profile{application/json, application/xml}
GET /visitor/profile/subscriberGet the visitor profile subscriber for the user matching the provided usertoken{application/json, application/xml}
POST /visitor/profile/subscriberUpdate the visitor profile subscriber for the user matching the provided usertoken{application/json, application/xml}
POST /visitor/profile/validateValidate 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/progressGet 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}
webhook
POST /webhook/mandrillThis webhook is meant to be called by Mandrill to provide profiles information about open and click event in sent messagesapplication/json