Webservices, udstilling af kodelister, Response/Request for kald samt fejlkoder

1 Foreløbig beskrivelse af services
2 Webservice
3 Selvstændig webservice til udstilling af kodelister
- 3.1 Kodeliste webservice metode navn
4 Fejlkoder
5 Request / Response for kald
- 5.1 GetJobannonce
  - 5.1.1 Request
  - 5.1.2 Response
- 5.2 CreateJobannonce
  - 5.2.1 Request
  - 5.2.2 Request
  - 5.2.3 Response
- 5.3 UpdateJobannonce
  - 5.3.1 Request
  - 5.3.2 Response
- 5.4 CloseJobannonce
  - 5.4.1 Request
  - 5.4.2 Response
- 5.5 DeleteJobannonce
- 5.6 SearchJobannonce
  - 5.6.1 Header
  - 5.6.2 Request (med query parametre)
  - 5.6.3 Response
- 5.7 SaveJobannonceAsDraft
  - 5.7.1 Request
  - 5.7.2 Header
  - 5.7.3 Request
  - 5.7.4 Response
- 5.8 PublishJobannonce
  - 5.8.1 Request
  - 5.8.2 Response
- 5.9 IsValidJobannonce
  - 5.9.1 Request
  - 5.9.2 Response
- 5.10 GetTicket
  - 5.10.1 Request
  - 5.10.2 Response
- 5.11 GetJobannonceHistory
  - 5.11.1 Request
  - 5.11.2 Response

Foreløbig beskrivelse af services

https://starwiki.atlassian.net/wiki/spaces/FYS/pages/4011820143

Webservice

Tidligere webservice navn	Nyt webservice navn

Tidligere webservice navn	Nyt webservice navn
JobAdService	Virksomhedsindsats.JobannonceService

Webservice metode navn

Tidligere webservicemetode navn	Nyt webservicemetode navn	Mulighed for at tilgå fra TMiljø

Tidligere webservicemetode navn	Nyt webservicemetode navn	Mulighed for at tilgå fra TMiljø
GetJob	GetJobannonce	-
AddJob	CreateJobannonce	-
UpdateJob	UpdateJobannonce	-
CloseJob	CloseJobannonce	-
CloseJobAsUser	CloseJobAsUser	-
DeleteJob	DeleteJobannonce	-
DeleteJobAsUser	DeleteJobAsUser	-
SearchJob	SearchJobannonce	-
SaveJobAsDraft	SaveJobannonceAsDraft	-
PublishJob	PublishJobannonce	-
IsValidJobAd	IsValidJobannonce	-
GetTicket	GetTicket	-
GetHistory	GetJobannonceHistory	-

Typebetegnelser i snitfladebeskrivelserne

Se https://starwiki.atlassian.net/wiki/spaces/FYS/pages/4011820143

Forretningstermer i snitfladebeskrivelserne

Se https://starwiki.atlassian.net/wiki/spaces/FYS/pages/4011820143

Selvstændig webservice til udstilling af kodelister

Fra tidligere at finde kodelister for JobAD på JobAD webservicen, vil disse i forbindelse med skiftet til det nye forretningsområde, flytte placering til kodeliste webservicen for forretningsområdet.

Virksomhedsindsats.CodeListsService

Kodeliste webservice metode navn

Tidligere kodeliste navn	Nyt kodeliste navn

Tidligere kodeliste navn	Nyt kodeliste navn
EmploymentType
WeeklyWorkTimeTypes
DriversLicence
Type
Status
JobAttribute

Fejlkoder

I forbindelse med skiftet til Virksomhedsindsats samt den ændrede tilgang/adgang for aftagere at tilgå webservice, vil fejlkoderne og beskrivelserne for disse nedlægges og nye vil i stedet oprettes, fejl koder vil fremgå af snitfladebeskrivelserne på service metode niveau.

Der er tale om nedenstående fejlkoder

