EksternKommunikation Webservicebeskeder (2025-4)

EksternKommunikation Webservicebeskeder (2025-4)

Siden opdateres automatisk til at afspejle koden.

Webservicebeskeder

Webservicebesked for WsmTest1.Create

Definitions

OrganisationTypeCodeList

 

 

OrganisationTypeCodeList

 

 

format

int32

description

Id på organisationstypen.

enum

[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25 ]

type

integer

MessageHeaderAuthorityModel

 

 

MessageHeaderAuthorityModel

 

 

description

Myndigheden som den registrende bruger har kaldt ind som.

required

[ "OrganisationKode", "OrganisationType" ]

type

object

properties

{ "OrganisationType": { "$ref": "#/definitions/OrganisationTypeCodeList" }, "OrganisationKode": { "description": "Myndighedskode.", "minLength": 1, "pattern": "[-][1]|[0-9]{1,8}", "type": "string" } }

additionalProperties

False

RequestUserTypeCodeList

 

 

RequestUserTypeCodeList

 

 

format

int32

description

Id på den registrende brugers brugertype.

enum

[ 1, 2, 3, 4 ]

type

integer

MessageHeaderUserModel

 

 

MessageHeaderUserModel

 

 

description

Oplysninger om den registrerende bruger.

required

[ "Brugeridentifikation", "Brugernavn", "BrugertypeId", "BrugertypeNavn", "KaldendeMyndighed" ]

type

object

properties

{ "BrugertypeId": { "$ref": "#/definitions/RequestUserTypeCodeList" }, "BrugertypeNavn": { "description": "Navn på den registrende brugers brugertype.", "minLength": 1, "type": "string" }, "Brugernavn": { "description": "Brugernavn på den registrerende bruger.", "minLength": 1, "type": "string" }, "Brugeridentifikation": { "description": "Identifikation på den registrende bruger.", "minLength": 1, "type": "string" }, "Brugeremail": { "description": "Emailadresse på den registrende bruger.", "type": [ "string", "null" ], "x-nullable": true }, "KaldendeMyndighed": { "$ref": "#/definitions/MessageHeaderAuthorityModel" } }

additionalProperties

False

ClientSystemTypeCodeList

 

 

ClientSystemTypeCodeList

 

 

format

int32

description

Id på det system, hvor hændelsen - der forårsagede afsendelsen af webservicesbeskeden - skete.

enum

[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81 ]

type

integer

MessageHeaderOriginModel

 

 

MessageHeaderOriginModel

 

 

description

Angivelse af, hvem der oprindelig var årsagen til afsendelse af webservicebeskeden.

required

[ "RegistrerendeBruger", "RegistrerendeMyndighed", "SystemId", "Systemnavn" ]

type

object

properties

{ "RegistrerendeMyndighed": { "$ref": "#/definitions/MessageHeaderAuthorityModel" }, "RegistrerendeBruger": { "$ref": "#/definitions/MessageHeaderUserModel" }, "SystemId": { "$ref": "#/definitions/ClientSystemTypeCodeList" }, "Systemnavn": { "description": "Navn på det system, hvor hændelsen - der forårsagede afsendelsen af webservicesbeskeden - skete.", "minLength": 1, "type": "string" } }

additionalProperties

False

EntityTypeCodeList

 

 

EntityTypeCodeList

 

 

format

int32

description

Id på entitetstypen, som webservicebeskeden omhandler.

enum

[ 9998, 9999, 30000, 30001, 30002, 30003, 30005, 30007, 30008, 30009, 40000, 50000, 50001, 50002, 50003, 60000, 60001, 60002, 60003, 60005, 60006, 60007, 60008, 60009, 60010, 60011, 60012, 60013, 60014, 60015, 60016, 70000, 70001, 70002, 80001, 80002, 80003, 90000, 90001, 90002, 90003, 90004, 100000, 100001, 100002, 100003, 100004, 100005, 100006, 100007, 100008, 100009, 100010, 100011, 100012, 100013, 100014, 100015, 100016, 110001, 110002, 110003, 110004, 110005, 110006, 110007, 110008, 110009, 110010, 110011, 120001, 120002, 120003, 150000 ]

type

integer

IdentificationTypeCodeList

 

 

IdentificationTypeCodeList

 

 

format

int32

description

