Vitec Connect
Dokumentation för API-funktioner
GET CustomField/Get Hämtar egendefinerade fält. Request Information URI Parameters
NamnBeskrivningTypInformation
customerId Kund id string Krävs
Response Information Resource Description Hämtar egendefinerade fält. Collection of CustomFields
NamnBeskrivningTypInformation
CustomerId Kund id string

Fields Lista av egendefinerade fält. Collection of Field

Kodexempel 

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

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


$URL = "https://connect.maklare.vitec.net/CustomField/Get?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["customerId"];
// TODO: Gör något med resultatet
Testformulär Text input
Response Formats 
[
  {
    "customerId": "sample string 1",
    "fields": [
      {
        "label": "sample string 1",
        "name": "sample string 2",
        "type": "sample string 3",
        "validFor": [
          "House",
          "House"
        ]
      },
      {
        "label": "sample string 1",
        "name": "sample string 2",
        "type": "sample string 3",
        "validFor": [
          "House",
          "House"
        ]
      }
    ]
  },
  {
    "customerId": "sample string 1",
    "fields": [
      {
        "label": "sample string 1",
        "name": "sample string 2",
        "type": "sample string 3",
        "validFor": [
          "House",
          "House"
        ]
      },
      {
        "label": "sample string 1",
        "name": "sample string 2",
        "type": "sample string 3",
        "validFor": [
          "House",
          "House"
        ]
      }
    ]
  }
]

<ArrayOfCustomFields xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.CustomField">
  <CustomFields>
    <CustomerId>sample string 1</CustomerId>
    <Fields>
      <Field>
        <Label>sample string 1</Label>
        <Name>sample string 2</Name>
        <Type>sample string 3</Type>
        <ValidFor xmlns:d5p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">
          <d5p1:ObjectType>House</d5p1:ObjectType>
          <d5p1:ObjectType>House</d5p1:ObjectType>
        </ValidFor>
      </Field>
      <Field>
        <Label>sample string 1</Label>
        <Name>sample string 2</Name>
        <Type>sample string 3</Type>
        <ValidFor xmlns:d5p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">
          <d5p1:ObjectType>House</d5p1:ObjectType>
          <d5p1:ObjectType>House</d5p1:ObjectType>
        </ValidFor>
      </Field>
    </Fields>
  </CustomFields>
  <CustomFields>
    <CustomerId>sample string 1</CustomerId>
    <Fields>
      <Field>
        <Label>sample string 1</Label>
        <Name>sample string 2</Name>
        <Type>sample string 3</Type>
        <ValidFor xmlns:d5p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">
          <d5p1:ObjectType>House</d5p1:ObjectType>
          <d5p1:ObjectType>House</d5p1:ObjectType>
        </ValidFor>
      </Field>
      <Field>
        <Label>sample string 1</Label>
        <Name>sample string 2</Name>
        <Type>sample string 3</Type>
        <ValidFor xmlns:d5p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">
          <d5p1:ObjectType>House</d5p1:ObjectType>
          <d5p1:ObjectType>House</d5p1:ObjectType>
        </ValidFor>
      </Field>
    </Fields>
  </CustomFields>
</ArrayOfCustomFields>