Dokumentation för API-funktioner
POST CRM/Link/{customerId}/{estateId} Metod för att lägga till en ny länk till en bostad. Request Information URI Parameters
NamnBeskrivningTypInformation
customerId Kundid string Krävs
estateId Bostadsid string Krävs
Body Parameters Länk LinkData
NamnBeskrivningTypInformation
Url URL string

Name Namn på länken string

Advertise Annonseras boolean

Category Länkkategori string

Request Formats

{
  "url": "sample string 1",
  "name": "sample string 2",
  "advertise": true,
  "category": "sample string 4"
}
<LinkData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Link">
  <Advertise>true</Advertise>
  <Category>sample string 4</Category>
  <Name>sample string 2</Name>
  <Url>sample string 1</Url>
</LinkData>
Response Information Resource Description Metod för att lägga till en ny länk till en bostad. string Kodexempel

curl "https://connect.maklare.vitec.net/CRM/Link/StringValue/StringValue" -X POST -H "Content-Type: application/json" -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" -d {\"url\":\"StringValue\",\"name\":\"StringValue\",\"advertise\":false}
            

$URL = "https://connect.maklare.vitec.net/CRM/Link/StringValue/StringValue"
$data = "{`"url`":`"StringValue`",`"name`":`"StringValue`",`"advertise`":false}"
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 = "{\"url\":\"StringValue\",\"name\":\"StringValue\",\"advertise\":false}";
using (var response = await HttpClientInstance.PostAsync("CRM/Link/StringValue/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/Link/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);
$data = "{\"url\":\"StringValue\",\"name\":\"StringValue\",\"advertise\":false}";
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
"sample string 1"
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>