BoligmappaApi Web Service

BoligmappaApi

Click here for a complete list of operations.

GetMyDocumentsByPlantId

This web method retrieves all the documents uploaded by the calling user to the given plant.

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/GetMyDocumentsByPlantId"

<?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>
    <GetMyDocumentsByPlantId xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
      <input>
        <plantId>long</plantId>
      </input>
      <applicationName>string</applicationName>
    </GetMyDocumentsByPlantId>
  </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>
    <GetMyDocumentsByPlantIdResponse xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
      <GetMyDocumentsByPlantIdResult>
        <Document>
          <Document>
            <DocumentId>long</DocumentId>
            <FileName>string</FileName>
            <FileTypeId>int</FileTypeId>
            <DocumentTypeId>int</DocumentTypeId>
            <Title>string</Title>
            <Description>string</Description>
            <OrderNumber>string</OrderNumber>
            <UpdatedDate>dateTime</UpdatedDate>
            <Url>string</Url>
            <Path>string</Path>
            <Official>boolean</Official>
            <OwnedById>long</OwnedById>
            <ShowInBoligboken>boolean</ShowInBoligboken>
            <Status>int</Status>
            <PdfDocId>long</PdfDocId>
            <PdfDocPath>string</PdfDocPath>
            <ApplicationTag>string</ApplicationTag>
            <FolderId>long</FolderId>
            <RoomIds xsi:nil="true" />
            <DeviceIds xsi:nil="true" />
            <ChapterTags xsi:nil="true" />
            <ProjectId>long</ProjectId>
          </Document>
          <Document>
            <DocumentId>long</DocumentId>
            <FileName>string</FileName>
            <FileTypeId>int</FileTypeId>
            <DocumentTypeId>int</DocumentTypeId>
            <Title>string</Title>
            <Description>string</Description>
            <OrderNumber>string</OrderNumber>
            <UpdatedDate>dateTime</UpdatedDate>
            <Url>string</Url>
            <Path>string</Path>
            <Official>boolean</Official>
            <OwnedById>long</OwnedById>
            <ShowInBoligboken>boolean</ShowInBoligboken>
            <Status>int</Status>
            <PdfDocId>long</PdfDocId>
            <PdfDocPath>string</PdfDocPath>
            <ApplicationTag>string</ApplicationTag>
            <FolderId>long</FolderId>
            <RoomIds xsi:nil="true" />
            <DeviceIds xsi:nil="true" />
            <ChapterTags xsi:nil="true" />
            <ProjectId>long</ProjectId>
          </Document>
        </Document>
      </GetMyDocumentsByPlantIdResult>
    </GetMyDocumentsByPlantIdResponse>
  </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>
    <GetMyDocumentsByPlantId xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
      <input>
        <plantId>long</plantId>
      </input>
      <applicationName>string</applicationName>
    </GetMyDocumentsByPlantId>
  </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>
    <GetMyDocumentsByPlantIdResponse xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
      <GetMyDocumentsByPlantIdResult>
        <Document>
          <Document>
            <DocumentId>long</DocumentId>
            <FileName>string</FileName>
            <FileTypeId>int</FileTypeId>
            <DocumentTypeId>int</DocumentTypeId>
            <Title>string</Title>
            <Description>string</Description>
            <OrderNumber>string</OrderNumber>
            <UpdatedDate>dateTime</UpdatedDate>
            <Url>string</Url>
            <Path>string</Path>
            <Official>boolean</Official>
            <OwnedById>long</OwnedById>
            <ShowInBoligboken>boolean</ShowInBoligboken>
            <Status>int</Status>
            <PdfDocId>long</PdfDocId>
            <PdfDocPath>string</PdfDocPath>
            <ApplicationTag>string</ApplicationTag>
            <FolderId>long</FolderId>
            <RoomIds xsi:nil="true" />
            <DeviceIds xsi:nil="true" />
            <ChapterTags xsi:nil="true" />
            <ProjectId>long</ProjectId>
          </Document>
          <Document>
            <DocumentId>long</DocumentId>
            <FileName>string</FileName>
            <FileTypeId>int</FileTypeId>
            <DocumentTypeId>int</DocumentTypeId>
            <Title>string</Title>
            <Description>string</Description>
            <OrderNumber>string</OrderNumber>
            <UpdatedDate>dateTime</UpdatedDate>
            <Url>string</Url>
            <Path>string</Path>
            <Official>boolean</Official>
            <OwnedById>long</OwnedById>
            <ShowInBoligboken>boolean</ShowInBoligboken>
            <Status>int</Status>
            <PdfDocId>long</PdfDocId>
            <PdfDocPath>string</PdfDocPath>
            <ApplicationTag>string</ApplicationTag>
            <FolderId>long</FolderId>
            <RoomIds xsi:nil="true" />
            <DeviceIds xsi:nil="true" />
            <ChapterTags xsi:nil="true" />
            <ProjectId>long</ProjectId>
          </Document>
        </Document>
      </GetMyDocumentsByPlantIdResult>
    </GetMyDocumentsByPlantIdResponse>
  </soap12:Body>
</soap12:Envelope>