BoligmappaApi Web Service

BoligmappaApi

Click here for a complete list of operations.

GetDocumentsByProjectId

This method returns a list of documents for the given project

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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

<?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>
    <GetDocumentsByProjectId xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
      <projectId>long</projectId>
      <projectCode>string</projectCode>
      <applicationName>string</applicationName>
    </GetDocumentsByProjectId>
  </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>
    <GetDocumentsByProjectIdResponse xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
      <GetDocumentsByProjectIdResult>
        <ProjectDocument>
          <DocumentId>long</DocumentId>
          <FileName>string</FileName>
          <FileTypeId>int</FileTypeId>
          <DocumentTypeId>int</DocumentTypeId>
          <Title>string</Title>
          <Description>string</Description>
          <OrderNumber>string</OrderNumber>
          <IsVisibleInBoligmappa>boolean</IsVisibleInBoligmappa>
          <UpdatedDate>dateTime</UpdatedDate>
          <Url>string</Url>
          <PdfDocId>long</PdfDocId>
          <ApplicationTag>string</ApplicationTag>
          <CompanyId>long</CompanyId>
          <ProfessionId>int</ProfessionId>
          <ProfessionName>string</ProfessionName>
          <BuildingId>long</BuildingId>
          <RoomIds>
            <long>long</long>
            <long>long</long>
          </RoomIds>
          <DeviceIds>
            <long>long</long>
            <long>long</long>
          </DeviceIds>
          <OrganizationNumber>long</OrganizationNumber>
          <UpdatedBy>string</UpdatedBy>
          <ChapterTags>
            <ChapterTagOutput xsi:nil="true" />
            <ChapterTagOutput xsi:nil="true" />
          </ChapterTags>
          <Company>
            <Id>long</Id>
            <OrganizationNumber>int</OrganizationNumber>
            <CompanyName>string</CompanyName>
          </Company>
          <ApartmentTags>
            <ApartmentTagsOutput xsi:nil="true" />
            <ApartmentTagsOutput xsi:nil="true" />
          </ApartmentTags>
          <DocumentCopiedPropertyDetails>
            <PropertyDetailsOfCopiedDocuments xsi:nil="true" />
            <PropertyDetailsOfCopiedDocuments xsi:nil="true" />
          </DocumentCopiedPropertyDetails>
        </ProjectDocument>
        <ProjectDocument>
          <DocumentId>long</DocumentId>
          <FileName>string</FileName>
          <FileTypeId>int</FileTypeId>
          <DocumentTypeId>int</DocumentTypeId>
          <Title>string</Title>
          <Description>string</Description>
          <OrderNumber>string</OrderNumber>
          <IsVisibleInBoligmappa>boolean</IsVisibleInBoligmappa>
          <UpdatedDate>dateTime</UpdatedDate>
          <Url>string</Url>
          <PdfDocId>long</PdfDocId>
          <ApplicationTag>string</ApplicationTag>
          <CompanyId>long</CompanyId>
          <ProfessionId>int</ProfessionId>
          <ProfessionName>string</ProfessionName>
          <BuildingId>long</BuildingId>
          <RoomIds>
            <long>long</long>
            <long>long</long>
          </RoomIds>
          <DeviceIds>
            <long>long</long>
            <long>long</long>
          </DeviceIds>
          <OrganizationNumber>long</OrganizationNumber>
          <UpdatedBy>string</UpdatedBy>
          <ChapterTags>
            <ChapterTagOutput xsi:nil="true" />
            <ChapterTagOutput xsi:nil="true" />
          </ChapterTags>
          <Company>
            <Id>long</Id>
            <OrganizationNumber>int</OrganizationNumber>
            <CompanyName>string</CompanyName>
          </Company>
          <ApartmentTags>
            <ApartmentTagsOutput xsi:nil="true" />
            <ApartmentTagsOutput xsi:nil="true" />
          </ApartmentTags>
          <DocumentCopiedPropertyDetails>
            <PropertyDetailsOfCopiedDocuments xsi:nil="true" />
            <PropertyDetailsOfCopiedDocuments xsi:nil="true" />
          </DocumentCopiedPropertyDetails>
        </ProjectDocument>
      </GetDocumentsByProjectIdResult>
    </GetDocumentsByProjectIdResponse>
  </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>
    <GetDocumentsByProjectId xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
      <projectId>long</projectId>
      <projectCode>string</projectCode>
      <applicationName>string</applicationName>
    </GetDocumentsByProjectId>
  </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>
    <GetDocumentsByProjectIdResponse xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
      <GetDocumentsByProjectIdResult>
        <ProjectDocument>
          <DocumentId>long</DocumentId>
          <FileName>string</FileName>
          <FileTypeId>int</FileTypeId>
          <DocumentTypeId>int</DocumentTypeId>
          <Title>string</Title>
          <Description>string</Description>
          <OrderNumber>string</OrderNumber>
          <IsVisibleInBoligmappa>boolean</IsVisibleInBoligmappa>
          <UpdatedDate>dateTime</UpdatedDate>
          <Url>string</Url>
          <PdfDocId>long</PdfDocId>
          <ApplicationTag>string</ApplicationTag>
          <CompanyId>long</CompanyId>
          <ProfessionId>int</ProfessionId>
          <ProfessionName>string</ProfessionName>
          <BuildingId>long</BuildingId>
          <RoomIds>
            <long>long</long>
            <long>long</long>
          </RoomIds>
          <DeviceIds>
            <long>long</long>
            <long>long</long>
          </DeviceIds>
          <OrganizationNumber>long</OrganizationNumber>
          <UpdatedBy>string</UpdatedBy>
          <ChapterTags>
            <ChapterTagOutput xsi:nil="true" />
            <ChapterTagOutput xsi:nil="true" />
          </ChapterTags>
          <Company>
            <Id>long</Id>
            <OrganizationNumber>int</OrganizationNumber>
            <CompanyName>string</CompanyName>
          </Company>
          <ApartmentTags>
            <ApartmentTagsOutput xsi:nil="true" />
            <ApartmentTagsOutput xsi:nil="true" />
          </ApartmentTags>
          <DocumentCopiedPropertyDetails>
            <PropertyDetailsOfCopiedDocuments xsi:nil="true" />
            <PropertyDetailsOfCopiedDocuments xsi:nil="true" />
          </DocumentCopiedPropertyDetails>
        </ProjectDocument>
        <ProjectDocument>
          <DocumentId>long</DocumentId>
          <FileName>string</FileName>
          <FileTypeId>int</FileTypeId>
          <DocumentTypeId>int</DocumentTypeId>
          <Title>string</Title>
          <Description>string</Description>
          <OrderNumber>string</OrderNumber>
          <IsVisibleInBoligmappa>boolean</IsVisibleInBoligmappa>
          <UpdatedDate>dateTime</UpdatedDate>
          <Url>string</Url>
          <PdfDocId>long</PdfDocId>
          <ApplicationTag>string</ApplicationTag>
          <CompanyId>long</CompanyId>
          <ProfessionId>int</ProfessionId>
          <ProfessionName>string</ProfessionName>
          <BuildingId>long</BuildingId>
          <RoomIds>
            <long>long</long>
            <long>long</long>
          </RoomIds>
          <DeviceIds>
            <long>long</long>
            <long>long</long>
          </DeviceIds>
          <OrganizationNumber>long</OrganizationNumber>
          <UpdatedBy>string</UpdatedBy>
          <ChapterTags>
            <ChapterTagOutput xsi:nil="true" />
            <ChapterTagOutput xsi:nil="true" />
          </ChapterTags>
          <Company>
            <Id>long</Id>
            <OrganizationNumber>int</OrganizationNumber>
            <CompanyName>string</CompanyName>
          </Company>
          <ApartmentTags>
            <ApartmentTagsOutput xsi:nil="true" />
            <ApartmentTagsOutput xsi:nil="true" />
          </ApartmentTags>
          <DocumentCopiedPropertyDetails>
            <PropertyDetailsOfCopiedDocuments xsi:nil="true" />
            <PropertyDetailsOfCopiedDocuments xsi:nil="true" />
          </DocumentCopiedPropertyDetails>
        </ProjectDocument>
      </GetDocumentsByProjectIdResult>
    </GetDocumentsByProjectIdResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP POST

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

