Express Connect

Dokumentation för API-funktioner

GET Report/Meeting/{customerId}/Assignment Hämta rapport över intagsmöten Request Information URI Parameters

Namn	Beskrivning	Typ	Information
customerId	Kund-id	string	Krävs
from	Från och med datum och tid	date
to	Till och med datum och tid	date
date	Vilket datum som från och till ska göra urval på	MeetingDateCriteria

Response Information Resource Description Hämta rapport över intagsmöten Collection of AssignmentMeetingReportRow

Namn	Beskrivning	Typ	Information
Id	Id	string
Contact	Kontakt som är bokad	MeetingContact
Estate	Bostaden som mötet berör	MeetingEstate
StartsAt	Starttid för mötet	date
MeetingType	Typ av möte	MeetingType
Agent	Handläggare för mötet	MeetingAgent
BookedBy	Bokad av	MeetingAgent
BookedDate	Bokad datum	date
IsCancelled	Är avbokad	boolean
CancelledBy	Avbokad av vem	MeetingCancelledBy

Kodexempel

CURL kommando
Powershell
.NET c#
PHP


curl "https://connect.maklare.vitec.net/Report/Meeting/StringValue/Assignment?from=2015-01-01T12:00:00&to=2015-01-01T12:00:00&date=MeetingStart" -X GET -H "Authorization: basic {Base64 kodad användarnamn och lösenord}"


$URL = "https://connect.maklare.vitec.net/Report/Meeting/StringValue/Assignment?from=2015-01-01T12:00:00&to=2015-01-01T12:00:00&date=MeetingStart"
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("Report/Meeting/StringValue/Assignment?from=2015-01-01T12:00:00&to=2015-01-01T12:00:00&date=MeetingStart")) {
    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 firstInArray = result[0];
    var id = firstInArray.id.Value;
    // TODO: Gör något med resultatet
}


$URL = "https://connect.maklare.vitec.net/Report/Meeting/StringValue/Assignment?from=2015-01-01T12:00:00&to=2015-01-01T12:00:00&date=MeetingStart";

$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
}

$first = $result[0];
$field_on_result = $first["id"];
// TODO: Gör något med resultatet

Testformulär Text input

Username

Password

customerId

from

date

Response Formats

application/json, text/json
application/xml, text/xml

[
  {
    "id": "sample string 1",
    "contact": {
      "id": "sample string 1",
      "name": "sample string 2"
    },
    "estate": {
      "id": "sample string 1",
      "status": "Undefined",
      "assignmentType": "ContractWriting",
      "type": "House",
      "isNewHome": true,
      "biType": {
        "id": 1,
        "value": "House",
        "name": "sample string 2"
      },
      "assignmentSource": {
        "id": 1,
        "name": "sample string 2"
      }
    },
    "startsAt": "2024-04-29T07:49:57.3095066+02:00",
    "meetingType": "Assignment",
    "agent": {
      "id": "sample string 1",
      "name": "sample string 2"
    },
    "bookedBy": {
      "id": "sample string 1",
      "name": "sample string 2"
    },
    "bookedDate": "2024-04-29T07:49:57.3095066+02:00",
    "isCancelled": true,
    "cancelledBy": "None"
  },
  {
    "id": "sample string 1",
    "contact": {
      "id": "sample string 1",
      "name": "sample string 2"
    },
    "estate": {
      "id": "sample string 1",
      "status": "Undefined",
      "assignmentType": "ContractWriting",
      "type": "House",
      "isNewHome": true,
      "biType": {
        "id": 1,
        "value": "House",
        "name": "sample string 2"
      },
      "assignmentSource": {
        "id": 1,
        "name": "sample string 2"
      }
    },
    "startsAt": "2024-04-29T07:49:57.3095066+02:00",
    "meetingType": "Assignment",
    "agent": {
      "id": "sample string 1",
      "name": "sample string 2"
    },
    "bookedBy": {
      "id": "sample string 1",
      "name": "sample string 2"
    },
    "bookedDate": "2024-04-29T07:49:57.3095066+02:00",
    "isCancelled": true,
    "cancelledBy": "None"
  }
]

<ArrayOfAssignmentMeetingReportRow xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Express.Connect.Api.Models.Reports">
  <AssignmentMeetingReportRow>
    <Agent>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </Agent>
    <BookedBy>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </BookedBy>
    <BookedDate>2024-04-29T07:49:57.3095066+02:00</BookedDate>
    <CancelledBy>None</CancelledBy>
    <Contact>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </Contact>
    <Estate>
      <AssignmentSource>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </AssignmentSource>
      <AssignmentType>ContractWriting</AssignmentType>
      <BIType>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <Value>House</Value>
      </BIType>
      <Id>sample string 1</Id>
      <IsNewHome>true</IsNewHome>
      <Status>Undefined</Status>
      <Type>House</Type>
    </Estate>
    <Id>sample string 1</Id>
    <IsCancelled>true</IsCancelled>
    <MeetingType>Assignment</MeetingType>
    <StartsAt>2024-04-29T07:49:57.3095066+02:00</StartsAt>
  </AssignmentMeetingReportRow>
  <AssignmentMeetingReportRow>
    <Agent>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </Agent>
    <BookedBy>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </BookedBy>
    <BookedDate>2024-04-29T07:49:57.3095066+02:00</BookedDate>
    <CancelledBy>None</CancelledBy>
    <Contact>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </Contact>
    <Estate>
      <AssignmentSource>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </AssignmentSource>
      <AssignmentType>ContractWriting</AssignmentType>
      <BIType>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <Value>House</Value>
      </BIType>
      <Id>sample string 1</Id>
      <IsNewHome>true</IsNewHome>
      <Status>Undefined</Status>
      <Type>House</Type>
    </Estate>
    <Id>sample string 1</Id>
    <IsCancelled>true</IsCancelled>
    <MeetingType>Assignment</MeetingType>
    <StartsAt>2024-04-29T07:49:57.3095066+02:00</StartsAt>
  </AssignmentMeetingReportRow>
</ArrayOfAssignmentMeetingReportRow>