Aspecten opvragen

<< Click to Display Table of Contents >>

Navigation:  API aanroepen >

Aspecten opvragen

Aanroep

Naam: GetAspects

 

Aanroep structuur

<?xml version="1.0" encoding="UTF-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:GetAspects xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <aspectType></aspectType>

    <filters>

      <filter>

        <field></field>

        <operator></operator>

        <value></value>

      </filter>

       ...

    </filters>

  </ns2:GetAspects>

</S:Body>

</S:Envelope>

 

Verklaring

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

securityToken

string

verplicht

securityToken verkregen bij login

aspectType

AspectType

verplicht

Moet een waarde hebben uit AspectType

Of vul * in om alle aspecten op te halen.

aspecttype

filters

List<Filter>

optioneel

Naast het aspectType filter kan via deze filters op specifieke aspect velden worden gefilterd.

filterlijst voor Aspect velden (zie hieronder in de Antwoord structuur en Verklaring)

zie Filter

Voor ophalen van gewijzigde gegevens zie: Filter -> Voorbeeld

 

Limiet

Er kunnen maximaal 10000 aspecten per bevraging worden teruggestuurd.

Indien de bevraging meer dan 10000 aspecten zal opleveren, worden er geen aspecten teruggegeven en wordt het gemeld in het veld errorMessage van het antwoord.

 

Voorbeelden

hmtoggle_arrow1Aspecten opvragen met AspectType

 

Dit voorbeeld zal alle Aspecten met AspectType IT_MED (medewerkers) ophalen:

<?xml version="1.0" encoding="UTF-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:GetAspects xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <aspectType>IT_MED</aspectType>

  </ns2:GetAspects>

</S:Body>

</S:Envelope>

 
hmtoggle_arrow1Alle aspecten opvragen

 

Dit voorbeeld zal alle Aspecten ophalen:

<?xml version="1.0" encoding="UTF-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:GetAspects xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <aspectType>*</aspectType>

  </ns2:GetAspects>

</S:Body>

</S:Envelope>

 

 

Antwoord

Naam: GetAspectsResponse

 

Antwoord structuur

<?xml version="1.0" encoding="utf-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:GetAspectsResponse xmlns:ns2="api.timewriter.nl">

    <result>

      <error></error>

      <errorMessage></errorMessage>

      <aspectList>

        <aspect>

          <id></id>

          <aspectType></aspectType>

          <name></name>

          <category></category>

          <abbreviation></abbreviation>

          <overhead></overhead>

          <validFrom></validFrom>

          <validTo></validTo>

          <notForAccess></notForAccess>

          <notForAuthorizations></notForAuthorizations>

          <notForCombinations></notForCombinations>

          <notForTariffAgreements></notForTariffAgreements>

          <notForBudgets></notForBudgets>

          <notForProgramModules></notForProgramModules>

          <taskData>

            <no></no>

            <groupId></groupId>

            <description></description>

            <closed></closed>

            <budget></budget>

            <invoiceable></invoiceable>

            <useInvoicing></useInvoicing>

            <invoiceType></invoiceType>

            <price></price>

            <recurringPattern>

              <start></start>

              <end></end>

              <type></type>

              <frequency></frequency>

            </recurringPattern>

            <id_GR_MED></id_GR_MED>

            <id_IT_AT1></id_IT_AT1>

            <id_IT_AT2></id_IT_AT2>

            <id_IT_AT3></id_IT_AT3>

            <id_IT_AT4></id_IT_AT4>

            <id_IT_AT5></id_IT_AT5>

          </taskData>            

          <invoiceData>

            <address></address>

            <postalCode></postalCode>

            <city></city>

            <contact></contact>

            <email></email>

            <debtorId></debtorId>

            <reference></reference>

            <debtorLedgerAccountCode></debtorLedgerAccountCode>

            <turnoverLedgerAccountCode></turnoverLedgerAccountCode>

          </invoiceData>

          <userFieldList>

            <userField>

              <key></key>

              <value></value>

            </userField>

             ...

          </userFieldList>

        </aspect>

         ...

      </aspectList>

    </result>

  </ns2:GetAspectsResponse>

</S:Body>

</S:Envelope>

 

Verklaring

Tag/veldnaam

Type

result

RequestResult

Tag/veldnaam

Type

Omschrijving

error

boolean

false indien geen fouten, true indien er fouten zijn opgetreden

errorMessage

string

foutboodschap, alleen gevuld indien error = true

aspectList

List<Aspect>

Een lijst van aspecten