GetProjects – 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 projektien hakemiseen.

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	ParametersForGetProjects	XML element	1	Juurielementti SOAP bodyn alla
1	CallerAuthentication	XML element	1	Tunnistautumisen tiedot. lue lisää tästä
1	FilterByProjectIds	string	0..1	Projektien suodatus Nepton tunnisteiden perusteella. Voit antaa useamman tunnisteen erottelemalle ne pilkulla (,)
1	FilterByProjectName	string	0..1	Projektien suodatus nimen perusteella hyväksyy jokerimerkin '*' käytön.
1	FilterByProjectCode	string	0..1	Projektien suodatus koodin perusteella. hyväksyy jokerimerkin '*' käytön.
1	FilterByUserGroupId	integer	0..1	Suodattaa henkilöryhmään liitetyt projektit henkilöryhmän tunnuksen mukaan
1	FilterByTerminalProjectsOnly	boolean	0..1	Suodattaa pois projektit, joiden ei kuulu näkyä työaikapäätteellä
1	FilterByProjectTypeInternalName	string	0..1	Projektien suodatus sisäisen nimen perusteella.
1	FilterActiveProjectsByStartDate	date	0..1	Käytä FilterActiveProjectsByEndDate-elementin kanssa suodattamaan pois projektit, jotka eivät olleet aktiivisena valitulla ajanjaksolla.
1	FilterActiveProjectsByEndDate	date	0..1	Käytä FilterActiveProjectsByStartDate-elementin kanssa suodattamaan pois projektit, jotka eivät olleet aktiivisena valitulla ajanjaksolla
1	OrderResultsFirstBy	string	0..1	Tulosten 1. järjestelyperuste. Vaihtoehdot ovat: projectid left right name code internaltype
1	OrderResultsSecondBy	string	0..1	Tulosten 2. järjestelyperuste. Samat vaihtoehdot kuin aiemmalla
1	OrderResultsThirdBy	string	0..1	Tulosten 3. järjestelyperuste. Samat vaihtoehdot kuin aiemmalla
1	ReturnFormat	string	0..1	Tulosten muoto- tällä hetkellä ainoa vaihtoehdo ja oletusarvo on "flat_list" (palauttaa yksittäisen luettelon, joka ei ole sisäkkäinen)

Pyynnön esimerkki

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
  <soapenv:Header/>
  <soapenv:Body>
    <tyo:ParametersForGetProjects>
      <CallerAuthentication /> <!-- Autentikointi vaaditaan mutta ei näytetä tässä esimerkissä -->
      <FilterByProjectName>customer work</FilterByProjectName>
    </tyo:ParametersForGetProjects>
  </soapenv:Body>
</soapenv:Envelope>

Vastaus

Taso	Kentän nimi	Muoto	Esiintymiskerrat	Selite
0	ReturnValueForGetProjects	XML element	1	Juurielementti SOAP bodyn alla
1	ResponseCode	int	1
1	ResponseString	string	1
1	ProjectList	XML element	1
2	Project	XML element	0..n	Yksittäisen projektin tiedot
3	Id	integer	0..1	Projektin yksilöllinen Nepton tunniste
3	Name	string	0..1	Projektin nimi
3	Deleted	boolean	0..1	Osoittaa onko projekti poistettu (true/false)
3	Code	string	0..1	Projektin koodi
3	TypeInternalName	string	0..1	Projektin sisäinen nimi
3	Description	string	0..1	Projektin kuvaus
3	StartDate	date	0..1	Projektin alkamispäivä (YYYY-MM-DD)
3	EndDate	date	0..1	Projektin päättymispäivä (YYYY-MM-DD)
3	ParentProjectId	int	0..1	Yliprojektin Nepton tunnus. Nolla päätason projekteille
3	ParentProjectCode	string	0..1	Yliprojektin koodi

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
  <soapenv:Header/>
  <soapenv:Body>
    <tyo:ReturnValueForGetProjects>
      <ResponseCode>?</ResponseCode>
      <ResponseString>?</ResponseString>
      <ProjectList>
        <Project>
          <Id>?</Id>
          <Name>?</Name>
          <Deleted>?</Deleted>
          <Code>?</Code>
          <TypeInternalName>?</TypeInternalName>
          <Description>?</Description>
          <StartDate>?</StartDate>
          <EndDate>?</EndDate>
          <ParentProjectId>?</ParentProjectId>
          <ParentProjectCode>?</ParentProjectCode>
        </Project>
      </ProjectList>
    </tyo:ReturnValueForGetProjects>
  </soapenv:Body>
</soapenv:Envelope>