GetActivitiesV4

This article has not been translated yet.

Rajapinnan yleiskuvaus

Verkkopalvelua käytetään tapahtumatietojen noutoon Neptonista. Verkkopalvelu palauttaa tapahtumat myös deaktivoiduille (Neptonissa Poista käyttäjätunnus -toiminolla poistetuille) henkilöille kun kyselyyn sisällytetään käyttäjäsuodatus (esim. henkilönumero).

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 kutsussa vai ei. Esiintymiskerrat 0, tarkoittaa että kyseistä tietoa ei tarvitse siirtää kutsussa. Esiintymiskerrat 1 tarkoittaa, että tiedon tulee esiintyä kutsussa yhden kerran. Esiintymiskerrat 0..n tarkoittaa, että kyseinen tieto voi esiintyä kutsussa minkä tahansa määrän. Esiintymiskerrat 1..n tarkoittaa että kyseinen tieto tulee olla aineistossa ainakin kerran, mutta voi olla useamminkin.

Muutokset aiempaan versioon nähden (GetActivitiesV3)

Uudet ominaisuudet ja kentät

• Kertymän ja vuosilomasaldon asetuksen arvo palautetaan
  • ResetValue-kenttä on lisätty vastaukseen
• Accrual and annual leave change values are returned
  • ChangeValue-element added to the response

Lähetettävät tiedot

Kyselyn esimerkki

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
  <soapenv:Header/>
  <soapenv:Body>
    <tyo:ParametersForGetActivitiesV4>
      <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:ParametersForGetActivitiesV4>
  </soapenv:Body>
</soapenv:Envelope>

Vastaus

Vastauksen esimerkki

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
  <SOAP-ENV:Body>
    <tyo:ReturnValueForGetActivitiesV4>
      <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-19T08:00:00</BeginDateTime>
          <EndDateTime>2021-01-19T16:00:00</EndDateTime>
          <ModifiedDateTime>2021-01-20T09: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:ReturnValueForGetActivitiesV4>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>