API documentation (frontend)

Simple list

Type: GET

Url: /cabin-type/all

Description: Gives a list of all cabin types in simple form


Simple list

Type: GET

Url: /cabin-type/allDetailed

Description: Gives a list of all cabin types in simple form, but with the cabins for that type


Check cabin type exists

Type: GET

Url: /cabin-type/{slug}/exists

Description: Gives a response whether or not a cabin type with that slug exists


Fetch cabin type

Type: GET

Url: /cabin-type/{slug}

Description: Returns all relevant values for that cabin type. Gives 404 if slug isn't found


List

Type: GET

Url: /showing/all

Description: Gives a list of future showings


Request showing

Type: POST

Url: /showing/request

Description: Sends a request to set up a showing for a give marketable cabin, or cabinfield

Parameter Type Notes Description
object.name String Required
object.email String Required
object.phone String Required
object.wantedDateAndTime String Required A short description of what time and dates might be good for a showing
object.cabinField.id Long Required if object.marketableCabin.id is null
object.marketableCabin.id Long Required if object.cabinField.id is null
isHumanToken String Required (ignored in dev mode) Token generated by Google Recaptcha

Join showing

Type: POST

Url: /showing/{id}/join

Description: Joining the showing with the given id

Parameter Type Notes Description
object.name String Required
object.email String Required
object.phone String Required
isHumanToken String Required (ignored in dev mode) Token generated by Google Recaptcha

List

Type: GET

Url: /area/all

Description: Gives a list of all areas, and all cabin fields under each area.


Check cabin exists

Type: GET

Url: /cabin/{slug}/exists

Description: Gives a response whether or not a cabin with that slug exists


Fetch cabin

Type: GET

Url: /cabin/{slug}

Description: Returns all relevant values for that cabin. Gives 404 if slug isn't found


Check cabin field exists

Type: GET

Url: /cabin-field/{slug}/exists

Description: Gives a response whether or not a cabin field with that slug exists


Fetch cabin field

Type: GET

Url: /cabin-field/{slug}

Description: Returns all relevant values for that cabin field. Gives 404 if slug isn't found


Order cabin field prospect

Type: POST

Url: /cabin-field/prospect-order

Description: Returns the url for the file after

Parameter Type Notes Description
id Long Required Id of the cabin field
email String Required. Email Users email
phone String Required Users phone number
name String Required Users full name
isHumanToken String Required (ignored in dev mode) Token generated by Google Recaptcha

Check plot picker exists

Type: GET

Url: /cabin-field-plot-picker/{id}/exists

Description: Gives a response whether or not a plot picker with that id exists


Fetch plot picker by ID

Type: GET

Url: /cabin-field-plot-picker/{id}

Description: Fetches plot picker for the given id


Fetch marketable cabin on Plot

Type: GET

Url: /cabin-field/{slug}/plot-{id}/{mcslug}

Description: Returns all relevant values for that marketable cabin and a full plot picker for the given cabin field.


Check marketable cabin exists

Type: GET

Url: /marketable-cabin/{type}/{slug}/exists

Description: Gives a response whether or not a marketable cabin with that slug and type exists. Valid types are "FOR_SALE", "SHOWING" and "BOTH"


Fetch marketable cabin

Type: GET

Url: /marketable-cabin/{slug}

Description: Returns all relevant values for that marketable cabin. Gives 404 if slug isn't found


Fetch marketable cabins

Type: GET

Url: /marketable-cabin/{type}/all

Description: Returns a list of marketable cabins of the given type. Valid types are "FOR_SALE", "SHOWING" and "BOTH". Any other value will give an empty list.


Order marketable cabin prospect

Type: POST

Url: /marketable-cabin/prospect-order

Description: Returns the url for the file after

Parameter Type Notes Description
id Long Required Id of the marketable cabin
email String Required. Email Users email
phone String Required Users phone number
name String Required Users full name
isHumanToken String Required (ignored in dev mode) Token generated by Google Recaptcha

Order catalog