ID	Beskrivelse

ID	Beskrivelse
1100	General fejl ved authorisation, ses ofte ved manglende eller forkert Request User Metadata
120030	Du har ikke rettigheder til at tilgå denne specifikke operation.
120031	Du har ikke rettigheder til at tilgå denne specifikke jobannoncetype
120032	Du har grundet dine rettigheder ikke adgang til at redigere, lukke eller slette jobannoncer for andre virksomheder
120033	Generel fejl
120034	Det pågældende CVR-nummer er blokeret på Jobnet
120035	Der findes ingen statistik for den pågældende jobannonce
120036	Validering fejlede (se detaljer i ‘Detalje.Besked’)
120037	Jobannoncen kunne ikke findes
120038	JobannonceID skal angives
120039	Der skete en fejl ifm. opdateringen af jobannoncen
120040	PublishJob: Forkert status. Forventet status er ‘NotReady’ eller ‘ReadyButNotPublished’
120041	Brugeren har ikke adgang til ikke-publicerede jobannoncer
120042	Autorisering til den pågældene request var ikke mulig
120043	Den angivne periode er over 8 uger. Annonceperioden må maks være 8 uger
120044	Du har ikke rettigheder til at arbejde med annonyme jobannoncer
120045	Den pågældende ESCO STAR kode er ikke længere gyldig og aktiv, og kan derfor ikke benyttes ifm. oprettelse/redigering ag en ny jobannonce
120046	Det er ikke muligt at oprette/opdatere en ny kladde, da jobannoncen pt. er tilgængelig på Jobnet
120047	Det er ikke muligt at opslå jobannoncen på EURES, da landet ikke er medlem af EURES
120048	Det er ikke muligt at opslå jobannoncen på EURES, da CVR-nummer på virksomheden mangler at blive tilføjet
120049	Det er ikke muligt at opslå jobannoncen på WIDK, da jobannoncetypen er angivet som HotJob
120050	Mindst mulige arbejdstimer skal være mindre end Højst mulige arbejdstimer
120052	Det angivne logo på jobannoncen efterlever ikke kravene for logo.
120053	Tidsintervallet for visningen af forhåndsvisningen for jobannoncen er udløbet
120054	Der findes ingen historik for den pågældende jobannonce
120055	Jobannoncen er ikke færdigudfyldt og kan derfor ikke sendes til godkendelse

Request / Response for kald

Forbehold for navne på webservicemetoderne

GetJobannonce

Request

[API Url]/v1/Jobannonce/{JobAnnonceId}(GET)

Header

{
	"ActiveOrganisation": {
		"OrganisationType": 8,
		"OrganisationCode": "10100"
	}
	"RequestUserMetadata":
	"RequestUserStructure": {
         "UserFullName": "Piratos", 
          "RequestUserType": 3,
          "UserIdentifier": "CVR:29973334-RID:9200000000XXX", 
          "UserEmail":"Piratos@bvl.com"
          },
     "RequestOrganisationStructure": { 
          "OrganisationType": 5,
          "OrganisationCode": "1"
          }, 
     "RegistrationDateTime": "2022-06-17T13:30:34.2832631+02:00"} 
}

Response

