English (GB)
Palvelun tila: -
  1. Nepton Support
  2. Tuki
  3. Liittymät
  4. Sovellusliittymät (API)
  5. API esimerkit ja metodi-kuvaukset

InsertActivitiesV2

  • Päivitetty

Huom! 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 löydät täältä

Rajapinnan yleiskuvaus

Verkkopalvelua käytetään tapahtumatietojen lisäämiseen Neptonissa.

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

  • Juurielementtien nimet muuttuneet

    • Pyynnössä ParametersForInsertActivities → ParametersForInsertActivitiesV2

    • Vastauksessa ReturnValueForInsertActivities → ReturnValueForInsertActivitiesV2

  • Pyynnössä tapahtumalle voi määrittää ulkoisen tunnisteen (ExternalIdentifier-elementti)

  • Ulkoiset tunnisteet näkyvillä vastauksessa (ExternalIdentifiers-elementti)

Käyttäjäviittaukset

Tapahtuman luonnissa on pakollinen tieto henkilöstä sekä ei-pakollinen tieto tapahtuman hyväksyneestä henkilöstä. Kumpaankin henkilötietoon voi viitata käyttäen tunnisteena jotain seuraavista: Neptonin yksilöllinen käyttäjä ID, käyttäjänimi, käyttäjän henkilötunnus, tai käyttäjän henkilönumero. Jos hyväksynyt henkilö määritetään niin tapahtuma merkitään myös hyväksytyksi. Katso lähetettävät tiedot -taulukosta tarkemmat tiedot elementeistä, joissa tiedot tulisi ilmoittaa.

Lähetettävät tiedot

TASO

KENTÄN NIMI

MUOTO

ESIINTYMISKERRAT

SELITE

0

ParametersForInsertActivitiesV2

XML element

1

SOAP body:n alla oleva juurielementti

1

CallerAuthentication

XML element

1

Lisää tietoa autentikoitumisesta täällä

1

ActivityList

XML element

1

Lista lisättävistä / päivitettävistä tapahtumista

2

Activity

XML element

1..n

Lisättävä / päivitettävä tapahtuma

3

UserId

integer

0..1

Henkilön Nepton-tunniste, jolle tapahtuma lisätään

3

UserUsername

string

0..1

Henkilön käyttäjätunnus, jolle tapahtuma lisätään.

3

UserSocialSecurityNumber

string

0..1

Henkilön henkilötunnus, jolle tapahtuma lisätään.

InsertActivitiesV2-kutsussa tarvitaan tieto siitä, mille henkilölle tapahtuma luodaan. UpdateActivitiesV2-kutsussa voidaan käyttää jos tapahtuma halutaan siirtää toiselle henkilölle.

3

UserPersonnelNumber

string

0..1

Henkilön henkilönumero, jolle tapahtuma lisätään.

InsertActivitiesV2-kutsussa tarvitaan tieto siitä, mille henkilölle tapahtuma luodaan. UpdateActivitiesV2-kutsussa voidaan käyttää jos tapahtuma halutaan siirtää toiselle henkilölle.

3

ActivityTypeId

integer

0..1

Tapahtumatyypin Nepton-tunniste.

Jos tietoa ei anneta kutsussa, tapahtuma luodaan Työ-tapahtumana.

3

BeginDateTime

dateTime

1..1

Tapahtuman alkamispäivä ja -aika. Muotona on  VVVV-KK-PPTHH:MM:SS , esimerkiksi  2021-02-18T12:30:00 .

Pakollinen

3

EndDateTime

dateTime

0..1

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

Jos tietoa ei anneta tai se on tyhjä, tapahtuma luodaan ilman päättymisaikaa.

3

ApproverUserId

integer

0..1

Tapahtuman hyväksyneen henkilön Nepton-tunniste.

Jos tietoa ei anneta tai se on tyhjä, tapahtumaa ei merkitä hyväksytyksi.

3

ApproverUsername

string

0..1

Tapahtuman hyväksyneen henkilön käyttäjätunnus

3

ApproverUserSocialSecurityNumber

string

0..1

Tapahtuman hyväksyneen henkilön henkilötunnus.

3

ApproverUserPersonnelNumber

string

0..1

Tapahtuman hyväksyneen henkilön henkilönumero.

3

Comment

string

0..1

Tapahtumalle kirjattavat huomiot.

3

IsClockedEvent

boolean

0..1

Onko lisättävä/päivitettävä tapahtuma kellotettu ( true ) vai ei ( false ).

3

IsCreatedWithPinCode

boolean

0..1

Onko lisättävä/päivitettävä tapahtuma kellotettu PIN-koodilla ( true ) vai ei ( false ).

3

OvertimeBasePartTargetedTo

string

0..1