Type: POST

Url: /catalog-order

Description: Submits a catalog order

Parameter Type Notes Description
object.firstName String Required
object.lastName String Required
object.email String Required
object.phone String Required
object.address String Required if object.receiveMail is true
object.zipCode String Required if object.receiveMail is true
object.zipCity String Required if object.receiveMail is true
object.locationPreference String
object.hasProperty boolean Default false
object.receiveEmail boolean Default false
object.receiveMail boolean Default false
cabinTypes[0..*] List<Long> Must be at least one List of ids of the cabin types wanted
isHumanToken String Required (ignored in dev mode) Token generated by Google Recaptcha

Request meeting

Type: POST

Url: /meeting/book

Description: Submits a meeting request

Parameter Type Notes Description
object.firstName String Required
object.lastName String Required
object.email String Required
object.phone String Required
object.municipalityToBuild String
object.comment String
object.cabinField.id Long Should be set if form is submitted from a "showCabinField"-page
object.marketableCabin.id Long Should be set if form is submitted from a "showMarketableCabin"-page
isHumanToken String Required (ignored in dev mode) Token generated by Google Recaptcha

API documentation (backend)

All API-methods (except login and reset password calls) requires a "token" in header of the request. This token is given the user when submitting a valid login request.
Login

Type: POST

Url: /api/login

Description: Validates credentials and returns a user token. Token is used for other requests and used by system to identify you.

Parameter Type Notes Description
username String Required Email of the user
password String Required Password for the user

Logout

Type: POST

Url: /api/logout

Description: Deletes the user token, making it invalid.


Logout from everywhere

Type: POST

Url: /api/logout-all

Description: Deletes all user tokens for this user, making them invalid. This logs you out too.


Request reset password email

Type: POST

Url: /api/password/reset

Description: Sends an email, with a reset password code to the given user, if user exists.

Parameter Type Notes Description
email String Required Email of the user

Set new password

Type: PUT

Url: /api/password/new

Description: Sets a new password

Parameter Type Notes Description
userId Long Required Id of the user. Given in reset password email.
code String Required Generated code. Given in reset password email.
newPassword String Required The new wanted password
confirmNewPassword String Required The new wanted password repeated

Fetch all users

Type: GET

Url: /api/user/all

Description: Gives a list of all users


Fetch user

Type: GET

Url: /api/user/{id}

Description: Gives a single user


Create user

Type: POST

Url: /api/user

Description: Creates a user with given values

Parameter Type Notes Description
object.name String Required
object.email String Required. Email. Unique
object.password String Required
object.userType String Defaults to ADMIN Can be: ADMIN or SYSTEMADMIN

Update user

Type: PUT

Url: /api/user/{id}

Description: Updates a user with given values

Parameter Type Notes Description
object.name String Required
object.email String Required. Email. Unique
object.password String Required
object.userType String Defaults to ADMIN Can be: ADMIN or SYSTEMADMIN

Delete user

Type: DELETE

Url: /api/user/{id}

Description: Deletes the given user


Fetch all cabinTypes

Type: GET

Url: /api/cabin-type/all

Description: Gives all cabin types. Includes inactive cabinTypes


Fetch cabinType

Type: GET

Url: /api/cabin-type/{id}

Description: Gives a cabin type


Create cabinType

Type: POST

Url: /api/cabin-type

Description: Creates a cabinType with given values

Parameter Type Notes Description
object.name String Required. Unique. Max length: 255 The slugged version must also be unique
object.description String
object.primaryColor String Required Hex color code
object.secondaryColor String Required Hex color code
object.active boolean Whether or not the cabin type should be active
object.picture File - Image
object.content String
object.catalogPdf File - PDF
object.completeStandardContent String
object.completeStandardContentPdf File - PDF
object.onlyExteriorContent String
object.onlyExteriorContentPdf File - PDF
object.heading String
object.introText String
object.headingFile File - Image, Video
object.picture File - Image Required if headingFile is a video picture to use as thumbnail if video is used as heading file for cabin field
object.section1Heading String
object.section1Img1 File - Image
object.section1Text1 String
object.section1Img2 File - Image
object.section1Text2 String
object.detailsContent String
object.detailsFile File - Image
object.section2Heading String
object.section2Img1 File - Image
object.section2Text1 String
object.section2Img2 File - Image
object.section2Text2 String
carouselPictures[0..*].position List<Integer> Required
carouselPictures[0..*].text List<String>
carouselPictures[0..*].picture List<File - Image> Required
object.priceConditions String
object.deliveryLink String