POST /boligmappaapi.asmx/GetDocumentsByProjectId HTTP/1.1
Host: ws2
Content-Type: application/x-www-form-urlencoded
Content-Length: length

projectId=string&projectCode=string&applicationName=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfProjectDocument xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
  <ProjectDocument>
    <DocumentId>long</DocumentId>
    <FileName>string</FileName>
    <FileTypeId>int</FileTypeId>
    <DocumentTypeId>int</DocumentTypeId>
    <Title>string</Title>
    <Description>string</Description>
    <OrderNumber>string</OrderNumber>
    <IsVisibleInBoligmappa>boolean</IsVisibleInBoligmappa>
    <UpdatedDate>dateTime</UpdatedDate>
    <Url>string</Url>
    <PdfDocId>long</PdfDocId>
    <ApplicationTag>string</ApplicationTag>
    <CompanyId>long</CompanyId>
    <ProfessionId>int</ProfessionId>
    <ProfessionName>string</ProfessionName>
    <BuildingId>long</BuildingId>
    <RoomIds>
      <long>long</long>
      <long>long</long>
    </RoomIds>
    <DeviceIds>
      <long>long</long>
      <long>long</long>
    </DeviceIds>
    <OrganizationNumber>long</OrganizationNumber>
    <UpdatedBy>string</UpdatedBy>
    <ChapterTags>
      <ChapterTagOutput>
        <Id>int</Id>
        <TagName>string</TagName>
        <TagDescription>string</TagDescription>
      </ChapterTagOutput>
      <ChapterTagOutput>
        <Id>int</Id>
        <TagName>string</TagName>
        <TagDescription>string</TagDescription>
      </ChapterTagOutput>
    </ChapterTags>
    <Company>
      <Id>long</Id>
      <OrganizationNumber>int</OrganizationNumber>
      <CompanyName>string</CompanyName>
    </Company>
    <ApartmentTags>
      <ApartmentTagsOutput>
        <ApartmentTagId>long</ApartmentTagId>
        <ApartmentTagName>string</ApartmentTagName>
        <ApartmentTagStatus>int</ApartmentTagStatus>
        <ApartmentTagDocumentCount>int</ApartmentTagDocumentCount>
      </ApartmentTagsOutput>
      <ApartmentTagsOutput>
        <ApartmentTagId>long</ApartmentTagId>
        <ApartmentTagName>string</ApartmentTagName>
        <ApartmentTagStatus>int</ApartmentTagStatus>
        <ApartmentTagDocumentCount>int</ApartmentTagDocumentCount>
      </ApartmentTagsOutput>
    </ApartmentTags>
    <DocumentCopiedPropertyDetails>
      <PropertyDetailsOfCopiedDocuments>
        <PlantId>long</PlantId>
        <BoligmappaNumber>string</BoligmappaNumber>
      </PropertyDetailsOfCopiedDocuments>
      <PropertyDetailsOfCopiedDocuments>
        <PlantId>long</PlantId>
        <BoligmappaNumber>string</BoligmappaNumber>
      </PropertyDetailsOfCopiedDocuments>
    </DocumentCopiedPropertyDetails>
  </ProjectDocument>
  <ProjectDocument>
    <DocumentId>long</DocumentId>
    <FileName>string</FileName>
    <FileTypeId>int</FileTypeId>
    <DocumentTypeId>int</DocumentTypeId>
    <Title>string</Title>
    <Description>string</Description>
    <OrderNumber>string</OrderNumber>
    <IsVisibleInBoligmappa>boolean</IsVisibleInBoligmappa>
    <UpdatedDate>dateTime</UpdatedDate>
    <Url>string</Url>
    <PdfDocId>long</PdfDocId>
    <ApplicationTag>string</ApplicationTag>
    <CompanyId>long</CompanyId>
    <ProfessionId>int</ProfessionId>
    <ProfessionName>string</ProfessionName>
    <BuildingId>long</BuildingId>
    <RoomIds>
      <long>long</long>
      <long>long</long>
    </RoomIds>
    <DeviceIds>
      <long>long</long>
      <long>long</long>
    </DeviceIds>
    <OrganizationNumber>long</OrganizationNumber>
    <UpdatedBy>string</UpdatedBy>
    <ChapterTags>
      <ChapterTagOutput>
        <Id>int</Id>
        <TagName>string</TagName>
        <TagDescription>string</TagDescription>
      </ChapterTagOutput>
      <ChapterTagOutput>
        <Id>int</Id>
        <TagName>string</TagName>
        <TagDescription>string</TagDescription>
      </ChapterTagOutput>
    </ChapterTags>
    <Company>
      <Id>long</Id>
      <OrganizationNumber>int</OrganizationNumber>
      <CompanyName>string</CompanyName>
    </Company>
    <ApartmentTags>
      <ApartmentTagsOutput>
        <ApartmentTagId>long</ApartmentTagId>
        <ApartmentTagName>string</ApartmentTagName>
        <ApartmentTagStatus>int</ApartmentTagStatus>
        <ApartmentTagDocumentCount>int</ApartmentTagDocumentCount>
      </ApartmentTagsOutput>
      <ApartmentTagsOutput>
        <ApartmentTagId>long</ApartmentTagId>
        <ApartmentTagName>string</ApartmentTagName>
        <ApartmentTagStatus>int</ApartmentTagStatus>
        <ApartmentTagDocumentCount>int</ApartmentTagDocumentCount>
      </ApartmentTagsOutput>
    </ApartmentTags>
    <DocumentCopiedPropertyDetails>
      <PropertyDetailsOfCopiedDocuments>
        <PlantId>long</PlantId>
        <BoligmappaNumber>string</BoligmappaNumber>
      </PropertyDetailsOfCopiedDocuments>
      <PropertyDetailsOfCopiedDocuments>
        <PlantId>long</PlantId>
        <BoligmappaNumber>string</BoligmappaNumber>
      </PropertyDetailsOfCopiedDocuments>
    </DocumentCopiedPropertyDetails>
  </ProjectDocument>
</ArrayOfProjectDocument>

Parameter	Value
projectId:
projectCode:
applicationName: