Suomi
Platform status: -
  1. Nepton Support
  2. Support
  3. Integration
  4. API
  5. Example APIs and method descriptions

GetActivities

  • Updated

This article has not been translated yet.

Tästä metodista on uudempi versio. Mikäli käytät jo tätä metodia, niin suosittelemme että tarkastelet seuraavan version ohjeesta, mitä muutoksia vaaditaan uuden version käyttöönottamiseksi. Seuraavan version ohjeen löydät täältä.

Rajapinnan yleiskuvaus

Verkkopalvelua käytetään tapahtumatietojen noutoon Neptonista. Verkkopalvelu palauttaa tapahtumat myös deaktivoiduille henkilöille.

Verkkopalvelun WSDL-skeema on julkisesti saatavilla täällä. Rajapinnat ovat yleisellä tasolla kuvattuna täällä.

Kuvauksessa oleva sarake esiintymiskerrat määrittää sen onko jokin tieto pakollinen pyynnössä vai ei. Esiintymiskerrat 0, tarkoittaa että kyseistä tietoa ei tarvitse siirtää pyynnössä. Esiintymiskerrat 1 tarkoittaa, että tiedon tulee esiintyä pyynnössä yhden kerran. Esiintymiskerrat 0..n tarkoittaa, että kyseinen tieto voi esiintyä pyynnössä minkä tahansa määrän. Esiintymiskerrat 1..n tarkoittaa että kyseinen tieto tulee olla aineistossa ainakin kerran, mutta voi olla useamminkin.

Lähetettävät tiedot

Taso

Kentän nimi

Muoto

Esiintymiskerrat

Selite
0

ParametersForGetActivities

XML element

1

Juurielementti,
SOAP body:n alla

1

CallerAuthentication

XML element

1

Lisää tietoa autentikoitumisesta täällä

1

FilterByUserIds

string

0..1

Suodatus henkilöiden yksilöllisten Nepton-tunnisteiden mukaan. Voit antaa useamman tunnisteen erottamalla ne pilkulla.

1

FilterByUserNames

string

0..1

Suodatus henkilöiden käyttäjätunnuksien mukaan. voit antaa useamman käyttäjätunnuksen erottelemalla ne pilkulla

1

FilterByActivityTypeIds

string

0..1

Suodatus tapahtumatyyppien yksilöllisten Nepton-tunnisteiden mukaan. Voit antaa useamman tunnisteen erottelemalla ne pilkulla.

1

FilterPeriodBeginDateTime

string

0..1

Suodatus tapahtumiin, jotka päättyvät annetun päivämäärän ja ajan jälkeen. Muotona on VVVV-KK-PP HH:MM:SS, esimerkiksi 2021-02-18 12:30:00.

1

FilterPeriodEndDateTime

string

0..1

Suodatus tapahtumiin, jotka alkavat ennen annettua päivämäärää ja aikaa. Muotona on VVVV-KK-PPHH:MM:SS, esimerkiksi 2021-02-18 12:30:00.

1

FilterModifiedBeginDateTime

string

0..1

Suodatus tapahtumiin, joita on viimeksi muutettu annetun päivämäärän ja ajan jälkeen. Muotona on VVVV-KK-PP HH:MM:SS, esimerkiksi 2021-02-18 12:30:00.

1

FilterModifiedEndDateTime

string

0..1

Suodatus tapahtumiin, joita on viimeksi muutettu ennen annettua päivämäärää ja aikaa. Muotona on VVVV-KK-PP HH:MM:SS, esimerkiksi 2021-02-18 12:30:00.

1

FilterIsApproved

boolean

0..1

Suodatus tapahtumiin, jotka ovat hyväksyttyjä (true) tai eivät ole hyväksyttyjä (false).

1

IncludeDeleted

boolean

0..1

Sisällytetäänkö poistetut tapahtumat (true) vai ei (false). Poistettuja tapahtumia ei oletusarvoisesti sisällytetä.

1

OrderResultsFirstBy

string

0..1

Tapahtumien ensisijainen lajittelukriteeri. Seuraavat arvot ovat tuettuja:

  • ActivityId - Tapahtuman yksilöllinen tunniste Neptonissa

  • ActivityBeginDatetime - Tapahtuman alkupäivä ja -aika

  • ActivityEndDatetime - Tapahtuman päättymispäivä ja -aika

  • UserId - Henkilön, jolla tapahtuma on, tunniste Neptonissa

  • ActivityTypeId - Tapahtumatyypin tunniste Neptonissa

1

OrderResultsSecondBy

string

0..1