Id på identifikationstypen, som f.eks. kan være Cpr-nummer, Cvr-nummer, EscoStar-stillingsberegnelse, mm.

enum

[ 1, 2, 3, 4, 5, 6, 7 ]

type

integer

ChangeTypeCodeList

 

 

ChangeTypeCodeList

 

 

format

int32

description

Id på ændringstypen, der beskriver hvordan entiteten er blevet ændret.

enum

[ 1, 2, 3 ]

type

integer

MessageHeaderModel

 

 

MessageHeaderModel

 

 

description

Teknisk information vedrørende webservicebeskeden.

required

[ "AendringstypeId", "AendringstypeNavn", "BeskedIdentifier", "EksternIdentifier", "EntitetstypeId", "EntitetstypeNavn", "HaendelsesTid", "Identifikation", "IdentifikationstypeId", "IdentifikationstypeNavn", "Miljoe", "Oprindelse" ]

type

object

properties

{ "Oprindelse": { "$ref": "#/definitions/MessageHeaderOriginModel" }, "BeskedIdentifier": { "format": "uuid", "description": "Unik identifikation på webservicebeskeden.", "type": "string" }, "HaendelsesTid": { "format": "date-time", "description": "Tidspunktet for hændelsen der forårsagede afsendelsen af webservicebeskeden.", "type": "string" }, "Miljoe": { "description": "Det STAR-miljø, hvorfra webservicebeskeden er sendt.", "minLength": 1, "type": "string" }, "KorrelationsIdentifier": { "format": "uuid", "description": "Benyttes til sporbarhed til enten det webservicekald, som var årsagen til, at webservicebeskeden blev sendt, også selv om webservicebeskeden blev sendt som en afledt handling i et andet forretningsdomæne end dét, hvor webservicekaldet blev modtaget, eller det STAR Batchjob, som var årsagen til, at webservicebeskeden blev sendt, også selv om webservicebeskeden blev sendt som en afledt handling i et andet forretningsdomæne end dér, hvor STAR Batchjobbet kører.", "type": [ "string", "null" ], "x-nullable": true }, "EntitetstypeId": { "$ref": "#/definitions/EntityTypeCodeList" }, "EntitetstypeNavn": { "description": "Navn på entitetstypen, som webservicebeskeden omhandler.", "minLength": 1, "type": "string" }, "EksternIdentifier": { "format": "uuid", "description": "Unik identifikation på entiteten, som webservicebeskeden omhandler.", "type": "string" }, "VersionIdentifier": { "format": "uuid", "description": "Versionering af entiteten, som webservicebeskeden omhandler.", "type": [ "string", "null" ], "x-nullable": true }, "Identifikation": { "description": "Identifikation af den borger, virksomhed eller forretningsobjekt som webservicebeskeden omhandler.", "minLength": 1, "type": "string" }, "IdentifikationstypeId": { "$ref": "#/definitions/IdentificationTypeCodeList" }, "IdentifikationstypeNavn": { "description": "Navn på identifikationstypen, som f.eks. kan være Cpr-nummer, Cvr-nummer, EscoStar-stillingsberegnelse, mm.", "minLength": 1, "type": "string" }, "AendringstypeId": { "$ref": "#/definitions/ChangeTypeCodeList" }, "AendringstypeNavn": { "description": "Navn på ændringstypen, der beskriver hvordan entiteten er blevet ændret.", "minLength": 1, "type": "string" } }

additionalProperties

False

Webservicebesked for WsmTest1.Update

Definitions

OrganisationTypeCodeList

 

 

OrganisationTypeCodeList

 

 

format

int32

description

Id på organisationstypen.

enum

[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25 ]

type

integer

MessageHeaderAuthorityModel

 

 

MessageHeaderAuthorityModel

 

 

description

Myndigheden som den registrende bruger har kaldt ind som.

required

[ "OrganisationKode", "OrganisationType" ]

type

object

properties

{ "OrganisationType": { "$ref": "#/definitions/OrganisationTypeCodeList" }, "OrganisationKode": { "description": "Myndighedskode.", "minLength": 1, "pattern": "[-][1]|[0-9]{1,8}", "type": "string" } }

additionalProperties

False

RequestUserTypeCodeList

 

 

RequestUserTypeCodeList

 

 

format

int32

description

Id på den registrende brugers brugertype.

enum

[ 1, 2, 3, 4 ]

type

integer

MessageHeaderUserModel

 

 

