Dokumentation för API-funktioner
GET BusinessIntelligence/External/Users Hämtar användare Request Information URI Parameters
NamnBeskrivningTypInformation
customerId Kund-id string Krävs
Response Information Resource Description Hämtar användare Collection of User
NamnBeskrivningTypInformation
Id Id på användare string

Name Namn på användare string

EmailAddress E-postadress string

PublicPhoneNumber Publikt telefonnummer string

CellPhone Mobilnummer string

SpokenLanguages Talande språk Collection of Language

ChangedAt Ändringsdatum date

Image Bild Image

Kodexempel

curl "https://connect.maklare.vitec.net/BusinessIntelligence/External/Users?customerId=StringValue" -X GET -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" 
            

$URL = "https://connect.maklare.vitec.net/BusinessIntelligence/External/Users?customerId=StringValue"
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("BusinessIntelligence/External/Users?customerId=StringValue")) {
    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/BusinessIntelligence/External/Users?customerId=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);

$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
Response Formats
[
  {
    "id": "sample string 1",
    "name": "sample string 2",
    "emailAddress": "sample string 3",
    "publicPhoneNumber": "sample string 4",
    "cellPhone": "sample string 5",
    "spokenLanguages": [
      {
        "code": "sample string 1"
      },
      {
        "code": "sample string 1"
      }
    ],
    "changedAt": "2024-05-08T04:03:31.7050634+02:00",
    "image": {
      "id": "sample string 1",
      "changedAt": "2024-05-08T04:03:31.7050634+02:00",
      "extension": "sample string 3"
    }
  },
  {
    "id": "sample string 1",
    "name": "sample string 2",
    "emailAddress": "sample string 3",
    "publicPhoneNumber": "sample string 4",
    "cellPhone": "sample string 5",
    "spokenLanguages": [
      {
        "code": "sample string 1"
      },
      {
        "code": "sample string 1"
      }
    ],
    "changedAt": "2024-05-08T04:03:31.7050634+02:00",
    "image": {
      "id": "sample string 1",
      "changedAt": "2024-05-08T04:03:31.7050634+02:00",
      "extension": "sample string 3"
    }
  }
]
<ArrayOfUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.BusinessIntelligense.External">
  <User>
    <CellPhone>sample string 5</CellPhone>
    <ChangedAt>2024-05-08T04:03:31.7050634+02:00</ChangedAt>
    <EmailAddress>sample string 3</EmailAddress>
    <Id>sample string 1</Id>
    <Image>
      <ChangedAt>2024-05-08T04:03:31.7050634+02:00</ChangedAt>
      <Extension>sample string 3</Extension>
      <Id>sample string 1</Id>
    </Image>
    <Name>sample string 2</Name>
    <PublicPhoneNumber>sample string 4</PublicPhoneNumber>
    <SpokenLanguages>
      <Language>
        <Code>sample string 1</Code>
      </Language>
      <Language>
        <Code>sample string 1</Code>
      </Language>
    </SpokenLanguages>
  </User>
  <User>
    <CellPhone>sample string 5</CellPhone>
    <ChangedAt>2024-05-08T04:03:31.7050634+02:00</ChangedAt>
    <EmailAddress>sample string 3</EmailAddress>
    <Id>sample string 1</Id>
    <Image>
      <ChangedAt>2024-05-08T04:03:31.7050634+02:00</ChangedAt>
      <Extension>sample string 3</Extension>
      <Id>sample string 1</Id>
    </Image>
    <Name>sample string 2</Name>
    <PublicPhoneNumber>sample string 4</PublicPhoneNumber>
    <SpokenLanguages>
      <Language>
        <Code>sample string 1</Code>
      </Language>
      <Language>
        <Code>sample string 1</Code>
      </Language>
    </SpokenLanguages>
  </User>
</ArrayOfUser>