Express Connect

Dokumentation för API-funktioner

PUT HousingCooperative/{customerId}/{id} Metod för att uppdatera en bostadsrätt. Request Information URI Parameters

Namn	Beskrivning	Typ	Information
customerId	Kund-id	string	Krävs
id	Id på bostadsrätten	string	Krävs

Body Parameters Bostadsrättsinformationen som ska uppdateras CmsHousingCooperative

Namn	Beskrivning	Typ	Information
BaseInformation	Basinformation	CmsHousingCooperativBaseInformation	Basinformation krävs vid nyupplägg
Interior	Interiör	CmsHousingCooperativInterior
BalconyPatio	Balkong/uteplats	BalconyPatio
ParticipationAndRepairFund	Andelstal/reparationsfond	ParticipationAndRepairFund
Predge	Pant	Predge
Building	Byggnad	Building
FloorAndElevator	Våning/hiss	FloorAndElevator
Price	Pris information	CmsPrice
Sellers	Lista över säljarid'n	Collection of string
Interests	Lista över intressenters id'n	Collection of string
Description	Beskrivning	Description
UserId	Användarid	string	UserId krävs vid nyupplägg och uppdatering
AssignmentSourceId	Intagskälla	integer

{
  "baseInformation": {
    "apartmentNumber": "sample string 1",
    "monthlyFee": 1.1,
    "monthlyFeeDescription": "sample string 2",
    "livingSpace": 1.1,
    "otherSpace": 1.1,
    "portCode": "sample string 3",
    "status": "AssignmentAttempt",
    "address": {
      "municipality": "sample string 1",
      "coordinate": {
        "longitud": 1.1,
        "latitud": 2.1
      },
      "streetAddress": "sample string 2",
      "zipCode": "sample string 3",
      "city": "sample string 4",
      "countryCode": "sample string 5"
    }
  },
  "interior": {
    "numberOfRooms": 1.1,
    "description": "sample string 1",
    "rooms": [
      {
        "heading": "sample string 1",
        "text": "sample string 2"
      },
      {
        "heading": "sample string 1",
        "text": "sample string 2"
      }
    ],
    "kitchenType": "sample string 2"
  },
  "balconyPatio": {
    "summaryBalconyPatio": "sample string 1"
  },
  "participationAndRepairFund": {
    "participationOffAnnualFee": 1.1,
    "participationInAssociation": 1.1,
    "indirectNetDebt": 1,
    "repairFund": 1
  },
  "predge": {
    "pawned": true
  },
  "building": {
    "buildingYear": "sample string 1"
  },
  "floorAndElevator": {
    "floor": 1.1,
    "totalNumberFloors": 1,
    "floorCommentary": "sample string 1",
    "elevator": true,
    "descriptionOfElevator": "sample string 2"
  },
  "price": {
    "startingPrice": 1.1
  },
  "sellers": [
    "sample string 1",
    "sample string 2"
  ],
  "interests": [
    "sample string 1",
    "sample string 2"
  ],
  "description": {
    "sellPhrase": "sample string 1",
    "sellingHeading": "sample string 2",
    "shortSellingDescription": "sample string 3",
    "longSellingDescription": "sample string 4",
    "other": "sample string 5"
  },
  "userId": "sample string 1",
  "assignmentSourceId": 1
}

<CmsHousingCooperative xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Estate.Cms">
  <AssignmentSourceId xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Estate.Cms.Common">1</AssignmentSourceId>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Estate.Cms.Common">sample string 1</UserId>
  <Description xmlns:d2p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Estate.Cms" xmlns="http://schemas.datacontract.org/2004/07/Express.Connect.Api.Models.Estate.Cms.HousingCooperative">
    <d2p1:LongSellingDescription>sample string 4</d2p1:LongSellingDescription>
    <d2p1:Other>sample string 5</d2p1:Other>
    <d2p1:SellPhrase>sample string 1</d2p1:SellPhrase>
    <d2p1:SellingHeading>sample string 2</d2p1:SellingHeading>
    <d2p1:ShortSellingDescription>sample string 3</d2p1:ShortSellingDescription>
  </Description>
  <FloorAndElevator xmlns:d2p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Estate.Cms" xmlns="http://schemas.datacontract.org/2004/07/Express.Connect.Api.Models.Estate.Cms.HousingCooperative">
    <d2p1:DescriptionOfElevator>sample string 2</d2p1:DescriptionOfElevator>
    <d2p1:Elevator>true</d2p1:Elevator>
    <d2p1:Floor>1.1</d2p1:Floor>
    <d2p1:FloorCommentary>sample string 1</d2p1:FloorCommentary>
    <d2p1:TotalNumberFloors>1</d2p1:TotalNumberFloors>
  </FloorAndElevator>
  <Interests xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Express.Connect.Api.Models.Estate.Cms.HousingCooperative">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Interests>
  <Price xmlns:d2p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Estate.Cms.Common" xmlns="http://schemas.datacontract.org/2004/07/Express.Connect.Api.Models.Estate.Cms.HousingCooperative">
    <d2p1:StartingPrice>1.1</d2p1:StartingPrice>
  </Price>
  <Sellers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Express.Connect.Api.Models.Estate.Cms.HousingCooperative">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Sellers>
  <BalconyPatio>
    <SummaryBalconyPatio>sample string 1</SummaryBalconyPatio>
  </BalconyPatio>
  <BaseInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Estate.Cms.HousingCooperative">
    <Address xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Estate.Cms.Common">
      <City xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">sample string 4</City>
      <CountryCode xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">sample string 5</CountryCode>
      <StreetAddress xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">sample string 2</StreetAddress>
      <ZipCode xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">sample string 3</ZipCode>
      <Coordinate xmlns:d4p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">
        <d4p1:Latitud>2.1</d4p1:Latitud>
        <d4p1:Longitud>1.1</d4p1:Longitud>
      </Coordinate>
      <Municipality>sample string 1</Municipality>
    </Address>
    <Status xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Estate.Cms.Common">AssignmentAttempt</Status>
    <d2p1:ApartmentNumber>sample string 1</d2p1:ApartmentNumber>
    <d2p1:LivingSpace>1.1</d2p1:LivingSpace>
    <d2p1:MonthlyFee>1.1</d2p1:MonthlyFee>
    <d2p1:MonthlyFeeDescription>sample string 2</d2p1:MonthlyFeeDescription>
    <d2p1:OtherSpace>1.1</d2p1:OtherSpace>
    <d2p1:PortCode>sample string 3</d2p1:PortCode>
  </BaseInformation>
  <Building>
    <BuildingYear>sample string 1</BuildingYear>
  </Building>
  <Interior xmlns:d2p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Estate.Cms.HousingCooperative">
    <d2p1:Description>sample string 1</d2p1:Description>
    <d2p1:KitchenType>sample string 2</d2p1:KitchenType>
    <d2p1:NumberOfRooms>1.1</d2p1:NumberOfRooms>
    <d2p1:Rooms xmlns:d3p1="http://schemas.datacontract.org/2004/07/Express.Connect.Api.Models.Estate.Cms.Common">
      <d3p1:CmsRoom>
        <d3p1:Heading>sample string 1</d3p1:Heading>
        <d3p1:Text>sample string 2</d3p1:Text>
      </d3p1:CmsRoom>
      <d3p1:CmsRoom>
        <d3p1:Heading>sample string 1</d3p1:Heading>
        <d3p1:Text>sample string 2</d3p1:Text>
      </d3p1:CmsRoom>
    </d2p1:Rooms>
  </Interior>
  <ParticipationAndRepairFund>
    <IndirectNetDebt>1</IndirectNetDebt>
    <ParticipationInAssociation>1.1</ParticipationInAssociation>
    <ParticipationOffAnnualFee>1.1</ParticipationOffAnnualFee>
    <RepairFund>1</RepairFund>
  </ParticipationAndRepairFund>
  <Predge>
    <Pawned>true</Pawned>
  </Predge>