Update cabinType

Type: PUT

Url: /api/cabin-type/{id}

Description: Updates a cabinType with given values

Parameter Type Notes Description
object.name String Required. Unique. Max length: 255 The slugged version must also be unique
object.description String
object.primaryColor String Required Hex color code
object.secondaryColor String Required Hex color code
object.active boolean Whether or not the cabin type should be active
object.picture File - Image
object.content String
object.catalogPdf File - PDF
object.completeStandardContent String
object.completeStandardContentPdf File - PDF
object.onlyExteriorContent String
object.onlyExteriorContentPdf File - PDF
object.heading String
object.introText String
object.headingFile File - Image, Video
object.picture File - Image Required if headingFile is a video picture to use as thumbnail if video is used as heading file for cabin field
object.section1Heading String
object.section1Img1 File - Image
object.section1Text1 String
object.section1Img2 File - Image
object.section1Text2 String
object.detailsContent String
object.detailsFile File - Image
object.section2Heading String
object.section2Img1 File - Image
object.section2Text1 String
object.section2Img2 File - Image
object.section2Text2 String
carouselPictures[0..*].id List<Long> Only for existing carouselPictures. This is the ID for the carouselPicture, NOT the picture.
carouselPictures[0..*].position List<Integer> Required
carouselPictures[0..*].text List<String>
carouselPictures[0..*].picture List<File - Image> Only for new carouselPictures
object.priceConditions String
object.deliveryLink String

Delete a cabin type

Type: DELETE

Url: /api/cabin-type/{id}

Description: Deletes cabin type with the given ID if not used by any cabins. (If used by cabins, error message is returned and cabin type is not deleted!)


Fetch all cabins

Type: GET

Url: /api/cabin/all

Description: Gives a list of all cabins. Includes inactive Cabins


Fetch cabin

Type: GET

Url: /api/cabin/{id}

Description: Gives a single cabin


Create cabin

Type: POST

Url: /api/cabin

Description: Creates a cabin with given values

Parameter Type Notes Description
object.name String Required. Unique. Max length: 255
object.introText String
object.project boolean If this is a project cabin or not
object.priceZoneA Double Required
object.priceZoneB Double Required
object.active boolean
object.BRA Double
object.BYA Double
object.BTA Double
object.PROM Double
object.bedrooms Integer
object.bathrooms Integer
object.loft Double "Hems" in norwegian
object.terrace Double
object.picture File - Image
object.contentImg1 File - Image
object.contentImg1Text String
object.description String
object.headingFile File - Image, Video
object.contentImg2 File - Image
object.contentImg2Text String
floorPlans[0..*].position List<Integer> Required
floorPlans[0..*].text List<String>
floorPlans[0..*].picture List<File - Image> Required
carouselPictures[0..*].position List<Integer> Required
carouselPictures[0..*].text List<String>
carouselPictures[0..*].picture List<File - Image> Required
object.threeDUrl String
object.threeDUrlBackgroundPicture File - Image
object.completeStandardContent String
object.completeStandardContentPdf File - PDF
object.pdfText String
object.onlyExteriorContent String
object.onlyExteriorContentPdf File - PDF
object.cabinType.id Long Required

Duplicate cabin

Type: POST

Url: /api/cabin/{id}

Description: Creates a copy of the cabin with the specified ID. Name of cabin is unique, thus name of copy cabin will be changed to have a number at the end indicating the number of copies existing, eg (1), (2), (3), etc... duplicated cabin is set to inactive