Ylityön perusosan kohdenne lisättävällä/päivitettävällä tapahtumalla.

3

OvertimeIncrementPartTargetedTo

string

0..1

Ylityön korotusosan kohdenne lisättävällä/päivitettävällä tapahtumalla.

3

RelatedProjects

XML element

0..1

Tapahtumalle kirjattavat projektit. Tämän elementin sisään laitetaan ActivityToProjectRelation - elementtejä jokaista tapahtuman projektilinkitystä kohden (ks. lisää seuraavasta kohdasta).

4

ActivityToProjectRelation

XML element

0..n

Tapahtumaan lisättävän projektimerkinnän tiedot. Katso lisätietoja ja esimerkki tästä.

5

Id

integer

0..1

Projektin yksilöllinen tunniste Neptonissa. Projektin yksilöllinen tunniste tai projektin koodi täytyy antaa.

5

Duration

integer

0..1

Projektin kesto minuutteina

5

Name

string

0..1

Projektin nimi. Tietoa ei käytetä.

5

Code

string

0..1

Projektin koodi. Projektin yksilöllinen tunniste tai projektin koodi täytyy antaa.

3

WorkIncrements

XML element

0..1

Tapahtumalle kirjattavat 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

ExternalIdentifiers

XML element

0..1

Tapahtumalle asetettavat ulkoiset tunnisteet

4

ExternalIdentifier

XML element

1..n

Tapahtumalle asetettava ulkoinen tunniste

5

Identifier

string

1

Ulkoinen tunniste

5

IdentifierType

string

1

Ulkoisen tunnisteen tyyppi. Ainoa tuettu tyyppi tällä hetkellä on  External .

Kyselyn esimerkki

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tyo="http://tyoaika.tyoteho.fi">
  <soapenv:Header/>
  <soapenv:Body>
    <tyo:ParametersForInsertActivitiesV2>
      <CallerAuthentication /><!-- Autentikoituminen vaaditaan, mutta on jätetty tässä esimerkissä pois -->
      <ActivityList>
        <Activity>
          <UserPersonnelNumber>9001</UserPersonnelNumber>
          <ActivityTypeId>2</ActivityTypeId>
          <BeginDateTime>2021-01-19T08:00:00</BeginDateTime>
          <ApproverUserPersonnelNumber>9999</ApproverUserPersonnelNumber>
          <Comment>Kovaa työtä</Comment>
          <IsClockedEvent>true</IsClockedEvent>
          <ExternalIdentifiers>
            <ExternalIdentifier>
              <Identifier>27ae3e08-bfa0-11eb-8529-0242ac130003</Identifier>
              <IdentifierType>External</IdentifierType>
            </ExternalIdentifier>
          </ExternalIdentifiers>
          <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:ParametersForInsertActivitiesV2>
  </soapenv:Body>
</soapenv:Envelope>


Vastaus

TASO

KENTÄN NIMI

MUOTO

ESIINTYMISKERRAT

SELITE

0

ReturnValueForInsertActivitiesV2

XML element

1

SOAP body:n alla oleva juurielementti

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

 

1

ActivityList

XML element

0..1

Lisätyt / päivitetyt tapahtumat

2

Activity

XML element

0..n

Lisätty / päivitetty tapahtuma

3

Id

integer

0..1

Lisätyn / päivitetyn tapahtuman yksilöllinen Nepton-tunniste.

3

ExternalIdentifiers

XML element

0..1

Lisätyn / päivitetyn tapahtuman ulkoiset tunnisteet. Virhetilanteissa ensisijaisesti palautetaan kutsussa ollut  ExternalIdentifiers  ja toisisjaisesti kutsussa ollut  ExistingExternalIdentifier .

4

ExternalIdentifier

XML element

1..n

 

5

Identifier

string

1

Ulkoinen tunniste

5

IdentifierType

string

1

Ulkoisen tunnisteen tyyppi. Ainoa tuettu tyyppi tällä hetkellä on  External .

3

Success

boolean

1

Onnistuiko tapahtuman lisäys ( true ) vai ei ( false ).

3

ErrorCode

integer

0..1

Jos tapahtuman lisäys tai päivitys ei onnistunut, syyn virhekoodi. Mahdolliset koodit löytyvät täältä

3

ErrorMessage

string

0..1

Jos tapahtuman lisäys tai päivitys ei onnistunut, syyn selite.

Vastauksen esimerkki 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"xmlns:ns1="http://tyoaika.tyoteho.fi">
  <SOAP-ENV:Body>
    <ns1:ReturnValueForInsertActivitiesV2>
      <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>
    </ns1:ReturnValueForInsertActivitiesV2>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>




Kommentit

0 kommenttia

Kirjaudu sisään jättääksesi kommentin.