MessageHeaderUserModel

 

 

description

Oplysninger om den registrerende bruger.

required

[ "Brugeridentifikation", "Brugernavn", "BrugertypeId", "BrugertypeNavn", "KaldendeMyndighed" ]

type

object

properties

{ "BrugertypeId": { "$ref": "#/definitions/RequestUserTypeCodeList" }, "BrugertypeNavn": { "description": "Navn på den registrende brugers brugertype.", "minLength": 1, "type": "string" }, "Brugernavn": { "description": "Brugernavn på den registrerende bruger.", "minLength": 1, "type": "string" }, "Brugeridentifikation": { "description": "Identifikation på den registrende bruger.", "minLength": 1, "type": "string" }, "Brugeremail": { "description": "Emailadresse på den registrende bruger.", "type": [ "string", "null" ], "x-nullable": true }, "KaldendeMyndighed": { "$ref": "#/definitions/MessageHeaderAuthorityModel" } }

additionalProperties

False

ClientSystemTypeCodeList

 

 

ClientSystemTypeCodeList

 

 

format

int32

description

Id på det system, hvor hændelsen - der forårsagede afsendelsen af webservicesbeskeden - skete.

enum

[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81 ]

type

integer

MessageHeaderOriginModel

 

 

MessageHeaderOriginModel

 

 

description

Angivelse af, hvem der oprindelig var årsagen til afsendelse af webservicebeskeden.

required

[ "RegistrerendeBruger", "RegistrerendeMyndighed", "SystemId", "Systemnavn" ]

type

object

properties

{ "RegistrerendeMyndighed": { "$ref": "#/definitions/MessageHeaderAuthorityModel" }, "RegistrerendeBruger": { "$ref": "#/definitions/MessageHeaderUserModel" }, "SystemId": { "$ref": "#/definitions/ClientSystemTypeCodeList" }, "Systemnavn": { "description": "Navn på det system, hvor hændelsen - der forårsagede afsendelsen af webservicesbeskeden - skete.", "minLength": 1, "type": "string" } }

additionalProperties

False

EntityTypeCodeList

 

 

EntityTypeCodeList

 

 

format

int32

description

Id på entitetstypen, som webservicebeskeden omhandler.

enum

[ 9998, 9999, 30000, 30001, 30002, 30003, 30005, 30007, 30008, 30009, 40000, 50000, 50001, 50002, 50003, 60000, 60001, 60002, 60003, 60005, 60006, 60007, 60008, 60009, 60010, 60011, 60012, 60013, 60014, 60015, 60016, 70000, 70001, 70002, 80001, 80002, 80003, 90000, 90001, 90002, 90003, 90004, 100000, 100001, 100002, 100003, 100004, 100005, 100006, 100007, 100008, 100009, 100010, 100011, 100012, 100013, 100014, 100015, 100016, 110001, 110002, 110003, 110004, 110005, 110006, 110007, 110008, 110009, 110010, 110011, 120001, 120002, 120003, 150000 ]

type

integer

IdentificationTypeCodeList

 

 

IdentificationTypeCodeList

 

 

format

int32

description

Id på identifikationstypen, som f.eks. kan være Cpr-nummer, Cvr-nummer, EscoStar-stillingsberegnelse, mm.

enum

[ 1, 2, 3, 4, 5, 6, 7 ]

type

integer

ChangeTypeCodeList

 

 

ChangeTypeCodeList

 

 

format

int32

description

Id på ændringstypen, der beskriver hvordan entiteten er blevet ændret.

enum

[ 1, 2, 3 ]

type

integer

MessageHeaderModel

 

 

MessageHeaderModel

 

 

description

Teknisk information vedrørende webservicebeskeden.

required

[ "AendringstypeId", "AendringstypeNavn", "BeskedIdentifier", "EksternIdentifier", "EntitetstypeId", "EntitetstypeNavn", "HaendelsesTid", "Identifikation", "IdentifikationstypeId", "IdentifikationstypeNavn", "Miljoe", "Oprindelse" ]

type

object

properties

