General information

...

What’s changed

The endpoint URLs are changed; where version 5 had a digit 5, version 6 has the digit 6

Enumerated data types changed to String

As the collaboration between banks and real estate brokers requires new values and changing continue to evolve, Ambita must be able to add new values to enumeration. Changing the enumerated type can be regarded as a braking change. Two document statuses are added breaking change and can lead to parsing errors if the client code was generated based on an old enumerated type. Making the data types strings (xs:string) will allow us to add new values without breaking changes.

Two added document statuses

Document status in version 6 has two new statuses, both related to bank-broker collaboration, see below. The new values are MOTTATT_AV_MEGLER and SAMHANDLING_FEILET.

Important

We will add new values to these types and the client (you) should not fail on receiving unknown values! We recommend to log unknown values and not fail the parsing on the client side.

Input values for listHendelser and listHendelserMedStatus

These two operations have the same input/query parameters and will be

Query parameters maxAntall, fraHendelsesId and fraTidspunkt are unchanged.

Query parameter statuser changes data type from wsDokumentStatus to String. This is done to enable us to add new status values without braking the Api (changing the enum type).

Valid status values in time of writing are:

• UTFYLT,

• OPPRETTET,

• UNDER_PART_SIGNERING,

• PART_SIGNERT,

• MOTTATT_AV_MEGLER (new),

• SAMHANDLING_FEILET (new),

• UNDER_SIGNERING,

• FJERNET_FRA_SIGNERING,

• SIGNERT,

• SENDT_TIL_TINGLYSING,

• SENDT_TIL_MEGLER,

• UNDER_TINGLYSING,

• TINGLYST,

• TINGLYSING_FEILET,

• FJERNET_FRA_TINGLYSING;

Query param typer:
Type changed from hendelsesType to String.

Enumerated types changed to string

wsDocumentStatus and documentStatusCode

These two are now reduced to one value (of type string) and the same values are used both for input and response. See Document Status Codes for possible values.

hendelsesType

Event types changed from hendelsesType to string. Valid event types are:

• STATUSOVERGANG,

• DOKUMENT_OPPRETTET,

• DOKUMENT_FJERNET,

• PREREQUISITE_OPPRETTET,

• PREREQUISITE_SLETTET;

wsDokumentKilde

Query parameter kilde changed type from wsDokumentKilde to String

• NETTLESER,

• INTEGRASJON,

• ALLE;

Response:

In the response type hendelse in listHendelserResponse the following changes are:
property type has changed type from hendelsesType to String

The fields nyStatus and gammelStatus has changed type from wsDokumentStatus to String.

============================

Above changes for both listHendelserMedStatus

the field statusCode in documentStatus changes type from documentStatusCode to String
Values are :
SLETTET,
OPPRETTET,
UNDER_PART_SIGNERING,
PART_SIGNERT,
MOTTATT_AV_MEGLER (new),
SAMHANDLING_FEILET (new),
UNDER_SIGNERING,
FJERNET_FRA_SIGNERING,
SIGNERT,
SENDT_TIL_TINGLYSING,
UNDER_TINGLYSING,
SENDT_TIL_MEGLER,
TINGLYST,
TINGLYSING_FEILET,
FJERNET_FRA_TINGLYSING;. Valid sources are:

• NETTLESER (actions performed in the UI)

• INTEGRASJON (actions done through WebService)

• ALLE