BoligmappaApi Web Service

BoligmappaApi

Click here for a complete list of operations.

SendDocument

This method is used to save a document with or without EFOs for a plant. If the plantId does not exist, it will throw an error.

Test

The test form is only available for methods with primitive types as parameters.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /boligmappaapi.asmx HTTP/1.1
Host: webservice2.boligmappa.no
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://webservice.boligmappa.no/BoligmappaApi.asmx/SendDocument"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <UserAuthentication xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
      <UserName>string</UserName>
      <Password>string</Password>
    </UserAuthentication>
  </soap:Header>
  <soap:Body>
    <SendDocument xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
      <plantId>long</plantId>
      <applicationName>string</applicationName>
      <document>
        <FileName>string</FileName>
        <DocumentTypeId>int</DocumentTypeId>
        <Url>string</Url>
        <Title>string</Title>
        <Description>string</Description>
        <OrderNumber>string</OrderNumber>
        <Data>string</Data>
        <IsVisibleInBoligmappa>boolean</IsVisibleInBoligmappa>
        <ProfessionId>int</ProfessionId>
        <BuildingId>long</BuildingId>
        <RoomIds>
          <long>long</long>
          <long>long</long>
        </RoomIds>
        <DeviceId>long</DeviceId>
        <ChapterTagIds>
          <int>int</int>
          <int>int</int>
        </ChapterTagIds>
        <ApartmentTagIds>
          <int>int</int>
          <int>int</int>
        </ApartmentTagIds>
      </document>
      <propertyOwnerEmail>string</propertyOwnerEmail>
    </SendDocument>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SendDocumentResponse xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
      <SendDocumentResult>
        <DocumentTitle>string</DocumentTitle>
        <DocumentId>long</DocumentId>
        <UploadStatusCode>int</UploadStatusCode>
        <ErrorCode>int</ErrorCode>
      </SendDocumentResult>
    </SendDocumentResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /boligmappaapi.asmx HTTP/1.1
Host: webservice2.boligmappa.no
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <UserAuthentication xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
      <UserName>string</UserName>
      <Password>string</Password>
    </UserAuthentication>
  </soap12:Header>
  <soap12:Body>
    <SendDocument xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
      <plantId>long</plantId>
      <applicationName>string</applicationName>
      <document>
        <FileName>string</FileName>
        <DocumentTypeId>int</DocumentTypeId>
        <Url>string</Url>
        <Title>string</Title>
        <Description>string</Description>
        <OrderNumber>string</OrderNumber>
        <Data>string</Data>
        <IsVisibleInBoligmappa>boolean</IsVisibleInBoligmappa>
        <ProfessionId>int</ProfessionId>
        <BuildingId>long</BuildingId>
        <RoomIds>
          <long>long</long>
          <long>long</long>
        </RoomIds>
        <DeviceId>long</DeviceId>
        <ChapterTagIds>
          <int>int</int>
          <int>int</int>
        </ChapterTagIds>
        <ApartmentTagIds>
          <int>int</int>
          <int>int</int>
        </ApartmentTagIds>
      </document>
      <propertyOwnerEmail>string</propertyOwnerEmail>
    </SendDocument>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SendDocumentResponse xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
      <SendDocumentResult>
        <DocumentTitle>string</DocumentTitle>
        <DocumentId>long</DocumentId>
        <UploadStatusCode>int</UploadStatusCode>
        <ErrorCode>int</ErrorCode>
      </SendDocumentResult>
    </SendDocumentResponse>
  </soap12:Body>
</soap12:Envelope>