{ "Oprindelse": { "$ref": "#/definitions/MessageHeaderOriginModel" }, "BeskedIdentifier": { "format": "uuid", "description": "Unik identifikation på webservicebeskeden.", "type": "string" }, "HaendelsesTid": { "format": "date-time", "description": "Tidspunktet for hændelsen der forårsagede afsendelsen af webservicebeskeden.", "type": "string" }, "Miljoe": { "description": "Det STAR-miljø, hvorfra webservicebeskeden er sendt.", "minLength": 1, "type": "string" }, "KorrelationsIdentifier": { "format": "uuid", "description": "Benyttes til sporbarhed til enten det webservicekald, som var årsagen til, at webservicebeskeden blev sendt, også selv om webservicebeskeden blev sendt som en afledt handling i et andet forretningsdomæne end dét, hvor webservicekaldet blev modtaget, eller det STAR Batchjob, som var årsagen til, at webservicebeskeden blev sendt, også selv om webservicebeskeden blev sendt som en afledt handling i et andet forretningsdomæne end dér, hvor STAR Batchjobbet kører.", "type": [ "string", "null" ], "x-nullable": true }, "EntitetstypeId": { "$ref": "#/definitions/EntityTypeCodeList" }, "EntitetstypeNavn": { "description": "Navn på entitetstypen, som webservicebeskeden omhandler.", "minLength": 1, "type": "string" }, "EksternIdentifier": { "format": "uuid", "description": "Unik identifikation på entiteten, som webservicebeskeden omhandler.", "type": "string" }, "VersionIdentifier": { "format": "uuid", "description": "Versionering af entiteten, som webservicebeskeden omhandler.", "type": [ "string", "null" ], "x-nullable": true }, "Identifikation": { "description": "Identifikation af den borger, virksomhed eller forretningsobjekt som webservicebeskeden omhandler.", "minLength": 1, "type": "string" }, "IdentifikationstypeId": { "$ref": "#/definitions/IdentificationTypeCodeList" }, "IdentifikationstypeNavn": { "description": "Navn på identifikationstypen, som f.eks. kan være Cpr-nummer, Cvr-nummer, EscoStar-stillingsberegnelse, mm.", "minLength": 1, "type": "string" }, "AendringstypeId": { "$ref": "#/definitions/ChangeTypeCodeList" }, "AendringstypeNavn": { "description": "Navn på ændringstypen, der beskriver hvordan entiteten er blevet ændret.", "minLength": 1, "type": "string" } }

additionalProperties

False

Webservicebesked for WsmTest1.Delete

Definitions

OrganisationTypeCodeList

 

 

OrganisationTypeCodeList

 

 

format

int32

description

Id på organisationstypen.

enum

[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25 ]

type

integer

MessageHeaderAuthorityModel

 

 

MessageHeaderAuthorityModel

 

 

description

Myndigheden som den registrende bruger har kaldt ind som.

required

[ "OrganisationKode", "OrganisationType" ]

type

object

properties

{ "OrganisationType": { "$ref": "#/definitions/OrganisationTypeCodeList" }, "OrganisationKode": { "description": "Myndighedskode.", "minLength": 1, "pattern": "[-][1]|[0-9]{1,8}", "type": "string" } }

additionalProperties

False

RequestUserTypeCodeList

 

 

RequestUserTypeCodeList

 

 

format

int32

description

Id på den registrende brugers brugertype.

enum

[ 1, 2, 3, 4 ]

type

integer

MessageHeaderUserModel

 

 

MessageHeaderUserModel

 

 

description

Oplysninger om den registrerende bruger.

required

[ "Brugeridentifikation", "Brugernavn", "BrugertypeId", "BrugertypeNavn", "KaldendeMyndighed" ]

type

object

properties

{ "BrugertypeId": { "$ref": "#/definitions/RequestUserTypeCodeList" }, "BrugertypeNavn": { "description": "Navn på den registrende brugers brugertype.", "minLength": 1, "type": "string" }, "Brugernavn": { "description": "Brugernavn på den registrerende bruger.", "minLength": 1, "type": "string" }, "Brugeridentifikation": { "description": "Identifikation på den registrende bruger.", "minLength": 1, "type": "string" }, "Brugeremail": { "description": "Emailadresse på den registrende bruger.", "type": [ "string", "null" ], "x-nullable": true }, "KaldendeMyndighed": { "$ref": "#/definitions/MessageHeaderAuthorityModel" } }

additionalProperties

False

ClientSystemTypeCodeList

 

 

ClientSystemTypeCodeList

 

 

format

int32

description

Id på det system, hvor hændelsen - der forårsagede afsendelsen af webservicesbeskeden - skete.