{ "data": "QEA=", "name": "sample string 1", "caption": "sample string 2", "advertise": true, "category": "sample string 3" }
Dokumentation för API-funktioner
POST Image/{customerId}/{estateId}
Metod för att lägga till en ny bild (gif,jpg,tiff,bmp,png) till en bostad.
Request Information
URI Parameters
Body Parameters
Bilddata ImageData
Response Information
Resource Description
Metod för att lägga till en ny bild (gif,jpg,tiff,bmp,png) till en bostad.
string
Kodexempel
Testformulär
Text input
Response Formats
Namn | Beskrivning | Typ | Information |
customerId | Kundid | string |
Krävs |
estateId | Bostadsid | string |
Krävs |
Namn | Beskrivning | Typ | Information |
Data | Data (gif,jpg,tiff,bmp,png) | Collection of byte | |
Name | Namn på bilden | string | |
Caption | Bildtext | string | |
Advertise | Annoneras | boolean | |
Category | Bildkategori | string |
Request Formats
<ImageData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image"> <Advertise>true</Advertise> <Caption>sample string 2</Caption> <Category>sample string 3</Category> <Data>QEA=</Data> <Name>sample string 1</Name> </ImageData>
curl "https://connect.maklare.vitec.net/Image/StringValue/StringValue" -X POST -H "Content-Type: application/json" -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" -d {\"data\":\"\",\"name\":\"StringValue\",\"caption\":\"StringValue\"}
$URL = "https://connect.maklare.vitec.net/Image/StringValue/StringValue"
$data = "{`"data`":`"`",`"name`":`"StringValue`",`"caption`":`"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 = "{\"data\":\"\",\"name\":\"StringValue\",\"caption\":\"StringValue\"}";
using (var response = await HttpClientInstance.PostAsync("Image/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/Image/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 = "{\"data\":\"\",\"name\":\"StringValue\",\"caption\":\"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>