Relaties opvragen

<< Click to Display Table of Contents >>

Navigation:  API aanroepen >

Relaties opvragen

Aanvullende informatie over hoe relaties werken in TimeWriter Pro vind u hier.

 

Aanroep

Naam: GetRelations

 

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:GetRelations xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <id1></id1>

    <id2></id2>

    <relationType></relationType>

    <filters>

      <filter>

        <field></field>

        <operator></operator>

        <value></value>

      </filter>

       ...

    </filters>

  </ns2:GetRelations>

</S:Body>

</S:Envelope>

 

Verklaring

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

securityToken

string

verplicht

securityToken verkregen bij login

id1

long

aspect id

id2

long

aspect id of -1 zie

relationType

RelationType

verplicht

Moet een waarde hebben uit RelationType

Of vul * in om alle relaties op te halen.

relatietype

filters

List<Filter>

optioneel

Naast het id1/id2/relationType filter kan via deze filters op het veld TIMESTAMP worden gefilterd. Hiermee kunnen wijzigingen worden gezocht.

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

zie Filter

Voor ophalen van gewijzigde gegevens zie: Filter -> Voorbeeld

 

Limiet

Er kunnen maximaal 100000 relaties per bevraging worden teruggestuurd.

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

 

Voorbeelden

hmtoggle_arrow1Alle relaties opzoeken vanuit id1

 

Het volgende voorbeeld haalt alle relaties op gezien vanuit het aspect met id 789 (vanuit id1).

<?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:GetRelations xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <id1>789</id1> <!-- id1 is ingevuld en wordt gebruikt als filter waarde -->

    <id2></id2> <!-- id2 is niet ingevuld -->

    <relationType>*</relationType> <!-- * betekent alle relation types  -->

  </ns2:GetRelations>

</S:Body>

</S:Envelope>

 
hmtoggle_arrow1Relaties opzoeken met RelationType eindigend op ALL

 

Het volgende voorbeeld controleert of een medewerker geautoriseerd is om te boeken op alle Klanten (aspect 1).

<?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:GetRelations xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <id1>789</id1> <!-- id1 is ingevuld en wordt gebruikt als filter waarde -->

    <id2></id2> <!-- id2 is niet ingevuld -->

    <relationType>AUTHORIZATION-IT_MED-IT_AT1_ALL</relationType> <!-- relatie type om op te filteren  -->

  </ns2:GetRelations>

</S:Body>

</S:Envelope>

 

Als het antwoord één relation oplevert, dan zal id2 -1 zijn. Dit betekent dat de medewerker op alle klanten mag boeken.

<?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:GetRelationsResponse xmlns:ns2="api.timewriter.nl">

    <result>

      <error>false</error>

      <errorMessage></errorMessage>

      <relationList>

        <relation>

          <id1>789</id1>

          <id2>-1</id2>

          <relationType>AUTHORIZATION-IT_MED-IT_AT1_ALL</relationType>

        </relation>

      </relationList>

    </result>

  </ns2:GetRelationsResponse>

</S:Body>

</S:Envelope>

 

De medewerker mag dan dus uren boeken op alle klanten uit dit resultaat:

<?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_AT1</aspectType>

  </ns2:GetAspects>

</S:Body>

</S:Envelope>

 

 

 

Antwoord

Naam: GetRelationsResponse

 

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:GetRelationsResponse xmlns:ns2="api.timewriter.nl">

    <result>

      <error></error>

      <errorMessage></errorMessage>

      <relationList>

        <relation>

          <id1></id1>

          <id2></id2>

          <relationType></relationType>

        </relation>

         ...

      </relationList>

    </result>

  </ns2:GetRelationsResponse>

</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

relationList

List<Relation>

een lijst van relaties