Dokumentation för API-funktioner
POST Service/ProspectiveBuyer/{customerId}/ObjectDescriptionRead Registrerar att en spekulant har läst en digital objektbeskrivning Request Information URI Parameters
NamnBeskrivningTypInformation
customerId Kund-id string Krävs
Body Parameters Notifieringsdata ObjectDescriptionReadNotification
NamnBeskrivningTypInformation
ProspectiveBuyerId Id för spekulanten som läste objektbeskrivningen string

EstateId Id för objektet vars objektbeskrivning lästes string

ReadAt Tidpunkt då objektbeskrivningen lästes date

Request Formats

{
  "prospectiveBuyerId": "sample string 1",
  "estateId": "sample string 2",
  "readAt": "2026-06-25T10:42:54.0789069+02:00"
}
<ObjectDescriptionReadNotification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.ProspectiveBuyer">
  <EstateId>sample string 2</EstateId>
  <ProspectiveBuyerId>sample string 1</ProspectiveBuyerId>
  <ReadAt>2026-06-25T10:42:54.0789069+02:00</ReadAt>
</ObjectDescriptionReadNotification>
Response Information Resource Description Registrerar att en spekulant har läst en digital objektbeskrivning boolean Kodexempel

curl "https://connect.maklare.vitec.net/Service/ProspectiveBuyer/StringValue/ObjectDescriptionRead" -X POST -H "Content-Type: application/json" -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" -d {\"prospectiveBuyerId\":\"StringValue\",\"estateId\":\"StringValue\",\"readAt\":\"2015-01-01T12:00:00\"}
            

$URL = "https://connect.maklare.vitec.net/Service/ProspectiveBuyer/StringValue/ObjectDescriptionRead"
$data = "{`"prospectiveBuyerId`":`"StringValue`",`"estateId`":`"StringValue`",`"readAt`":`"2015-01-01T12:00:00`"}"
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 = "{\"prospectiveBuyerId\":\"StringValue\",\"estateId\":\"StringValue\",\"readAt\":\"2015-01-01T12:00:00\"}";
using (var response = await HttpClientInstance.PostAsync("Service/ProspectiveBuyer/StringValue/ObjectDescriptionRead", 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/Service/ProspectiveBuyer/StringValue/ObjectDescriptionRead";

$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 = "{\"prospectiveBuyerId\":\"StringValue\",\"estateId\":\"StringValue\",\"readAt\":\"2015-01-01T12:00:00\"}";
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
Testformulär Text input
Response Formats
true
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>