Dokumentation för API-funktioner
POST Area/FocusArea

För att kunna skapa ett fokusområde så krävs ett områdesnamn och koordinater (GeoJSON [longitud, latitud]). Giltig kommunkod kan anges.

GeoJSON

Kommunkoder från SCB

Request Information URI Parameters
NamnBeskrivningTypInformation
customerId Kund-id string Krävs
Body Parameters Områdesinformation CreateFocusAreaRequest
NamnBeskrivningTypInformation
Name Områdets namn string Området måste ha ett namn
MunicipalityCode Kommunkod integer

Coordinates Koordinater GeoJSON Multipolygon (longitud, latitud) Collection of Collection of Collection of Collection of decimal number Området måste ha en polygon

Request Formats

{
  "name": "sample string 1",
  "municipalityCode": 1,
  "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
        ]
      ]
    ]
  ]
}
<CreateFocusAreaRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.FocusArea">
  <Coordinates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfArrayOfArrayOfdouble>
      <d2p1:ArrayOfArrayOfdouble>
        <d2p1:ArrayOfdouble>
          <d2p1:double>1.1</d2p1:double>
          <d2p1:double>2.1</d2p1:double>
        </d2p1:ArrayOfdouble>
        <d2p1:ArrayOfdouble>
          <d2p1:double>1.1</d2p1:double>
          <d2p1:double>2.1</d2p1:double>
        </d2p1:ArrayOfdouble>
      </d2p1:ArrayOfArrayOfdouble>
      <d2p1:ArrayOfArrayOfdouble>
        <d2p1:ArrayOfdouble>
          <d2p1:double>1.1</d2p1:double>
          <d2p1:double>2.1</d2p1:double>
        </d2p1:ArrayOfdouble>
        <d2p1:ArrayOfdouble>
          <d2p1:double>1.1</d2p1:double>
          <d2p1:double>2.1</d2p1:double>
        </d2p1:ArrayOfdouble>
      </d2p1:ArrayOfArrayOfdouble>
    </d2p1:ArrayOfArrayOfArrayOfdouble>
    <d2p1:ArrayOfArrayOfArrayOfdouble>
      <d2p1:ArrayOfArrayOfdouble>
        <d2p1:ArrayOfdouble>
          <d2p1:double>1.1</d2p1:double>
          <d2p1:double>2.1</d2p1:double>
        </d2p1:ArrayOfdouble>
        <d2p1:ArrayOfdouble>
          <d2p1:double>1.1</d2p1:double>
          <d2p1:double>2.1</d2p1:double>
        </d2p1:ArrayOfdouble>
      </d2p1:ArrayOfArrayOfdouble>
      <d2p1:ArrayOfArrayOfdouble>
        <d2p1:ArrayOfdouble>
          <d2p1:double>1.1</d2p1:double>
          <d2p1:double>2.1</d2p1:double>
        </d2p1:ArrayOfdouble>
        <d2p1:ArrayOfdouble>
          <d2p1:double>1.1</d2p1:double>
          <d2p1:double>2.1</d2p1:double>
        </d2p1:ArrayOfdouble>
      </d2p1:ArrayOfArrayOfdouble>
    </d2p1:ArrayOfArrayOfArrayOfdouble>
  </Coordinates>
  <MunicipalityCode>1</MunicipalityCode>
  <Name>sample string 1</Name>
</CreateFocusAreaRequest>
Response Information Resource Description Skapar ett område som är dedikerat att användas som fokusområde string Kodexempel

curl "https://connect.maklare.vitec.net/Area/FocusArea?customerId=StringValue" -X POST -H "Content-Type: application/json" -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" -d {\"name\":\"StringValue\",\"municipalityCode\":0,\"coordinates\":[[[[0.0]]]]}
            

$URL = "https://connect.maklare.vitec.net/Area/FocusArea?customerId=StringValue"
$data = "{`"name`":`"StringValue`",`"municipalityCode`":0,`"coordinates`":[[[[0.0]]]]}"
Invoke-WebRequest -Uri $URL -Method POST -Headers @{"Content-Type" = "application/json"; "authorization" = "basic {Base64 kodad användarnamn och lösenord}"} -Body $data
                

// 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}")
//     }
// }
var json = "{\"name\":\"StringValue\",\"municipalityCode\":0,\"coordinates\":[[[[0.0]]]]}";
using (var response = await HttpClientInstance.PostAsync("Area/FocusArea?customerId=StringValue", new StringContent(json, Encoding.UTF8, "application/json"))) {
    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);
    
    // TODO: Gör något med resultatet
}

$URL = "https://connect.maklare.vitec.net/Area/FocusArea?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);
$data = "{\"name\":\"StringValue\",\"municipalityCode\":0,\"coordinates\":[[[[0.0]]]]}";
curl_setopt($ch, CURLOPT_POST, true);

curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json',
    'Content-Length: ' . strlen($data)
));

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

// TODO: Gör något med resultatet
Testformulär Text input
Response Formats
"sample string 1"
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>