{ "sumArea": { "maxValue": 1, "minValue": 1 }, "subtypes": [ "Retail", "Retail" ], "areaIds": [ "sample string 1", "sample string 2" ], "municipalityCodes": [ "sample string 1", "sample string 2" ], "isAutomaticProfile": true, "price": { "maxValue": 1, "minValue": 1 }, "drawnAreas": [ { "coordinates": [ { "longitud": 1.1, "latitud": 2.1 }, { "longitud": 1.1, "latitud": 2.1 } ] }, { "coordinates": [ { "longitud": 1.1, "latitud": 2.1 }, { "longitud": 1.1, "latitud": 2.1 } ] } ], "drawnAreasName": "sample string 2", "increasedRequirementIds": [ "sample string 1", "sample string 2" ] }
Dokumentation för API-funktioner
POST CRM/Contact/{customerId}/SearchProfile/Premises/{contactId}
Skapa en sökprofil av typen lokal
Request Information
URI Parameters
Body Parameters
Sökprofilen SearchProfilePremisesCreate
Response Information
Resource Description
Skapa en sökprofil av typen lokal
string
Kodexempel
Testformulär
Text input
Response Formats
Namn | Beskrivning | Typ | Information |
customerId | Kundid | string |
Krävs |
contactId | Kontaktid | string |
Krävs |
Namn | Beskrivning | Typ | Information |
SumArea | Summa areor | RangeOfInt32 | |
Subtypes | Typ av lokal | Collection of SubtypePremises | |
AreaIds | Områdes id:n | Collection of string | |
MunicipalityCodes | Kommunkoder | Collection of string | |
IsAutomaticProfile | Sökprofilen är automatskapad | boolean | |
Price | Pris min/max. Valbara värden för svenska objekt finns i "DomesticPriceSteps" som fås via anrop till GET CRM/Contact/{customerId}/SearchProfile/SearchProfileValues. För utlandsbostäder skall istället "ForeignPriceSteps" användas. | RangeOfInt32 | |
DrawnAreas | Ritat område | Collection of Polygon | |
DrawnAreasName | Namn på ritat område | string | |
IncreasedRequirementIds | Utökade krav id:n (increased requirements) Valbara värden för olika objettyper fås via anrop till GET IncreasedRequirement/{customerId}. | Collection of string |
Request Formats
<SearchProfilePremisesCreate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Express.Connect.Api.Models.SearchProfileV2"> <DrawnAreas xmlns:d2p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models"> <d2p1:Polygon> <d2p1:Coordinates> <d2p1:Coordinate> <d2p1:Latitud>2.1</d2p1:Latitud> <d2p1:Longitud>1.1</d2p1:Longitud> </d2p1:Coordinate> <d2p1:Coordinate> <d2p1:Latitud>2.1</d2p1:Latitud> <d2p1:Longitud>1.1</d2p1:Longitud> </d2p1:Coordinate> </d2p1:Coordinates> </d2p1:Polygon> <d2p1:Polygon> <d2p1:Coordinates> <d2p1:Coordinate> <d2p1:Latitud>2.1</d2p1:Latitud> <d2p1:Longitud>1.1</d2p1:Longitud> </d2p1:Coordinate> <d2p1:Coordinate> <d2p1:Latitud>2.1</d2p1:Latitud> <d2p1:Longitud>1.1</d2p1:Longitud> </d2p1:Coordinate> </d2p1:Coordinates> </d2p1:Polygon> </DrawnAreas> <DrawnAreasName>sample string 2</DrawnAreasName> <IncreasedRequirementIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </IncreasedRequirementIds> <IsAutomaticProfile>true</IsAutomaticProfile> <Price xmlns:d2p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models"> <d2p1:MaxValue>1</d2p1:MaxValue> <d2p1:MinValue>1</d2p1:MinValue> </Price> <AreaIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </AreaIds> <MunicipalityCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MunicipalityCodes> <Subtypes> <SubtypePremises>Retail</SubtypePremises> <SubtypePremises>Retail</SubtypePremises> </Subtypes> <SumArea xmlns:d2p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models"> <d2p1:MaxValue>1</d2p1:MaxValue> <d2p1:MinValue>1</d2p1:MinValue> </SumArea> </SearchProfilePremisesCreate>
curl "https://connect.maklare.vitec.net/CRM/Contact/StringValue/SearchProfile/Premises/StringValue" -X POST -H "Content-Type: application/json" -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" -d {\"sumArea\":{\"maxValue\":0,\"minValue\":0},\"subtypes\":[0],\"areaIds\":[\"StringValue\"]}
$URL = "https://connect.maklare.vitec.net/CRM/Contact/StringValue/SearchProfile/Premises/StringValue"
$data = "{`"sumArea`":{`"maxValue`":0,`"minValue`":0},`"subtypes`":[0],`"areaIds`":[`"StringValue`"]}"
Invoke-WebRequest -Uri $URL -Method POST -Headers @{"Content-Type" = "application/json"; "authorization" = "basic {Base64 kodad användarnamn och lösenord}"} -Body $data
// 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}")
// }
// }
var json = "{\"sumArea\":{\"maxValue\":0,\"minValue\":0},\"subtypes\":[0],\"areaIds\":[\"StringValue\"]}";
using (var response = await HttpClientInstance.PostAsync("CRM/Contact/StringValue/SearchProfile/Premises/StringValue", new StringContent(json, Encoding.UTF8, "application/json"))) {
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);
// TODO: Gör något med resultatet
}
$URL = "https://connect.maklare.vitec.net/CRM/Contact/StringValue/SearchProfile/Premises/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);
$data = "{\"sumArea\":{\"maxValue\":0,\"minValue\":0},\"subtypes\":[0],\"areaIds\":[\"StringValue\"]}";
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($data)
));
$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
}
// TODO: Gör något med resultatet
Resultat av begäran
"sample string 1"
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>