</CmsHousingCooperative>

Response Information Resource Description Metod för att uppdatera en bostadsrätt.

Kodexempel

CURL kommando
Powershell
.NET c#
PHP


curl "https://connect.maklare.vitec.net/HousingCooperative/StringValue/StringValue" -X PUT -H "Content-Type: application/json" -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" -d {\"baseInformation\":{\"apartmentNumber\":\"StringValue\",\"monthlyFee\":0.0,\"monthlyFeeDescription\":\"StringValue\"},\"interior\":{\"numberOfRooms\":0.0,\"description\":\"StringValue\",\"rooms\":[{\"heading\":\"StringValue\",\"text\":\"StringValue\"}]},\"balconyPatio\":{\"summaryBalconyPatio\":\"StringValue\"}}


$URL = "https://connect.maklare.vitec.net/HousingCooperative/StringValue/StringValue"
$data = "{`"baseInformation`":{`"apartmentNumber`":`"StringValue`",`"monthlyFee`":0.0,`"monthlyFeeDescription`":`"StringValue`"},`"interior`":{`"numberOfRooms`":0.0,`"description`":`"StringValue`",`"rooms`":[{`"heading`":`"StringValue`",`"text`":`"StringValue`"}]},`"balconyPatio`":{`"summaryBalconyPatio`":`"StringValue`"}}"
Invoke-WebRequest -Uri $URL -Method PUT -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 = "{\"baseInformation\":{\"apartmentNumber\":\"StringValue\",\"monthlyFee\":0.0,\"monthlyFeeDescription\":\"StringValue\"},\"interior\":{\"numberOfRooms\":0.0,\"description\":\"StringValue\",\"rooms\":[{\"heading\":\"StringValue\",\"text\":\"StringValue\"}]},\"balconyPatio\":{\"summaryBalconyPatio\":\"StringValue\"}}";
using (var response = await HttpClientInstance.PutAsync("HousingCooperative/StringValue/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
    }
}


$URL = "https://connect.maklare.vitec.net/HousingCooperative/StringValue/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 = "{\"baseInformation\":{\"apartmentNumber\":\"StringValue\",\"monthlyFee\":0.0,\"monthlyFeeDescription\":\"StringValue\"},\"interior\":{\"numberOfRooms\":0.0,\"description\":\"StringValue\",\"rooms\":[{\"heading\":\"StringValue\",\"text\":\"StringValue\"}]},\"balconyPatio\":{\"summaryBalconyPatio\":\"StringValue\"}}";
$headers = array( "Content-Type: application/json", "Content-Length: " . strlen($data) );
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');

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
}

Testformulär Text input

Username

Password

customerId

ApartmentNumber

MonthlyFee

MonthlyFeeDescription

LivingSpace

OtherSpace

PortCode

Status

Municipality

Longitud

Latitud

Coordinate

StreetAddress

ZipCode

City

CountryCode

Address

BaseInformation

NumberOfRooms

Description

Rooms

Heading

Text

item

KitchenType

Interior

SummaryBalconyPatio

BalconyPatio

ParticipationOffAnnualFee

ParticipationInAssociation

IndirectNetDebt

RepairFund

ParticipationAndRepairFund

Pawned

Predge

BuildingYear

Building

Floor

TotalNumberFloors

FloorCommentary

Elevator

DescriptionOfElevator

FloorAndElevator

StartingPrice

Price

Sellers

item

Interests

item

SellPhrase

SellingHeading

ShortSellingDescription

LongSellingDescription

Other

Description

UserId

AssignmentSourceId

housingCooperative