Update cabin

Type: PUT

Url: /api/cabin/{id}

Description: Updates a cabin with given values

Parameter Type Notes Description
object.name String Required. Unique. Max length: 255
object.introText String
object.project boolean If this is a project cabin or not
object.priceZoneA Double Required
object.priceZoneB Double Required
object.active boolean
object.BRA Double
object.BYA Double
object.BTA Double
object.PROM Double
object.bedrooms Integer
object.bathrooms Integer
object.loft Double "Hems" in norwegian
object.terrace Double
object.contentImg1 File - Image
object.contentImg1Text String
object.description String
object.headingFile File - Image, Video
object.contentImg2 File - Image
object.contentImg2Text String
floorPlans[0..*].id List<Long> Required for existing Id of the CabinCarouselPicture, not the Picture
floorPlans[0..*].position List<Integer> Required
floorPlans[0..*].text List<String>
floorPlans[0..*].picture List<File - Image> Required for new floorplans
carouselPictures[0..*].id List<Long> Required for existing Id of the CabinCarouselPicture, not the Picture
carouselPictures[0..*].position List<Integer> Required
carouselPictures[0..*].text List<String>
carouselPictures[0..*].picture List<File - Image> Required for new floorplans
object.threeDUrl String
object.threeDUrlBackgroundPicture File - Image
object.completeStandardContent String
object.completeStandardContentPdf File - PDF
object.pdfText String
object.onlyExteriorContent String
object.onlyExteriorContentPdf File - PDF
object.cabinType.id Long Required

Delete a cabin

Type: DELETE

Url: /api/cabin/{id}

Description: Deletes cabin with the given ID if not used by any marketable cabins. (If used by marketable cabins, error message is returned and cabin is not deleted!)


Fetch all CabinFields

Type: GET

Url: /api/cabin-field/all

Description: Gives a list of all CabinFields. Includes inactive CabinFields


Fetch a CabinField

Type: GET

Url: /api/cabin-field/{id}

Description: Gives a single CabinField


Create CabinField

Type: POST

Url: /api/cabin-field

Description: Creates a CabinField with given values

Parameter Type Notes Description
object.name String Required. Unique. Max length: 255
object.active boolean
object.partner boolean
object.partnerUrl String Valid url. Required if partner is true
object.partnerLogo File - Image
object.primaryColor String Required if partner is true Hex color code
object.secondaryColor String Required if partner is true Hex color code
object.introText String
object.section1Heading String
object.section1Img1 File - Image
object.section1Text1 String
object.section1Img2 File - Image
object.section1Text2 String
object.descriptionHeading String
object.description String
object.shortIntroText String
object.destination String
object.section2Heading String
object.section2Img1 File - Image
object.section2Text1 String
object.section2Img2 File - Image
object.section2Text2 String
object.type List<PlotType> Required. Default: STANDARD Valid PlotStatuses: STANDARD or PROJECTED
carouselPictures[0...*].position List<Integer> Required
carouselPictures[0...*].text List<String>
carouselPictures[0...*].picture List<File - Image> Required
object.headingFile File - Image, Video
object.cabinFieldHeading String
object.cabinFieldDescription String
object.directionsHeading String
object.directionsContent String
object.lat Double Latitude coordinates
object.lng Double Longitude coordinates
suggested[0...*].cabin.id List<Long> Required Id of the suggested Cabins
suggested[0...*].overridePrice List<Long>
suggested[0...*].overrideLink List<Long>
object.plotMapPicture File - Image
object.priceInfoText1 String
object.priceInfoText2 String
object.infoHeading String
object.infoDescription String
object.prospectPDF File - PDF
object.zoningPlan File - PDF
object.regulatoryProvisions File - PDF
object.costsPDF File - PDF
object.prospectPicture File - Image
infoItems[0...*].name List<String> Required
infoItems[0...*].content List<String>
infoItems[0...*].position List<Integer> Required
cabinFieldContactPersons[0...*].position List<Integer> Required
cabinFieldContactPersons[0...*].contactPerson.id List<Long> Id of the wanted contact person
object.area.id Long Required
plots[0...*].number List<String> Required
plots[0...*].area List<Double>
plots[0...*].price List<Double>
plots[0...*].priceCabin1 List<Double>
plots[0...*].priceCabin2 List<Double>
plots[0...*].priceCabin3 List<Double>
plots[0...*].priceCabin4 List<Double>
plots[0...*].priceCabin5 List<Double>
plots[0...*].status List<PlotStatus> Valid PlotStatuses: FOR_SALE or SOLD
plots[0...*].cabinName List<String>
plots[0...*].cabinPrice List<Double>
facts[0...*].name List<String> Required
facts[0...*].content List<String>