{
    "jobannonce": {
        "ansoegningsdetaljer": {
            "kontaktpersoner": [
                {
                    "titel": "Direktør",
                    "emailadresse": "eksempel@eksempel.dk",
                    "telefonnumre": {
                        "mobiltelefonnummer": "12345678",
                        "primaertTelefonnummer": "12345678",
                        "sekundaertTelefonnummer": "12345678"
                    },
                    "skjulTelefonnumre": false,
                    "fornavne": "Person",
                    "efternavn": "Personsen"
                }
            ],
            "ansoegningsmetoder": {
                "email": "eksempel@eksempel.dk",
                "brev": true,
                "telefon": "12345678",
                "url": "eksempel.dk"
            },
            "beskrivelse": null, (kan denne udfyldes?)
            "virksomhedReferencenummer": "firma-ref-123"
        },
        "arbejdsgiverOrganisationsDetaljer": {
            "branchekodeBeskrivelse": null, (kan denne udfyldes?)
            "arbejdsgiverOrganisationAdresse": {
                "husnummer": "1",
                "landekode": "DK",
                "etage": "5",
                "kommunenummer": 810,
                "sideDoer": "tv",
                "vejnavn": "Bredgade",
                "kommunenavn": "Brønderslev",
                "postdistrikt": "Brønderslev",
                "postnummer": "9700"
            },
            "kontaktperson": null, (kan denne udfyldes?)
            "branchekode": "123",
            "cvrNummer": "12345678",
            "virksomhedsnavn": "SH BILER APS",
            "pNummer": "1234567890",
            "virksomhedsUrl": null (kan denne udfyldes?)
        },
        "jobannonceDetaljer": {
            "jobannonceOpretter": {
                "emailadresse": "eksempel@eksempel.dk",
                "titel": "Direktør",
                "kontaktIdentifikation": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
                "primaertTelefonnummer": "12345678",
                "sagsbehandlerRid": null, (kan denne udfyldes?)
                "fornavne": "Person",
                "efternavn": "Personsen"
            },
            "antalVisninger": 5,
            "jobannonceDatoer": {
                "opdateringsTidspunkt": "2023-05-02T08:45:51.267",
                "publiceringSlutDato": "2023-06-26T00:00:00",
                "publiceringStartDato": "2023-05-01T00:00:00"
            },
            "logo": null,
            "status": 1,
            "jobannonceType": 1
        },
        "jobDetaljer": {
            "arbejdssted": {
                "arbejdsstedAdresse": {
                    "husnummer": "1",
                    "landekode": "DK",
                    "etage": "5",
                    "kommunenummer": 147,
                    "sideDoer": "tv",
                    "vejnavn": "Konge vej",
                    "kommunenavn": "Frederiksberg",
                    "postdistrikt": "Frederiksberg",
                    "postnummer": "2000"
                },
                "ingenFastArbejdsplads": false
            },
            "ansvarligtJobcenterKode": 0, (kan denne udfyldes?)
            "hovednummer": null, (kan denne udfyldes?)
            "jobannonceEgenskaber": [
                1,
                3,
                2
            ],
            "ansaettelsesType": 1,
            "jobannonceTekst": "<p>Du skal arbejde i køkken, please :)</p>",
            "paakraevedeKoerekortTyper": [
                6,
                5
            ],
            "skjulTelefonnumre": false,
            "anonymArbejdsgiver": false,
            "handicapIngenHindring": true,
            "ansaettelsesDetaljer": {
                "ansoegningsfrist": "2023-06-26T00:00:00",
                "ansaettelsesdato": "2023-06-27T00:00:00",
                "hurtigstMuligt": false
            },
            "antalLedigeStillinger": 2,
            "stillingsbetegnelse": "http://data.star.dk/esco/occupation/68c9d4ce-3dfe-45ec-aa21-6ea6bed91035",
            "arbejdstider": {
                "arbejdstidspunktTyper": {
                    "dagarbejde": true,
                    "aftenarbejde": true,
                    "natarbejde": false,
                    "weekendarbejde": false
                },
                "arbejdstidType": 1,
                "ugentligeArbejdstider": {
                    "hoejesteUgentligeArbejdstimer": null,
                    "mindsteUgentligeArbejdstimer": null
                }
            },
            "jobannonceoverskrift": "Kok til kokkelokale"
        },
        "jobannonceId": 1234567
    }
}

CreateJobannonce

Request

[API Url]/v1/Jobannonce (POST)

Header

