Versions Compared

Version Old Version 18 New Version Current
Changes made by

Ronny Opsahl

Bjørn Hamre

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: draw.io diagram "flowchart-send-pant.drawio" edited
Table of Contents
maxLevel2

The aim is to make using our API as transparent as possible whether it is an Ambita broker or not.

...

However, a new AFPant feature for sharing tinglysing information is being developed by DSVE. When this new feature hits production, also pantedokument sent to non-Ambita brokers will get TINGLYST/TINGLYSING_FEILET.

To make the handling uniform whether it is an Ambita broker or not, the preferred handling is polling for events or status. Will work in both cases.

The drawing below depicts an overview of the complete process of sending a pantedokument to a real state broker. Please see below, Ambita broker or non-Ambita broker, for more details about each scenario

Drawio
zoom1
simple0
inComment0
pageId1910374541
custContentId1914044537
lbox1
diagramDisplayNameflowchart-send-pant.drawio
contentVer422
revision422
baseUrlhttps://ambita.atlassian.net/wiki
diagramNameflowchart-send-pant.drawio
pCenter0
width1071
links
tbstyle
height721821

Send pantedokument to an existing settlement for an Ambita broker

The flow diagram below describes steps for Ambita brokers only.

Drawio
zoom1
simple0
inComment0
pageId1910374541
custContentId19185664191945994324
lbox1
diagramDisplayNameflowchart-send-pant-ambitabrokerambitabroker2.drawio
contentVer25
revision25
baseUrlhttps://ambita.atlassian.net/wiki
diagramNameflowchart-send-pant-ambitabrokerambitabroker2.drawio
pCenter0
width773813
links
tbstyle
height321426

If it is an Ambita broker and the settlement exists, the response is immediate and will contain the status MOTTATT_AV_MEGLER:

...

languagexml

...

. To find the correct settlement for Ambita broker, there must be a match between the real estates and buyers in the settlement with the registerenheter and borrowers in the Pantedokument.

Example MOTTATT_AV_MEGLER response for an Ambita broker

Code Block
languagexml
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	  <soap:Body>
 		   <ns2:sendToRealEstateBrokerResponse xmlns:ns2="http://dokument.ws7.etinglysing.no/">
 			<return>
				<status>
					     <return>
        <status>
          <created>2021-01-07T14:50:45.667+01:00</created>
					
          <documentStatusTinglysing/>
					<id>123321123</id>
					
          <id>123321123</id>
          <statusCode>MOTTATT_AV_MEGLER</statusCode>
					
          <description>Pant - 4444/66/66// [G]</description>
					
          <reference>Customer reference</reference>
				
        </status>
				
        <type>PANTEDOKUMENT</type>
				
        <documentVersion>KARTVERKET</documentVersion>
			
      </return>
 		   </ns2:sendToRealEstateBrokerResponse>
  	</soap:Body>
</soap:Envelope>

Pantedokument sent to an existing settlement for an Ambita broker will get TINGLYST or TINGLYSING_FEILET(given that the broker tinglyser pantedokumentet) Se this state diagram for more details.

Alternate flows

For alternate flows, see next chapter.

more details.

Error cases

The following alternate flow might happen:

Scenario

The pantedokument gets SAMHANDLING_FEILET - buyer mismatch

One of the borrowers in the pantedokument does not exists in the brokers settlement. The settlement might not be ready. I these cases, take contact with the real estate broker. If the real estate broker is able to fix the problem, resend the pantedokument.

Error code 9999. The reason for is found in the detail element of the xml.

Example response for the sendToRealEstateBroker when the broker is an Ambita broker:

Code Block
languagexml
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:sendToRealEstateBrokerResponse xmlns:ns2="http://dokument.ws7.etinglysing.no/">
         <return>
            <status>
               <created>2019-09-23T15:26:41.341+02:00</created>
               <documentStatusTinglysing/>
               <id>2650589</id>
               <statusCode>SAMHANDLING_FEILET</statusCode>
               <parentDocumentId>2650590</parentDocumentId>
               <description>Pant - 5555/4444/333// [G]</description>
               <reference>666</reference>
            </status>
            <type>PANTEDOKUMENT</type>
            <documentVersion>KARTVERKET</documentVersion>
            <documentMessages>
               <documentMessage>
                  <detail>Kjøper mangler: Kjøpere i oppgjøret stemmer ikke med panthaver i innsendt pantedokument</detail>
                  <errorGroup>EKSTERNFEIL</errorGroup>
                  <message>Samhandling feilet</message>
                  <errorCode>9999</errorCode>
               </documentMessage>
            </documentMessages>
         </return>
      </ns2:sendToRealEstateBrokerResponse>
   </soap:Body>