Update CabinField

Type: PUT

Url: /api/cabin-field/{id}

Description: Updates a CabinField with given values

Parameter Type Notes Description
object.name String Required. Unique. Max length: 255
object.active boolean
object.partner boolean
object.partnerUrl String Valid url. Required if partner is true
object.partnerLogo File - Image
object.primaryColor String Required Hex color code
object.secondaryColor String Required Hex color code
object.introText String
object.section1Heading String
object.section1Img1 File - Image
object.section1Text1 String
object.section1Img2 File - Image
object.section1Text2 String
object.descriptionHeading String
object.description String
object.section2Heading String
object.section2Img1 File - Image
object.section2Text1 String
object.section2Img2 File - Image
object.section2Text2 String
object.type List<PlotType> Required. Default: STANDARD Valid PlotStatuses: STANDARD or PROJECTED
carouselPictures[0...*].id List<Long> Required for existing
carouselPictures[0...*].position List<Integer> Required
carouselPictures[0...*].text List<String>
carouselPictures[0...*].picture List<File - Image> Required for new
object.headingFile File - Image, Video
object.cabinFieldHeading String
object.cabinFieldDescription String
object.directionsHeading String
object.directionsContent String
object.lat Double Latitude coordinates
object.lng Double Longitude coordinates
suggested[0...*].cabin.id List<Long> Required Id of the suggested Cabins
suggested[0...*].overridePrice List<Long>
suggested[0...*].overrideLink List<Long>
object.plotMapPicture File - Image
object.priceInfoText1 String
object.priceInfoText2 String
object.infoHeading String
object.infoDescription String
object.prospectPDF File - PDF
object.zoningPlan File - PDF
object.regulatoryProvisions File - PDF
object.costsPDF File - PDF
object.prospectPicture File - Image
infoItems[0...*].id List<Long> Required for existing
infoItems[0...*].name List<String> Required
infoItems[0...*].content List<String>
infoItems[0...*].position List<Integer> Requried
cabinFieldContactPersons[0...*].id List<Long> Required for existing Id of the CabinFieldContactPerson
cabinFieldContactPersons[0...*].position List<Integer> Required
cabinFieldContactPersons[0...*].contactPerson.id List<Long> Id of the wanted contact person
object.area.id Long Required
plots[0...*].id List<Long> Required for existing
plots[0...*].number List<String> Required
plots[0...*].area List<Double>
plots[0...*].price List<Double>
plots[0...*].priceCabin1 List<Double>
plots[0...*].priceCabin2 List<Double>
plots[0...*].priceCabin3 List<Double>
plots[0...*].priceCabin4 List<Double>
plots[0...*].priceCabin5 List<Double>
plots[0...*].status List<PlotStatus> Valid PlotStatuses: FOR_SALE or SOLD
plots[0...*].cabinName List<String>
plots[0...*].cabinPrice List<Double>
facts[0...*].id List<Long> Required for existing
facts[0...*].name List<String> Required
facts[0...*].content List<String>

Delete cabin field prospect

Type: DELETE

Url: /api/cabin-field/{id}/removeProspect

Description: Removes the prospect from the cabin field.


Create plot picker

Type: POST

