Express Connect

Dokumentation för API-funktioner

GET Area/FocusArea Hämtar områden som är dedikerade att användas som fokusområde Request Information URI Parameters

Namn	Beskrivning	Typ	Information
AreaId	Områdets id	string
CustomerId	Kund-id	string	Required

Response Information Resource Description Hämtar områden som är dedikerade att användas som fokusområde Collection of GetFocusAreaResponse

Namn	Beskrivning	Typ	Information
Name	Områdets namn	string
MunicipalityCode	Kommunkod	string
Coordinates	Koordinater GeoJSON Multipolygon (longitud, latitud)	Collection of Collection of Collection of Collection of decimal number

Kodexempel

CURL kommando
Powershell
.NET c#
PHP


curl "https://connect.maklare.vitec.net/Area/FocusArea?AreaId=StringValue&CustomerId=StringValue" -X GET -H "Authorization: basic {Base64 kodad användarnamn och lösenord}"


$URL = "https://connect.maklare.vitec.net/Area/FocusArea?AreaId=StringValue&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("Area/FocusArea?AreaId=StringValue&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 name = firstInArray.name.Value;
    // TODO: Gör något med resultatet
}


$URL = "https://connect.maklare.vitec.net/Area/FocusArea?AreaId=StringValue&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["name"];
// TODO: Gör något med resultatet

Testformulär Text input

Username

Password

AreaId

CustomerId

request

Response Formats

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

[
  {
    "name": "sample string 1",
    "municipalityCode": "sample string 2",
    "coordinates": [
      [
        [
          [
            1.1,
            2.1
          ],
          [
            1.1,
            2.1
          ]
        ],
        [
          [
            1.1,
            2.1
          ],
          [
            1.1,
            2.1
          ]
        ]
      ],
      [
        [
          [
            1.1,
            2.1
          ],
          [
            1.1,
            2.1
          ]
        ],
        [
          [
            1.1,
            2.1
          ],
          [
            1.1,
            2.1
          ]
        ]
      ]
    ]
  },
  {
    "name": "sample string 1",
    "municipalityCode": "sample string 2",
    "coordinates": [
      [
        [
          [
            1.1,
            2.1
          ],
          [
            1.1,
            2.1
          ]
        ],
        [
          [
            1.1,
            2.1
          ],
          [
            1.1,
            2.1
          ]
        ]
      ],
      [
        [
          [
            1.1,
            2.1
          ],
          [
            1.1,
            2.1
          ]
        ],
        [
          [
            1.1,
            2.1
          ],
          [
            1.1,
            2.1
          ]
        ]
      ]
    ]
  }
]

<ArrayOfGetFocusAreaResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.FocusArea">
  <GetFocusAreaResponse>
    <Coordinates xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfArrayOfArrayOfdouble>
        <d3p1:ArrayOfArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
        </d3p1:ArrayOfArrayOfdouble>
        <d3p1:ArrayOfArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
        </d3p1:ArrayOfArrayOfdouble>
      </d3p1:ArrayOfArrayOfArrayOfdouble>
      <d3p1:ArrayOfArrayOfArrayOfdouble>
        <d3p1:ArrayOfArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
        </d3p1:ArrayOfArrayOfdouble>
        <d3p1:ArrayOfArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
        </d3p1:ArrayOfArrayOfdouble>
      </d3p1:ArrayOfArrayOfArrayOfdouble>
    </Coordinates>
    <MunicipalityCode>sample string 2</MunicipalityCode>
    <Name>sample string 1</Name>
  </GetFocusAreaResponse>
  <GetFocusAreaResponse>
    <Coordinates xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfArrayOfArrayOfdouble>
        <d3p1:ArrayOfArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
        </d3p1:ArrayOfArrayOfdouble>
        <d3p1:ArrayOfArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
        </d3p1:ArrayOfArrayOfdouble>
      </d3p1:ArrayOfArrayOfArrayOfdouble>
      <d3p1:ArrayOfArrayOfArrayOfdouble>
        <d3p1:ArrayOfArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
        </d3p1:ArrayOfArrayOfdouble>
        <d3p1:ArrayOfArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
          <d3p1:ArrayOfdouble>
            <d3p1:double>1.1</d3p1:double>
            <d3p1:double>2.1</d3p1:double>
          </d3p1:ArrayOfdouble>
        </d3p1:ArrayOfArrayOfdouble>
      </d3p1:ArrayOfArrayOfArrayOfdouble>
    </Coordinates>
    <MunicipalityCode>sample string 2</MunicipalityCode>
    <Name>sample string 1</Name>
  </GetFocusAreaResponse>
</ArrayOfGetFocusAreaResponse>