Versions Compared

Old Version 4

changes.mady.by.user Per-Christian Svendsen

Saved on

compared with

New Version 5

changes.mady.by.user Yohan Wijeratne (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Scenario 1: Uploading a document to a Plant

A typical use case for When a third-party application using uses the Boligmappa web service for uploading to upload a document to a plant would have a workflow Plant, the workflow will be as follows.

  • Lookup Finding a property

Based on

address/name-info

name/address information available in the third-party application

  • If
    • the web method
  • choosing LookupPropertyByAddress
    •  return
  •  returns 0 results, the
    • address/name-info
  • name/address information provided by the third-party app needs to be verified/corrected. We have also seen examples where a lack of consistency in Infoland records
    • may result
  • results in 0 records returned, even if the input is correct.
  • If more than 1 result is returned, the third-party application will typically
    • present the list to the user and have
  • return a list, and the user can select the correct record.

Based on cadastre (NO: matrikkel) information available in the third-party application

  • If the property address
    • information is not available for a given property and if matrikkel information is available LookupPropertyByMatrikkel web method can be used to
  • is unavailable, but the cadastre is known, choosing LookupPropertyByMatrikkel will retrieve the property information.

Based on Boligmappa number

When looking for an already existing

plant

Plant

  • If Boligmappa number,
    • matrikkel and address is not available and if
  • cadastre or address are unknown, and a user is looking for
    • an already
  • a Plant created
    • plant
  • by his company
    • GetAllPlants web method can be used. This method returns property and plant information of all the plants created by the company of authenticated user.

 

  • Create , choosing GetAllPlants will return property and Plant information for all Plants created by the company’s authorized users.

Creating a Plant in the Boligmappa system using the information returned from the LookupPropertyByAddress service:

 
  • .
  • Please note: cadastre information must be provided. The more additional information is provided, the more efficient the search for the property will be. For regular and sectioned properties, it is usually possible to create the property Plant by using only the cadastre. When this is not sufficient, the user will be asked to provide more details such as address, unit number and building number. For housing cooperative shares, the user must provide either 1) share number and organization number, or 2) address, unit number and building number, along with the cadastre. Of these two, alternative 1) is more efficient.
  • Select CreateBuildingPlant to create a Building Plant, and fill in the cadastre information.
  • Submit document(s) for the selected plant by using web service operation Plant by choosing SendDocument or SendDocuments.
  • Use information returned from LookupPropertyByAddress, CreatePropertyPlantByBoligmappaNumber,  CreatePropertyPlantByMatrikkel or CreatePropertyPlantForHousingCooperative as input to SendDocument CreatePropertyPlant or CreateBuildingPlant in order to link the document to the correct property. NOTE: Select GetChapterTags to retrieve the chapter tags that are needed for SendDocument or SendDocuments to add the documents to the correct chapter in Boligmappa.
  • It is also possible to select GetRoomsForProperty to add the document to a specific room.
    • If no rooms are available, AddRoom web method will add a room to a property.
    • If the document is related to FDV on a device such as water guard (vannstopper) or stove guard (komfyrvakt), choosing CreateDevices may be useful, as well.

If the property does not exist

with plant

as a Plant in Boligmappa, or the input parameter details are incorrect, then SendDocument will

throw

result in an error message.

 

IMPORTANT: The Boligmappa number is returned by LookupPropertyByAddress,  CreatePropertyPlantByMatrikkel and CreatePropertyPlantForHousingCooperative if the property already exists in Boligmappa system or CreatePropertyPlant and CreateBuldingPlant. We recommend that third-party applications store this in their the database for future use when sending documents etc. to the same property.

Scenario 2: Sending a Job Note

Some professionals don’t have documents associated with their each and every job.  In such situations professionals don’t have a proper way to track all the small jobs done by them. Furthermore there is no way to update property owners about these jobs.

SendNoteToPlant web method addresses this problem and can be used to send a note about the each and every job done by a professional to the associated plant. A PDF document will be created with the job description and other information provided by the professional and will be attached to the relevant plant.  Professional can make this document visible to property owner in Boligmappa if needed.

If you have a job description adding section in your ERP system, it is the best place to include this ‘Sending a Job Note’ feature. 