</soap:Envelope>

The pantedokument gets SAMHANDLING_FEILET - unable to find settlement

The external broker system is unable to find the settlement. I these cases, take contact with the real estate broker. If the real estate broker is able to fix the problem, resend the pantedokument. It means that the real estates in the Pantedokument does match any settlement for the given broker.

Error code 9999. The reason for is found in the detail element of the xml.

Example response for the sendToRealEstateBroker when the broker is an Ambita broker:

Code Block
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:sendToRealEstateBrokerResponse xmlns:ns2="http://dokument.ws7.etinglysing.no/">
         <return>
            <status>
               <created>2019-09-23T15:26:41.341+02:00</created>
               <documentStatusTinglysing/>
               <id>2650589</id>
               <statusCode>SAMHANDLING_FEILET</statusCode>
               <parentDocumentId>2650590</parentDocumentId>
               <description>Pant - 5555/4444/333// [G]</description>
               <reference>666</reference>
            </status>
            <type>PANTEDOKUMENT</type>
            <documentVersion>KARTVERKET</documentVersion>
            <documentMessages>
               <documentMessage>
                  <detail>Ukjent registerenhet: Finnes ikke oppgjør for for megler 945811714</detail>
                  <errorGroup>EKSTERNFEIL</errorGroup>
                  <message>Samhandling feilet</message>
                  <errorCode>9999</errorCode>
               </documentMessage>
            </documentMessages>
         </return>
      </ns2:sendToRealEstateBrokerResponse>
   </soap:Body>
</soap:Envelope>

Send pantedokument to an external broker

The flow diagram below describes steps for non-Ambita brokers only.

Drawio
zoom1
simple0
inComment0
pageId1910374541
custContentId19140773353152740382
lbox1
diagramDisplayNameflowchart-send-pant-external-brokerbroker2.drawio
contentVer21
revision29
baseUrlhttps://ambita.atlassian.net/wiki
diagramNameflowchart-send-pant-external-brokerbroker2.drawio
pCenter0
width9631071
links
tbstyle
height671641

If a pantedokument is sent to a broker (sendToRealEstateBroker) and a settlement does not exist/is not an Ambita broker, the following steps is executed:

  • Can the real estate broker given, receive pantedokument. Determined by a lookup in Akeldo.

  • The pantedokument is uploaded to AFPant(Altinn) for the broker to download.

  • The pantedokument copy in etinglysing is changed from PART_SIGNER to SENDT_TIL_MEGLER

  • The response will contain will contain SENDT_TIL_MEGLER(See below for an example)

Example SENDT_TIL_MEGLER

...

response

Code Block
languagexml
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns2:sendToRealEstateBrokerResponse xmlns:ns2="http://dokument.ws7.etinglysing.no/">
			<return>
				<status>
					<created>2021-01-07T14:50:45.667+01:00</created>
					<documentStatusTinglysing/>
					<id>123321123</id>

...

<statusCode>SENDT_

...

TIL_MEGLER</statusCode>
					<description>Pant - 4444/66/66// [G]</description>
					<reference>Customer reference</reference>
				</status>
				<type>PANTEDOKUMENT</type>
				<documentVersion>KARTVERKET</documentVersion>
			</return>
		</ns2:sendToRealEstateBrokerResponse>
	</soap:Body>
</soap:Envelope>

The final MOTTATT_AV_MEGLER state must be obtained by polling for event(hendelser) or status(getStatus)

...

Error cases

The following alternate flow might happen

xml

Example, getStatus:

Scenario

Broker is not able to receive pantedokument

Broker is not in Akeldo. In this case the response is immediate and no change is made to etinglysing’s copy of the pantedokument.

ResponseExample, response from sendToRealEstateBroker when the broker is not in akeldo:

Code Block
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <soap:Fault>
         <faultcode>soap:Server</faultcode>
         <faultstring>Megler med org.nr. 999999999 kan ikke motta pantedokumentet elektronisk. Opprett pantedokumentet på papir.: null</faultstring>
         <detail>
            <ns2:FellesDokumentException xmlns:ns2="http://dokument.ws7.etinglysing.no/">
               <exceptionId>1610453917418</exceptionId>
               <documentMessages>
                  <documentMessage>
                     <errorGroup>VALIDERINGSFEIL</errorGroup>
                     <message>Megler med org.nr. 999999999 kan ikke motta pantedokumentet elektronisk. Opprett pantedokumentet på papir.</message>
                     <errorCode>9050</errorCode>
                  </documentMessage>
               </documentMessages>
            </ns2:FellesDokumentException>
         </detail>
      </soap:Fault>
   </soap:Body>
</soap:Envelope>

Pantedokument status does not change from SENDT_TIL_MEGLER

