National Identifiers
National identifiers enttities allow associating different Norway specific identifiers to both folders and records.
- Address (
Adresse) - Building (
Bygning) - Property (
Eiendom) - Plan (
Plan)
Diagram showing the relation of the national identifiers entities to any other entities through its reference fields.
The diagram depicts the most important set of fields, leaving some of the use cases out of it for simplicity.
Address
Address (Adresse) is an entity representing an address.
Data Fields
Common Data Fields
Following the Noark5 specification requirements and the internal implementation details the following set of data fields are present for all entities :
| Field Name | Type | Noark Metadata No. | Required on Create | Value Always Available | Modifiable | Description |
|---|---|---|---|---|---|---|
id |
string | unique entity identifier in the specific Documaster installation, used for referencing the entity in the API. The id for created entities is a numeric value.Default : new value generated on creation Sortable |
||||
version |
string | contains the verions of the entity, used for optimistic locking Default : sequence version number of the entity |
||||
uuid |
string | M001 | globally unique identification of the entity, an UUID value (sysemId) Default : new value generated on creation Indexed, Sortable |
|||
opprettetDato |
timestamp | M600 | date and time at which the entity was created (createdDate) Default : current date time Indexed, Sortable |
|||
opprettetAv |
string | M601 | name of the user that created the entity (createdBy) Default : logged in user name Sortable |
|||
opprettetAvBrukerIdent |
string | M601 | identifier of the user that created the entity (createdByIdent) Default : logged in user identifier Sortable |
Adresse Specific Data Fields
| Field Name | Type | Noark Metadata No. | Required on Create | Value Always Available | Modifiable | Description |
|---|---|---|---|---|---|---|
beskrivelse |
string | M201 | Sortable | |||
adresseKnr |
string | Sortable | ||||
postnr |
string | Sortable | ||||
poststed |
string | Sortable | ||||
adressenavn |
string | address name Sortable |
||||
nummer |
string | Sortable | ||||
adressekode |
string | Sortable | ||||
alternativAdresse |
string | Sortable |
Reference Fields
Only one of the reference fields below can be set for a single Address (Adress).
| Field Name | Referenced Entity Type | Cardinality | Link Required on Create | Modifiable | Description |
|---|---|---|---|---|---|
refMappe |
AbstraktMappe |
0 . . 1 | reference to a folder (any type of folder) for which the Address (Adresse) is attached |
||
refRegistrering |
AbstraktRegistrering |
0 . . 1 | reference to a record (any type of record) for which the Address (Adresse) is attached |
Building
Building (Bygning) is an entity representing a building.
Data Fields
Common Data Fields
Following the Noark5 specification requirements and the internal implementation details the following set of data fields are present for all entities :
| Field Name | Type | Noark Metadata No. | Required on Create | Value Always Available | Modifiable | Description |
|---|---|---|---|---|---|---|
id |
string | unique entity identifier in the specific Documaster installation, used for referencing the entity in the API. The id for created entities is a numeric value.Default : new value generated on creation Sortable |
||||
version |
string | contains the verions of the entity, used for optimistic locking Default : sequence version number of the entity |
||||
uuid |
string | M001 | globally unique identification of the entity, an UUID value (sysemId) Default : new value generated on creation Indexed, Sortable |
|||
opprettetDato |
timestamp | M600 | date and time at which the entity was created (createdDate) Default : current date time Indexed, Sortable |
|||
opprettetAv |
string | M601 | name of the user that created the entity (createdBy) Default : logged in user name Sortable |
|||
opprettetAvBrukerIdent |
string | M601 | identifier of the user that created the entity (createdByIdent) Default : logged in user identifier Sortable |
Bygning Specific Data Fields
| Field Name | Type | Noark Metadata No. | Required on Create | Value Always Available | Modifiable | Description |
|---|---|---|---|---|---|---|
beskrivelse |
string | M201 | Sortable | |||
bygningsnummer |
string | Sortable | ||||
endringsloepenummer |
string | Sortable | ||||
bygningsStatus |
string | Sortable | ||||
bygningsType |
string | Sortable | ||||
bygningsendringsType |
string | Sortable | ||||
koordinatsystem |
string | Sortable | ||||
koordX |
string | Sortable | ||||
koordY |
string | Sortable | ||||
koordZ |
string | Sortable | ||||
etasjeNummer |
string | Sortable | ||||
etasjeplan |
string | Sortable | ||||
bygningsnavn |
string | Sortable | ||||
bruksenhetLoepenr |
string | Sortable |
Reference Fields
Only one of the reference fields below can be set for a single Building (Bygning).
| Field Name | Referenced Entity Type | Cardinality | Link Required on Create | Modifiable | Description |
|---|---|---|---|---|---|
refMappe |
AbstraktMappe |
0 . . 1 | reference to a folder (any type of folder) for which the Building (Bygning) is attached |
||
refRegistrering |
AbstraktRegistrering |
0 . . 1 | reference to a record (any type of record) for which the Building (Bygning) is attached |
Property
Property (Eiendom) is an entity representing a property.
Data Fields
Common Data Fields
Following the Noark5 specification requirements and the internal implementation details the following set of data fields are present for all entities :
| Field Name | Type | Noark Metadata No. | Required on Create | Value Always Available | Modifiable | Description |
|---|---|---|---|---|---|---|
id |
string | unique entity identifier in the specific Documaster installation, used for referencing the entity in the API. The id for created entities is a numeric value.Default : new value generated on creation Sortable |
||||
version |
string | contains the verions of the entity, used for optimistic locking Default : sequence version number of the entity |
||||
uuid |
string | M001 | globally unique identification of the entity, an UUID value (sysemId) Default : new value generated on creation Indexed, Sortable |
|||
opprettetDato |
timestamp | M600 | date and time at which the entity was created (createdDate) Default : current date time Indexed, Sortable |
|||
opprettetAv |
string | M601 | name of the user that created the entity (createdBy) Default : logged in user name Sortable |
|||
opprettetAvBrukerIdent |
string | M601 | identifier of the user that created the entity (createdByIdent) Default : logged in user identifier Sortable |
Eiendom Specific Data Fields
| Field Name | Type | Noark Metadata No. | Required on Create | Value Always Available | Modifiable | Description |
|---|---|---|---|---|---|---|
beskrivelse |
string | M201 | Sortable | |||
knr |
string | Sortable | ||||
gnr |
string | Sortable | ||||
bnr |
string | Sortable | ||||
fnr |
string | Sortable | ||||
snr |
string | Sortable | ||||
bruksnavn |
string | Sortable |
Reference Fields
Only one of the reference fields below can be set for a single Property (Eiendom).
| Field Name | Referenced Entity Type | Cardinality | Link Required on Create | Modifiable | Description |
|---|---|---|---|---|---|
refMappe |
AbstraktMappe |
0 . . 1 | reference to a folder (any type of folder) for which the Property (Eiendom) is attached |
||
refRegistrering |
AbstraktRegistrering |
0 . . 1 | reference to a record (any type of record) for which the Property (Eiendom) is attached |
Plan
Plan (Plan) is an entity representing a plan.
Data Fields
Common Data Fields
Following the Noark5 specification requirements and the internal implementation details the following set of data fields are present for all entities :
| Field Name | Type | Noark Metadata No. | Required on Create | Value Always Available | Modifiable | Description |
|---|---|---|---|---|---|---|
id |
string | unique entity identifier in the specific Documaster installation, used for referencing the entity in the API. The id for created entities is a numeric value.Default : new value generated on creation Sortable |
||||
version |
string | contains the verions of the entity, used for optimistic locking Default : sequence version number of the entity |
||||
uuid |
string | M001 | globally unique identification of the entity, an UUID value (sysemId) Default : new value generated on creation Indexed, Sortable |
|||
opprettetDato |
timestamp | M600 | date and time at which the entity was created (createdDate) Default : current date time Indexed, Sortable |
|||
opprettetAv |
string | M601 | name of the user that created the entity (createdBy) Default : logged in user name Sortable |
|||
opprettetAvBrukerIdent |
string | M601 | identifier of the user that created the entity (createdByIdent) Default : logged in user identifier Sortable |
Plan Specific Data Fields
| Field Name | Type | Noark Metadata No. | Required on Create | Value Always Available | Modifiable | Description |
|---|---|---|---|---|---|---|
beskrivelse |
string | M201 | Sortable | |||
planident |
string | Sortable | ||||
planKommunenummer |
string | only one of planKommunenummer, planLandskode, or planFylkesnummer is required on create
Sortable
|
||||
planLandskode |
string | only one of planKommunenummer, planLandskode, or planFylkesnummer is required on create
Sortable
|
||||
planFylkesnummer |
string | only one of planKommunenummer, planLandskode, or planFylkesnummer is required on create
Sortable
|
||||
plannavn |
string | Sortable | ||||
plantype |
string | Sortable | ||||
planstatus |
string | Sortable | ||||
lovreferanse |
string | Sortable |
Reference Fields
Only one of the reference fields below can be set for a single Plan (Plan).
| Field Name | Referenced Entity Type | Cardinality | Link Required on Create | Modifiable | Description |
|---|---|---|---|---|---|
refMappe |
AbstraktMappe |
0 . . 1 | reference to a folder (any type of folder) for which the Plan (Plan) is attached |
||
refRegistrering |
AbstraktRegistrering |
0 . . 1 | reference to a record (any type of record) for which the Plan (Plan) is attached |