MarketObjects
Get List of MarketObjects
Returns a list of active market objects e.g. rental property ads.
Request
Example
Please note that properties returned by the "GET /v2/market/objects” endpoint can be controlled by the property management system’s market object type field configuration. If a field configuration exists for the market object's type then apart from essential properties such as Guid and Types only the fields contained in the market object type’s field configuration will be returned by the “GET /v2/market/objects” endpoint. For more information about market object type field configuration see the “Konfiguration annons fältstyrning” section of the property management system’s manual.
Parameters
| Name |
Description |
| offset |
Used for pagination of the result set. Indicates offset from zero. If not supplied the default value is 0. |
| limit |
Used for pagination of the result set. Indicates the max number of market objects returned. If not supplied the default value is 50. |
| type |
Type of the market object e.g. Bostad or Fordonsplats. |
| sizeRoomsMin |
Filter the result to only contain market objects with a number of rooms greater than or equal to roomsMin. |
| sizeRoomsMax |
Filter the result to only contain market objects with a number of rooms less than or equal to roomsMin. |
| sizeAreaMin |
Filter the result to only contain market objects with a total area greater than or equal to areaMin. |
| sizeAreaMax |
Filter the result to only contain market objects with a total area less than or equal to areaMin. |
| priceMin |
Filter the result to only contain market objects with a total price (base rent and additions) greater than or equal to priceMax. |
| priceMax |
Filter the result to only contain market objects with a total price (base rent and additions) less than or equal to priceMax. |
| availableFrom |
Filter the result to only contain market objects that are available from this date. |
| locationAreaDisplayName |
List (List<string>) of area display names used to filter the response e.g. List<string> {"Centrum Väst"; "Nordstan"}. Names available by /v2/market/objects/areas |
| locationAreaId |
List (List<string>) of area id´s used to filter the response e.g. List<string> {"dfg7Hgsd68"; "KA789Hkxs"}. Id´s available by /v2/market/objects/types/{id}/areas |
| includedDisplayName |
List (List<string>) of included amenity display names used to filter the response e.g. List<string> {"Hiss"; "Balkong"}. Names available by GET /v2/market/objects/includes |
| attribute |
List (List<string>) used to filter the result only to contain attributes contained in the List<MarketObjectsAttributeItem> list. Please note that attributes supplied in the attributes list that are no longer active in the system’s market object type configuration are ignored in the filtering of market objects. This scenario can arise for instance if a client has a cached list of attributes used to filter market objects, but the list contains market object attributes that are no longer active. |
.attribute
| Name |
Description |
List<string> |
List containing attribute items intended to filter the resulet. Each string in the list should be constructed according to the following guidelines. The delimiter “;“ is used to separate the attribute’s guid from the values to be applied in the filter e.g. “lift:true” in the case of a filter applying a Boolean value. If several filter values are to be applied such as in the case of an attribute containing multiple alternatives the delimiter “:” is used to separate the alternatives e.g. “balconyCompassPoint;south:southWest:west”. |
.MarketObjectsAttributeItem
| Name |
Description |
| type |
The attribute type's unique identifier e.g. "balconyCompassPoint", "internet". |
| isNumber |
Indicates that the filter value to be used is numerical. Please note that when isNumber is set to true the minValue and maxValue parameters are to be used and not the value parameter. |
| isText |
Indicates that the filter value to be used is in text form. |
| isDate |
Indicates that the filter value to be used is in date form. Please note that when isDate is set to true the minValue and maxValue parameters are to be used and not the value parameter. |
| isBool |
Indicates that the filter value to be used is in Boolean form. |
| isAlternative |
Indicates that the filter value to be used is in the form of a list of alternatives. |
| value |
Filter value used in conjunction with the isText, isBool and isAlternative parameters e.g. "Min Kommun", "true" or when filtering by attribute alternatives a semicolon separated list such as "yesFrench;yesCorner". |
| minValue |
Filter value used in conjunction with the isNumber and isData parameters e.g. 4, 01-01-1999 etc. |
| maxValue |
Filter value used in conjunction with the isNumber and isData parameters e.g. 12, 01-01-2021 etc. |
Response
Example
{
"count": 1,
"items": [
{
"id": "HdGVfTHPvj4VXkgBFDvvywCm",
"localId": "2594731",
"number": "AN-1020",
"displayName": "Adressgränden 16",
"description": "En ljus och luftig lägenhet med trevligt läge.",
"type": "residential",
"queueType": "residential",
"rentalObjectType": "Lägenhet",
"sortOrder": "queuedate",
"process": "Bostadsuthyrning med granskning",
"pricing": {
"price": 6666.8600,
"priceInclVAT": 6666.8600
},
"location": {
"area": {
"displayName": "Bostadsområde Söder"
},
"areaPath": [
{
"id": "hb76k9PGK9vgPfTcD74bCJWW",
"displayName": "Söder"
}
],
"floorDisplayName": "Våning 2",
"officialApartmentNumber": "1101",
"signNumber": "096"
},
"availability": {
"availableFrom": "2024-12-03T00:00:00+01:00",
"earlyAvailabilityPossible": false,
"earlyAvailabilityPossibleFrom": "2024-09-01T00:00:00+01:00"
},
"publishing": {
"publishedFrom": "2024-12-03T08:58:00+01:00",
"publishedTo": "2024-12-10T23:59:00+01:00"
},
"application": {
"openFrom": "2024-12-03T08:58:00+01:00",
"openTo": "2024-12-10T23:59:00+01:00"
},
"size": {
"roomsDisplayName": "4 rum och kök",
"shortRoomsDisplayName": "4 RK",
"area": 88.0000,
"rooms": 4.0000
},
"thumbnail": {
"exists": true,
"displayName": "Byggnaden på Adressgränden 14-16",
"version": "f-554831"
}
}
]
}
| Name |
Description |
| count |
Total number of market objects returned before paging is applied to the response. |
| id |
Identifier of the market object. |
| number |
Serial number of the market object. |
| displayName |
Header for the market object. |
| type |
Type of the market object e.g. residential or parking. |
| queueType |
Type of queue that the market object is listed under e.g. residential or parking. |
| description |
Text describing the market object. |
| rentalObjectType |
The type of the rental object e.g. Lägenhet or Parkeringsplats. |
| sortOrder |
The sort order applied to the market object's applications in order to determine queue places e.g. Ködatum. |
| process |
The market object's rental process as defined in the property management system e.g. Bostadsuthyrning. |
| pricing |
Total price for the market object i.e. base price and all additions such as cable tv, heating & hot water, electricity etc. |
| location |
Information about the location of the market object, e.g. the era and floor. |
| availability |
Information about the availability of the market object e.g. potential moving in date etc. |
| publishing |
The duration that the market object is published. |
| application |
The duration that the market object is open for applications. |
| size |
Information about the size of the market object. |
| thumbnail |
Information about the market object's thumbnail image. |
.pricing
| Name |
Description |
| price |
Price. |
| priceInclVAT |
Price inclusive of VAT, normally used when the price property is returned exclusive of VAT. |
.application
| Name |
Description |
| openFrom |
Start date of the period under which the market object is open for applications. |
| openTo |
End date of the period under which the market object is open for applications. |
.publishing
| Name |
Description |
| published |
Indicates that the market object is published i.e. today's date is between publishedFrom and publishedTo. |
| publishedFrom |
Start date of the period under which the market object is published. |
| publishedTo |
End date of the period under which the market object is published. |
.availability
| Name |
Description |
| availableFrom |
Date from which the market object is available for rent. |
| earlyAvailabilityPossible |
Indicates whether or not early availability i.e. early moving in date is possible. Please note that even if this property is true early availability is dependent upon consensus being reached between the property rental company and both the previous and new tenant. |
| earlyAvailabilityPossibleFrom |
A date from which it may be possible to move in from. As with the earlyAvailabilityPossible parameter this date is dependent upon consensus being reached between the property rental company and both the previous and new tenant. |
.size
| Name |
Description |
| area |
The market object's floor space in square meters. |
| rooms |
The number of rooms in the market object. |
| roomsDisplayName |
Display name of the market object's size e.g. "2 rum och kök". |
| shortRoomsDisplayName |
Short display name of the market object's size e.g. "2 RK". |
.location
| Name |
Description |
| area |
Information about the geographical location of the market object described below. |
| areaPath |
Information about the geographical location in a rental structure of the market object described below. |
| address |
Information about the address of the market object described below. |
| floorDisplayName |
Floor upon which the market object is to be found e.g. "2" for a rental property found upon the second floor. |
| officialApartmentNumber |
Official number of the market object. |
| signNumber |
The sign number for the market object. |
.location.area
| Name |
Description |
| displayName |
Display name of the market object's district or housing area. |
.location.areaPath
| Name |
Description |
| id |
Id of a market area which the market object is related to. |
| displayName |
Display name of a market area which the market object is related to. |
.location.address
| Name |
Description |
| address |
The market object's address consisting of street name, street number and official number. |
| street |
Street name part of the market object's address. |
| streetNumber |
Street number part of the market object's address. |
| postcode |
Postcode part of the market object's address. |
| city |
City part of the market object's address. |
| country |
Country part of the market object's address. |
| completeAddress |
The market object's complete address consisting of address, postcode, city and country. |
.thumbnail
| Name |
Description |
| exists |
True if the market object has a thumbnail image. Can be retrieved with the GET /v2/market/objects/{id}/thumbnail api. |
| displayName |
alt text. |
| version |
Can be used for cache-bustning. |
Get Market Object
Returns detailed information about a single market object.
Request
Example
GET /v2/market/objects/{id}
Please note that properties returned by the "GET /v2/market/objects/{id}” endpoint can be controlled by the property management system’s market object type field configuration. If a field configuration exists for the market object's type then apart from essential properties such as Guid and Types only the fields contained in the market object type’s field configuration will be returned by the “GET /v2/market/objects/{id}” endpoint. For more information about market object type field configuration see the “Konfiguration annons fältstyrning” section of the property management system’s manual.
Parameters
| Name |
Description |
| id |
Required
The market object's identifier (string), access key (string) or guid (string). |
The id parameter can be a simple identifier (e.g. 123456) an access key (e.g. SL1EmLZ3h9) or guid (e.g. 6e575140e4ae436dade348e917ed5232).
The simple identifier of a market object is normally sent to and returned by the api, e.g. the /market/objects endpoint. If a simple identifier is used to retrieve a single market object, and the market object is no longer published or has not yet been published, status code 404 (not found) is returned.
An access key is typically sent in an email to an applicant or used for market object preview prior to publishing. When an access key is used as an id, it enables access to read market object information after the market object has been unpublished (e.g. withdrawn) or before it has been published, even is the user is not signed in.
Response
Example
{
"id": "HdGVfTHPvj4VXkgBFDvvywCm",
"localId": "2594731",
"number": "AN-1020",
"displayName": "Adressgränden 16",
"description": "En ljus och luftig lägenhet med trevligt läge.",
"type": "residential",
"queueType": "residential",
"queueTypeDisplayName": "Bostad",
"rentalObjectNumber": "102-005-01",
"rentalObjectType": "Lägenhet",
"sortOrder": "Ködatum",
"process": "Bostadsuthyrning med granskning",
"nrApplications": 30,
"queuePointsCurrentPositionX": "567",
"queuePointsLockedPositionX": "345",
"pricing": {
"price": 6666.8600,
"priceInclVAT": 6666.8600
},
"economy": {},
"location": {
"area": {
"displayName": "Bostadsområde Söder"
},
"areaPath": [
{
"id": "hb76k9PGK9vgPfTcD74bCJWW",
"displayName": "Söder"
}
],
"address": {
"address": "Adressgränden 16",
"street": "Adressgränden",
"streetnumber": "16",
"postcode": "11111",
"city": "Uthyrningsorten",
"country": "Sverige",
"completeAdress": "Adressgränden 16, 11111, Uthyrningsorten, Sverige"
},
"floorDisplayName": "Våning 2",
"officialApartmentNumber": "1101",
"signNumber": "096"
},
"availability": {
"availableFrom": "2024-12-03T00:00:00+01:00",
"earlyAvailabilityPossible": false,
"earlyAvailabilityPossibleFrom": "2024-09-01T00:00:00+01:00"
},
"publishing": {
"published": true,
"publishedFrom": "2024-12-03T08:58:00+01:00",
"publishedTo": "2024-12-10T23:59:00+01:00"
},
"application": {
"openFrom": "2024-12-03T08:58:00+01:00",
"openTo": "2024-12-10T23:59:00+01:00"
},
"size": {
"roomsDisplayName": "4 rum och kök",
"shortRoomsDisplayName": "4 RK",
"area": 88.0000,
"rooms": 4.0000
},
"included": [
{
"displayName": "Parkett"
},
{
"displayName": "Säkerhetsdörr"
}
],
"attributes": [
{
"type": "digitalLaundryReservation",
"typeDisplayName": "Digital tvättbokning",
"value": "Ja"
},
{
"type": "lift",
"typeIcon": {
"svg": "M19 5V19H5V5H19M19 3H5C3.9 3 3 3.9 3 5V19C3 20.1 3.9 21 5 21H19C20.1 21 21 20.1 21 19V5C21 3.9 20.1 3 19 3M10 18V14H11V11.5C11 10.4 10.1 9.5 9 9.5H8C6.9 9.5 6 10.4 6 11.5V14H7V18H10M8.5 8.5C9.19 8.5 9.75 7.94 9.75 7.25S9.19 6 8.5 6 7.25 6.56 7.25 7.25 7.81 8.5 8.5 8.5M18 11L15.5 7L13 11H18M13 13L15.5 17L18 13H13Z"
},
"typeDisplayName": "Hiss",
"value": "Ja"
}
]
"info": {
"list": [
{
"displayName": "Om lägenheten",
"value": "En ljus och luftig lägenhet med trevligt läge.",
"linkedToType": "building",
"typeOrder": 15
}
],
"area": [
{
"displayName": "Om Söder",
"value": "I den gamla stadskärnan på söder finns vackra tegelbyggnader, smala gator och en trivsam stämning. I den kulturmärkta timmerstadens kullerstensgator finns lugna och vackra innergårdar.",
"linkedToType": "residentialArea",
"typeOrder": 50
}
],
"company": [
{
"displayName": "Om oss",
"value": "Hos oss på Bostadsbolaget finns stora möjligheter att växa och trivas i ett vackert och tryggt hem.\n\nVi erbjuder attraktiva hyresrätter för boende och lokaler för många olika verksamheter i hela staden.\n\nGenom ett stort engagemang gentemot våra hyresgäster vill vi tillsammans med våra samarbetspartners bidra till en hållbar framtid och nutid.",
"linkedToType": "organisation1",
"typeOrder": 60
}
]
},
"files": {
"locationImage": [
{
"displayName": "Byggnaden på Adressgränden 14-16",
"mimeType": "image/jpeg",
"address": "https://localhost/propertymain-property-api-portal/v2/market/objects/HdGVfTHPvj4VXkgBFDvvywCm/images/554831?mimeType=image/jpeg",
"linkedToType": "building"
},
{
"displayName": "Vardagsrummet",
"mimeType": "image/jpeg",
"address": "https://localhost/propertymain-property-api-portal/v2/market/objects/HdGVfTHPvj4VXkgBFDvvywCm/images/554781?mimeType=image/jpeg",
"linkedToType": "building"
},
{
"displayName": "Köket",
"mimeType": "image/jpeg",
"address": "https://localhost/propertymain-property-api-portal/v2/market/objects/HdGVfTHPvj4VXkgBFDvvywCm/images/554780?mimeType=image/jpeg",
"linkedToType": "building"
},
{
"displayName": "Sovrummet",
"mimeType": "image/jpeg",
"address": "https://localhost/propertymain-property-api-portal/v2/market/objects/HdGVfTHPvj4VXkgBFDvvywCm/images/554782?mimeType=image/jpeg",
"linkedToType": "building"
},
{
"displayName": "Badrummet",
"mimeType": "image/jpeg",
"address": "https://localhost/propertymain-property-api-portal/v2/market/objects/HdGVfTHPvj4VXkgBFDvvywCm/images/554783?mimeType=image/jpeg",
"linkedToType": "building"
}
]
},
"thumbnail": {
"exists": true,
"displayName": "Byggnaden på Adressgränden 14-16"
}
}
| Name |
Description |
| id |
Identifier of the market object. |
| number |
Serial number of the market object. |
| displayName |
Header for the market object. |
| description |
Text to display as list text. The text to display is collected from the most specific level. If set at "building" and "object" only the text from the object is listed. If more than one text is listed the texts is concatenated. |
| type |
Type of the market object e.g. residential or parking. |
| queueType |
Type of queue that the market object is listed under e.g. residential or parking. |
| queueTypeDisplayName |
Display name of the queue that the market object is listed under e.g. Bostad or Fordonsplats. |
| rentalObjectType |
The type of the rental object e.g. Lägenhet or Parkeringsplats. |
| rentalObjectNumber |
The rental object's identifying number as is shown in the property management system e.g. 123-321-01. |
| sortOrder |
The sort order applied to the market object's applications in order to determine queue places e.g. Ködatum. |
| process |
The market object's rental process as defined in the property management system e.g. Bostadsuthyrning. |
| nrApplications |
The market object's current number of active applications. |
| queuePointsCurrentPositionX |
The number of queue points held by the applicant att a specified place, x, in the queue. In this case the current queue place amongst active applications is shown. |
| queuePointsLockedPositionX |
The locked of queue points held by the applicant att a specified place, x, in the queue. In this case the queue place allocated when the queue was locked as part of a rental process is shown. |
| pricing |
Total price for the market object i.e. base price and all additions such as cable tv, heating & hot water, electricity etc. |
| economy |
Financial properties relevant to the market object such as e.g billing period. |
| application |
The duration that the market object is open for applications. |
| publishing |
The duration that the market object is published. |
| withdrawal |
Information to be displayed if the market object has been withdrawn from publication. |
| availability |
Information about the availability of the market object e.g. potential moving in date etc. |
| size |
Information about the size of the market object. |
| location |
Information about the location of the market object, e.g. the address and floor of the market object. |
| thumbnail |
Information about the market object's thumbnail image. |
| included |
List (List<string>) of the market object's included amenities e.g. List<string> {"Diskmaskin"; "Parkett"}. |
| attributes |
List (List<MarketObjectsItemAttribute>) of the market object’s attributes such as balcony compass point, internet etc. |
| info |
Dictionary (Dictionary<string, MarketObjectsItemInfo>), containing information about the market object to be used for presentation purposes e.g. important, object, location. |
| files |
Dictionary (Dictionary<string, MarketObjectsItemFile>), containing images and other files to be used for presentation purposes e.g. image, locationImage. |
.pricing
| Name |
Description |
| price |
Price. |
| priceInclVAT |
Price inclusive of VAT, normally used when the price property is returned exclusive of VAT. |
.economy
| Name |
Description |
| billingPeriodDescription |
Billing period description. |
| billingPeriodDisplayName |
Billing period display name. |
.application
| Name |
Description |
| openFrom |
Start date of the period under which the market object is open for applications. |
| openTo |
End date of the period under which the market object is open for applications. |
.publishing
| Name |
Description |
| published |
Indicates that the market object is published i.e. today's date is between publishedFrom and publishedTo. |
| publishedFrom |
Start date of the period under which the market object is published. |
| publishedTo |
End date of the period under which the market object is published. |
.withdrawal
| Name |
Description |
| withdrawn |
Indicates that the market object has been withdrawn from publication. |
| description |
Text explaining why the market object as been withdrawn from publication. |
.availability
| Name |
Description |
| availableFrom |
Date from which the market object is available for rent. |
| earlyAvailabilityPossible |
Indicates whether or not early availability i.e. early moving in date is possible. Please note that even if this property is true early availability is dependent upon consensus being reached between the property rental company and both the previous and new tenant. |
| earlyAvailabilityPossibleFrom |
A date from which it may be possible to move in from. As with the earlyAvailabilityPossible parameter this date is dependent upon consensus being reached between the property rental company and both the previous and new tenant. |
.size
| Name |
Description |
| area |
The market object's floor space in square meters. |
| rooms |
The number of rooms in the market object. |
| roomsDisplayName |
Display name of the market object's size e.g. "2 rum och kök". |
| shortRoomsDisplayName |
Short display name of the market object's size e.g. "2 RK". |
.location
| Name |
Description |
| area |
Information about the geographical location of the market object described below. |
| areaPath |
Information about the geographical location in a rental structure of the market object described below. |
| address |
Information about the address of the market object described below. |
| floorDisplayName |
Floor upon which the market object is to be found e.g. "2" for a rental property found upon the second floor. |
| officialApartmentNumber |
Official number of the market object. |
| signNumber |
The sign number for the market object. |
.location.area
| Name |
Description |
| displayName |
Display name of the market object's district or housing area. |
.location.areaPath
| Name |
Description |
| id |
Id of a market area which the market object is related to. |
| displayName |
Display name of a market area which the market object is related to. |
.location.address
| Name |
Description |
| address |
The market object's address consisting typically of street name, street number and official number. |
| street |
Street name part of the market object's address. |
| streetNumber |
Street number part of the market object's address. |
| postcode |
Postcode part of the market object's address. |
| city |
City part of the market object's address. |
| country |
Country part of the market object's address. |
| completeAddress |
The market object's complete address consisting of address, postcode, city and country. |
.thumbnail
| Name |
Description |
| exists |
True if the market object has a thumbnail picture. Can be retrieved with the GET /v2/market/objects/{id}/thumbnail?version=xxxx api. |
| displayName |
alt text. |
.attributes
| Name |
Description |
List<MarketObjectsItemAttribute> |
List containing the market object’s attributes e.g. balcony compass point, internet etc. |
.MarketObjectsItemAttribute
| Name |
Description |
| type |
The attribute's unique identifier e.g. "balconyCompassPoint", "internet". |
| typeIcon |
MarketObjectsItemAttributeIcon item containing an icon in the form of a svg image string to be used for presentation purposes. |
| typeDisplayName |
The attribute's display name e.g. "Balkong vädersträck", "Internet". |
| value |
The attribute's value in the form of a text string e.g. "Ja", "NÖ", "Stadsnät". |
MarketObjectsItemAttribute.MarketObjectsItemAttributeIcon
| Name |
Description |
| svg |
An icon representing the attribute in the form of a svg image string. |
.info
| Name |
Description |
Dictionary<string, MarketObjectsItemInfo> |
Dictionary containing information about the market object to be used for presentation purposes e.g. important, object, location. |
.MarketObjectsItemInfo
| Name |
Description |
| displayName |
Display name of the text e.g. Floor plan. |
| value |
Text to be used when presenting the market object. Please note that it’s possible for the value text to be formatted with markdown if this has been configured for the text type. If this is the case then this must be handled by the client displaying the text. Furthermore, formatting with markdown is left up to the discretion of the author when creating texts meaning that text types configured to be formatted with markdown may or not be formatted with markdown. |
| link |
Url to external resources. |
| file |
MarketObjectsItemFile item containing image to be used in conjunction with the presentation text. |
MarketObjectsItemInfo.MarketObjectsItemFile
| Name |
Description |
| mimeType |
Mime type of the image used in conjunction with the presentation text e.g. image/png, image/jpeg etc. |
| address |
Adress to the file via the /v2/market/objects/{id}/images/{fileId} route. |
.files
| Name |
Description |
Dictionary<string, MarketObjectsItemFile> |
Dictionary containing images and other files to be used for presentation purposes e.g. image, locationImage. |
.MarketObjectsItemFile
| Name |
Description |
| displayName |
Display name of the file e.g. Floor plan. |
| description |
File description e.g. Apartment block exterior image. |
| mimeType |
Mime type of the image used in conjunction with the presentation text e.g. image/png, image/jpeg etc. |
| address |
Image Id to be used when retrieving the image via the /v2/market/objects/{id}/images/{fileId} route. |
Get Market Object Status Item
Retrieves status of a specific market object for the current user, e.g. if the current user may post a new application for the market object or the status of an existing application linked to the market object.
Request
Example
GET /v2/market/objects/{id}/status
Parameters
| Name |
Description |
| id |
Required
The market object's identifier (string), access key (string) or guid (string). |
| removedApplications |
If an actors application is deleted this parameter determines whether a deleted application's details are returned as part of the response. |
Response
Example
{
"applied": true,
"allowContact": false,
"commands": [
{
"command": "apply",
"displayName": "Intresseanmäl",
"checklist": [
{
"passed": false,
"type": "applied",
"message": "Intresseanmälan redan gjord"
},
{
"passed": true,
"type": "open",
"message": "Intresseanmälan möjlig t o m 2021-05-09 23:59"
},
{
"passed": true,
"type": "applicant"
},
{
"passed": true,
"type": "login"
},
{
"passed": true,
"type": "queue"
},
{
"passed": true,
"type": "consent"
},
{
"passed": false,
"type": "age min application",
"message": "Minimiålder för att intresseanmäla sig är 18 år"
},
{
"passed": true,
"type": "age max application"
}
]
}
],
"applications": [
{
"id": "551",
"statusDisplayName": "Anmäld"
}
// Example of an application that can be deleted:
{
"id": "139649",
"statusDisplayName": "Intresseanmäld",
"commands": [
{
"command": "remove",
"displayName": "Ta bort"
}
]
},
]
}
| Name |
Description |
| applied |
True if the actor has applied for the market object. |
| allowContact |
True if the contact property can be set on the POST /v2/market/object/{id}/applications API. |
| commands |
Available commands to perform on the market object. |
| applications |
Information about applications the actor has made for the market object. |
.commands
| Name |
Description |
| command |
Nonnumerical identity of the command e.g. apply. |
| displayName |
Display name of the command. |
| checklist |
A set of criteria that must be fulfilled in able to perform the command. |
.checklist
| Name |
Description |
| passed |
If the user's profile fulfils the criteria. |
| type |
Name of the criteria to be fulfilled. |
| message |
Message to be presented to the user if the criteria has not been fulfilled in the passed property. |
Get Market Object Image
Retrieve an image for presentation via the v2/market/objects or v2/market/objects/{id} api.
In the files section use the id found in address property.
Request
Example
GET /v2/market/objects/{id}/images/{fileId}
Parameters
| Name |
Description |
| id |
Required
The market object's identifier (string), access key (string) or guid (string) for which the image resource is to be retrieved. |
| fileId |
Required
Image Id of the resource to be retrieved. |
| mimeType |
The mimeType of the resource to be retrieved. Can be fetched with GET /v2/market/objects/{id}. If not entered then default mimeType image/jpeg is used. |
| width |
Required width of the image after transformation. If either width or height is null no size transformation is carried out. |
| height |
Required height of the image after transformation. If either width or height is null no size transformation is carried out. |
Get Market Object File
Retrieve an file for presentation via the v2/market/objects or v2/market/objects/{id} api.
In the files section use the id found in address property.
Request
Example
GET /v2/market/objects/{id}/files/{fileId}
Parameters
| Name |
Description |
| id |
Required
The market object's identifier (string), access key (string) or guid (string) for which the image resource is to be retrieved. |
| fileId |
Required
Id of the resource to be retrieved. |
| mimeType |
Required
The mimeType of the resource to be retrieved. Can be fetched with GET /v2/market/objects/{id}. |
Get Market Object Thumbnail Image
Retrieve a thumbnail image for the market object.
Gets the first image found in following order. Market object image, location image and area image.
Request
Example
GET /v2/market/objects/{id}/thumbnail
Parameters
| Name |
Description |
| id |
Required
The market object's identifier (string), access key (string) or guid (string) for which the thumbnail image is to be retrieved. |
| width |
Required width of the image after transformation. If either width or height is null no size transformation is carried out. |
| height |
Required height of the image after transformation. If either width or height is null no size transformation is carried out. |
| version |
Can be used for cache-bustning. Retrived from /v2/market/objects thumbnail->version propertyn. |
Get Market Object Types
Retrieve information about a specific market object type.
Request
Example
GET /v2/market/objects/types/{id}
Parameters
| Name |
Description |
| id |
Non-numerical identifier of the market object type found in the api /v2/client/configuration property market.types |
Response
Example
{
"displayName": "Bostad",
"description": "Testar en annonstypbeskrivning",
"minNumberOfRooms": "1",
"maxNumberOfRooms": "7",
"minSize": "15",
"maxSize": "300",
"minPrice": "1500",
"maxPrice": "15000",
"numberOfMarketObjects": 2,
"areas": [
"Centrum, väst, Falun"
],
"includes": [
"Balkong",
"Hiss",
"Ej Hiss"
],
"sizeRoomsDisplayName": [
"5 RK",
"4 RK"
],
"attributes": [
{
"type": "balcony",
"typeIcon": {
"svg": "M10 10V12H8V10H10M16 12V10H14V12H16M21 14V22H3V14H4V10C4 5.58 7.58 2 12 2S20 5.58 20 10V14H21M7 16H5V20H7V16M11 16H9V20H11V16M11 4.08C8.16 4.56 6 7.03 6 10V14H11V4.08M13 14H18V10C18 7.03 15.84 4.56 13 4.08V14M15 16H13V20H15V16M19 16H17V20H19V16Z"
},
"typeDisplayName": "Balkong",
"isAlternative": true,
"alternatives": [
{
"id": "yes",
"displayName": "Ja"
},
{
"id": "yesFrench",
"displayName": "Ja, fransk"
},
{
"id": "yesCorner",
"displayName": "Ja, hörnbalkong"
},
{
"id": "yesGlazed",
"displayName": "Ja, inglasad"
}
]
},
{
"type": "lift",
"typeIcon": {
"svg": "M19 5V19H5V5H19M19 3H5C3.9 3 3 3.9 3 5V19C3 20.1 3.9 21 5 21H19C20.1 21 21 20.1 21 19V5C21 3.9 20.1 3 19 3M10 18V14H11V11.5C11 10.4 10.1 9.5 9 9.5H8C6.9 9.5 6 10.4 6 11.5V14H7V18H10M8.5 8.5C9.19 8.5 9.75 7.94 9.75 7.25S9.19 6 8.5 6 7.25 6.56 7.25 7.25 7.81 8.5 8.5 8.5M18 11L15.5 7L13 11H18M13 13L15.5 17L18 13H13Z"
},
"typeDisplayName": "Hiss",
"canHaveFilter": true,
"isBool": true
},
{
"type": "internet",
"typeIcon": {
"svg": "M12,21L15.6,16.2C14.6,15.45 13.35,15 12,15C10.65,15 9.4,15.45 8.4,16.2L12,21M12,3C7.95,3 4.21,4.34 1.2,6.6L3,9C5.5,7.12 8.62,6 12,6C15.38,6 18.5,7.12 21,9L22.8,6.6C19.79,4.34 16.05,3 12,3M12,9C9.3,9 6.81,9.89 4.8,11.4L6.6,13.8C8.1,12.67 9.97,12 12,12C14.03,12 15.9,12.67 17.4,13.8L19.2,11.4C17.19,9.89 14.7,9 12,9Z"
},
"typeDisplayName": "Internet",
"isAlternative": true,
"alternatives": [
{
"id": "mAN",
"displayName": "Stadsnät"
},
{
"id": "notIncluded",
"displayName": "Ingår ej"
}
]
}
],
"singleMarketObjektDataFields": [
{
"type": "displayName",
"displayName": "Annonsbeteckning",
"order": 10
},
{
"type": "files",
"displayName": "Filer",
"order": 20
},
{
"type": "location.address",
"displayName": "Adress",
"order": 30
},
{
"type": "location.area.displayName",
"displayName": "Områdesbeteckning",
"order": 40
}
],
"marketObjektListDataFields": [
{
"type": "thumbnail",
"displayName": "Miniatyrbild",
"order": 10
},
{
"type": "displayName",
"displayName": "Annonsbeteckning",
"order": 20
},
{
"type": "location.area.displayName",
"displayName": "Områdesbeteckning",
"order": 30
}
]
}
| Name |
Description |
| displayName |
Display name of the market object type. |
| discription |
Description for the market object type. |
| minNumberOfRooms |
Min number of rooms to be used when presenting filter options for the listing of market objects. |
| maxNumberOfRooms |
Max number of rooms to be used when presenting filter options for the listing of market objects. |
| minSize |
Min area size of rentable objects to be used when presenting filter options for the listing of market objects. |
| maxSize |
Max area size of rentable objects to be used when presenting filter options for the listing of market objects. |
| minPrice |
Max price of rentable objects to be used when presenting filter options for the listing of market objects. |
| maxPrice |
Max price of rentable objects to be used when presenting filter options for the listing of market objects. |
| numberOfMarketObjects |
Number of active published market objects of the market object type. |
| areas |
List of district or housing area display names for all of the market objects of the market object type. |
| includes |
List of included amenity display names for all of the market objects of the market object types. |
| sizeRoomsDisplayName |
List of size display names for the market objects of the market object type, to be used when presenting filter options for the listing of market objects. |
| attributes |
List (List<MarketObjectsTypesItemAttribute>) of the market object type's attributes such as balcony type, internet etc. |
| singleMarketObjektDataFields |
List (List<MarketObjectDataFieldProtected>) of fields to be used when displaying a single market object via the v2/market/objects/{id} endpoint and there is a wish to control which fields are returned. Please note that to utilise this function the "Annons fältstyrning" feature flag must be activated. When this property is set only fields contained in the singleMarketObjektDataFields will be returned by the v2/market/objects/{id} endpoint. When this property is not set all fields will be returned by the v2/market/objects/{id} endpoint. |
| marketObjektListDataFields |
List (List<MarketObjectDataFieldProtected>) of fields to be used when displaying a list of market objects via the v2/market/objects endpoint and there is a wish to control which fields are returned. Please note that to utilise this function the "Annons fältstyrning" feature flag must be activated. When this property is set only fields contained in the singleMarketObjektDataFields will be returned by the v2/market/objects endpoint. When this property is not set all fields will be returned by the v2/market/objects endpoint. |
.attributes
| Name |
Description |
List<MarketObjectsTypesItemAttribute> |
List containing tthe market object type's attributes such as balcony type, internet etc. |
.MarketObjectsTypesItemAttribute
| Name |
Description |
| type |
The attribute type's unique identifier e.g. balconyCompassPoint, internet. |
| typeIcon |
MarketObjectsTypesItemAttributeIcon item containing an icon in the form of a svg image string to be used for presentation purposes. |
| typeDisplayName |
The attribute type's display name e.g. Balkong vädersträck, Internet. |
| canHaveFilter |
Indicates whether it is possible to use the attribute typ to search for market objects. It is not recommended to filter market objects using attributes where the canHaveFilter value is false. |
| isNumber |
Indicates that the attribute type’s values are numerical. |
| isText |
Indicates that the attribute type’s values are in text form. |
| isDate |
Indicates that the attribute type’s values are in date form. |
| isBool |
Indicates that the attribute type’s values are in Boolean form. |
| isAlternative |
Indicates that the attribute type’s values are in the form of a list of alternatives. |
| alternatives |
List (List<MarketObjectsTypesItemAttributeAlternative>) of the market object type's searchable alternatives e.g. if the attribute type is balcony the list will contain balcony types such as Ja, fransk, Ja, hörnbalkong etc. |
MarketObjectsTypesItemAttribute.MarketObjectsTypesItemAttributeIcon
| Name |
Description |
| svg |
An icon representing the attribute in the form of a svg image string. |
MarketObjectsTypesItemAttribute.MarketObjectsTypesItemAttributeAlternative
| Name |
Description |
| id |
The alternative's unique identifier e.g. "yesFrench", "yesCorner". |
| displayName |
The alternative's display name e.g. "Ja, fransk", "Ja, hörnbalkong". |
Get Market Object Areas
Retrieve information about all the areas in which market objects are residing in.
Can be used for presenting all the searchable areas when finding market objects.
Request
Example
GET /v2/market/objects/areas
Response
Example
{
"count": 2,
"items": [
{
"id": "152ed189fc8b46dbaf893265505bec0f",
"displayName": "Centrum, väst, Falun"
},
{
"id": "d1416da26adc40f3b6ad8901ed309e66",
"displayName": "Centrum öst"
}
]
}
| Name |
Description |
| count |
Total number of areas. |
| items |
Information about each of the areas. |
.items
| Name |
Description |
| id |
Unique identifier of the area. |
| displayName |
Display name for the area. |
Get Market Object Areas for a specific object type
Retrieve information about all the areas in which market objects are residing in.
Can be used for presenting all the searchable areas when finding market objects.
Returning a structure of market object areas.
The types id's to use as id parameter is fetched from /v2/client/configuration and the market/types/id property in the output.
Request
Example
GET /v2/market/objects/types/{id}/areas
Response
Example
{
"count": 2,
"items": [
{
"id": "JmhhjrrMTpBBkqqgmwQMTwrF",
"displayName": "Västernorrland",
"areas": [
{
"id": "Rpcv6jp6WjQhJvMVv6hVDfdF",
"displayName": "Härnösand",
"areas": [
{
"id": "7QBhx9YMBK9HCpFHFpCcCMkV",
"displayName": "Brännan"
},
{
"id": "TV8kFRXQXb64PTfytyhMFBJf",
"displayName": "Specksta"
},
{
"id": "fwPWdXpJVhjfQRjFQDpxwbvH",
"displayName": "Centrum"
}
]
},
{
"id": "fDbKkwMrqv8rxjrHkxBb6mpy",
"displayName": "Kramfors"
},
{
"id": "MtFTDCW9xchjfCcdVTQp9B6t",
"displayName": "Timrå"
}
]
},
{
"id": "hBhvJ46Bx7DhvbXRHYKRJFTF",
"displayName": "Medelpad",
"areas": [
{
"id": "GTXwPkQJRYvyvTBq6HmPjvxQ",
"displayName": "Bräcke"
},
{
"id": "7Y4MRgmWW4v4kxKdQWhFQfdb",
"displayName": "Njurunda"
}
]
}
]
}
| Name |
Description |
| count |
Total number of areas. |
| displayName |
Name of the area. |
| items |
If the area is diveded into further areas then a structure of sub-areas. |
.items
| Name |
Description |
| id |
Unique identifier of the area. |
| displayName |
Display name for the area. |
Get Market Object Includes
Retrieve information about all the includes selectable for market objects.
Can be used for presenting all the searchable includes when finding market objects.
Request
Example
GET /v2/market/objects/includes
Response
Example
{
"count": 2,
"items": [
{
"displayName": "Balkong"
},
{
"displayName": "Braskamin"
}
]
}
| Name |
Description |
| count |
Total number of areas. |
| items |
Information about each of the includes. |
.items
| Name |
Description |
| displayName |
Display name for the includes. |
Get Market Object Types Subscriptions Setting
Retrieve information about a specific market object type's subscription setting.
Request
Example
GET /v2/market/objects/types/{id}/subscriptions/setting
Parameters
| Name |
Description |
| id |
Nonnumerical identifier of the market object type found in the api /v2/client/configuration property market.types |
Response
Example
{
"numberOfRoomsMin": false,
"areaMin": false,
"priceMax": false,
"areas": false
}
| Name |
Description |
| numberOfRoomsMin |
If it's allowed to subscribe on the minimum number of rooms on the market object. |
| areaMin |
If it's allowed to subscribe on the minimum area size property on the market object. |
| priceMax |
If it's allowed to subscribe on the maximum price property on the market object. |
| areas |
If it's allowed to subscribe on market objets in a residing in a specific area. |
Post Market Object Application Item
Post command on an application item for a specific market object.
Request
Example
POST /v2/market/{marketObjectId}/applications/{id}
Parameters
| Name |
Description |
| marketObjectId |
Id (local database id, guid or access key) of the market object found in the api /v2/market/objects property MarketObjects.id |
| id |
Id of the application. |
| command |
Command to execute on the application for the current user. |
.command
| Name |
Description |
| type |
Type of command to execute on the application. E.g. yes or no. |
Post Market Object Application
Post application command on specific market object.
Request
Example
POST /v2/market/{id}/applications
Parameters
| Name |
Description |
| id |
Id (local database id, guid or access key) of the market object found in the api /v2/market/objects property MarketObjects.id |
| command |
Command to execute on the application for the current user. |
| contact |
Contact information. Can only be set when using the command type apply and when allowContact is true in GET /v2/market/{id}/application API. |
.command
| Name |
Description |
| type |
Name of the command the execute on the application for the current user. |
| Name |
Description |
| name |
Name of the applicant. |
| phone |
Landline phone number of the applicant. |
| mobile |
Mobile phone number of the applicant. |
| email |
Email address of the applicant. |