Dokumentation för API-funktioner
GET CRM/Estate/{customerId}/{estateId}/biddingSettings

Hämtar budgivningsinställningar.

För att kunna hämta bidinställningar så krävs det en giltig API nyckel och ett kundid.

Request Information URI Parameters
NamnBeskrivningTypInformation
customerId Kundid string Krävs
estateId bostadsid string Krävs
Response Information Resource Description Hämtar budgivningsinställningar. BiddingSetting
NamnBeskrivningTypInformation
Identified Identifierad budgivning boolean

MinimumRecommendedRaise Minsta rekommenderade höjning integer

BiddingOptions Hur bud ska visas på internet BiddingOptions

SMSBidding Sms budgivning boolean

Kodexempel

curl "https://connect.maklare.vitec.net/CRM/Estate/StringValue/StringValue/biddingSettings" -X GET -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" 
            

$URL = "https://connect.maklare.vitec.net/CRM/Estate/StringValue/StringValue/biddingSettings"
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("CRM/Estate/StringValue/StringValue/biddingSettings")) {
    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 identified = result.identified.Value;
    // TODO: Gör något med resultatet
}

$URL = "https://connect.maklare.vitec.net/CRM/Estate/StringValue/StringValue/biddingSettings";

$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["identified"];
// TODO: Gör något med resultatet
Testformulär Text input
Response Formats
{
  "identified": true,
  "minimumRecommendedRaise": 1,
  "biddingOptions": "DontShowBidding",
  "smsBidding": true
}
<BiddingSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Bid">
  <BiddingOptions>DontShowBidding</BiddingOptions>
  <SMSBidding>true</SMSBidding>
  <Identified>true</Identified>
  <MinimumRecommendedRaise>1</MinimumRecommendedRaise>
</BiddingSetting>