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

EnsureProjectsExistV2

  • Päivitetty

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 siihen, että kutsussa annettu lista projekteista päivitetään Neptoniin. Mikäli projekti on olemassa niin sen tietoja päivitetään. Mikäli projektia ei ole olemassa niin se luodaan. Päivitettävä projekti tunnistetaan joko Projektin Nepton tunnisteella (Id), ExistingIdentifier-elementissä määritetyllä tunnisteella tai projektin koodilla (Code)

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

Rakenteelliset muutokset

Vanha Uusi Lisätiedot 
<tyo:ParametersForEnsureProjectsExist>
  ...
</tyo:ParametersForEnsureProjectsExist>
 
<tyo:ParametersForEnsureProjectsExistV2>
  ...
</tyo:ParametersForEnsureProjectsExistV2>
  Kutsussa juurielementin nimi vaihtunut 
<tyo:ReturnValueForEnsureProjectsExist>
  ...
</tyo:ReturnValueForEnsureProjectsExist>
 
<tyo:ReturnValueForEnsureProjectsExistV2>
...
</tyo:ReturnValueForEnsureProjectsExistV2>
  Vastauksessa juurielementin nimi muuttunut

Uudet ominaisuudet ja elementit

  • Olemassaolevaan projektiin voi viitata Nepton tunnisteen tai koodin lisäksi myös käyttämällä ulkoista tunnistetta
    • ExistingProjectIdentifier-elementti lisätty kutsuun
  • Luotavalle/päivitettävälle projektille voi määrittää ulkoisen tunnisteen
    • ExternalIdentifier-elementti lisätty kutsuun

Lähetettävät tiedot

Taso Kentän nimi Muoto Esiintymiskerrat Selite
Juuri,
SOAP body:n alla		 ParametersForEnsureProjectsExistV2 XML element 1  
1 CallerAuthentication XML element 1 Lisää tietoa autentikoitumisesta täällä
1 ProjectList XML element 1 Listaus projekteja
2 Project XML element 1..n Yhden projektin tiedot. Yleisten elementtien sisällön näkee täältä.
3 ExistingProjectIdentifier XML element 0..1

Tunniste, jolla haetaan olemassaolevaa projektia. Jos projekti löytyy, sen tiedot päivitetään, muutoin luodaan uusi projekti. Tässä elementissä annettua tunnistetta ei tallenneta projektin tietoihin.
4 Identifier string 1 Projektin tunnisteen arvo.
4 IdentifierType string 1

Projektin tunnisteen tyyppi. Voi olla joko

  • ProjectCode - projektin koodi
  • ExternalIdentifier - projektin ulkoinen tunniste

Lue lisää projektin koodista ja ulkoisesta tunnisteesta täällä.
3 Id unsignedInt 0..1 Neptonin antama yksilöllinen projektin tunniste. Määritä vain, jos haluat järjestelmän tunnistavan olemassaolevan projektin tämän tiedon perusteella.
3 ExternalIdentifier XML element 0..n Ulkoisen järjestelmän tunniste, joka tallennetaan projektille
4 Identifier string 1 Projektin tunnisteen arvo
4 IdentifierType string 1

Projektin tunnisteen tyyppi. Tällä hetkellä ainoa tuettu arvo on

  • ExternalIdentifier - projektin ulkoinen tunniste

Lue lisää ulkoisesta tunnisteesta täällä.
3 Name string 1 Projektin nimi
3 Deleted boolean 0..1 Onko projekti poistettu vai ei. Poistetut projektit säilyvät tietokannassa, mutta niiden palauttaminen ei ole mahdollista tämän rajapinnan kautta.
3 Active boolean 0..1

Jos kentän arvona on true, projektin päättymispäivä tyhjennetään. Jos kentän arvona on false, päättymispäiväksi asetetaan eilinen päivä.

