Vitec Connect
Dokumentation för API-funktioner
POST Viewing/{customerId}/{viewingId}/{timeSlotId}/Participant/{contactId} Lägg till befintlig visningsdeltagare på en bostad. Request Information URI Parameters
NamnBeskrivningTypInformation
viewingId Visningsid string Krävs
timeSlotId Id på visningstillfället string Krävs
contactId Id på kontakten. string Krävs
customerId Kundid string

Body Parameters Information om deltagaren. AddViewingParticipant
NamnBeskrivningTypInformation
Participated Deltog boolean

ReminderTime Minuter innan visningen som påminnelse ska skickas ut integer

SMSReminder SMS påminnelse boolean

MailConfirmation Bekräftelse via epost boolean

SMSConfirmation Bekräftelse via SMS boolean

ContactMessage Meddelande från kontaktpersonen. Meddelandet kommer att sparas på det lead som skapas i samband med att visningsdeltagaren läggs till. string

LeadSourceId Leadskälla - Det lead som skapas i samband med anmälan till visning kommer att kopplas till aktuell leadskälla. Leadskällan får inte ha något definierat arbetsflöde, dvs det skall bara innehålla information. Om fältet inte anges, kommer leadet att kopplas till en förvald leadskälla. string

Options Alternativ som rör bokningen ViewingParticipantBookingOptions

Request Formats

{
  "participated": true,
  "reminderTime": 2,
  "smsReminder": true,
  "mailConfirmation": true,
  "smsConfirmation": true,
  "contactMessage": "sample string 6",
  "leadSourceId": "sample string 7",
  "options": {
    "isDeadlineValidationEnabled": true,
    "enableBookingLimitValidation": true
  }
}

<AddViewingParticipant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Connect.Models.Viewing">
  <ContactMessage>sample string 6</ContactMessage>
  <LeadSourceId>sample string 7</LeadSourceId>
  <MailConfirmation>true</MailConfirmation>
  <Options xmlns:d2p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Viewing">
    <d2p1:EnableBookingLimitValidation>true</d2p1:EnableBookingLimitValidation>
    <d2p1:IsDeadlineValidationEnabled>true</d2p1:IsDeadlineValidationEnabled>
  </Options>
  <Participated>true</Participated>
  <ReminderTime>2</ReminderTime>
  <SMSConfirmation>true</SMSConfirmation>
  <SMSReminder>true</SMSReminder>
</AddViewingParticipant>
Response Information Resource Description Lägg till befintlig visningsdeltagare på en bostad.

Kodexempel 

curl "https://connect.maklare.vitec.net/Viewing/StringValue/StringValue/StringValue/Participant/StringValue" -X POST -H "Content-Type: application/json" -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" -d {\"participated\":false,\"reminderTime\":0,\"sMSReminder\":false}
            

$URL = "https://connect.maklare.vitec.net/Viewing/StringValue/StringValue/StringValue/Participant/StringValue"
$data = "{`"participated`":false,`"reminderTime`":0,`"sMSReminder`":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 = "{\"participated\":false,\"reminderTime\":0,\"sMSReminder\":false}";
using (var response = await HttpClientInstance.PostAsync("Viewing/StringValue/StringValue/StringValue/Participant/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
    }
}


$URL = "https://connect.maklare.vitec.net/Viewing/StringValue/StringValue/StringValue/Participant/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 = "{\"participated\":false,\"reminderTime\":0,\"sMSReminder\":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
}
Testformulär Text input