Scenario 3: Several companies are working on the same property

  • The Property with address Rosenlundveien 20 B, 3150 Tolvsrød, is owned by Per-Christian Svendsen, and has Boligmappa number AAA5296.
  • Both companies Pettersens elektriske AS and Oslo Rør AS are doing a job on this property.
  • They each create a Plant by using CreatePlantByBoligmappa web service operation, with the Boligmappa number they received from their customer as input. This results in two plants being created in the system, one for each company, but they are both connected to the same property with the unique Boligmappa number.
  • The user at Pettersen Elektriske AS creates this plant using system ABC:
  • When any user belonging to Pettersen Elektriske is submitting a document with SendDocumet/ SendDocumets web service operation, the document will be linked to the plant created for Pettersen Elektriske.
  • When a user belonging to Oslo Rør is submitting a document, the document will be linked to the plant created for Oslo Rør.

Scenario 4: Get correct owner and address information in the ERP system

When creating a new order or a new customer in the ERP system, our web service can be used as a lookup service to ensure that the information typed in by the user is correct and valid.

Information about the property and owner, delivered through above web services can be displayed to the user so that they can choose the correct information. And that information can be stored in the ERP system.  

Furthermore, the valid information provided through our web methods can be used to validate and update your existing customer database or to avoid duplicates. 

Scenario 5: Show all orders connected to one unique address

Suppose a User need to find a list of orders connected to a specific address over the time. Nowadays, in most ERP systems this is a challenging task. The address model used in most ERP systems consists of street address, house number and house sub number only. This model is failed to provide a unique address to the properties like Housing coop shares and sectioned houses.

But in Boligmappa web service we are dealing with unique matrikkel values.  With the information provided by us, the address is unique all the way to the ‘end apartment’. By performing a property search based on the address, any property can be uniquely identified and all the orders connected to a unique address can be displayed simply. 

Scenario 6: All documents published to one unique address

GetDocumentsByPlantId web method can be used to get all the documents published on one unique address. Documents uploaded by PDA, ERP, connected to different owners or the orders in the past can be retrieved through this web method. This is a great way to show order and documents history on a unique address.

Scenario 7: Create several plants at one time

In some cases, users have to deal with many apartments in a housing cooperative. Let’s say a company gets an order to renovate 180 apartments in one housing cooperative.

In such a case, LookupPropertyByAddress can be used to get all the matrikkels and owner information of that particular housing corporative.  This information can be stored locally in your system and then CreatePropertyPlantForHousingCooperative web method can be called whenever needed, for each apartment to create plants.  Once property information of all the housing cooperative shares are saved locally it is not required to call LookupPropertyByAddress again and again when creating plants. 

Scenario 8: Creating and editing a job document (This web method is s made for electricians)

GenerateJobDocument method can be used to generate a job document for a plant by attaching the related EFO documents. As described in web service method, the job document contains six main sections, namely, Cover Page, Company details page, Contents Page, Chapter 1, Chapter 2 and Chapter 3.

The user should call the GenerateJobDocument method by providing inputs for chapter 2 and 3. The input for chapter 2 is optional, and the users may provide a document as a base 64 encoded string or via a URL. For chapter 3, the users can provide a list of EFO Ids, a base 64 encoded document, or a URL.

The documents provided as a URL or a base 64 encoded string could be of any common document format such as PDF, Word documents, Excel sheets, images etc. The Boligmappa system will attempt to identify the input file type and convert it to PDF.

The GenerateJobDocument method will output a URL which can be used to download the generated document. The generated document will also be attached to the given plant, and the Boligmappa document id of the document will also be returned as a part of the output.

The users can use EditJobDocumentChapterTwo and EditJobDocumentChapterThree methods to edit the chapter 2 and 3 sections of a previously generated job document. Both methods provide the option to either append documents to a chapter, or overwrite the existing chapter with the new document. These methods takes a public URL or a base 64 encoded document as input. Additionally EditJobDocumentChapterThree methods accepts a list of EFO ids as well. If the input to the job document provided by the Boligmappa doc id or a Boligmappa URL, the existing document in the system will be updated, otherwise a new job document, with a new Boligmappa doc id will be generated.

Scenario 9 – Sync property details among several applications

Suppose that a user of a given company has created a plant for a particular property using a one ERP system called ABC. Users of this company has also created plants using another application called XYZ. If users of ABC ERP system want to access the plants created using XYZ application they can use GetAllPlants web method.

This web method returns a list of all the plants created by a particular company using several applications.


 




Panel

On this page:

Table of Contents