BoligmappaApi
Click here for a complete list of operations.
GetDocumentById
This web service returns a document by when queried by the Id.
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/GetDocumentById"
<?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>
<GetDocumentById xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
<documentId>long</documentId>
<applicationName>string</applicationName>
</GetDocumentById>
</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>
<GetDocumentByIdResponse xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
<GetDocumentByIdResult>
<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>
<long>long</long>
<long>long</long>
</RoomIds>
<DeviceIds>
<long>long</long>
<long>long</long>
</DeviceIds>
<ChapterTags>
<ChapterTagOutput>
<Id>int</Id>
<TagName>string</TagName>
<TagDescription>string</TagDescription>
</ChapterTagOutput>
<ChapterTagOutput>
<Id>int</Id>
<TagName>string</TagName>
<TagDescription>string</TagDescription>
</ChapterTagOutput>
</ChapterTags>
<ProjectId>long</ProjectId>
</GetDocumentByIdResult>
</GetDocumentByIdResponse>
</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>
<GetDocumentById xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
<documentId>long</documentId>
<applicationName>string</applicationName>
</GetDocumentById>
</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>
<GetDocumentByIdResponse xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
<GetDocumentByIdResult>
<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>
<long>long</long>
<long>long</long>
</RoomIds>
<DeviceIds>
<long>long</long>
<long>long</long>
</DeviceIds>
<ChapterTags>
<ChapterTagOutput>
<Id>int</Id>
<TagName>string</TagName>
<TagDescription>string</TagDescription>
</ChapterTagOutput>
<ChapterTagOutput>
<Id>int</Id>
<TagName>string</TagName>
<TagDescription>string</TagDescription>
</ChapterTagOutput>
</ChapterTags>
<ProjectId>long</ProjectId>
</GetDocumentByIdResult>
</GetDocumentByIdResponse>
</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/GetDocumentById HTTP/1.1 Host: ws2 Content-Type: application/x-www-form-urlencoded Content-Length: length documentId=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"?>
<Document xmlns="http://webservice.boligmappa.no/BoligmappaApi.asmx">
<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>
<long>long</long>
<long>long</long>
</RoomIds>
<DeviceIds>
<long>long</long>
<long>long</long>
</DeviceIds>
<ChapterTags>
<ChapterTagOutput>
<Id>int</Id>
<TagName>string</TagName>
<TagDescription>string</TagDescription>
</ChapterTagOutput>
<ChapterTagOutput>
<Id>int</Id>
<TagName>string</TagName>
<TagDescription>string</TagDescription>
</ChapterTagOutput>
</ChapterTags>
<ProjectId>long</ProjectId>
</Document>