Dokumentation för API-funktioner
GET Association/{customerId}/{associationId} Hämtar bostadsrättsförening, ersatt av Advertising/Association. Request Information URI Parameters
NamnBeskrivningTypInformation
customerId string Krävs
associationId string

Response Information Resource Description Hämtar bostadsrättsförening, ersatt av Advertising/Association. Association
NamnBeskrivningTypInformation
Name Föreningsnamn string Ersätt med AdvertisingAssociation.Name
OrganizationalForm Organisationsform string Ersätt med AdvertisingAssociation.OrganizationalForm OBS! Enum
CorporateNumber Organisationsnummer string Ersätt med AdvertisingAssociation.CorporateNumber
StreetAddress Gatuadress string

ZipCode Postnummer string

City Ort string

Email Epostadress Email Ersätt med AdvertisingAssociation.Email OBS! string
HomePage Hemsida string Ersätt med AdvertisingAssociation.HomePage
GenuineAssociation Äkta/oäkta förening boolean Ersätt med AdvertisingAssociation.GenuineAssociation OBS! Enum
PublicContact Kontaktperson (offentlig) string Ersätt med AdvertisingAssociation.PublicContact?.Name
PhonePublicContact Telefon Kontaktperson string Ersätt med AdvertisingAssociation.PublicContact?.CellPhone/OtherPhone
ApplicationEntranceResignation Ansökan in/utträde string

ResponsibleApartmentRegister Ansvarig lägenhetsregister string

GeneralAboutAssociation Allmänt om föreningen string Ersätt med (OverridenDescriptions ?? AdvertisingAssociation.Descriptions).GeneralAboutAssociation
Notes Anteckningar(ej i annonser) string

Finances Föreningens ekonomi och planerade förändringar string Ersätt med (OverridenEconomy ?? AdvertisingAssociation.Economy).Finances
TheAssociationOwnTheGround Äger föreningen marken string Ersätt med (OverridenEconomy ?? AdvertisingAssociation.Economy).TheAssociationOwnTheGround
NumberOfApartments Antal lägenheter integer Ersätt med AdvertisingAssociation.NumberOfApartments
NumberOfRentalUnits Antal hyresrätter integer Ersätt med AdvertisingAssociation.NumberOfRentalApartments OBS! Namnbyte
NumberOfLocals Antal lokaler integer Ersätt med AdvertisingAssociation.NumberOfPremises OBS! Namnbyte
Renovations Renoveringar, utförda och planerade string Ersätt med (OverridenDescriptions ?? AdvertisingAssociation.Descriptions).Renovations
Parking Parkering string Ersätt med (OverridenDescriptions ?? AdvertisingAssociation.Descriptions).Parking
TvAndBroadband Tv och bredband string Ersätt med (OverridenDescriptions ?? AdvertisingAssociation.Descriptions).TvAndBroadband
TransferFee Överlåtelseavgift decimal number Ersätt med (OverridenEconomy ?? AdvertisingAssociation.Economy).TransferFee OBS! Integer
PledgeFee Pantsättningsavgift decimal number Ersätt med (OverridenEconomy ?? AdvertisingAssociation.Economy).PledgeFee OBS! Integer
AllowLegalPersonAsBuyer Tillåter föreningen juridisk person som köpare string Ersätt med (OverridenEconomy ?? AdvertisingAssociation.Economy).AllowLegalPersonAsBuyer OBS! Enum
AllowTwinOwnership Föreningen tillåter delat ägande string Ersätt med (OverridenEconomy ?? AdvertisingAssociation.Economy).AllowsSharedOwnershipInfo OBS! Namnbyte
TransferFeePaidBy Överlåtelseavgift betalas av string Ersätt med (OverridenEconomy ?? AdvertisingAssociation.Economy).TransferFeePaidBy OBS! Enum
Courtyard Gårdsplats string Ersätt med (OverridenDescriptions ?? AdvertisingAssociation.Descriptions).Courtyard
Other Övrigt string Ersätt med (OverridenDescriptions ?? AdvertisingAssociation.Descriptions).Other
SharedSpaces Gemensamma utrymmen string Ersätt med (OverridenDescriptions ?? AdvertisingAssociation.Descriptions).SharedSpaces
Documents Publika dokument Collection of Document Ersätt med AdvertisingAssociation.Documents
MonthlyFeeinfinformation Information om månadsavgift string Ersätt med (OverridenEconomy ?? AdvertisingAssociation.Economy).MonthlyFeeInformation OBS! Namnbyte
Images Bilder Collection of AssociationImage

Insurance Försäkring string Ersätt med (OverridenDescriptions ?? AdvertisingAssociation.Descriptions).Insurance
BuildingYear Byggår string

CommentaryForBuildingYear Byggår kommentar string

AssociationAdresses Adresser som hör till BRFen Collection of AssociationAdress

PropertyUnitDesignation Fastighetsbeteckning string

SublettingPolicy Andrahandsuthyrningspolicy string Ersätt med (OverridenEconomy ?? AdvertisingAssociation.Economy).SublettingPolicy
Municipality Kommun string

Coordinate WGS84 Coordinate

Kodexempel

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

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

$URL = "https://connect.maklare.vitec.net/Association/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);

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

$field_on_result = $result["name"];
// TODO: Gör något med resultatet
Testformulär Text input
Response Formats
{
  "name": "sample string 1",
  "organizationalForm": "sample string 2",
  "corporateNumber": "sample string 3",
  "streetAddress": "sample string 4",
  "zipCode": "sample string 5",
  "city": "sample string 6",
  "email": {
    "emailAddress": "sample string 1",
    "emailAddress2": "sample string 2"
  },
  "homePage": "sample string 7",
  "genuineAssociation": true,
  "publicContact": "sample string 8",
  "phonePublicContact": "sample string 9",
  "applicationEntranceResignation": "sample string 10",
  "responsibleApartmentRegister": "sample string 11",
  "generalAboutAssociation": "sample string 12",
  "notes": "sample string 13",
  "finances": "sample string 14",
  "theAssociationOwnTheGround": "sample string 15",
  "numberOfApartments": 16,
  "numberOfRentalUnits": 17,
  "numberOfLocals": 18,
  "renovations": "sample string 19",
  "parking": "sample string 20",
  "tvAndBroadband": "sample string 21",
  "transferFee": 22.0,
  "pledgeFee": 23.0,
  "allowLegalPersonAsBuyer": "sample string 24",
  "allowTwinOwnership": "sample string 25",
  "transferFeePaidBy": "sample string 26",
  "courtyard": "sample string 27",
  "other": "sample string 28",
  "sharedSpaces": "sample string 29",
  "documents": [
    {
      "name": "sample string 1",
      "id": "sample string 2",
      "extension": "sample string 3",
      "url": "sample string 4",
      "dateChangedData": "2024-04-28T16:12:49.5897181+02:00",
      "category": "sample string 5"
    },
    {
      "name": "sample string 1",
      "id": "sample string 2",
      "extension": "sample string 3",
      "url": "sample string 4",
      "dateChangedData": "2024-04-28T16:12:49.5897181+02:00",
      "category": "sample string 5"
    }
  ],
  "monthlyFeeinfinformation": "sample string 30",
  "images": [
    {
      "category": "sample string 1",
      "headning": "sample string 2",
      "description": "sample string 3",
      "orderNumber": 1,
      "imageId": "sample string 4",
      "dateChanged": "2024-04-28T16:12:49.5897181+02:00",
      "dateChangedImageData": "2024-04-28T16:12:49.5897181+02:00",
      "url": "sample string 7",
      "showImageOnInternet": true,
      "extension": "sample string 9",
      "cdnReferences": [
        {
          "name": "sample string 1",
          "url": "sample string 2"
        },
        {
          "name": "sample string 1",
          "url": "sample string 2"
        }
      ]
    },
    {
      "category": "sample string 1",
      "headning": "sample string 2",
      "description": "sample string 3",
      "orderNumber": 1,
      "imageId": "sample string 4",
      "dateChanged": "2024-04-28T16:12:49.5897181+02:00",
      "dateChangedImageData": "2024-04-28T16:12:49.5897181+02:00",
      "url": "sample string 7",
      "showImageOnInternet": true,
      "extension": "sample string 9",
      "cdnReferences": [
        {
          "name": "sample string 1",
          "url": "sample string 2"
        },
        {
          "name": "sample string 1",
          "url": "sample string 2"
        }
      ]
    }
  ],
  "insurance": "sample string 31",
  "buildingYear": "sample string 32",
  "commentaryForBuildingYear": "sample string 33",
  "associationAdresses": [
    {
      "streetAddress": "sample string 1",
      "zipCode": "sample string 2",
      "city": "sample string 3"
    },
    {
      "streetAddress": "sample string 1",
      "zipCode": "sample string 2",
      "city": "sample string 3"
    }
  ],
  "propertyUnitDesignation": "sample string 34",
  "sublettingPolicy": "sample string 35",
  "municipality": "sample string 36",
  "coordinate": {
    "longitud": 1.1,
    "latitud": 2.1
  }
}
<Association xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Association">
  <AllowLegalPersonAsBuyer>sample string 24</AllowLegalPersonAsBuyer>
  <AllowTwinOwnership>sample string 25</AllowTwinOwnership>
  <ApplicationEntranceResignation>sample string 10</ApplicationEntranceResignation>
  <AssociationAdresses>
    <AssociationAdress>
      <City>sample string 3</City>
      <StreetAddress>sample string 1</StreetAddress>
      <ZipCode>sample string 2</ZipCode>
    </AssociationAdress>
    <AssociationAdress>
      <City>sample string 3</City>
      <StreetAddress>sample string 1</StreetAddress>
      <ZipCode>sample string 2</ZipCode>
    </AssociationAdress>
  </AssociationAdresses>
  <BuildingYear>sample string 32</BuildingYear>
  <City>sample string 6</City>
  <CommentaryForBuildingYear>sample string 33</CommentaryForBuildingYear>
  <Coordinate xmlns:d2p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">
    <d2p1:Latitud>2.1</d2p1:Latitud>
    <d2p1:Longitud>1.1</d2p1:Longitud>
  </Coordinate>
  <CorporateNumber>sample string 3</CorporateNumber>
  <Courtyard>sample string 27</Courtyard>
  <Documents xmlns:d2p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Estate.Common">
    <d2p1:Document>
      <d2p1:Category>sample string 5</d2p1:Category>
      <d2p1:DateChangedData>2024-04-28T16:12:49.5897181+02:00</d2p1:DateChangedData>
      <d2p1:Extension>sample string 3</d2p1:Extension>
      <d2p1:Id>sample string 2</d2p1:Id>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Url>sample string 4</d2p1:Url>
    </d2p1:Document>
    <d2p1:Document>
      <d2p1:Category>sample string 5</d2p1:Category>
      <d2p1:DateChangedData>2024-04-28T16:12:49.5897181+02:00</d2p1:DateChangedData>
      <d2p1:Extension>sample string 3</d2p1:Extension>
      <d2p1:Id>sample string 2</d2p1:Id>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Url>sample string 4</d2p1:Url>
    </d2p1:Document>
  </Documents>
  <Email xmlns:d2p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models">
    <d2p1:EmailAddress>sample string 1</d2p1:EmailAddress>
    <d2p1:EmailAddress2>sample string 2</d2p1:EmailAddress2>
  </Email>
  <Finances>sample string 14</Finances>
  <GeneralAboutAssociation>sample string 12</GeneralAboutAssociation>
  <GenuineAssociation>true</GenuineAssociation>
  <HomePage>sample string 7</HomePage>
  <Images xmlns:d2p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Estate.Common">
    <d2p1:AssociationImage>
      <CdnReferences xmlns:d4p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image">
        <d4p1:CdnImageReference>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Url>sample string 2</d4p1:Url>
        </d4p1:CdnImageReference>
        <d4p1:CdnImageReference>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Url>sample string 2</d4p1:Url>
        </d4p1:CdnImageReference>
      </CdnReferences>
      <DateChanged xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image">2024-04-28T16:12:49.5897181+02:00</DateChanged>
      <DateChangedImageData xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image">2024-04-28T16:12:49.5897181+02:00</DateChangedImageData>
      <Extension xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image">sample string 9</Extension>
      <ImageId xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image">sample string 4</ImageId>
      <ShowImageOnInternet xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image">true</ShowImageOnInternet>
      <Url xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image">sample string 7</Url>
      <d2p1:Category>sample string 1</d2p1:Category>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Headning>sample string 2</d2p1:Headning>
      <d2p1:OrderNumber>1</d2p1:OrderNumber>
    </d2p1:AssociationImage>
    <d2p1:AssociationImage>
      <CdnReferences xmlns:d4p1="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image">
        <d4p1:CdnImageReference>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Url>sample string 2</d4p1:Url>
        </d4p1:CdnImageReference>
        <d4p1:CdnImageReference>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Url>sample string 2</d4p1:Url>
        </d4p1:CdnImageReference>
      </CdnReferences>
      <DateChanged xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image">2024-04-28T16:12:49.5897181+02:00</DateChanged>
      <DateChangedImageData xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image">2024-04-28T16:12:49.5897181+02:00</DateChangedImageData>
      <Extension xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image">sample string 9</Extension>
      <ImageId xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image">sample string 4</ImageId>
      <ShowImageOnInternet xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image">true</ShowImageOnInternet>
      <Url xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Image">sample string 7</Url>
      <d2p1:Category>sample string 1</d2p1:Category>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Headning>sample string 2</d2p1:Headning>
      <d2p1:OrderNumber>1</d2p1:OrderNumber>
    </d2p1:AssociationImage>
  </Images>
  <Insurance>sample string 31</Insurance>
  <MonthlyFeeinfinformation>sample string 30</MonthlyFeeinfinformation>
  <Municipality>sample string 36</Municipality>
  <Name>sample string 1</Name>
  <Notes>sample string 13</Notes>
  <NumberOfApartments>16</NumberOfApartments>
  <NumberOfLocals>18</NumberOfLocals>
  <NumberOfRentalUnits>17</NumberOfRentalUnits>
  <OrganizationalForm>sample string 2</OrganizationalForm>
  <Other>sample string 28</Other>
  <Parking>sample string 20</Parking>
  <PhonePublicContact>sample string 9</PhonePublicContact>
  <PledgeFee>23</PledgeFee>
  <PropertyUnitDesignation>sample string 34</PropertyUnitDesignation>
  <PublicContact>sample string 8</PublicContact>
  <Renovations>sample string 19</Renovations>
  <ResponsibleApartmentRegister>sample string 11</ResponsibleApartmentRegister>
  <SharedSpaces>sample string 29</SharedSpaces>
  <StreetAddress>sample string 4</StreetAddress>
  <SublettingPolicy>sample string 35</SublettingPolicy>
  <TheAssociationOwnTheGround>sample string 15</TheAssociationOwnTheGround>
  <TransferFee>22</TransferFee>
  <TransferFeePaidBy>sample string 26</TransferFeePaidBy>
  <TvAndBroadband>sample string 21</TvAndBroadband>
  <ZipCode>sample string 5</ZipCode>
</Association>