RS Integrasjon Webservice
(2021 © Tieto, versjon 1.4.1, 1.12.2021 (RS 7.39.x) (.net 4.8))
The following operations are supported. For a formal definition, please review the Service Description.
-
A_Generelt
Denne Webservice (WS) tilbyr funksjoner for å lese/skrive data fra/til Tieto Ressursstyring (RS).
Nedenfor gis en oversikt og beskrivelse av disse funksjonene og hvilke data de returnerer.
Alle funksjoner i WS krever autentifisering med "kunde"+"brukernavn"+"passord" for å kalle funksjoner WS.
Alle funksjoner returnerer også en status/info/feilmelding i feltet "returinfo"
Alle funksjoner som kan kalles returnerer en xml streng av en gitt type/klasse som er definert i tilhørende "dummy" _Typedef funksjonen.
Alle funksjoner returnerer en string xml som utledes fra Dataset.WriteXml (C#)) der dataset inneholder x antall rader med kolonner definert i angitt type/klasse.
Dato er angitt på formatet YYYYMMDD, klokke er angitt på formatet HHMM.
Boolean verdi er angitt som True eller False.
Felter i type/klasse som trenger forklaring er beskrevet i nærmere detalj i aktuell _Typedef funksjon.
Kontakt Tieto for flere detaljer angående integrasjon med Ressursstyring. Tieto.no -
FinnBrukerForID
Henter brukernavn+passord koblet til angitt ID i RS Autorisasjon.
Returnerer liste for bruker(e).
TypeID = 'P' - Søker bruker på PersonID.
TypeID = 'F' - Søker PersonID via Fødselsnummer (hvis fnr ikke finnes i DB, søkes det på PersonID -
GetActivities
Get ActivityBasedPlanning activities from RS.
Request parameter array of orgUnitId(s) or personId(s) must be set.
Request dateFrom/dateTo (yyyyMMdd) must be set.
Request externalSystem must be set to identify activities for external system. -
GetPlanActivities
Gets all defined activities in valid ABP plans for given orgUnits/period from RS.
Request parameter array of orgUnitId(s) must be set.
Request dateFrom/dateTo (yyyyMMdd) must be set.
Request externalSystem must be set to identify activities for external system. -
GetPlannedAbsence
Get 'planned absence' (absence with no divagation in RS).
Include HolidayRequest with status not processed or approved with no divagation ref.
Include AbsenceOfLeaveRequest with status not approved/rejected or approved with no divagation ref.
Include TimeOfBasis with status not approved/rejected or approved with no divagation ref.
NB: OrgUnitId, PositionId and EmploymentId si not set for HolidayRequests (only person related).
AbsenceOfLeaveRequest can be employment releated if not values not set.
Request parameter array of personId(s) must be set.
Request dateFrom/dateTo (yyyyMMdd) must be set.
-
GetTaskCodes
Get Task codes defined in RS for use for given OrgUnitId.
Request parameter array of orgUnitId(s) must be set
ExternalSystem must be set to determine valid codes to use in RS -
HentLederForAnsatt
Henter leder for en ansatt. Alle parameter må angis: PersonID/FNR, OrgenhetID og Pr.Dato
Ansatt identifiseres med PersonID eller Fnr. Kan søke mot flere personer i samme søket -
LesAnsettelse
Leser ansettelser fra RS.
Innparameter orgenhetid, personid, stillingsid og ansattloepenr kan angis for å begrense søket.
Angi blank verdi for å lese alle på angitt parameter. -
LesArbeidsbok
Leser arbeidsbok fra RS.
Minst ett innparameter orgenhetid/personid/datofra/datotil MÅ angis for å begrense søket.
Dato angis i format YYYYMMDD
ExternalId/ExternalSystem angitt indikerer at denne oppgaven er importert til RS fra eksternt system -
LesArbeidsboker
Leser arbeidsbok fra RS.
Minst ett innparameter orgenhet(er)/person(er)/datofra/datotil MÅ angis for å begrense søket.
Dato angis i format YYYYMMDD
ExternalId/ExternalSystem angitt indikerer at denne oppgaven er importert til RS fra eksternt system -
LesFravaerForPerson
Leser avvik for person fra RS.
Innparameter personid, datofra og datotil MÅ angis, orgenhetid, stillingsid og ansattloepenr kan angis for å begrense søket.
Innparamter visvaktifravaerperiode angis som False/True. Hvis True vil kun vaktperioder i fraværsperioden returneres. Dvs det kan returneres flere rader for ett fravær. (F.eks Fravær hel dag 00:00-00:00, Har vakt D 08:00-16:00 og Mertid 16:00-18:00, returnerer en linje med 08:00-16:00 og en med 16:00-18:00 på aktuelt fravær.
Dato angis i format YYYYMMDD
12.02.2015: Rettelse på fravær registrert med fra/til = 00:00 i RS. Denne skal tolkes som 'hele dagen', dvs tildato ble angitt med en dag for lite -
LesFravaerForPersoner
Leser avvik for personer fra RS.
Innparameter EmploymentSearchRequest[] (orgenhetid, personid, stillingsid, ansattloepenr), datofra og datotil. Minst en ansettelse (personid) og periode MÅ angis for å begrense søket.
Innparamter visvaktifravaerperiode angis som False/True. Hvis True vil kun vaktperioder i fraværsperioden returneres. Dvs det kan returneres flere rader for ett fravær. (F.eks Fravær hel dag 00:00-00:00, Har vakt D 08:00-16:00 og Mertid 16:00-18:00, returnerer en linje med 08:00-16:00 og en med 16:00-18:00 på aktuelt fravær.
Dato angis i format YYYYMMDD
12.02.2015: Rettelse på fravær registrert med fra/til = 00:00 i RS. Denne skal tolkes som 'hele dagen', dvs tildato ble angitt med en dag for lite -
LesOrgenhet
Leser alle orgenheter fra RS.
1.1.0: Lagt til LederAnsattNr, standardleder som gjelder per dags dato. -
LesPerson
Leser personinformasjon fra RS for en person.
Innparameter personid MÅ angis. -
LesPlanForPeriode
Leser ansettelser som har vakt på angitt orgenhetid i angitt periode.
Innparameter orgenhetid, datofra og datotil MÅ angis.Gir grunnlag for kall til funksjonen LesVaktForPerson() -
LesStilling
Leser stilling fra RS.
Innparameter orgenhetid kan angis for å begrense søket -
LesVaktForPerson
Leser vakt for person fra RS.
Innparameter personid, datofra og datotil MÅ angis, orgenhetid, stillingsid og ansattloepenr kan angis for å begrense søket.
Innparamter kunvakterforgyldigansettelse angis som False/True. Hvis True vil kun vakter med gyldig ansettelse (vaktens datofra < sluttetdato på ansettelse) returneres.
Innparamter fjernfravaer angis som False/True. Hvis True vil kun faktisk vakt returneres. Dvs alle typer fravær er fjernet fra vakta (Kan da returner flere rader pr. faktisk vakt i RS).
Dato angis i format YYYYMMDD -
LesVaktForPersoner
Leser vakt for personer fra RS.
Innparameter EmploymentSearchRequest[] (orgenhetid, personid, stillingsid, ansattloepenr), datofra og datotil. Minst en ansettelse (personid) og periode MÅ angis for å begrense søket.
Innparamter kunvakterforgyldigansettelse angis som False/True. Hvis True vil kun vakter med gyldig ansettelse (vaktens datofra < sluttetdato på ansettelse) returneres.
Innparamter fjernfravaer angis som False/True. Hvis True vil kun faktisk vakt returneres. Dvs alle typer fravær er fjernet fra vakta (Kan da returner flere rader pr. faktisk vakt i RS).
Dato angis i format YYYYMMDD -
LesVaktForPersoner_MedFrivakter
Leser vakt (med frivaktkoder) for personer fra RS.
Innparameter EmploymentSearchRequest[] (orgenhetid, personid, stillingsid, ansattloepenr), datofra og datotil. Minst en ansettelse (personid) og periode MÅ angis for å begrense søket.
Innparamter kunvakterforgyldigansettelse angis som False/True. Hvis True vil kun vakter med gyldig ansettelse (vaktens datofra < sluttetdato på ansettelse) returneres.
Innparamter fjernfravaer angis som False/True. Hvis True vil kun faktisk vakt returneres. Dvs alle typer fravær er fjernet fra vakta (Kan da returner flere rader pr. faktisk vakt i RS).
Dato angis i format YYYYMMDD
Merk: frivakter har ikke verdi for: KlokkaFra, KlokkaTil, VisDato og Kategori -
SaveTasks
Save array of WorkbookTask to RS workbook.
WorkbookTask item properties:
DBStatus (None, Create, Update, Delete). (required)
ExternalId = ID for item in external system (required).
ExternalSystem = Description for system item is inserted from (required).
RSId = Id in RS for item. Is returned for new items. Use RSid with DBStatus to update/delete item.
NationalId = Version 1.1.0: New property for WorkbookTask.NationalId (se version documentation for more details):
- Can be used for external system for saving tasks to persons current employment info based only on persons NationalId.
- If using value in NationalId then PersonID must be 0. No need for info in OrgUnitId/PositionId/EmploymentId.
- Employment (first and best) for task is selected in this order:
* Activity for external system exist and task period is inside activity period
* Activity for external system exist and task period is outside activity period
* Shift exist and task periode is inside shift period
* Shift exist and task periode is outside shift period
* Free shift exist for start date of task
* None => Error getting RS employment
PersonId/OrgUnitId/PositionId/EmploymentId = Person/Employment executing the task (required if NationalId is blank).
TaskOrgunitId: The orgunit the task is to be executed on (required if NationalId is blank).
TaskId: ID of the task as given from GetTaskCodes() (required) (NB! Use only tasks defined in RS, use GetTaskCodes() to get defined tasks for orgunit)
Comment (optional)
Start = start date and time for the task (required)
End = end date and time for the task (required)
ResponseStatus = OK, OKWithInfo, Error
ResponseMessage = Error details or info for OKWithInfo
-
Transer
Opprette/lese/endre/slette transer i RS fra eksternt system.
Innparameter typehandling, transtype og trans MÅ angis.
TypeHandling:
'N'=Ny Trans
'L'=Les trans (transID MÅ angis)
'E'=Endre trans (transID MÅ angis)
'S'=Slette trans (transID MÅ angis)
TransType:
V=variabel lønntrans
F=fast lønntrans
FR=fravær trans
Trans gir returverdi ved TypeHandling=L
TransID gir returverdi ved TypeHandling=N
-
VerifiserPassord
Verifiserer at brukernavn+passord finnes i RS Autorisasjon.
Returnerer TRUE hvis OK, ellers FALSE. Se returinfo for meldinger. -
_Typedef_FinnBrukerForID
Returtype for FinnBrukerForID().
NB! Benyttes IKKE av Gerica Pro. -
_Typedef_GetActivities
Returtype for GetActivities()
Start/End har formatet 'YYYYMMDDHHMM'.
RESHid - Kun for integrasjon med Tieto Personal.
30.06.2017: Added column Priority -
_Typedef_GetPlanActivities
Returtype for GetPlanActivities()
Start/End har formatet 'HHmm' -
_Typedef_GetPlannedAbsence
Returtype for GetPlannedAbsence()
Start/End har formatet 'YYYYMMDDHHMM'.
-
_Typedef_GetTaskCodes
Returtype for GetTaskCodes() -
_Typedef_HentLederForAnsatt
Returtype for HentLederForAnsatt()
-
_Typedef_LesAnsettelse
Returtype for LesAnsettelser()
Stillingsandel angis som format 100% = 1.0
Arbeidstimeruke er timetall angitt på ansettelse (33.6, 35.5, 36, 37.5 etc) justert for Stillingsandel
EksternAnsattLoepenr inneholder løpenr i eksternt system der RS er integrert med annet personalsystem (NB! Hvis ikke angitt, benytt AnsattLoepenr.)
RESHid - Kun for integrasjon med Tieto Personal
(For integrasjon med Tieto Personal vil EksternAnsattLoepenr=AnsattLoepenr.
NB! Følgende returverdier benyttes IKKE av Gerica Pro:
- Stillingsandel
- Ansettelsesdato
- EksternAnsattLoepenr
- RESHid -
_Typedef_LesArbeidsbok
Returtype for LesArbeidsbok()
Hvis type = 'R' så er det en ressurs som er benyttet.
Fra/til har formatet 'YYYYMMDDHHMM'.
RESHid - Kun for integrasjon med Tieto Personal. -
_Typedef_LesFravaerForPerson
Returtype for LesFravaerForPerson()
AnsattOrgenhetID - Hvis fraværet er registrert ifm en annen orgenhet en ansettelsen er registrert på.
Kategori - Kategori for fraværet:
SF=Sykefravær(sykdom enkeltdag)
PF=Periode fravær (sykdom)
AV=Avspasering
PM=Permisjon
VA=Vakans
KU=Kurs
FF=Forskyvning AvviksID - Database PK for registrerte data. Generert teller. Benyttes for å skille på registrert tidspunkt ved beregning av faktisk arbeidstid fratrukket fravær
VisDato - Kun angitt hvis fravær er <= 24t, dvs relatert til en enkeltdag
RESHid - Kun for integrasjon med Tieto Personal
Fnr - Kun angitt dersom det er søkt på fødselsnummer
NB! Følgende returverdier benyttes IKKE av Gerica Pro:
- OrgenhetID
- PersonID
- StillingsID
- AnsattLoepenr
- AnsattOrgenhetID
- DatoTil
- Vikarvakt
- RegDato
- RegKlokka
- RESHid
- Fnr -
_Typedef_LesOrgenhet
Returtype for LesOrgenhet()
RESHid - Kun for integrasjon med Tieto Personal
-
_Typedef_LesPerson
Returtype for LesPerson()
NB! Følgende returverdier benyttes IKKE av Gerica Pro:
- Telefon
- TelefonMobil
- TelefonArbeid
- EMail
- EMail_Privat -
_Typedef_LesPlanForPeriode
Returtype for LesPlanForPeriode()
OrgenhetID = Orgenhet vakt er utført på.
AnsattLoepenr - Løpenr for ansettelse ihht ansatt orgenhet.
AnsattOrgenhetID - Orgenhet personen er ansatt på.
Stillingskode - På ansettelse.
RESHid - Kun for integrasjon med Tieto Personal.
NB! Følgende returverdier benyttes IKKE av Gerica Pro:
- Stillingskode
- RESHid -
_Typedef_LesStilling
Returtype for LesStilling()
Timerpruke - Angitt antall timer pr. uke for stillingen
Arbtidgruppe - Integer verdi fra 1 til x som definerer Normaltimer (pr.år) relatert til en stilling/ansettelse
F.eks ID = 1 (Normaltimer 1950 = 37.5t pr. uke) Tilsvarende for 33.6, 35.5, 36, etc. RS benytter 1 = 37.5 og 2 = 35.5 (Avhengig av oppsett i database tabell.)
NB! Følgende returverdier benyttes IKKE av Gerica Pro:
- OrgenhetID
- Stillingkode
- Arbtidgruppe -
_Typedef_LesVaktForPerson
Returtype for LesVaktForPerson()
Vikarvakt - Angir at vakten er registrert som ett avvik av type vikar.
Kategori - Vaktens kategori. D=Dagvakt, A=Aftenvakt, N=Nattevakt, V=Vaktvakt
AvviksID - Database PK for registrerte data. Generert teller. Benyttes for å skille på registrert tidspunkt ved beregning av faktisk arbeidstid fratrukket fravær
VisDato - For vakter som går over døgnskillet vil den dagen det er registrert flest timer på angis som visdato.
RESHid - Kun for integrasjon med Tieto Personal.
ForskyvningsFravaerID - Referanse til AvviksID som er forskjøvet fra (fraværsbit av forskyvningen). Denne skal ikke trekkes ifra ihht visning av forskjøvet til vakt.
Fnr - Kun angitt dersom det er søkt på fødselsnummer
NB! Følgende returverdier benyttes IKKE av Gerica Pro:
- OrgenhetID
- PersonID
- StillingsID
- AnsattLoepenr
- AnsattOrgenhetID
- DatoTil
- Vikarvakt
- RegDato
- RegKlokka
- AvviksID
- RESHid
- Fnr