Schemas for API's - production

The page contains information regarding the schemas that are used for the interfaces/API’s published or used by the Orchestration component. The schemas on this page are schemas supported in production.

Editor: Kurt Hansen

Content:

Introduction to page

 

On this page you will find both XML and JSON schemas for data models that are supported by the Orchestration component and that are currently used on interfaces for collecting and orchestrating data for digital overviews. The version of schemas inserted in the table below is the version used in production on the Orchestration component.

Schemas are used both in interfaces from the Orchestration component to display clients (Mit Overblik at http://borger.dk ) and in interfaces for data sources.

The page is divided into 2 sections:

  • In section 1 you will find schemas for each data model and a list of known differences between XSD and JSON versions of schemas

  • In section 2 you will find schemas for the core model for Digital Overview. These schemas are included/referenced in schemas for the data models. Users must always download these in order to have a working schema for the data model. Not all schema files are currently updated to include/reference the latest schema for the core model, but have embedded elements from this directly in the schema. An overview of which schemas for the data models that includes/reference the latest scheme for the core model can also be found in the section.

Schemas for the data models

Schemas can be found on and downloaded from this page:

Known differences between XSD and JSON schemas

The table below contains description of known differences between XML/XSD and JSON schemas in the schemas currently in production. Known differences are expected to be removed in future versions of the schemas.

Data model

Schema version

Difference

Details/attribute

Data model

Schema version

Difference

Details/attribute

BorgervendtSag

2.0.1

Difference on casing for entity name of the type definition

Kontaktinformation

 

 

Difference on casing for attribut name

sagsrelationstype

 

 

Difference on casing for attribut name

sagsrelationstypebeskrivelse

KalenderaftalerOgFrister

1.1.0

Mandatory attribute, but not listed as mandatory in JSON schema

Aktivitet.emne

 

 

Mandatory attribute, but not listed as mandatory in JSON schema

AktivitetListevisning.aktivitetstype

borgervendt GældogBetaling

1.0.0

No known differences

 

BorgervendtØkonomiskYdelse

1.0.0

Difference on casing for entity name of the type definition

Ydelseseffektuering

Borgervendtakkreditiv

1.1.0

Different casing between data model and schemas:

  • udstedAf relation is with capital A in the data model but with lower case a in the schemas

<xs:element name="udstedtaf"…

Borgervendtstamdata

1.0.0

Difference on casing for attribut name

Borger.cprnr

 

 

Difference on casing for attribut name

ItSystem.itSystemID

 

 

Difference on casing for attribut name

Myndighed.myndighedskode

 

 

Missing attribute in XSD

Myndighed.myndighedsTekst

 

 

Mandatory attribute, but not listed as mandatory in JSON schema

Stamdataelement.stamdataValuebeskrivelse

Borgervendtakkreditiv

1.1.0

No known differences

 

Versions of schemas for the core model for Digital overview

The designed data models use different versions of the core model for Digital Overblik, both in the data model itself and in the derived schemas.

In the attached spreadsheet you can find an overview of which versions of the core data model that are used in the various data models supported by the Orchestration component.

No Schema has been produced for version 1.0.0 of the core model for Digital Overview, as elements from this version always are embedded in the schemas.

 

Schemas for the core model - Borgervendt Digitalt Overblik

Schemas can be found on and downloaded from this page:

 

 

 

 

Version Date Comment
Current Version (v. 2) Aug 02, 2024 12:23 Kurt Hansen
v. 1 Aug 02, 2024 12:19 Kurt Hansen