{ "timeSlotId": "sample string 1", "firstName": "sample string 2", "lastName": "sample string 3", "email": "sample string 4", "cellPhone": "sample string 5", "address": { "streetAddress": "sample string 1", "zipCode": "sample string 2", "city": "sample string 3" }, "gdpr": { "hasApproved": true }, "lead": { "leadSourceId": "sample string 1", "message": "sample string 2" }, "confirmation": { "isEmailEnabled": true, "isSmsEnabled": true }, "marketing": { "referrer": "sample string 1", "utmTags": [ { "name": "sample string 1", "value": "sample string 2" }, { "name": "sample string 1", "value": "sample string 2" } ] }, "reminderTime": 1, "validation": { "isBookingLimitEnabled": true, "isDeadLineEnabled": true } }
Dokumentation för API-funktioner
POST v2/Advertising/Form/{customerId}/Estate/{estateId}/Viewing/Attend
Lägg till en visningsdeltagare
Request Information
URI Parameters
Body Parameters
Anmälningsuppgifter ViewingAttendeeApplication
Response Information
Resource Description
Lägg till en visningsdeltagare
AttendViewingResult
Kodexempel
Testformulär
Text input
Response Formats
Namn | Beskrivning | Typ | Information |
customerId | Kund-id | string |
Krävs |
estateId | Bostadsid | string |
Krävs |
Namn | Beskrivning | Typ | Information |
TimeSlotId | Id på tillfället som ska bokas | string | |
FirstName | Förnamn | string | |
LastName | Efternamn | string | |
Epostadress | string | ||
CellPhone | Mobiltelefonnummer | string | |
Address | Adressuppgifter, valfritt | FormAddress | |
Gdpr | GDPR uppgifter | FormApplicationGdpr | |
Lead | Lead uppgifter | FormApplicationLead | |
Confirmation | Bekräftelsehantering | ViewingConfirmationOptions | |
Marketing | Marknadsföringsuppgifter som t ex UTM taggar | FormMarketing | |
ReminderTime | Påminnelsetid (Minuter innan visning) | integer | |
Validation | Konfiguration av valideringsregler, lämna tom (null) om ni inte har särskilda regler | ViewingAttendeeApplicationValidation |
Request Formats
<ViewingAttendeeApplication xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Express.Connect.Api.Services.Advertising"> <Address> <City>sample string 3</City> <StreetAddress>sample string 1</StreetAddress> <ZipCode>sample string 2</ZipCode> </Address> <CellPhone>sample string 5</CellPhone> <Confirmation> <IsEmailEnabled>true</IsEmailEnabled> <IsSmsEnabled>true</IsSmsEnabled> </Confirmation> <Email>sample string 4</Email> <FirstName>sample string 2</FirstName> <Gdpr> <HasApproved>true</HasApproved> </Gdpr> <LastName>sample string 3</LastName> <Lead> <LeadSourceId>sample string 1</LeadSourceId> <Message>sample string 2</Message> </Lead> <Marketing> <Referrer>sample string 1</Referrer> <UtmTags> <FormMarketingUtmTags> <Name>sample string 1</Name> <Value>sample string 2</Value> </FormMarketingUtmTags> <FormMarketingUtmTags> <Name>sample string 1</Name> <Value>sample string 2</Value> </FormMarketingUtmTags> </UtmTags> </Marketing> <ReminderTime>1</ReminderTime> <TimeSlotId>sample string 1</TimeSlotId> <Validation> <IsBookingLimitEnabled>true</IsBookingLimitEnabled> <IsDeadLineEnabled>true</IsDeadLineEnabled> </Validation> </ViewingAttendeeApplication>
Namn | Beskrivning | Typ | Information |
ContactId | Den bokade kontaktens id | string |
curl "https://connect.maklare.vitec.net/v2/Advertising/Form/StringValue/Estate/StringValue/Viewing/Attend" -X POST -H "Content-Type: application/json" -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" -d {\"timeSlotId\":\"StringValue\",\"firstName\":\"StringValue\",\"lastName\":\"StringValue\"}
$URL = "https://connect.maklare.vitec.net/v2/Advertising/Form/StringValue/Estate/StringValue/Viewing/Attend"
$data = "{`"timeSlotId`":`"StringValue`",`"firstName`":`"StringValue`",`"lastName`":`"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 = "{\"timeSlotId\":\"StringValue\",\"firstName\":\"StringValue\",\"lastName\":\"StringValue\"}";
using (var response = await HttpClientInstance.PostAsync("v2/Advertising/Form/StringValue/Estate/StringValue/Viewing/Attend", 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);
var contactId = result.contactId.Value ;
// TODO: Gör något med resultatet
}
$URL = "https://connect.maklare.vitec.net/v2/Advertising/Form/StringValue/Estate/StringValue/Viewing/Attend";
$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 = "{\"timeSlotId\":\"StringValue\",\"firstName\":\"StringValue\",\"lastName\":\"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
}
$field_on_result = $result["contactId"];
// TODO: Gör något med resultatet
Resultat av begäran
{ "contactId": "sample string 1" }
<AttendViewingResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Express.Connect.Api.Services.Advertising"> <ContactId>sample string 1</ContactId> </AttendViewingResult>