Url: /api/cabin-field/{id}/plot-picker

Description:

Parameter Type Notes Description
picture File Optional The area map to make shapes on. Create is adviced
plotPicker.active boolean

Fetch plot picker by id

Type: GET

Url: /api/plot-picker/{id}

Description:


Update plot picker

Type: PUT

Url: /api/plot-picker/{id}

Description:

Parameter Type Notes Description
object.picture File The area map to make shapes on
object.active boolean
object.description String

Delete plot picker

Type: DELETE

Url: /api/plot-picker/{id}

Description: Deletes plot picker with the given id


Update plot coordinates

Type: PUT

Url: /api/plot-picker/update-coordinates

Description: Updates the coordinates of a set of Plots

Parameter Type Notes Description
plots[0...*].id List<Long> Required for existing
plots[0...*].coordinates List<String> JSON format of the coordinates for the given plot

Fetch all marketable cabins

Type: GET

Url: /api/marketable-cabin/all

Description: Gives a list of all Areas that are saved in the database.


Fetch a marketable cabin

Type: GET

Url: /api/marketable-cabin/{id}

Description: Gives a single marketable cabin with given ID if found.


Create a new marketable cabin

Type: POST

Url: /api/marketable-cabin

Description: Creates a new marketable cabin and saves it in the database.

Parameter Type Notes Description
object.active boolean Sets marketable cabin active or inactive. Inactive cabins won't show in any frontend api methods.
object.name String Required. Unique. Max length: 255 Title of marketable cabin.
object.address String Required Address of marketable cabin.
object.zipCode String Zip code of marketable cabin.
object.area String Area of marketable cabin.
object.lat Double Latitude of which marketable cabin is located (Coordinate).
object.lng Double longitude of which marketable cabin is located (Coordinate).
object.price Double Price of marketable cabin.
object.costs Double Costs of marketable cabin.
object.yearBuilt Integer Year marketable cabin was built.
object.plotArea Double Size of plot area.
object.locationHeader String Header of location of marketable cabin.
object.locationContent String Content of location of marketable cabin.
object.arrivalPlotConditionHeader String Header of arrival plot condition of marketable cabin.
object.arrivalPlotConditionContent String Content of arrival plot condition of marketable cabin.
object.arrivalPlotConditionPicture File - Image Picture of arrival plot condition of marketable cabin.
object.content String Content to be displayed on page of marketable cabin.
object.status String Required. (if not provided, default value applies) Sets status of marketable cabin to PLANNED or READY. Default is PLANNED (if no value is specified).
object.finnId String Finn ID.
object.finnReference String Finn reference.
object.finnStatus String Status of finn publication. Allowed values: UNPUBLISHED, CREATE_ASSETS, PUBLISHED.
facilities[0..*].name List<String> Required Facility name.
facilities[0..*].position List<Integer> Required Facility placement/position in the list.
showings[0..*].startDate List<Date> Required Showing start date. Format: YYYY-MM-DDTHH:mm:ss.sssZ (milliseconds can be omitted), example: 2016-08-10T15:50:05
showings[0..*].endDate List<Date> Required Showing end date. Format: YYYY-MM-DDTHH:mm:ss.sssZ (milliseconds can be omitted), example: 2016-08-10T15:50:05
object.cabinField.id Long Reference (ID) to cabin field.
object.cabin.id Long Required Reference (ID) to cabin.
object.manualPdfFile File - PDF PDF file to be used instead of the generated file for that marketable cabin

Update existing marketable cabin

Type: PUT

Url: /api/marketable-cabin/{id}

Description: Updates marketable cabin with the given ID.