{
	"ActiveOrganisation": {
		"OrganisationType": 8,
		"OrganisationCode": "10100"
	}
	"RequestUserMetadata":
	"RequestUserStructure": {
         "UserFullName": "Piratos", 
          "RequestUserType": 3,
          "UserIdentifier": "CVR:29973334-RID:9200000000XXX", 
          "UserEmail":"Piratos@bvl.com"
          },
     "RequestOrganisationStructure": { 
          "OrganisationType": 5,
          "OrganisationCode": "1"
          }, 
     "RegistrationDateTime": "2022-06-17T13:30:34.2832631+02:00"} 
}

Request

Response

UpdateJobannonce

[API Url]/v1/Jobannonce/{JobAnnonceId}(PUT)

Header

Request

Response

Success

CloseJobannonce

Request

[API Url]/v1/Jobannonce/luk/{JobAnnonceId}(PUT)

Header

Response

Success

DeleteJobannonce

[API Url]/v1/Jobannonce/{JobAnnonceId} (DELETE)

Header

Reponse

Success

SearchJobannonce

Request (med query parametre)

{API Url}v1/Jobannonce/soeg?Jobcenterkode=10100
{API Url}v1/Jobannonce/soeg?JobcenterNavn=København
{API Url}v1/Jobannonce/soeg?KontaktIdentifikation=aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
{API Url}v1/Jobannonce/soeg?OpdateretTidspunktFra=2023-04-27T15:35:30.123
{API Url}v1/Jobannonce/soeg?OpdateretTidspunktTil=2023-04-27T15:35:30.123
{API Url}v1/Jobannonce/soeg?CvrNummerEllerPNummer=11111111
{API Url}v1/Jobannonce/soeg?VirksomhedNavn=CompanyAS
{API Url}v1/Jobannonce/soeg?JobannonceId=12
{API Url}v1/Jobannonce/soeg?JobannonceEgenskaber=1&JobannonceEgenskaber=2
{API Url}v1/Jobannonce/soeg?Kommunenummer=101
{API Url}v1/Jobannonce/soeg?StillingsbetegnelseKoder=http://data.star.dk/esco/occupation/6c4558de-7fdd-4de1-921a-bd1d6ab4fe6d&StillingsbetegnelseKoder=http://data.star.dk/esco/occupation/6c4558de-7fdd-4de1-921a-bd1d6ab4fe6d
{API Url}v1/Jobannonce/soeg?StillingsbetegnelseNavn=kok
{API Url}v1/Jobannonce/soeg?Sidenummer=1
{API Url}v1/Jobannonce/soeg?SideStoerrelse=10
{API Url}v1/Jobannonce/soeg?OprettetAf=Person%20Personsen
{API Url}v1/Jobannonce/soeg?Regionsnummer=1084
{API Url}v1/Jobannonce/soeg?Status=1&Status=2
{API Url}v1/Jobannonce/soeg?SagsbehandlerRid=aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa

Flere parametre kan naturligvis bruges i samme kald. Dette gøres, som vist herunder, med hvert argument adskilt af et '&':

{API Url}v1/Jobannonce/soeg?Jobcenterkode=10100&JobcenterNavn=København&OpdateretTidspunktFra=2023-04-27T15:35:30.123

Foreløbig beskrivelse af services

Webservice

Webservice metode navn

Typebetegnelser i snitfladebeskrivelserne

Forretningstermer i snitfladebeskrivelserne

Selvstændig webservice til udstilling af kodelister

Kodeliste webservice metode navn

Fejlkoder

Request / Response for kald

GetJobannonce

Request

Response

CreateJobannonce

Request

Request

Response

UpdateJobannonce

Request

Response

CloseJobannonce

Request

Response

DeleteJobannonce

SearchJobannonce

Header

Request (med query parametre)

Response

SaveJobannonceAsDraft

Request

Header

Request

Response

PublishJobannonce

Request

Response

IsValidJobannonce

Request

Response

GetTicket

Request

Response

GetJobannonceHistory

Request

Response

Tilgængelighed: https://starwiki.atlassian.net/was