EnsureProjectsExist – Nepton Support

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. Projektin olemassaolo todetaan joko kutsussa määritetyn Nepton tunnisteen (Id) perusteella tai projektin koodin perusteella (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.

Lähetettävät tiedot

Taso	Kentän nimi	Muoto	Esiintymiskerrat	Selite
Juuri, SOAP body:n alla	ParametersForEnsureProjectsExist	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	Id	unsignedInt	0..1	Neptonin antama yksilöllinen projektin tunniste.
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, jota voidaan myös käyttää projektin tunnisteena
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	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:ParametersForEnsureProjectsExist>
  </soapenv:Body>
</soapenv:Envelope>

Vastaus

Taso	Kentän nimi	Muoto	Esiintymiskerrat	Selite
Juuri, SOAP body:n alla	ReturnValueForEnsureProjectsExist	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.

Vastauksen esimerkki

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