Express Connect

Dokumentation för API-funktioner

GET CRM/Office/{customerId}/{id}/FocusAreas Hämta fokusområden för huvudkontor Request Information URI Parameters

Namn	Beskrivning	Typ	Information
customerId	Kund-id	string	Krävs
id	Gruppid/KundId/Kontorsid/Kontorsgruppsid	string	Krävs

Response Information Resource Description Hämta fokusområden för huvudkontor Collection of FocusArea

Namn	Beskrivning	Typ	Information
Id	Id på område , saknas vid "Egenritade områden"	string
Polygons	Området som 2d-polygon i WGS84. Returneras enbart för "Egenritade Områden"	Collection of Polygon
Name	Områdesnamn	string
CustomerId	Kundid	string
OfficeId	Kontorsid	string

Kodexempel

CURL kommando
Powershell
.NET c#
PHP


curl "https://connect.maklare.vitec.net/CRM/Office/StringValue/StringValue/FocusAreas" -X GET -H "Authorization: basic {Base64 kodad användarnamn och lösenord}"


$URL = "https://connect.maklare.vitec.net/CRM/Office/StringValue/StringValue/FocusAreas"
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("CRM/Office/StringValue/StringValue/FocusAreas")) {
    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/CRM/Office/StringValue/StringValue/FocusAreas";

$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

Username

Password

customerId

Response Formats

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

[
  {
    "id": "sample string 1",
    "polygons": [
      {
        "coordinates": [
          {
            "longitud": 1.1,
            "latitud": 2.1
          },
          {
            "longitud": 1.1,
            "latitud": 2.1
          }
        ]
      },
      {
        "coordinates": [
          {
            "longitud": 1.1,
            "latitud": 2.1
          },
          {
            "longitud": 1.1,
            "latitud": 2.1
          }
        ]
      }
    ],
    "name": "sample string 2",
    "customerId": "sample string 3",
    "officeId": "sample string 4"
  },
  {
    "id": "sample string 1",
    "polygons": [
      {
        "coordinates": [
          {
            "longitud": 1.1,
            "latitud": 2.1
          },
          {
            "longitud": 1.1,
            "latitud": 2.1
          }
        ]
      },
      {
        "coordinates": [
          {
            "longitud": 1.1,
            "latitud": 2.1
          },
          {
            "longitud": 1.1,
            "latitud": 2.1
          }
        ]
      }
    ],
    "name": "sample string 2",
    "customerId": "sample string 3",
    "officeId": "sample string 4"
  }
]

<ArrayOfFocusArea xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.FocusArea">
  <FocusArea>
    <CustomerId>sample string 3</CustomerId>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
    <OfficeId>sample string 4</OfficeId>
    <Polygons xmlns:d3p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">
      <d3p1:Polygon>
        <d3p1:Coordinates>
          <d3p1:Coordinate>
            <d3p1:Latitud>2.1</d3p1:Latitud>
            <d3p1:Longitud>1.1</d3p1:Longitud>
          </d3p1:Coordinate>
          <d3p1:Coordinate>
            <d3p1:Latitud>2.1</d3p1:Latitud>
            <d3p1:Longitud>1.1</d3p1:Longitud>
          </d3p1:Coordinate>
        </d3p1:Coordinates>
      </d3p1:Polygon>
      <d3p1:Polygon>
        <d3p1:Coordinates>
          <d3p1:Coordinate>
            <d3p1:Latitud>2.1</d3p1:Latitud>
            <d3p1:Longitud>1.1</d3p1:Longitud>
          </d3p1:Coordinate>
          <d3p1:Coordinate>
            <d3p1:Latitud>2.1</d3p1:Latitud>
            <d3p1:Longitud>1.1</d3p1:Longitud>
          </d3p1:Coordinate>
        </d3p1:Coordinates>
      </d3p1:Polygon>
    </Polygons>
  </FocusArea>
  <FocusArea>
    <CustomerId>sample string 3</CustomerId>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
    <OfficeId>sample string 4</OfficeId>
    <Polygons xmlns:d3p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">
      <d3p1:Polygon>
        <d3p1:Coordinates>
          <d3p1:Coordinate>
            <d3p1:Latitud>2.1</d3p1:Latitud>
            <d3p1:Longitud>1.1</d3p1:Longitud>
          </d3p1:Coordinate>
          <d3p1:Coordinate>
            <d3p1:Latitud>2.1</d3p1:Latitud>
            <d3p1:Longitud>1.1</d3p1:Longitud>
          </d3p1:Coordinate>
        </d3p1:Coordinates>
      </d3p1:Polygon>
      <d3p1:Polygon>
        <d3p1:Coordinates>
          <d3p1:Coordinate>
            <d3p1:Latitud>2.1</d3p1:Latitud>
            <d3p1:Longitud>1.1</d3p1:Longitud>
          </d3p1:Coordinate>
          <d3p1:Coordinate>
            <d3p1:Latitud>2.1</d3p1:Latitud>
            <d3p1:Longitud>1.1</d3p1:Longitud>
          </d3p1:Coordinate>
        </d3p1:Coordinates>
      </d3p1:Polygon>
    </Polygons>
  </FocusArea>
</ArrayOfFocusArea>