UpdateProjects – Nepton Support

Rajapinnan yleiskuvaus

Verkkopalvelua käytetään siihen, että kutsussa annettu lista projekteista päivitetään Neptoniin.

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
0	ParametersForUpdateProjects	XML element		Juurielementti SOAP bodyn alla
1	CallerAuthentication	XML element		tunnistautumistiedot (katso Tunnistautuminen)
1	ProjectList	XML element		Päivitettävät projektit
2	Id	int	0..1	Päivitettävän projektin Nepton tunniste. Palvelu antaa virheen mikäli tämä puuttuu tai tunnistetta vastaavaa projektia ei löydy
2	Name	string	1	Projektin nimi
2	Code	string		Projektin koodi
2	Deleted	boolean		Onko projekti poistettu (true/false)
2	Active	boolean		Onko projekti aktiivinen (true/false)
2	TypeInternalName	string		Sisäinen merkkijonotunnus (ei sen asiakaskohtainen nimi tai kielikäännös)
2	Description	string		Projektin kuvaus
2	StartDate	date		Projektin alkamispäivä
2	EndDate	date		Projektin päättymispäivä
2	ParentProjectId	int		Jos ollaan lisäämässä aliprojektia niin tämä määrittää ylätason projektin nepton tunnisteen perusteella.
2	ParentProjectCode	string		Voidaan käyttää ParentProjectID-elementin sijaan jos halutaan viitata ylätason projektiin sen koodin perusteella
2	Left	int		Ei käytetä tässä käyttötapauksessa.
2	Right	int		Ei käytetä tässä käyttötapauksessa

Kyselyn esimerkki

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
  <soapenv:Header/>
  <soapenv:Body>
    <tyo:ParametersForUpdateProjects>
      <CallerAuthentication /> <!-- Autentikointi vaaditaan mutta ei näytetä tässä esimerkissä -->
      <ProjectList>
        <Project>
          <Id>1</Id>
          <Name>laskutettava työ asiakas 1</Name>
          <Deleted>false</Deleted>
          <Code>L/001</Code>
          <TypeInternalName>lta1</TypeInternalName>
          <Description>Asiakas 1:n laskutettavien tuntien kohdistaminen</Description>
          <StartDate>2020-01-01</StartDate>
          <EndDate>2024-01-01</EndDate>
        </Project>
      </ProjectList>
    </tyo:ParametersForUpdateProjects>
  </soapenv:Body>
</soapenv:Envelope>

Vastaus

Taso	Kentän nimi	Muoto	Esiintymiskerrat	Selite
0	ReturnValueForUpdateProjects	XML element	1	Juurielementti SOAP bodyn alla
1	ResponseCode	integer	1
1	ResponseString	string	1	Tekstimuotoinen kuvaus pyynnön onnistumisesta tai epäonnistumisesta
1	ProjectUpdatetResultList	XML element	1
2	ProjectUpdateResult	XML element	0..n	Yksittäisen projektin lisäyksen tulos
3	ResponseCode	int		Koodi, joka kuvaa tämän projektin lisäämisen tilaa. Katso vastauskoodit
3	ResponseString	string		Tekstimuotoinen kuvaus projektin lisäämisen tilasta
3	ProjectId	int		Lisätyn projektin yksilöllinen Nepton tunniste

Vastauksen esimerkki

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
  <soapenv:Header/>
  <soapenv:Body>
    <tyo:ReturnValueForUpdateProjects>
      <ResponseCode>1000</ResponseCode>
      <ResponseString>All clear. No errors</ResponseString>
      <ProjectUpdateResultList>
        <ProjectUpdateResult>
          <ResponseCode>1000</ResponseCode>
          <ResponseString>All clear no errors</ResponseString>
          <ProjectId>1</ProjectId>
        </ProjectUpdateResult>
      </ProjectUpdateResultList>
    </tyo:ReturnValueForUpdateProjects>
  </soapenv:Body>
</soapenv:Envelope>