Vitec Connect
Dokumentation för API-funktioner
PUT PublicAdvertising/Estate/{customerId}/{id}/Status Uppdatera marknadsföringsstatus för bostaden på aktuell marknadsplats. Request Information URI Parameters
NamnBeskrivningTypInformation
customerId Kund-id string Krävs
id Bostadens id string Krävs
Body Parameters Statusinformation PublicAdvertisingEstateStatus
NamnBeskrivningTypInformation
AdvertisementId Annnonsid hos marknadsplatsen string

AdvertisementUrl Url till annonsen på marknadsplatsens hemsida string

StatusInformation En lista av statusinformation som presenteras för användarna. Använd för att ange t ex valideringsfel, varningar eller annan information till användaren. Låt det vara null eller skicka inte med om ni inte har något särskilt att meddela användaren. Collection of PublicAdvertisingEstateStatusInfo

Request Formats

{
  "advertisementId": "sample string 1",
  "advertisementUrl": "sample string 2",
  "statusInformation": [
    {
      "message": "sample string 1",
      "type": "Warning"
    },
    {
      "message": "sample string 1",
      "type": "Warning"
    }
  ]
}

<PublicAdvertisingEstateStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.PublicAdvertisement">
  <AdvertisementId>sample string 1</AdvertisementId>
  <AdvertisementUrl>sample string 2</AdvertisementUrl>
  <StatusInformation>
    <PublicAdvertisingEstateStatusInfo>
      <Message>sample string 1</Message>
      <Type>Warning</Type>
    </PublicAdvertisingEstateStatusInfo>
    <PublicAdvertisingEstateStatusInfo>
      <Message>sample string 1</Message>
      <Type>Warning</Type>
    </PublicAdvertisingEstateStatusInfo>
  </StatusInformation>
</PublicAdvertisingEstateStatus>
Response Information Resource Description Uppdatera marknadsföringsstatus för bostaden på aktuell marknadsplats.

Kodexempel 

curl "https://connect.maklare.vitec.net/PublicAdvertising/Estate/StringValue/StringValue/Status" -X PUT -H "Content-Type: application/json" -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" -d {\"advertisementId\":\"StringValue\",\"advertisementUrl\":\"StringValue\",\"statusInformation\":[{\"message\":\"StringValue\",\"type\":0}]}
            

$URL = "https://connect.maklare.vitec.net/PublicAdvertising/Estate/StringValue/StringValue/Status"
$data = "{`"advertisementId`":`"StringValue`",`"advertisementUrl`":`"StringValue`",`"statusInformation`":[{`"message`":`"StringValue`",`"type`":0}]}"
Invoke-WebRequest -Uri $URL -Method PUT -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 = "{\"advertisementId\":\"StringValue\",\"advertisementUrl\":\"StringValue\",\"statusInformation\":[{\"message\":\"StringValue\",\"type\":0}]}";
using (var response = await HttpClientInstance.PutAsync("PublicAdvertising/Estate/StringValue/StringValue/Status", 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
    }
}


$URL = "https://connect.maklare.vitec.net/PublicAdvertising/Estate/StringValue/StringValue/Status";

$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 = "{\"advertisementId\":\"StringValue\",\"advertisementUrl\":\"StringValue\",\"statusInformation\":[{\"message\":\"StringValue\",\"type\":0}]}";
$headers = array( "Content-Type: application/json", "Content-Length: " . strlen($data) );
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');

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
}
Testformulär Text input