curl "https://connect.maklare.vitec.net/PublicAdvertising/CommercialProperty/StringValue/StringValue" -X GET -H "Authorization: basic {Base64 kodad användarnamn och lösenord}"
Dokumentation för API-funktioner
GET PublicAdvertising/CommercialProperty/{customerId}/{id}
Hämta kommersiellt objekt
Request Information
URI Parameters
Response Information
Resource Description
Hämta kommersiellt objekt
CommercialProperty
Kodexempel
Testformulär
Text input
Response Formats
| Namn | Beskrivning | Typ | Information |
| customerId | Kundid | string |
Krävs |
| id | Bostadens id | string |
Krävs |
| Namn | Beskrivning | Typ | Information |
| PropertyDesignation | Fastighetsbeteckning | string | |
| Marketing | Marknadsföring | CommercialPropertyMarketing | |
| Price | Prisuppgift | Price | |
| Buildings | Byggnader | Collection of CommercialPropertyBuilding | |
| Surfaces | Ytor | CommercialPropertySurfaces | |
| Business | Rörelse (Endast ifall det är försäljning av en rörelse) | CommercialPropertyBusiness | |
| Expenses | Utgifter | CommercialPropertyExpenses | |
| Type | Typ av fastighet | CommercialPropertyType | |
| VerifiedBidding | Verified budgivning | VerifiedBidding | |
| Id | Bostadens id | string | |
| Status | Status på försäljningen/uthyrningen. | EstateStatus | |
| OfficeAffiliation | Kontorstillhörighet | OfficeAffiliation | |
| CustomAttributes | Ytterligare specialiseringsattribut | Dictionary of string [key] and string [value] | |
| PrimaryAgentId | Id på huvudhandläggare | string | |
| SecondaryAgentId | Id på andrahandläggare | string | |
| Address | Adress och geografiska uppgifter | Address | |
| Texts | Texter | Texts | |
| Surroundings | Närområde | Surroundings | |
| AcceptingBids | Om budgivning pågår | boolean | |
| IsVerifiedBidding | Om budgivningen är en verifierad budgivning | boolean | |
| ChangedAt | När bostaden senast ändrades | date | |
| AdmissionAt | Tillträde vid | date | |
| Urls | Url:er | Urls | |
| Files | Filer | Collection of File | |
| Viewings | Visningar | Collection of Viewing | |
| Images | Bilder | Collection of Image | |
| IsAdvertisedOnHomepage | Annonserad på hemsida | boolean |
$URL = "https://connect.maklare.vitec.net/PublicAdvertising/CommercialProperty/StringValue/StringValue"
Invoke-WebRequest -Uri $URL -Method GET -Headers @{"authorization" = "basic {Base64 kodad användarnamn och lösenord}"}
// HttpClientInstance ska deklareras som en singleton
// public static readonly HttpClient HttpClientInstance = new HttpClient {
// BaseAddress = new Uri("https://connect.maklare.vitec.net"),
// DefaultRequestHeaders = {
// Authorization = new AuthenticationHeaderValue("Basic", "{Base64 kodad användarnamn och lösenord}")
// }
// }
using (var response = await HttpClientInstance.GetAsync("PublicAdvertising/CommercialProperty/StringValue/StringValue")) {
if (response.StatusCode == HttpStatusCode.Unauthorized) {
// Authorization headern är inte korrekt
}
if (response.StatusCode == HttpStatusCode.Forbidden) {
// Begärt data som det saknas åtkomst till
}
if (response.StatusCode == HttpStatusCode.InternalServerError) {
// Oväntat fel, kontakta Vitec
}
if (response.StatusCode == HttpStatusCode.BadRequest) {
var json = await response.Content.ReadAsStringAsync();
var result = JsonConvert.DeserializeObject<dynamic>(json);
// Hantera valideringsfel, presenteras i resultatet
}
var json = await response.Content.ReadAsStringAsync();
// JsonConvert finns i biblioteket Newtonsoft.Json
var result = JsonConvert.DeserializeObject<dynamic>(json);
var propertyDesignation = result.propertyDesignation.Value ;
// TODO: Gör något med resultatet
}
$URL = "https://connect.maklare.vitec.net/PublicAdvertising/CommercialProperty/StringValue/StringValue";
$ch = curl_init();
curl_setopt($ch, CURLOPT_USERNAME, "{Användarnamn}");
curl_setopt($ch, CURLOPT_PASSWORD, "{Lösenord}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_URL, $URL);
$result = curl_exec($ch);
if (curl_errno($ch)) {
die(curl_getinfo($ch));
}
$info = curl_getinfo($ch);
curl_close($ch);
$http_code = $info["http_code"];
if ($http_code == 401) {
// Användarnamnet eller lösenordet är felaktigt
}
if ($http_code == 403) {
// Begärt data som det saknas åtkomst till
}
if ($http_code == 500) {
// Oväntat fel, kontakta Vitec
}
if ($http_code == 400) {
$json = json_decode($result, true);
// Hantera valideringsfel, presenteras i $json
}
$field_on_result = $result["propertyDesignation"];
// TODO: Gör något med resultatet
Resultat av begäran
{
"propertyDesignation": "sample string 1",
"marketing": {
"residental": true,
"retail": true,
"industrial": true,
"office": true,
"warehouse": true,
"premises": true,
"plot": true,
"business": true,
"isOtherType": true,
"isFutureSale": true,
"isSoonForSale": true
},
"price": {
"swedishCurrency": 1.1,
"foreignCurrency": {
"value": 1.1,
"currency": "sample string 2"
},
"text": "sample string 2"
},
"buildings": [
{
"name": "sample string 1",
"yearBuilt": 2,
"numberOfFloors": 3.1,
"elevator": "Exists"
},
{
"name": "sample string 1",
"yearBuilt": 2,
"numberOfFloors": 3.1,
"elevator": "Exists"
}
],
"surfaces": {
"livingSpace": {
"value": 1.1,
"unit": "sample string 2"
},
"office": {
"value": 1.1,
"unit": "sample string 2"
},
"workshop": {
"value": 1.1,
"unit": "sample string 2"
},
"retail": {
"value": 1.1,
"unit": "sample string 2"
},
"storage": {
"value": 1.1,
"unit": "sample string 2"
},
"plot": {
"value": 1.1,
"unit": "sample string 2"
},
"other": {
"value": 1.1,
"unit": "sample string 2"
},
"total": {
"value": 1.1,
"unit": "sample string 2"
}
},
"business": {
"lineOfBusiness": "Shop",
"revenue": {
"value": 1.1,
"currency": "sample string 2"
},
"profitable": "Unspecified",
"activity": "sample string 1",
"numberOfEmployees": 1,
"equipment": "sample string 2",
"establishedYear": 1
},
"expenses": {
"operatingCost": 1.1
},
"type": "Industrial",
"verifiedBidding": {
"id": "sample string 1",
"name": "sample string 2",
"isActive": true
},
"id": "sample string 2",
"status": "SoonForSale",
"officeAffiliation": {
"officeId": "sample string 1",
"customerId": "sample string 2"
},
"customAttributes": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"primaryAgentId": "sample string 3",
"secondaryAgentId": "sample string 4",
"address": {
"streetAddress": "sample string 1",
"zipCode": "sample string 2",
"city": "sample string 3",
"areaName": "sample string 4",
"countryCode": "sample string 5",
"countyMunicipalityParishCode": "sample string 6",
"wgs84Coordinate": {
"longitude": 1.1,
"latitude": 2.1
},
"directions": "sample string 7"
},
"texts": {
"shortSaleDescription": "sample string 1",
"saleDescription": "sample string 2",
"salePhrase": "sample string 3",
"saleHeading": "sample string 4"
},
"surroundings": {
"service": "sample string 1",
"communication": "sample string 2",
"generalAboutArea": "sample string 3",
"parking": "sample string 4",
"other": "sample string 5"
},
"acceptingBids": true,
"isVerifiedBidding": true,
"changedAt": "2025-10-20T22:54:22.554473+02:00",
"admissionAt": "2025-10-20T22:54:22.554473+02:00",
"urls": {
"description": "sample string 1",
"imageList": "sample string 2"
},
"files": [
{
"id": "sample string 1",
"extension": "sample string 2",
"description": "sample string 3",
"dataChangedAt": "2025-10-20T22:54:22.554473+02:00"
},
{
"id": "sample string 1",
"extension": "sample string 2",
"description": "sample string 3",
"dataChangedAt": "2025-10-20T22:54:22.554473+02:00"
}
],
"viewings": [
{
"id": "sample string 1",
"startsAt": "2025-10-20T22:54:22.554473+02:00",
"endsAt": "2025-10-20T22:54:22.554473+02:00",
"comment": "sample string 4"
},
{
"id": "sample string 1",
"startsAt": "2025-10-20T22:54:22.554473+02:00",
"endsAt": "2025-10-20T22:54:22.554473+02:00",
"comment": "sample string 4"
}
],
"images": [
{
"id": "sample string 1",
"dataChangedAt": "2025-10-20T22:54:22.554473+02:00",
"description": "sample string 3",
"name": "sample string 4",
"category": "Layout",
"tags": "sample string 5",
"extension": "sample string 6",
"cdnReferences": [
{
"name": "sample string 1",
"url": "sample string 2"
},
{
"name": "sample string 1",
"url": "sample string 2"
}
]
},
{
"id": "sample string 1",
"dataChangedAt": "2025-10-20T22:54:22.554473+02:00",
"description": "sample string 3",
"name": "sample string 4",
"category": "Layout",
"tags": "sample string 5",
"extension": "sample string 6",
"cdnReferences": [
{
"name": "sample string 1",
"url": "sample string 2"
},
{
"name": "sample string 1",
"url": "sample string 2"
}
]
}
],
"isAdvertisedOnHomepage": true
}
<CommercialProperty xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.PublicAdvertisement">
<AcceptingBids>true</AcceptingBids>
<Address>
<AreaName>sample string 4</AreaName>
<City>sample string 3</City>
<CountryCode>sample string 5</CountryCode>
<CountyMunicipalityParishCode>sample string 6</CountyMunicipalityParishCode>
<Directions>sample string 7</Directions>
<StreetAddress>sample string 1</StreetAddress>
<Wgs84Coordinate>
<Latitude>2.1</Latitude>
<Longitude>1.1</Longitude>
</Wgs84Coordinate>
<ZipCode>sample string 2</ZipCode>
</Address>
<AdmissionAt>2025-10-20T22:54:22.554473+02:00</AdmissionAt>
<ChangedAt>2025-10-20T22:54:22.554473+02:00</ChangedAt>
<CustomAttributes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</CustomAttributes>
<Files xmlns:d2p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.PublicAdvertisement.Media">
<d2p1:File>
<d2p1:DataChangedAt>2025-10-20T22:54:22.554473+02:00</d2p1:DataChangedAt>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:Extension>sample string 2</d2p1:Extension>
<d2p1:Id>sample string 1</d2p1:Id>
</d2p1:File>
<d2p1:File>
<d2p1:DataChangedAt>2025-10-20T22:54:22.554473+02:00</d2p1:DataChangedAt>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:Extension>sample string 2</d2p1:Extension>
<d2p1:Id>sample string 1</d2p1:Id>
</d2p1:File>
</Files>
<Id>sample string 2</Id>
<Images>
<Image>
<Category>Layout</Category>
<CdnReferences xmlns:d4p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api">
<d4p1:CdnImageReference>
<d4p1:Name>sample string 1</d4p1:Name>
<d4p1:Url>sample string 2</d4p1:Url>
</d4p1:CdnImageReference>
<d4p1:CdnImageReference>
<d4p1:Name>sample string 1</d4p1:Name>
<d4p1:Url>sample string 2</d4p1:Url>
</d4p1:CdnImageReference>
</CdnReferences>
<DataChangedAt>2025-10-20T22:54:22.554473+02:00</DataChangedAt>
<Description>sample string 3</Description>
<Extension>sample string 6</Extension>
<Id>sample string 1</Id>
<Name>sample string 4</Name>
<Tags>sample string 5</Tags>
</Image>
<Image>
<Category>Layout</Category>
<CdnReferences xmlns:d4p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api">
<d4p1:CdnImageReference>
<d4p1:Name>sample string 1</d4p1:Name>
<d4p1:Url>sample string 2</d4p1:Url>
</d4p1:CdnImageReference>
<d4p1:CdnImageReference>
<d4p1:Name>sample string 1</d4p1:Name>
<d4p1:Url>sample string 2</d4p1:Url>
</d4p1:CdnImageReference>
</CdnReferences>
<DataChangedAt>2025-10-20T22:54:22.554473+02:00</DataChangedAt>
<Description>sample string 3</Description>
<Extension>sample string 6</Extension>
<Id>sample string 1</Id>
<Name>sample string 4</Name>
<Tags>sample string 5</Tags>
</Image>
</Images>
<IsAdvertisedOnHomepage>true</IsAdvertisedOnHomepage>
<IsVerifiedBidding>true</IsVerifiedBidding>
<OfficeAffiliation>
<CustomerId>sample string 2</CustomerId>
<OfficeId>sample string 1</OfficeId>
</OfficeAffiliation>
<PrimaryAgentId>sample string 3</PrimaryAgentId>
<SecondaryAgentId>sample string 4</SecondaryAgentId>
<Status>SoonForSale</Status>
<Surroundings>
<Communication>sample string 2</Communication>
<GeneralAboutArea>sample string 3</GeneralAboutArea>
<Other>sample string 5</Other>
<Parking>sample string 4</Parking>
<Service>sample string 1</Service>
</Surroundings>
<Texts>
<SaleDescription>sample string 2</SaleDescription>
<SaleHeading>sample string 4</SaleHeading>
<SalePhrase>sample string 3</SalePhrase>
<ShortSaleDescription>sample string 1</ShortSaleDescription>
</Texts>
<Urls>
<Description>sample string 1</Description>
<ImageList>sample string 2</ImageList>
</Urls>
<Viewings>
<Viewing>
<Comment>sample string 4</Comment>
<EndsAt>2025-10-20T22:54:22.554473+02:00</EndsAt>
<Id>sample string 1</Id>
<StartsAt>2025-10-20T22:54:22.554473+02:00</StartsAt>
</Viewing>
<Viewing>
<Comment>sample string 4</Comment>
<EndsAt>2025-10-20T22:54:22.554473+02:00</EndsAt>
<Id>sample string 1</Id>
<StartsAt>2025-10-20T22:54:22.554473+02:00</StartsAt>
</Viewing>
</Viewings>
<Buildings>
<CommercialPropertyBuilding>
<Elevator>Exists</Elevator>
<Name>sample string 1</Name>
<NumberOfFloors>3.1</NumberOfFloors>
<YearBuilt>2</YearBuilt>
</CommercialPropertyBuilding>
<CommercialPropertyBuilding>
<Elevator>Exists</Elevator>
<Name>sample string 1</Name>
<NumberOfFloors>3.1</NumberOfFloors>
<YearBuilt>2</YearBuilt>
</CommercialPropertyBuilding>
</Buildings>
<Business>
<Activity>sample string 1</Activity>
<Equipment>sample string 2</Equipment>
<EstablishedYear>1</EstablishedYear>
<LineOfBusiness>Shop</LineOfBusiness>
<NumberOfEmployees>1</NumberOfEmployees>
<Profitable>Unspecified</Profitable>
<Revenue xmlns:d3p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">
<d3p1:Currency>sample string 2</d3p1:Currency>
<d3p1:Value>1.1</d3p1:Value>
</Revenue>
</Business>
<Expenses>
<OperatingCost>1.1</OperatingCost>
</Expenses>
<Marketing>
<IsFutureSale>true</IsFutureSale>
<IsSoonForSale>true</IsSoonForSale>
<Business>true</Business>
<Industrial>true</Industrial>
<IsOtherType>true</IsOtherType>
<Office>true</Office>
<Plot>true</Plot>
<Premises>true</Premises>
<Residental>true</Residental>
<Retail>true</Retail>
<Warehouse>true</Warehouse>
</Marketing>
<Price>
<ForeignCurrency xmlns:d3p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">
<d3p1:Currency>sample string 2</d3p1:Currency>
<d3p1:Value>1.1</d3p1:Value>
</ForeignCurrency>
<SwedishCurrency>1.1</SwedishCurrency>
<Text>sample string 2</Text>
</Price>
<PropertyDesignation>sample string 1</PropertyDesignation>
<Surfaces>
<LivingSpace>
<Unit>sample string 2</Unit>
<Value>1.1</Value>
</LivingSpace>
<Office>
<Unit>sample string 2</Unit>
<Value>1.1</Value>
</Office>
<Other>
<Unit>sample string 2</Unit>
<Value>1.1</Value>
</Other>
<Plot>
<Unit>sample string 2</Unit>
<Value>1.1</Value>
</Plot>
<Retail>
<Unit>sample string 2</Unit>
<Value>1.1</Value>
</Retail>
<Storage>
<Unit>sample string 2</Unit>
<Value>1.1</Value>
</Storage>
<Total>
<Unit>sample string 2</Unit>
<Value>1.1</Value>
</Total>
<Workshop>
<Unit>sample string 2</Unit>
<Value>1.1</Value>
</Workshop>
</Surfaces>
<Type>Industrial</Type>
<VerifiedBidding>
<Id>sample string 1</Id>
<IsActive>true</IsActive>
<Name>sample string 2</Name>
</VerifiedBidding>
</CommercialProperty>