Tapahtumien toinen lajittelukriteeri. Tuetut kriteerit ovat samat kuin ensisijaisessa lajittelukriteerissä.

1

OrderResultsThirdBy

string

0..1

Tapahtumien kolmas lajittelukriteeri. Tuetut kriteerit ovat samat kuin ensisijaisessa lajittelukriteerissä.

Kyselyn esimerkki

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
  <soapenv:Header/>
  <soapenv:Body>
    <tyo:ParametersForGetActivities>
      <CallerAuthentication /> <!-- Autentikoituminen vaaditaan, mutta on jätetty tässä esimerkissä pois --> 
      <FilterByActivityTypeIds>
        <ActivityTypeId>1</ActivityTypeId>
      </FilterByActivityTypeIds>
      <FilterByExternalIdentifiers>
        <ExternalIdentifier>
          <Identifier>c2d816bc-bf67-11eb-8529-0242ac130003</Identifier>
          <IdentifierType>External</IdentifierType>
        </ExternalIdentifier>
       <ExternalIdentifier>
          <Identifier>4a700e90-c754-4d1d-ac9a-bfdc011fc2c1</Identifier>
          <IdentifierType>External</IdentifierType>
        </ExternalIdentifier>
      </FilterByExternalIdentifiers>
      <FilterPeriodBeginDateTime>2021-01-01T00:00:00</FilterPeriodBeginDateTime>
      <FilterPeriodEndDateTime>2021-01-31T23:59:59</FilterPeriodEndDateTime>
      <IncludeDeleted>false</IncludeDeleted>
      <OrderResultsFirstBy>ActivityBeginDatetime</OrderResultsFirstBy>
    </tyo:ParametersForGetActivities>
  </soapenv:Body>
</soapenv:Envelope>

Vastaus

Taso

Kentän nimi

Muoto

Esiintymiskerrat

Selite

Juuri,
SOAP body:n alla

ReturnValueForGetActivities

XML element

1

 

1

ResponseCode

integer

1

Käsittelyn tuloksen koodi. Mahdolliset koodit löytyvät täältä.

1

ResponseString

string

1

Koodin kuvaus

1

ActivityList

XML element

1

 

2

Activity

XML element

0..n

 

3

Id

integer

0..1

Tapahtuman yksilöllinen tunniste. Tapahtuman tunniste pysyy muuttumattomana vaikka tapahtumaa muokataan.

3

UserId

integer

0..1

Henkilön yksilöllinen tunniste Neptonissa. Kuuluu henkilölle, jolla tapahtuma on.

3

UserFirstName

string

0..1

Henkilön etunimi. Kuuluu henkilölle, jolla tapahtuma on.

3

UserLastName

string

0..1

Henkilön sukunimi. Kuuluu henkilölle, jolla tapahtuma on.

3

UserUsername

string

0..1

Henkilön käyttäjätunnus. Kuuluu henkilölle, jolla tapahtuma on.

3

UserSocialSecurityNumber

string

0..1

Henkilön henkilötunnus. Kuuluu henkilölle, jolla tapahtuma on.

3

ActivityTypeId

integer

0..1

Tapahtumatyypin yksilöllinen tunniste Neptonissa.

3

ActivityTypeName

string

0..1

Tapahtumatyypin nimi.

3

ActivityTypeCategoryId

integer

0..1

Tapahtumatyypin kategorian yksilöllinen tunniste Neptonissa.

3

ActivityTypeCategoryName

string

0..1

Tapahtumatyypin kategorian nimi.

3

ApproverUserId

integer

0..1

Tapahtuman hyväksyneen henkilön yksilöllinen tunniste Neptonissa.

3

ApproverFirstName

string

0..1

Tapahtuman hyväksyneen henkilön etunimi.

3

ApproverLastName

string

0..1

Tapahtuman hyväksyneen henkilön sukunimi.

3

BeginDateTime

string

0..1

Tapahtuman alkupäivä ja -aika. Muotona on VVVV-KK-PP HH:MM:SS, esimerkiksi 2021-02-18 12:30:00.

3

EndDateTime

string

0..1

Tapahtuman päättymispäivä ja -aika. Muotona on VVVV-KK-PP HH:MM:SS, esimerkiksi 2021-02-18 12:30:00.

3

ModifiedDateTime

string

0..1

Aika milloin tapahtumaa on viimeksi muutettu. Muotona on VVVV-KK-PP HH:MM:SS, esimerkiksi 2021-02-18 12:30:00.

3

ModifiedByUserId

integer

0..1

Tapahtumaa viimeksi muuttaneen henkilön tunniste Neptonissa.

3

ModifiedFromIp