Jos EndDate kentällä on arvo, tämän kentän tiedot sivuutetaan.
3 Code string 0..1 Projektin koodi. Jos ID tai ExistingIdentifier elementtejä ei ole kutsussa määritetty niin olemassaoleva projektia koitetaan löytää tämän perusteella
3 TypeInternalName string 0..1 Projektin tyypin sisäinen tunniste. Arvo täytyy antaa projektia luodessa. Jos erillisiä projektityyppejä ei ole asetettuna, arvona on project_work
3 Description string 0..1 Projektin kuvaus
3 StartDate date 0..1 Projektin alkamispäivä. Projektia ei voida asettaa tapahtumien kohdisteeksi tai projektin tunteja raportoida ennen tätä päivää. Arvona voi myös olla null, esimerkiksi: 
<StartDate xsi:nil="true" />
3 EndDate date 0..1 Projektin päättymispäivä. Projektia ei voida asettaa tapahtumien kohdisteeksi tai projektin tunteja raportoida tämän päivän jälkeen. Arvona voi myös olla null, esimerkiksi: 
<EndDate xsi:nil="true" />
3 ParentProjectId unsignedInt 0..1 Projektin yläprojektin Neptonin yksilöllinen tunniste. Arvona voi myös olla null, esimerkiksi: 
<ParentProjectId xsi:nil="true" />
3 ParentProjectCode string 0..1 Projektin yläprojektin projektikoodi. Arvona voi myös olla null, esimerkiksi: 
<ParentProjectCode xsi:nil="true" />
3 ParentProjectIdentifier XML element 0..1 Projektin yläprojektin tunniste. Arvona voi myös olla null, esimerkiksi: 
<ParentProjectIdentifier xsi:nil="true" />
4 Identifier string 1 Yläprojektin tunniste
4 IdentifierType string 1 Yläprojektin tunnisteen tyyppi. Voi olla joko ProjectCode tai ExternalIdentifier
3 Left unsignedInt 0..1 Tietoa ei käytetä
3 Right unsignedInt 0..1 Tietoa ei käytetä
3 ChildProjects XML element 0..n Tietoa ei käytetä

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:ParametersForEnsureProjectsExistV2>
      <CallerAuthentication /> <!-- Autentikoituminen vaaditaan, mutta on jätetty tässä esimerkissä pois -->
      <ProjectList>
        <Project>
          <ExistingProjectIdentifier>
            <Identifier>4a78611d-4a00-4c4a-a987-865664d732ce</Identifier>
            <IdentifierType>ExternalIdentifier</IdentifierType>
          </ExistingProjectIdentifier>
          <ExternalIdentifier>
            <Identifier>4a78611d-4a00-4c4a-a987-865664d732ce</Identifier>
            <IdentifierType>ExternalIdentifier</IdentifierType>
          </ExternalIdentifier>
          <Name>Projekti X</Name>
          <Code>1000/9001</Code>
          <TypeInternalName>project_work</TypeInternalName>
          <Description>Lorem ipsum primis venenatis justo mollis fringilla lectus sociosqu nostra, vehicula nunc massa sodales habitasse duis</Description>
          <StartDate>2001-01-01</StartDate>
          <EndDate xsi:nil="true" />
          <ParentProjectIdentifier>
            <Identifier>45453ddd-f167-408b-9e75-6c419755caf8</Identifier>
            <IdentifierType>ExternalIdentifier</IdentifierType>
          </ParentProjectIdentifier>
        </Project>
      </ProjectList>
    </tyo:ParametersForEnsureProjectsExistV2>
  </soapenv:Body>
</soapenv:Envelope>

Vastaus

Taso Kentän nimi Muoto Esiintymiskerrat Selite
Juuri,
SOAP body:n alla		 ReturnValueForEnsureProjectsExistV2 XML element 1  
1 ResponseCode integer 1 Projektien käsittelyn tuloksen koodi. Mahdolliset koodit löytyvät täältä.
1 ResponseString string 1 Koodin kuvaus
1 EnsureProjectsExistResultList XML element 1  
2 EnsureProjectsExistResult XML element 0..n Yhden projektin käsittelyn tulos
3 ResponseCode integer 1 Tuloksen koodi. Mahdolliset koodit löytyvät täältä.
3 ResponseString integer 1 Tuloksen koodin kuvaus
3 ProjectId unsignedInt 1 Käsitellyn projektin Neptonin antama yksilöllinen tunniste. Arvona voi myös olla null, esimerkiksi: 
<ProjectId xsi:nil="true" />
Virhetilanteissa palautetaan null jos kyselyssä ei annettu Neptonin antamaa yksilöllistä tunnistetta.
3 ProjectIdentifier XML element 1 Tunniste, joka lähetettiin kyselyssä ExistingProjectIdentifier kentässä.
4 Identifier string 1 Projektin tunnisteen arvo
4 IdentifierType string 1

Projektin tunnisteen tyyppi. Voi olla joko

  • ProjectCode - projektin koodi
  • ExternalIdentifier - projektin ulkoinen tunniste

Lue lisää projektin koodista ja ulkoisesta tunnisteesta täällä.

Vastauksen esimerkki

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
  <SOAP-ENV:Body>
    <tyo:ReturnValueForEnsureProjectsExistV2>
      <ResponseCode>1000</ResponseCode>
      <ResponseString>All clear. No errors.</ResponseString>
      <EnsureProjectsExistResultList>
        <EnsureProjectsExistResult>
          <ResponseCode>1000</ResponseCode>
          <ResponseString>All clear. No errors.</ResponseString>
          <ProjectId>76254</ProjectId>
          <ProjectIdentifier>
            <Identifier>4a78611d-4a00-4c4a-a987-865664d732ce</Identifier>
            <IdentifierType>ExternalIdentifier</IdentifierType>
          </ProjectIdentifier>
        </EnsureProjectsExistResult>
      </EnsureProjectsExistResultList>
    </tyo:ReturnValueForEnsureProjectsExistV2>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>