Taxonomy.EscoStarService (Version 2, 2024-4)
Siden opdateres automatisk til at afspejle koden.
Metoder
- 1 GetOccupation (GET /v2/EscoStar/occupations/{conceptUri})
- 2 GetOccupations (GET /v2/EscoStar/occupations)
- 3 UpdateOccupation (PUT /v2/EscoStar/occupations)
- 4 UpdateAlias (PUT /v2/EscoStar/occupations/alias)
- 5 CreateHierarchyRelation (POST /v2/EscoStar/occupations/hierarchyrelation)
- 6 UpdateHierarchyRelation (PUT /v2/EscoStar/occupations/hierarchyrelation)
GetOccupation (GET /v2/EscoStar/occupations/{conceptUri})
Henter en specifik ESCO STAR stillingsbetegnelse (conceptUri skal URL Encodes).
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
conceptUri [Path] | string |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetOccupationResponseDto |
| 1 | REST-objekt. Serialiseres til JSON |
- occupation | OccupationDto |
| 0 - 1 | Stillingsbetegnelse. |
- - escoStarStatus |
| 1 |
| |
- - conceptUriDa | string | Length: 0-256 | 1 | Unik ESCO STAR identifikation - defineret af STAR.
|
- - conceptUriEu | string | Length: 0-256 | 0 - 1 | Unik ESCO identifikation - kommer fra EU og kan ikke ændres. |
- - parentConceptUriDa | string | Length: 0-256 | 0 - 1 | ESCO STAR identifikation af det overordnede element i ESCO STAR hierarkiet. |
- - escoStatus | string | Length: 0-128 | 0 - 1 | Status givet fra EU. |
- - escoStarType |
| 1 |
| |
- - iscoGroup | string | Length: 0-4 | 0 - 1 | ISCO kode fra EU, kun ved ESCO extensions. vil være udfyldt fra niveau 5 |
- - iscoCode | string | Length: 0-16 | 0 - 1 | ISCO kode, fra EU kun ved de 4 øverste niveauer, som er ISCO i ESCO STAR hierarkiet. |
- - preferredLabelEu | string | Length: 0-512 | 0 - 1 | Dansk stillingsbetegnelse fra EU. |
- - preferredLabelDa | string | Length: 2-512 | 0 - 1 | Dansk stillingsbetegnelse givet i Danmark. |
- - descriptionEu | string |
| 0 - 1 | Beskrivelse givet fra EU. |
- - descriptionDa | string | Length: 2-2048 | 0 - 1 | Beskrivelse givet i Danmark. |
- - regulatedProfessionNote | string | Length: 0-512 | 0 - 1 | Profession note, som er beskyttet af EU. |
- - scopeNote | string |
| 0 - 1 | Afgrænsning note givet fra EU. |
- - definition | string | Length: 0-1024 | 0 - 1 | Definition givet fra EU. |
- - additionalInformation | string | Length: 0-2048 | 0 - 1 | Supplerende information som fritekst. |
- - modifiedByEuDateTime | date-time |
| 0 - 1 | Seneste ændringsdato fra EU. |
- - validFrom | date-time |
| 1 | Hvilken dag stillingsbetegnelsen er aktiv fra |
- - validTo | date-time |
| 1 | Hvilken dag stillingsbetegnelsen er aktiv til |
- - schemes | SchemeDtoCollection |
| 1 | ESCO skemaet, som stillingsbetegnelsen befinder sig i. |
- - - SchemeDto | SchemeDto |
| 0 - * |
|
- - - - scheme | string | Length: 1-256 | 1 | Navn på ESCO skemaet. |
- - tags | TagDtoCollection |
| 1 | Liste med tags på stilllingsbetegnelse i dansk sammenhæng |
- - - TagDto | TagDto |
| 0 - * |
|
- - - - tag |
| 1 |
| |
- - preferredLabelsForeign | PreferredLabelForeignDtoCollection |
| 1 | Liste af udlanske Stillingsbetegnelser. |
- - - PreferredLabelForeignDto | PreferredLabelForeignDto |
| 0 - * |
|
- - - - occupationId | int32 |
| 1 | Id på den tilhørende stillingsbetegnelse |
- - - - languageCode |
| 1 |
| |
- - - - preferredLabel | string | Length: 1-256 | 1 | Tekstbeskrivelse af label. |
- - euescoStatusType |
| 1 |
| |
- - aliases | AliasDtoCollection |
| 1 | Aliases for stillingsbetegnelsen. |
- - - AliasDto | AliasDto |
| 0 - * |
|
- - - - escoStarStatus |
| 1 |
| |
- - - - aliasIdentifier | uuid |
| 1 | Identificerer alias skal oplyses ved opdatering. |
- - - - conceptUriDa | string | Length: 0-256 | 1 | Unik ESCO STAR identifikation - defineret af STAR.
|
- - - - originConceptUriEu | string | Length: 0-256 | 0 - 1 | Unik ESCO Occupation identifikation. Identifikationen sættes på alias som er oprettes på til erstatning af en inaktiveret EU stillingsbetegnelse, som reference til denne |
- - - - alternativeLabelEu | string | Length: 0-512 | 0 - 1 | Alias givet fra EU. |
- - - - alternativeLabelDa | string | Length: 0-512 | 0 - 1 | Alias givet i Danmark. |
- - - - origin |
| 1 |
| |
- - - - relationType |
| 1 |
| |
- - - - euescoStatusType |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
1101 | Client certificate missing from request | Client certificate missing from request |
2002 | Invalid CodeList value | Invalid CodeList value |
4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
GetOccupations (GET /v2/EscoStar/occupations)
Henter alle ESCO STAR stillingsbetegnelser.
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetOccupationsResponseDto |
| 1 | REST-objekt. Serialiseres til JSON |
- occupations | OccupationDtoCollection |
| 1 | ESCO STAR stillingsbetegnelser. |
- - OccupationDto | OccupationDto |
| 0 - * |
|
- - - escoStarStatus |
| 1 |
| |
- - - conceptUriDa | string | Length: 0-256 | 1 | Unik ESCO STAR identifikation - defineret af STAR.
|
- - - conceptUriEu | string | Length: 0-256 | 0 - 1 | Unik ESCO identifikation - kommer fra EU og kan ikke ændres. |
- - - parentConceptUriDa | string | Length: 0-256 | 0 - 1 | ESCO STAR identifikation af det overordnede element i ESCO STAR hierarkiet. |
- - - escoStatus | string | Length: 0-128 | 0 - 1 | Status givet fra EU. |
- - - escoStarType |
| 1 |
| |
- - - iscoGroup | string | Length: 0-4 | 0 - 1 | ISCO kode fra EU, kun ved ESCO extensions. vil være udfyldt fra niveau 5 |
- - - iscoCode | string | Length: 0-16 | 0 - 1 | ISCO kode, fra EU kun ved de 4 øverste niveauer, som er ISCO i ESCO STAR hierarkiet. |
- - - preferredLabelEu | string | Length: 0-512 | 0 - 1 | Dansk stillingsbetegnelse fra EU. |
- - - preferredLabelDa | string | Length: 2-512 | 0 - 1 | Dansk stillingsbetegnelse givet i Danmark. |
- - - descriptionEu | string |
| 0 - 1 | Beskrivelse givet fra EU. |
- - - descriptionDa | string | Length: 2-2048 | 0 - 1 | Beskrivelse givet i Danmark. |
- - - regulatedProfessionNote | string | Length: 0-512 | 0 - 1 | Profession note, som er beskyttet af EU. |
- - - scopeNote | string |
| 0 - 1 | Afgrænsning note givet fra EU. |
- - - definition | string | Length: 0-1024 | 0 - 1 | Definition givet fra EU. |
- - - additionalInformation | string | Length: 0-2048 | 0 - 1 | Supplerende information som fritekst. |
- - - modifiedByEuDateTime | date-time |
| 0 - 1 | Seneste ændringsdato fra EU. |
- - - validFrom | date-time |
| 1 | Hvilken dag stillingsbetegnelsen er aktiv fra |
- - - validTo | date-time |
| 1 | Hvilken dag stillingsbetegnelsen er aktiv til |
- - - schemes | SchemeDtoCollection |
| 1 | ESCO skemaet, som stillingsbetegnelsen befinder sig i. |
- - - - SchemeDto | SchemeDto |
| 0 - * |
|
- - - - - scheme | string | Length: 1-256 | 1 | Navn på ESCO skemaet. |
- - - tags | TagDtoCollection |
| 1 | Liste med tags på stilllingsbetegnelse i dansk sammenhæng |
- - - - TagDto | TagDto |
| 0 - * |
|
- - - - - tag |
| 1 |
| |
- - - preferredLabelsForeign | PreferredLabelForeignDtoCollection |
| 1 | Liste af udlanske Stillingsbetegnelser. |
- - - - PreferredLabelForeignDto | PreferredLabelForeignDto |
| 0 - * |
|
- - - - - occupationId | int32 |
| 1 | Id på den tilhørende stillingsbetegnelse |
- - - - - languageCode |
| 1 |
| |
- - - - - preferredLabel | string | Length: 1-256 | 1 | Tekstbeskrivelse af label. |
- - - euescoStatusType |
| 1 |
| |
- - - aliases | AliasDtoCollection |
| 1 | Aliases for stillingsbetegnelsen. |
- - - - AliasDto | AliasDto |
| 0 - * |
|
- - - - - escoStarStatus |
| 1 |
| |
- - - - - aliasIdentifier | uuid |
| 1 | Identificerer alias skal oplyses ved opdatering. |
- - - - - conceptUriDa | string | Length: 0-256 | 1 | Unik ESCO STAR identifikation - defineret af STAR.
|
- - - - - originConceptUriEu | string | Length: 0-256 | 0 - 1 | Unik ESCO Occupation identifikation. Identifikationen sættes på alias som er oprettes på til erstatning af en inaktiveret EU stillingsbetegnelse, som reference til denne |
- - - - - alternativeLabelEu | string | Length: 0-512 | 0 - 1 | Alias givet fra EU. |
- - - - - alternativeLabelDa | string | Length: 0-512 | 0 - 1 | Alias givet i Danmark. |
- - - - - origin |
| 1 |
| |
- - - - - relationType |
| 1 |
| |
- - - - - euescoStatusType |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
1101 | Client certificate missing from request | Client certificate missing from request |
2002 | Invalid CodeList value | Invalid CodeList value |
4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
UpdateOccupation (PUT /v2/EscoStar/occupations)
Opdaterer en specifik STAR ESCO stillingsbetegnelse.
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
requestBody | UpdateOccupationRequestDto |
| 1 | REST-objekt. Serialiseres til JSON |
- occupation | UpdateOccupationDto |
| 1 | Stillingsbetegnelse. |
- - escoStarStatus |
| 1 |
| |
- - conceptUriDa | string | Length: 0-256 | 1 | Unik ESCO STAR identifikation - defineret af STAR.
|
- - escoStarType |
| 1 |
| |
- - preferredLabelDa | string | Length: 2-512 | 0 - 1 | Dansk stillingsbetegnelse givet i Danmark. |
- - descriptionDa | string | Length: 2-2048 | 0 - 1 | Beskrivelse givet i Danmark. |
- - additionalInformation | string | Length: 0-2048 | 0 - 1 | Supplerende information som fritekst. |
- - euescoStatusType |
| 1 |
|
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
1101 | Client certificate missing from request | Client certificate missing from request |
2002 | Invalid CodeList value | Invalid CodeList value |
4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
40001 | The specified EscoStar Status does not exist. | The specified EscoStar Status does not exist. |
40002 | The specified EscoStar Type does not exist. | The specified EscoStar Type does not exist. |
50001 | EscoStar PreferredLabelDa is a required field. Only plain text (no HTML) is allowed. Minimum text length is 2 characters and maximum 512 characters. | EscoStar PreferredLabelDa is a required field. Only plain text (no HTML) is allowed. Minimum text length is 2 characters and maximum 512 characters. |
50002 | EscoStar DescriptionDa is a required field. Only plain text (no HTML) is allowed. Minimum text length is 2 characters and maximum 2048 characters. | EscoStar DescriptionDa is a required field. Only plain text (no HTML) is allowed. Minimum text length is 2 characters and maximum 2048 characters. |
50003 | Only plain text (no HTML) is allowed for EscoStar AdditionalInformation. Maximum text length is 2048 characters. | Only plain text (no HTML) is allowed for EscoStar AdditionalInformation. Maximum text length is 2048 characters. |
50004 | EscoStar Status should be inactive when Esco Status is inactive. | EscoStar Status should be inactive when Esco Status is inactive. |
50005 | EscoStar Status can not be set to Inactive when Esco Status is active. | EscoStar Status can not be set to Inactive when Esco Status is active. |
50006 | The specified PreferredLabelDa is already in use by another occupation. This is not permitted as it must be unique | The specified PreferredLabelDa is already in use by another occupation. This is not permitted as it must be unique |
UpdateAlias (PUT /v2/EscoStar/occupations/alias)
Opdaterer et alias til en specifik STAR ESCO stillingsbetegnelse.
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
requestBody | UpdateAliasRequestDto |
| 1 | REST-objekt. Serialiseres til JSON |
- alias | UpdateAliasDto |
| 1 | Alias til en stillingsbetegnelse. |
- - escoStarStatus |
| 1 |
| |
- - aliasIdentifier | uuid |
| 1 | Identificerer alias skal oplyses ved opdatering. |
- - alternativeLabelDa | string | Length: 2-512 | 1 | Alias givet i Danmark. |
- - originConceptUriEu | string | Length: 0-256 | 0 - 1 | Unik ESCO Occupation identifikation. Identifikationen sættes på alias som er oprettes på til erstatning af en inaktiveret EU stillingsbetegnelse, som reference til denne |
- - euescoStatusType |
| 1 |
|
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
1101 | Client certificate missing from request | Client certificate missing from request |
2002 | Invalid CodeList value | Invalid CodeList value |
4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
40001 | The specified EscoStar Status does not exist. | The specified EscoStar Status does not exist. |
40007 | The specified EscoStar Alias Origin does not exist. | The specified EscoStar Alias Origin does not exist. |
40003 | The specified EscoStar Occupation does not exist. | The specified EscoStar Occupation does not exist. |
40004 | The specified entity does not exist. | The specified entity does not exist. |
50007 | EscoStar AlternativeLabelDa is a required field. Only plain text (no HTML) is allowed. Minimum text length is 2 characters and maximum 512 characters. | EscoStar AlternativeLabelDa is a required field. Only plain text (no HTML) is allowed. Minimum text length is 2 characters and maximum 512 characters. |
50008 | EscoStar status can not be set to Active when set to Inactive origin by EU. | EscoStar status can not be set to Active when set to Inactive origin by EU. |
50012 | EscoStar status can not be set to Deselected when set to Inactive. | EscoStar status can not be set to Deselected when set to Inactive. |
50014 | EscoStar status can not be set to Inactive. | EscoStar status can not be set to Inactive. |
50018 | EscoStar Alias EscoStarStatus can not be set to Active when another active Alias having the same OriginConceptUriEu specified. | EscoStar Alias EscoStarStatus can not be set to Active when another active Alias having the same OriginConceptUriEu specified. |
CreateHierarchyRelation (POST /v2/EscoStar/occupations/hierarchyrelation)
Opretter en relation imellem en STAR ESCO stillingsbetegnelse og et andet hieraki. F.eks. Jobnet.
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
requestBody | CreateHierarchyElementRelationRequestDto |
| 1 | REST-objekt. Serialiseres til JSON |
- hierarchyRelation | CreateHierarchyElementRelationDto |
| 1 | REST-objekt. Serialiseres til JSON |
- - parentHierarchyElementId | string | Length: 1-256 | 1 | Id på forælder elementet |
- - childHierarchyElementId | string | Length: 1-256 | 1 | Id på barn elementet |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
1101 | Client certificate missing from request | Client certificate missing from request |
2002 | Invalid CodeList value | Invalid CodeList value |
4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
50030 | HierarkiElementRelation forælder element findes ikke | HierarkiElementRelation forælder element findes ikke |
50031 | HierarkiElementRelation barn element findes ikke | HierarkiElementRelation barn element findes ikke |
50033 | HierarkiElementRelation eksisterer allerede | HierarkiElementRelation eksisterer allerede |
50034 | HierarkiElementRelation forælder har forkert hierarkiniveau | HierarkiElementRelation forælder har forkert hierarkiniveau |
50035 | HierarkiElementRelation barn har forkert hierarkiniveau | HierarkiElementRelation barn har forkert hierarkiniveau |
40003 | The specified EscoStar Occupation does not exist. | The specified EscoStar Occupation does not exist. |
UpdateHierarchyRelation (PUT /v2/EscoStar/occupations/hierarchyrelation)
Opdaterer en relation imellem en STAR ESCO stillingsbetegnelse og et andet hieraki. F.eks. Jobnet.
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
requestBody | UpdateHierarchyElementRelationRequestDto |
| 1 | REST-objekt. Serialiseres til JSON |
- hierarchyRelation | UpdateHierarchyElementRelationDto |
| 1 | REST-objekt. Serialiseres til JSON |
- - parentHierarchyElementId | string | Length: 1-256 | 1 | Id på forælder elementet |
- - childHierarchyElementId | string | Length: 1-256 | 1 | Id på barn elementet |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
1101 | Client certificate missing from request | Client certificate missing from request |
2002 | Invalid CodeList value | Invalid CodeList value |
4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
50030 | HierarkiElementRelation forælder element findes ikke | HierarkiElementRelation forælder element findes ikke |
50031 | HierarkiElementRelation barn element findes ikke | HierarkiElementRelation barn element findes ikke |
50032 | HierarkiElementRelation findes ikke | HierarkiElementRelation findes ikke |
50034 | HierarkiElementRelation forælder har forkert hierarkiniveau | HierarkiElementRelation forælder har forkert hierarkiniveau |
50035 | HierarkiElementRelation barn har forkert hierarkiniveau | HierarkiElementRelation barn har forkert hierarkiniveau |