Käyttöohje: employeelist-metodi
Mitä metodi tekee?
Metodi employeelist hakee työntekijöiden tietoja järjestelmästä. Se kommunikoi palvelimen kanssa HTTP POST -pyynnöllä ja palauttaa työntekijälistan JSON-muodossa.
Miten sitä käytetään?
Lähetä POST-pyyntö osoitteeseen:http://localhost:88/employeelist
Autentikointi:
Käytetään Basic Authentication -menetelmää (käyttäjätunnus ja salasana koodataan base64-muotoon).
Sisältömuoto:application/json
Esimerkki pyynnöstä:
POST /employeelist HTTP/1.1
Host: localhost:88
Authorization: Basic ZGVtbzpkZW1v
Content-Type: application/json
Accept: application/json
{
"maxrecords": 100,
"skiprecords": 0,
"firstnumber": 1000,
"lastnumber": [1100]
}
Syöteparametrit:
Kaikki parametrit ovat valinnaisia.
-
maxrecords (int): Kuinka monta riviä palautetaan enintään
-
skiprecords (int): Kuinka monta riviä ohitetaan alusta
-
firstnumber (int): Ensimmäinen haettava työntekijänumero
-
lastnumber (string[]): Viimeinen työntekijänumero listana
Vastaus:
Palvelu palauttaa listan työntekijöistä ja seuraavat tekniset metatiedot:
-
employee: työntekijätietojen lista
-
skippedrecords: montako työntekijää ohitettiin
-
resultcomplete: 1 jos kaikki tulokset haettiin, 0 jos niitä on enemmän
Kaikki palautettavat kentät:
| Kenttä | Tietotyyppi | Selite |
| id | (string) | Uniikki ID |
| number | (int) | Työntekijän numero |
| companyid | (int) | Yritystunniste |
| name | (string) | Koko nimi |
| forename | (string) | Etunimi |
| surname | (string) | Sukunimi |
| incomeearnerid | (string) | Henkilötunnus |
| gender | (string) | Sukupuoli |
| education | (string) | Koulutus |
| profession | (string) | Työtehtävä |
| address1 | (string) | Katuosoite |
| address2 | (string) | Postitoimipaikka |
| country | (string) | Maa |
| telephone | (string) | Puhelinnumero |
| taxcommunity | (int) | Verotuskunta |
| bank | (string) | Pankki |
| bankaccount | (string) | Tilinumero |
| pensionsystem | (string) | Eläkejärjestelmä |
| taxdeduction | (int) | Verovähennys |
| taxdeductionperiod | (int) | Verovähennysjakso |
| verovap | (int) | Verovapautustieto |
| startdate | (int) | Työsuhteen alkamispäivämäärä |
| startdatetechnical | (int) | Tekninen alkamispäivämäärä |
| enddate | (int) | Työsuhteen päättymispäivämäärä |
| fixeddurationenddate | (int) | Määräaikaisen työsuhteen päättmispvm |
| enddatetechnical | (int) | Tekninen päättymispäivämäärä |
| employmenttype | (string) | Työsuhdetyyppi |
| professionid | (string) | Ammattinumero |
| payclass | (string) | Palkkaluokka |
| group | (string) | Ryhmä |
| cba | (string) | Työehtosopimus |
| typeofworktime | (string) | Työaikamuoto |
| costunit | (string) | Kustannuspaikka |
| project | (string) | Projekti |
| dimension3 | (string) | Dimensio 3 |
| dimension4 | (string) | Dimensio 4 |
| dimension5 | (string) | Dimensio 5 |
| paymentgroup | (string) | Ryhmä |
| cbacode | (string) | AY-liitto |
| cbadepartment | (int) | AY osasto |
| cbapercentage | (int) | AY prosentti |
| cbasum | (int) | AY summa |
| monthlywage | (int) | Kuukausipalkka |
| divisor | (int) | Jakaja |
| benefit | (int) | Luontoisetu |
| benefit2 | (int) | Luontoisetu 2 |
| agesupplement | (int) | Ikälisä |
| hourlywageotp | (int) | Ohjetuntipalkka |
| hourlywageptp | (int) | Perustuntipalkka |
| hourlywageatp | (int) | Aikatuntipalkka |
| taxpercentbasic | (int) | Verokortin perusprosentti |
| taxpercentextra | (int) | Lisäprosentti |
| pricingwagetype | (string) | Hinnoittelulaji |
| wagegroup | (string) | Palkkaryhmä |
| startdateofageallowance | (int) | Ikälisän aloituspvm |
| ageallowancecode | (string) | Ikälisän koodi |
| pro1 | (int) | Veroprosentti 1 |
| summa1 | (int) | Rajasumma 1 |
| pro2 | (int) | Veroprosentti 2 |
| summa2 | (int) | Rajasumma 2 |
| pro3 | (int) | Veroprosentti 3 |
| summa3 | (int) | Rajasumma 3 |
| pro4 | (int) | Veroprosentti 4 |
| summa4 | (int) | Rajasumma 4 |
| kbrutto | (int) | Kauden brutto |
| knetto | (int) | Kauden netto |
| kmaks | (int) | Kauden maks |
| kepa | (int) | Kauden epa |
| kep | (int) | Kauden ep |
| brutto | (int) | Kauden rutto |
| vkepa | (int) | Kauden kepa |
| parttimepension | (int) | Kauden arttimepension |
| onmatalap | (int) | Kauden nmatalap |
| taxatsource | (int) | Kauden axatsource |
| taxcarddate | (int) | Kauden axcarddate |
| netto | (int) | Kauden etto |
| maks | (int) | Kauden aks |
| pensionsalary | (int) | Kauden ensionsalary |
| epa | (int) | Kauden pa |
| ep | (int) | Kauden p |
| ktp | (int) | Kauden tp |
| vacancysalary | (int) | Kauden acancysalary |
| klomapalkka | (int) | Kauden lomapalkka |
| vacancydays | (int) | Kauden acancydays |
| vacancydayspermonth | (int) | Kauden acancydayspermonth |
| averagewage | (int) | Kauden veragewage |
| averagewage2 | (int) | Rajasumma 2 |
| averagewage3 | (int) | Rajasumma 3 |
| average1hours | (int) | KTA 1 tunnit |
| average1sum | (int) | KTA 1 eurot |
| average2hours | (int) | KTA 2 tunnit |
| average2sum | (int) | KTA 2 eurot |
| average3hours | (int) | KTA 3 tunnit |
| average3sum | (int) | KTA 3 eurot |
| status | (string) | Status |
| veropv | (int) | Kauden veropäivät |
| kumraja | (int) | Kumulatiivinen raja |
| ylimsotu | (int) | Kauden ylim. Sotu |
| toimenlaji | (string) | Toimen laji |
| accidentinsurance | (string) | Tapaturmavakuutus |
| language | (string) | Kieli |
| accountinggroup | (string) | Tiliryhmä |
| vacancytable | (string) | Lomataulu |
| timestamprole | (string) | |
| v2 | (string) | |
| v3 | (int) | |
| timestampgroup | (int) | |
| (string) | Sähköpostiosoite | |
| skype | (string) | Skype-tunnus |
| reminderdate | (int) | Muistutuspäivämäärä |
| remaindertext | (string) | Muistutusteksti |
| contractok | (int) | Työsopimus toimitettu |
| dataformok | (int) | Henkilötietolomake toimitettu |
| tagged | (int) | Valittu |
| lastchangedate | (int) | Viim muttospvm |
| lastchangeuser | (string) | Viimeisen muutoksen tekijä |
| iban | (string) | IBAN-tilinumero |
| bic | (string) | BIC-koodi |
| pekkanentable | (string) | Pekkastaulu |
| vacancyrule | (string) | Lomasääntö |
| vacancymethod | (string) | Lomapalkan laskentatapa |
| vacancypercentage | (int) | Lomaprosentti |
| payslipmethod | (string) | Palkkalaskelman toimitustapa |
| weeklyhours | (int) | Viikkotyötunnit |
| temporary | (int) | Määräaikaisuustieto |
| image | (string) | Kuvapolku |
| iban2 | (string) | IBAN 2 |
| bic2 | (string) | BIC 2 |
| yearsupplement1 | (int) | Kokemuslisä 1 |
| yearsupplement2 | (int) | Kokemuslisä 2 |
| yearsupplement3 | (int) | Kokemuslisä 3 |
| yearsupplement4 | (int) | Kokemuslisä 4 |
| experiancecode1 | (int) | Ikälisä 1 |
| experiencecode2 | (int) | Ikälisä 2 |
| experiencecode3 | (int) | Ikälisä 3 |
| experiencecode4 | (int) | Ikälisä 4 |
| nopekkanen | (int) | Ei pekkaskäsittelyä |
| taxmethod | (int) | Verotustapa |
| statisticwagetype | (int) | EK Tilastotyyppi |
| suppressfromstatistic | (int) | EK Ei tilastoon |
| crosstradetime | (int) | Crosstrade-aika |
| taxcardlocked | (int) | Verokortti lukittu |
| statisticscontracttype | (int) | EK Sopimustyyppi |
| statisticspersonnelgroup | (int) | EK henkilöstöryhmä |
| accidentinsurancenumber | (string) | Tapaturmavakuutusnumero |
| accidentincurancecompany | (string) | Tapaturmavakuutusyhtiö |
| supervisortext | (string) | Esihenkilön nimi |
| nationality | (string) | Kansalaisuus |
| statisticworktypecode | (string) | |
| statisticworktypename | (string) | |
| employmentregcode | (int) | |
| kevaprofessioncode | (int) | Kauden evaprofessioncode |
| birthdate | (int) | Syntymäaika |
| supervisor2 | (int) | Esihenkilö 2 |
| cba2startdate | (int) | AY 2 alkupvm |
| cba2enddate | (int) | AY2 loppupvm |
| cbastartdate | (int) | AY alkupvm |
| cbaenddate | (int) | AY loppupvm |
| pekkanenpercentage | (int) | Pekkasprosentti |
| cbaminimumsumlimit | (int) | AY vähimmäissumma |
| taxincomesum | (int) | Verotulo |
| pekkanenyearlimit | (int) | Vuoden pekkasaraja |
| supplement2 | (int) | Lisä 2 |
| taxdays | (int) | Veropäivät |
| taxwithholdmanual | (int) | |
| vacancyallowandedays | (int) | |
| paymentpercentage | (int) | Maksukerroin |
| cba2 | (string) | AY2 liitto |
| cba2department | (int) | AY2 osasto |
| cba2percentage | (int) | AY2 prosentti |
| cba2sum | (int) | AY2 summa |
| cba2minimumlimit | (int) | AY2 alaraja |
| cba2maximumlimit | (int) | AY2 yläraja |
| cba2refstart | (string) | AY2 alkupvm |
| cbarefend | (string) | AY viite |
| novacancyallowance | (int) | Ei loma |
| nonrecident | (int) | |
| dailyhours | (int) | Päivän tunnit |
| employmentendingcode | (int) | Työsuhteen päättymiskoodi |
| exceptioncodess | (int) | Vakuutuspoikkeama |
| socialseccertificate | (int) | Vakuutuspoikkeama |
| exceptioncodepension | (int) | Vakuutuspoikkeama |
| exceptioncodehealth | (string) | Vakuutuspoikkeama |
| exceptioncodeunemployment | (int) | Vakuutuspoikkeama |
| exceptioncodeaccident | (int) | Vakuutuspoikkeama |
| exceptioncodenotfin | (int) | Vakuutuspoikkeama |
| exceptioncodenotfinpension | (int) | Vakuutuspoikkeama |
| exceptioncodenotfinhealth | (int) | Vakuutuspoikkeama |
| exceptioncodenotfinunemployment | (int) | Vakuutuspoikkeama |
| exceptioncodenotfinaccident | (int) | Vakuutuspoikkeama |
| incomearnertype | (int) | |
| supervisor | (int) | Esihenkilö |
| note | (string) | Muistio |
| email2 | (string[250]) | sähköposti 2 |
| telephone2 | (string[60]) | Puhelin 2 |
| identifiertype | (string[50]) | Tunnisteyyppi |
| identifier | (string[60]) | Tunniste |
| dateofbirth | (string[]) | Syntymäaika |
| intlco | (string[250]) | KV osoitetieto |
| intlstreetaddress | (string[250]) | KV osoitetieto |
| intlpobox | (string[250]) | KV osoitetieto |
| intlpostalcode | (string[20]) | KV osoitetieto |
| intlpostoffice | (string[250]) | KV osoitetieto |
| intlcountrycode | (string[10]) | KV osoitetieto |
| intlcountryname | (string[200]) | KV osoitetieto |
| parttimepercentage | (string[20]) | Osa-aikaprosentti |
| partowner | (string[]) | Osaomistaja |
| fixedduration | (string[]) | Määräaikainen |
| termofnotice | (string[250]) | Työsuhteen loppumisen syy |
| acceptor | (int) | Hyväksyjä |
| acceptor2 | (int) | Hyväksyjä 2 |
| currency | (string[20]) | Valuutta |
| phonebenefit | (string[]) | Puhelinetu |
| bicyclebenefit | (string[]) | Polkupyöräetu |
| bicyclebenefitsubstracts | (string[]) | Polkupyöräetu |
| foodbenefit | (string[]) | Ruokaetu |
| carbenefit | (string[]) | Autoetu |
| carbenefitvalue | (string[]) | Autoedun arvo |
| carbenefityearmodel | (string[20]) | Autoedun vuosimalli |
| mealbenefittaxablevalue | (string[]) | Ateriaetu |
| garagebenefit | (string[]) | |
| garagebenefitvalue | (decimal) | |
| otherbenefits | (string[255]) | |
| vacationinformation | (string[250]) | |
| paymentperiod | (string[20]) | |
| paymentday | (string[250]) | |
| workhoursinformation | (string[250]) | |
| hours | (decimal) | |
| hoursperiod | (string[20]) | |
| vacancytext | (string[255]) | |
| keywords | (string[255]) | |
| nextofkin | (string[120]) | Lähiomainen |
| experiencecode | (string[20]) | Kokemuskoodi |
| endinfotopayroll | (string[255]) | Loppumisviesti |
| supp1 | (decimal) | Lisä 1 |
| supp2 | (decimal) | Lisä 2 |
| supp3 | (decimal) | Lisä 3 |
| supp4 | (decimal) | Lisä 4 |
| supp5 | (decimal) | Lisä 5 |
| supp6 | (decimal) | Lisä 6 |
| supp7 | (decimal) | Lisä 7 |
| supp8 | (decimal) | Lisä 8 |
| supp9 | (decimal) | Lisä 9 |
| supp10 | (decimal) | Lisä 10 |
| supp11 | (decimal) | Lisä 11 |
| supp12 | (decimal) | Lisä 12 |
| supp13 | (decimal) | Lisä 13 |
| supp14 | (decimal) | Lisä 14 |
| supp15 | (decimal) | Lisä 15 |
| supp16 | (decimal) | Lisä 16 |
| hrmemo | (string[255]) | HR muistio |
| memosalary | (string[255]) | ePalkat muistio |
| taxnumber | (string[30]) | Veronumero |
| workhourstext | (string[255]) | |
| pekkanenhours | (string[20]) | |
| holidaycredits | (string[20]) | |
| fonumber | (string[20]) |