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 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 pyynnössä, tietoa ei nollata. Tieto jätetään päivittämättä.
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.
Muutokset aiempaan versioon nähden (UpdateActivities)
Rakenteelliset muutokset
Vanha | Uusi | Lisätiedot |
---|---|---|
<tyo:ParametersForUpdateActivities> |
<tyo:ParametersForUpdateActivitiesV2> |
Pyynnön juurielementin nimi vaihtunut |
<tyo:ReturnValueForUpdateActivities> |
<tyo:ReturnValueForUpdateActivitiesV2> |
Vastauksen juurielementin nimi vaihtunut |
Uudet omainaisuudet ja elementit
- Tapahtumalle voi asettaa ulkoisia tunnisteita ja ulkoisen tunnisteen näkee myös vastauksessa
-
ExternalIdentifiers-elementti lisätty kutsuun
-
ExternalIdentifiers-elementti lisätty vastaukseen
-
-
Muokattavaan tapahtumaan voi nyt viitata Nepton tunnisteella tai ulkoisella tunnisteella
-
ExistingExternalIdentifier-elementti lisätty kutsuun
-
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ään 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
TASO |
KENTÄN NIMI |
MUOTO |
ESIINTYMISKERRAT |
SELITE |
---|---|---|---|---|
ParametersForUpdateActivitiesV2 |
XML element |
1 |
Juuri, |
|
1 |
CallerAuthentication |
XML element |
1 |
Lisää tietoa autentikoitumisesta täällä |
1 |
ActivityList |
XML element |
1 |
Lista päivitettävistä tapahtumista |
2 |
Activity |
XML element |
1..n |
Päivitettävä tapahtuma |
3 |
ActivityId |
integer |
0..1 |
Päivitettävä tapahtuma. Viittaus yksilöllisen Nepton tunnisteen perusteella. Joko tämä tai ulkoinen tunniste on pakko ilmoittaa |
3 |
ExistingExternalIdentifier |
XML element |
0..1 |
Päivitettävän tapahtuma. Viittaus ulkoisen tunnisteen perusteella. Joko tämä tai Nepton tunniste on ilmoitettava |
4 |
Identifier |
string |
1 |
Ulkoinen tunniste |
4 |
IdentifierType |
string |
1 |
Ulkoisen tunnisteen tyyppi. Tällä hetkellä ainoa tuettu tyyppi on |
3 |
UserId |
integer |
0..1 |
Tapahtuman henkilö. Viittaus Nepton tunnisteen perusteella. |
3 |
UserUsername |
string |
0..1 |
Tapahtuman henkilö. Viittaus käyttäjänimen perusteella. |
3 |
UserSocialSecurityNumber |
string |
0..1 |
Tapahtuman henkilö. Viittaus henkilötunnuksen perusteella. |
3 |
UserPersonnelNumber |
string |
0..1 |
Tapahtuman henkilö. Viittaus henkilönumeron perusteella. |
3 |
ActivityTypeId |
integer |
0..1 |
Tapahtumatyyppi yksilöllisen Nepton tunnisteen perusteella. Voidaan jättää pois, jos ei haluta muuttaa tapahtumatyyppiä |
3 |
BeginDateTime |
dateTime |
0..1 |
Tapahtuman alkamispäivä ja -aika. Muotona on |
3 |
EndDateTime |
dateTime |
0..1 |
Tapahtuman päättymispäivä ja -aika. Muotona on Jos tietoa ei anneta kutsussa, tapahtuman päättymisaikaa ei päivitetä. Tyhjän ( |
3 |
ApproverUserId |
integer |
0..1 |
Tapahtuman hyväksynyt henkilö. Viittaus Nepton tunnisteen perusteella |
3 |
ApproverUsername |
string |
0..1 |
Tapahtuman hyväksynyt henkilö. Viittaus käyttäjänimen perusteella |
3 |
ApproverUserSocialSecurityNumber |
string |
0..1 |
Tapahtuman hyväksynyt henkilö. Viittaus henkilötunnuksen perusteella |
3 |
ApproverUserPersonnelNumber |
string |
0..1 |
Tapahtuman hyväksynyt henkilö. Viittaus henkilötunnuksen perusteella |
3 |
Comment |
string |
0..1 |
Tapahtumalle kirjattavat huomiot. |
3 |
IsClockedEvent |
boolean |
0..1 |
Onko päivitettävä tapahtuma kellotettu ( |
3 |
IsCreatedWithPinCode |
boolean |
0..1 |
Onko päivitettävä tapahtuma kellotettu PIN-koodilla ( |
3 |
OvertimeBasePartTargetedTo |
string |
0..1 |
Ylityön perusosan kohdenne päivitettävällä tapahtumalla. |
3 |
OvertimeIncrementPartTargetedTo |
string |
0..1 |
Ylityön korotusosan kohdenne 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 (kts. 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. Projekteja on mahdollista hake API:n kautta. Lue lisää tästä --todo-- |
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 |
SetDeleted |
boolean |
0..1 |
Merkitäänkö tapahtuma poistetuksi? (true/false) |
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 |
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:ParametersForUpdateActivitiesV2>
<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:ParametersForUpdateActivitiesV2>
</soapenv:Body>
</soapenv:Envelope>
Vastaus
TASO |
KENTÄN NIMI |
MUOTO |
ESIINTYMISKERRAT |
SELITE |
---|---|---|---|---|
0 |
ReturnValueForUpdateActivitiesV2 |
XML element |
1 |
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 |
Päivitetyt tapahtumat |
2 |
Activity |
XML element |
0..n |
Päivitetty tapahtuma |
3 |
Id |
integer |
0..1 |
Päivitetyn tapahtuman yksilöllinen Nepton-tunniste. |
3 |
ExternalIdentifiers |
XML element |
0..1 |
Päivitetyn tapahtuman ulkoiset tunnisteet. Virhetilanteissa ensisijaisesti palautetaan kutsussa ollut |
4 |
ExternalIdentifier |
XML element |
1..n |
Päivitetyn tapahtuman ulkoinen tunniste |
5 |
Identifier |
string |
1 |
Ulkoinen tunniste |
5 |
IdentifierType |
string |
1 |
Ulkoisen tunnisteen tyyppi. Ainoa tuettu tyyppi tällä hetkellä on |
3 |
Success |
boolean |
1 |
Onnistuiko tapahtuman muokkaus ( |
3 |
ErrorCode |
integer |
0..1 |
Jos tapahtuman päivitys ei onnistunut, syyn virhekoodi. Mahdolliset koodit löytyvät täältä |
3 |
ErrorMessage |
string |
0..1 |
Jos tapahtuman päivitys ei onnistunut, syyn selite. |
Vastauksen esimerkki
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tyo="http://tyoaika.tyoteho.fi">
<SOAP-ENV:Body>
<tyo:ReturnValueForUpdateActivitiesV2>
<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:ReturnValueForUpdateActivitiesV2>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Kommentit
0 kommenttia
Kirjaudu sisään jättääksesi kommentin.