Dokumentation för API-funktioner
GET Category/GetCategories Hämtar kategorier. För att kunna hämta kategorier så krävs det en giltig API nyckel och ett kundid Request Information URI Parameters
NamnBeskrivningTypInformation
customerId Kund id string Krävs
Response Information Resource Description Hämtar kategorier. För att kunna hämta kategorier så krävs det en giltig API nyckel och ett kundid Categories
NamnBeskrivningTypInformation
CompanyCategories Företagskategorier Collection of Category

PersonCategories Personkategorier Collection of Category

Kodexempel

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

$URL = "https://connect.maklare.vitec.net/Category/GetCategories?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("Category/GetCategories?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 companyCategories = result.companyCategories.Value;
    // TODO: Gör något med resultatet
}

$URL = "https://connect.maklare.vitec.net/Category/GetCategories?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
}

$field_on_result = $result["companyCategories"];
// TODO: Gör något med resultatet
Testformulär Text input
Response Formats
{
  "companyCategories": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "readOnly": true
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "readOnly": true
    }
  ],
  "personCategories": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "readOnly": true
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "readOnly": true
    }
  ]
}
<Categories xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Category">
  <CompanyCategories>
    <Category>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <ReadOnly>true</ReadOnly>
    </Category>
    <Category>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <ReadOnly>true</ReadOnly>
    </Category>
  </CompanyCategories>
  <PersonCategories>
    <Category>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <ReadOnly>true</ReadOnly>
    </Category>
    <Category>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <ReadOnly>true</ReadOnly>
    </Category>
  </PersonCategories>
</Categories>