string

0..1

IP-osoite mistä tapahtumaa on viimeksi muutettu.

3

Comment

string

0..1

Tapahtumalle kirjatut huomiot.

3

IsClockedEvent

boolean

0..1

Onko tapahtuma kellotettu (true) vai ei (false).

3

IsCreatedWithPinCode

boolean

0..1

Onko tapahtuma kellotettu PIN-koodilla (true) vai ei (false).

3

OvertimeBasePartTargetedTo

string

0..1

Ylityön perusosan kohdenne tapahtumalla.

3

OvertimeIncrementPartTargetedTo

string

0..1

Ylityön korotusosan kohdenne tapahtumalla.

3

RelatedProjects

XML element

0..1

Tapahtumalle kirjatut projektit.

4

ActivityToProjectRelation

XML element

0..n

 

5

Id

integer

0..1

Projektin yksilöllinen tunniste Neptonissa

5

Duration

integer

0..1

Projektin kesto minuutteina

5

Name

string

0..1

Projektin nimi

5

Code

string

0..1

Projektin koodi

3

WorkIncrements

XML element

0..1

Tapahtumalle kirjatut työlisät.

4

WorkIncrement

XML element

0..n

 

5

Index

integer

1

Työlisän indeksi

5

Value

decimal

1

Työlisän arvo minuutteina, yksikköinä tai desimaalina.

3

PlannedWorkCalculationUnit

string

0..1

Tämä tieto löytyy myös ActivityDetailsin alta. Tämä elementti poistuu uudemmissa versioissa

3

PlannedWorkColor

string

0..1

Tämä tieto löytyy myös ActivityDetailsin alta. Tämä elementti poistuu uudemmissa versioissa

3

PlannedWorkUseForWorkDayLengthCalculations

boolean

0..1

Tämä tieto löytyy myös ActivityDetailsin alta. Tämä elementti poistuu uudemmissa versioissa

3

PlannedWorkCanBeCancelledUntil

string

0..1

Tämä tieto löytyy myös ActivityDetailsin alta. Tämä elementti poistuu uudemmissa versioissa

3

PlannedWorkWorkTimeLimitOffsetStartInMins

integer

0..1

Tämä tieto löytyy myös ActivityDetailsin alta. Tämä elementti poistuu uudemmissa versioissa

3

PlannedWorkWorkTimeLimitOffsetEndInMins

integer

0..1

Tämä tieto löytyy myös ActivityDetailsin alta. Tämä elementti poistuu uudemmissa versioissa

3

PlannedWorkActivityGroupPublicInfo

string

0..1

Tämä tieto löytyy myös ActivityDetailsin alta. Tämä elementti poistuu uudemmissa versioissa

3

ActivityDetails

XML element

0..1

Tapahtuman lisätiedot

4

AbsenceDetails

XML element

0..1

Poissaolotapahtuman lisätiedot

5

CompensationTypeId

integer

0..1

Poissaolon korvaustyypin tunniste. Mahdolliset arvot:

  • 1 - palkallinen

  • 2 - palkaton

  • 3 - vähennetty palkka

5

CompensationTypeName

string

0..1

Poissaolon korvaustyypin nimi

5

EarnsVacationDays

boolean

0..1

Ansaitaanko poissaolosta vuosilomapäiviä (true) vai ei (false)

5

AbsenceTypeId

integer

0..1

Poissaolotyypin tunniste. Poissaolotyypit näkee Työajasta, Työyhteisön asetuksista: Työtunnis > Poissaolotyypit

5

AbsenceTypeName

string

0..1

Poissaolotyypin nimi

4

PlannedWorkDetails

XML element

0..1

Suunnitellun työvuoron lisätiedot

5

PlannedWorkCalculationUnit

string

0..1

Työvuoron toimipisteen laskentayksikkö. Lue toimipisteen lisäyksestä ja laskentayksiköstä täällä.

5

PlannedWorkColor

string

0..1

Työvuoron toimipisteen suunnittelutason tunnusväri. Tunnusvärin voi asettaa Vuorosuunnittelussa: Toimipisteet > Valitse suunnittelutaso > Suunnittelutason asetukset > Suunnittelutason väri

5

PlannedWorkUseForWorkDayLengthCalculations

boolean

0..1

Tuleeko työpäivän pituus työvuorosta (true) vai ei (false)

5

PlannedWorkCanBeCancelledUntil

string

0..1

Päivämäärä ja aika, mihin asti varattu vuorotarve on mahdollista perua. Muotona on VVVV-KK-PP HH:MM:SS, esimerkiksi 2021-02-18 12:30:00.

