Dokumentation för API-funktioner
GET CRM/Estate/{customerId}/{estateId}/mypagesdocuments

Hämtar document för minasidor

Request Information URI Parameters
NamnBeskrivningTypInformation
customerId Kundid string Krävs
estateId Bostadsid string Krävs
Response Information Resource Description Hämtar document för minasidor Collection of MyPagesEstateDocument
NamnBeskrivningTypInformation
Id Id string

Name Namn string

Extension Filtyp string

DocumentSharedWith Ska visas för Collection of DocumentSharedWith

Public Annonseras publikt boolean

Kodexempel

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

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

$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
Response Formats
[
  {
    "id": "sample string 1",
    "name": "sample string 2",
    "extension": "sample string 3",
    "documentSharedWith": [
      "Seller",
      "Seller"
    ],
    "public": true
  },
  {
    "id": "sample string 1",
    "name": "sample string 2",
    "extension": "sample string 3",
    "documentSharedWith": [
      "Seller",
      "Seller"
    ],
    "public": true
  }
]
<ArrayOfMyPagesEstateDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Invoice">
  <MyPagesEstateDocument>
    <DocumentSharedWith>
      <DocumentSharedWith>Seller</DocumentSharedWith>
      <DocumentSharedWith>Seller</DocumentSharedWith>
    </DocumentSharedWith>
    <Extension>sample string 3</Extension>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
    <Public>true</Public>
  </MyPagesEstateDocument>
  <MyPagesEstateDocument>
    <DocumentSharedWith>
      <DocumentSharedWith>Seller</DocumentSharedWith>
      <DocumentSharedWith>Seller</DocumentSharedWith>
    </DocumentSharedWith>
    <Extension>sample string 3</Extension>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
    <Public>true</Public>
  </MyPagesEstateDocument>
</ArrayOfMyPagesEstateDocument>