Parameter Type Notes Description
object.active boolean Sets marketable cabin active or inactive. Inactive cabins won't show in any frontend api methods.
object.name String Required. Unique. Max length: 255 Title of marketable cabin.
object.address String Required Address of marketable cabin.
object.zipCode String Zip code of marketable cabin.
object.area String Area of marketable cabin.
object.lat Double Latitude of which marketable cabin is located (Coordinate).
object.lng Double longitude of which marketable cabin is located (Coordinate).
object.price Double Price of marketable cabin.
object.costs Double Costs of marketable cabin.
object.yearBuilt Integer Year marketable cabin was built.
object.plotArea Double Size of plot area.
object.locationHeader String Header of location of marketable cabin.
object.locationContent String Content of location of marketable cabin.
object.arrivalPlotConditionHeader String Header of arrival plot condition of marketable cabin.
object.arrivalPlotConditionContent String Content of arrival plot condition of marketable cabin.
object.arrivalPlotConditionPicture File - Image Picture of arrival plot condition of marketable cabin.
object.content String Content to be displayed on page of marketable cabin.
object.status String Required Sets status of marketable cabin to PLANNED or READY. Default is PLANNED (if no value is specified).
object.finnId String Finn ID.
object.finnReference String Finn reference.
object.finnStatus String Status of finn publication. Allowed values: UNPUBLISHED, CREATE_ASSETS, PUBLISHED.
facilities[0..*].id List<String> Required for existing Facility name.
facilities[0..*].name List<String> Required Facility name.
facilities[0..*].position List<Integer> Required Facility placement/position in the list.
showings[0..*].id List<Date> Required for existing Showing start date. Format: YYYY-MM-DDTHH:mm:ss.sssZ (milliseconds can be omitted), example: 2016-08-10T15:50:05
showings[0..*].startDate List<Date> Required Showing start date. Format: YYYY-MM-DDTHH:mm:ss.sssZ (milliseconds can be omitted), example: 2016-08-10T15:50:05
showings[0..*].endDate List<Date> Required Showing end date. Format: YYYY-MM-DDTHH:mm:ss.sssZ (milliseconds can be omitted), example: 2016-08-10T15:50:05
object.cabinField.id Long Reference (ID) to cabin field.
object.cabin.id Long Reference (ID) to cabin.
object.manualPdfFile File - PDF PDF file to be used instead of the generated file for that marketable cabin

Delete a marketable cabin

Type: DELETE

Url: /api/marketable-cabin/{id}

Description: Deletes marketable cabin with the given ID.


Fetch all areas

Type: GET

Url: /api/area/all

Description: Gives a list of all Areas that are saved in the database.


Update areas (entire list)

Type: PUT

Url: /api/area

Description: Updates entire area list.

Parameter Type Notes Description
areas[0..*].id String Required for existing ID of existing area to keep (if an update request is sent without ID/IDs of existing entries, existing entries will be deleted. It is also possible to send entire object as is including its ID if that is more convenient).
areas[0..*].name String Required Name of area.
areas[0..*].active boolean Sets area to active or inactive. Default is inactive (if no value is specified).

Fetch all contact persons

Type: GET

Url: /api/contact-person/all

Description: Gives a list of all contact persons that are saved in the database.


Update contact persons (entire list)

Type: PUT

Url: /api/contact-person

Description: Updates entire contact person list.

Parameter Type Notes Description
contactPersons[0..*].id Long Required for existing ID of contact person. To keep an existing entry all you need to provide is the ID of the entry (or the entire object if that is more convenient). That way it will not be deleted from DB
contactPersons[0..*].name String Required Name of contact person.
contactPersons[0..*].picture File - Image Picture of contact person.
contactPersons[0..*].title String Required Title of contact person.
contactPersons[0..*].phone String Required Phone number of contact person.
contactPersons[0..*].email String Required. Email Email of contact person.

Fetch last import

Type: GET

Url: /api/model-import/

Description: Returns an import object which contains information about the import including a download link to file.


Fetch a specific import by ID

Type: GET

Url: /api/model-import/id

Description: Returns an import object which contains information about the import including a download link to file.


Import cabins from MS excel file

Type: POST

Url: /api/model-import

Description: Creates new cabin entry/entries or updates existing.

Parameter Type Notes Description
file File - xlsx Required Microsoft excel file to import cabin/cabins from