UpdateActivitiesV4

Rajapinnan yleiskuvaus

Verkkopalvelua käytetään tapahtumatietojen päivittämiseen Neptonissa.

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

Huom! Jos jotain tapahtuman tietoa ei ole kutsussa, tietoa ei nollata. Tieto jätetään päivittämättä.

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 (UpdateActivitiesV3)

Uudet ominaisuudet ja kentät

• Kertymän ja vuosilomasaldon arvo on mahdollista päivittää kertymän asetus -tapahtumalla
  • ResetValue-kenttä on lisätty kyselyyn
• Kertymän ja vuosilomasaldon muutos on mahdollista päivittää kertymän muutos -tapahtumalla
  • ChangeValue-kenttä on lisätty kyselyyn

Käyttäjäviittaukset

Tapahtuman henkilö ja tapahtuman hyväksynyt henkilö voidaan asettaa kutsussa. Henkilöön voi viitata jollain seuraavista tunnisteista: Käyttäjän yksilöllinen Nepton ID, käyttäjänimi, käyttäjän henkilötunnus, tai käyttäjän henkilönumero. Kaikki näihin liittyvät kentät voi jättää pois mikäli näihin ei ole tarkoitus tehdä muutoksia. Jos halutaan poistaa tapahtuman hyväksyntä ja hyväksynyt henkilö niin tunnistekenttää täytyy antaa tyhjä arvo (nil). Katso lähetettävät tiedot -taulukosta tarkemmat tiedot elementeissä, joissa tiedot tulisi antaa.

Lähetettävät tiedot

Kyselyn esimerkki

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tyo="http://tyoaika.tyoteho.fi"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header/>
  <soapenv:Body>
    <tyo:ParametersForUpdateActivitiesV4>
      <CallerAuthentication /><!-- Autentikoituminen vaaditaan, mutta on jätetty tässä esimerkissä pois -->
      <ActivityList>
        <Activity>
          <ExistingExternalIdentifier>
            <Identifier>27ae3e08-bfa0-11eb-8529-0242ac130003</Identifier>
            <IdentifierType>External</IdentifierType>
          </ExistingExternalIdentifier>
          <EndDateTime>2021-01-19T16:00:00</EndDateTime>
          <ApproverUserId xsi:nil="true" /><!-- Tapahtuman hyväksyjän ja hyväksynnän poisto -->
          <RelatedProjects>
            <ActivityToProjectRelation>
              <Id>1234567890</Id><!-- Viittaa projektiin jonka Neptonin sisäinen tunniste on 1234567890 -->
              <Duration>120</Duration>
            </ActivityToProjectRelation>
            <ActivityToProjectRelation>
              <Code>ExampleProjectCode</Code><!-- Viittaa projektiin jonka koodi on ExampleProjectCode -->
              <Duration>60</Duration>
            </ActivityToProjectRelation>
          </RelatedProjects>
        </Activity>
      </ActivityList>
    </tyo:ParametersForUpdateActivitiesV4>
  </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:ReturnValueForUpdateActivitiesV4>
      <ResponseCode>1000</ResponseCode>
      <ResponseString>All clear. No errors.</ResponseString>
      <ActivityList>
        <Activity>
          <Id>12345678</Id>
          <ExternalIdentifiers>
            <ExternalIdentifier>
              <Identifier>27ae3e08-bfa0-11eb-8529-0242ac130003</Identifier>
              <IdentifierType>External</IdentifierType>
            </ExternalIdentifier>
          </ExternalIdentifiers>
          <Success>true</Success>
        </Activity>
      </ActivityList>
    </tyo:ReturnValueForUpdateActivitiesV4>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>