This happens very rarely and it means that there might some technical issue. To resolve this issue, contact the real estate broker.

The pantedokument gets SAMHANDLING_FEILET - buyer mismatch

One of the borrowers in the pantedokument does not exists in the brokers settlement. The settlement might not be ready. I these cases, take contact with the real estate broker. If the real estate broker is able to fix the problem, resend the pantedokument.

Error code 9999. The reason for is found in the detail element of the xml.
The prefix of the text, Kjøper mangler, is supplied by Ambita and the rest of the text is from the external broker system, in this case it is Fant ingen oppdrag i meglersystemet der debitor(er) fra pantedokument stemmer eksakt med kjøper(e) i megleroppdrag.

Example, getStatus:

Code Block
languagexml
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns2:getStatusResponse xmlns:ns2="http://dokument.ws7.etinglysing.no/">
			<return>
				<status>
					<created>2021-01-05T11:02:41.210+01:00</created>
					<documentStatusTinglysing/>
					<id>1234123</id>
					<statusCode>SAMHANDLING_FEILET</statusCode>
					<description>Pant - 5555/4444/333// [G]</description>
					<reference>customerRef</reference>
				</status>
				<type>PANTEDOKUMENT</type>
				<documentVersion>KARTVERKET</documentVersion>
				<documentMessages>
					<documentMessage>
						<detail>Kjøper mangler: Fant ingen oppdrag i meglersystemet der debitor(er) fra pantedokument stemmer eksakt med kjøper(e) i megleroppdrag.</detail>
						<errorGroup>EKSTERNFEIL</errorGroup>
						<message>Samhandling feilet</message>
						<errorCode>9999</errorCode>
					</documentMessage>
				</documentMessages>
			</return>
		</ns2:getStatusResponse>
	</soap:Body>
</soap:Envelope>

The pantedokument gets SAMHANDLING_FEILET - unable to find settlement

The external broker system is unable to find the settlement. I these cases, take contact with the real estate broker. If the real estate broker is able to fix the problem, resend the pantedokument.

Error code 9999. The reason for is found in the detail element of the xml.
The prefix of the text, Ukjent registerenhet:, is supplied by Ambita and the rest of the text is from the external broker system, in this case it is Fant ikke noe oppgjør for eiendomsnøkkel.

Code Block
language
Code Block
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns2:getStatusResponse xmlns:ns2="http://dokument.ws7.etinglysing.no/">
			<return>
				<status>
					<created>2021-01-05T11:02:41.210+01:00</created>
					<documentStatusTinglysing/>
					<id>1234123</id>
					<statusCode>SAMHANDLING_FEILET</statusCode>
					<description>Pant - 5555/4444/333// [G]</description>
					<reference>customerRef</reference>
				</status>
				<type>PANTEDOKUMENT</type>
				<documentVersion>KARTVERKET</documentVersion>
				<documentMessages>
					<documentMessage>
						<detail>Ukjent registerenhet: Fant ikke noe oppgjør for eiendomsnøkkel</detail>
						<errorGroup>EKSTERNFEIL</errorGroup>
						<message>Samhandling feilet</message>
						<errorCode>9999</errorCode>
					</documentMessage>
				</documentMessages>
			</return>
		</ns2:getStatusResponse>
	</soap:Body>
</soap:Envelope>

The pantedokument gets SAMHANDLING_FEILET - rejected

For any number of reasons:

  • sent to an

organisation

  • organization number that no longer has an active customer relationship with the supplier

,

  • incorrect config in Altinn AFPANT

, or

  • invalid shipment

.

  • other unexpected issues

Retry sending the pantedokument and/or make contact with the real estate broker or Ambita kundesupport.

We have never experienced this error in beta or production.

Example, getStatus:

xml
Code Block
language
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns2:getStatusResponse xmlns:ns2="http://dokument.ws7.etinglysing.no/">
			<return>
				<status>
					<created>2021-01-05T11:02:41.210+01:00</created>
					<documentStatusTinglysing/>
					<id>1234123</id>
					<statusCode>SAMHANDLING_FEILET</statusCode>
					<description>Pant - 5555/4444/333// [G]</description>
					<reference>customerRef</reference>
				</status>
				<type>PANTEDOKUMENT</type>
				<documentVersion>KARTVERKET</documentVersion>
				<documentMessages>
					<documentMessage>
						<detail>Avvist: ....</detail>
						<errorGroup>EKSTERNFEIL</errorGroup>
						<message>Samhandling feilet</message>
						<errorCode>9999</errorCode>
					</documentMessage>
				</documentMessages>
			</return>
		</ns2:getStatusResponse>
	</soap:Body>
</soap:Envelope>