5

PlannedWorkWorkTimeLimitOffsetStartInMins

integer

0..1

Työvuorosta tulevan sallitun työn aloitusajan aikasiirtymä minuutteina.

Arvo lisätään tapahtuman alkuaikaan, jota käytetään sallitun työn aloitusajan asettamiseen. Nolla-arvo asettaa sallitun työn aloitusajan tapahtuman aloitusajaksi.

5

PlannedWorkWorkTimeLimitOffsetEndInMins

integer

0..1

Työvuorosta tulevan sallitun työn lopetusajan aikasiirtymä minuutteina.

Arvo lisätään tapahtuman loppuaikaan, jota käytetään sallitun työn lopetusajan asettamiseen. Nolla-arvo asettaa sallitun työn lopetusajan tapahtuman lopetusajaksi.

5

AssumedLunchInMinutes

integer

0..1

Työvuorosta tulevan oletetun ruokatauon pituus minuutteina

5

PlannedWorkActivityGroupPublicInfo

string

0..1

Työvuoron ryhmän tietoihin annettu julkinen tieto

4

SickLeaveDetails

XML element

0..1

Sairausloman lisätiedot

5

CompensationTypeId

integer

0..1

Sairausloman korvaustyypin tunniste. Mahdolliset arvot:

  • 1 - palkallinen

  • 2 - palkaton

  • 3 - vähennetty palkka

5

CompensationTypeName

string

0..1

Sairausloman korvaustyypin nimi

5

EarnsVacationDays

boolean

0..1

Ansaitaanko poissaolosta vuosilomapäiviä (true) vai ei (false)

5

SickLeaveTypeId

integer

0..1

Sairausloman tyypin tunniste. Mahdolliset arvot:

  • 1 - sairas

  • 2 - lapsi sairas

  • 3 - työtapaturma

  • 4 - työmatkatapaturma

  • 5 - vapaa-ajan tapaturma

5

SickLeaveTypeName

string

0..1

Sairausloman tyypin nimi

5

MedicalCertificateGiven

boolean

0..1

Onko lääkärintodistus luovutettu (true) vai ei (false)

5

SupervisorsPermission

boolean

0..1

Onko sairauslomalle esimiehen hyväksyntä lääkärintodistuksen sijaan (true) vai ei (false)

5

ReasonCode

string

0..1

Sairausloman syykoodi

3

IsDeleted

boolean

0..1

Onko tapahtuma poistettu (true) vai ei (false)

Vastauksen esimerkki

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
  <SOAP-ENV:Body>
    <tyo:ReturnValueForGetActivities>
      <ResponseCode>1000</ResponseCode>
      <ResponseString>All clear. No errors.</ResponseString>
      <ActivityList>
        <Activity>
          <Id>12345678</Id>
          <UserId>9001</UserId>
          <UserFirstName>Maija</UserFirstName>
          <UserLastName>Meikäläinen</UserLastName>
          <UserUsername>maija.meikäläinen</UserUsername>
          <UserPersonnelNumber>1111</UserPersonnelNumber>
          <ActivityTypeId>1</ActivityTypeId>
          <ActivityTypeName>Työ</ActivityTypeName>
          <ActivityTypeCategoryId>1</ActivityTypeCategoryId>
          <ActivityTypeCategoryName>Työ</ActivityTypeCategoryName>
          <BeginDateTime>2021-01-19 08:00:00</BeginDateTime>
          <EndDateTime>2021-01-19 16:00:00</EndDateTime>
          <ModifiedDateTime>2021-01-20 09:12:23</ModifiedDateTime>
          <ModifiedByUserId>9001</ModifiedByUserId>
          <ModifiedFromIp>127.0.0.1</ModifiedFromIp>
          <Comment>Työtapahtuma</Comment>
          <IsClockedEvent>false</IsClockedEvent>
          <IsCreatedWithPinCode>false</IsCreatedWithPinCode>
          <OvertimeBasePartTargetedTo>salary</OvertimeBasePartTargetedTo>
          <OvertimeIncrementPartTargetedTo>salary</OvertimeIncrementPartTargetedTo>
          <RelatedProjects>
            <ActivityToProjectRelation>
              <Id>12345</Id>
              <Duration>450</Duration>
              <Name>Asiakaspalvelu</Name>
              <Code>ASPA</Code>
            </ActivityToProjectRelation>
          </RelatedProjects>
          <IsDeleted>false</IsDeleted>
        </Activity>
      </ActivityList>
    </tyo:ReturnValueForGetActivities>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

 


Comments

0 comments

Please sign in to leave a comment.