Gebruikersvelden opvragen

<< Click to Display Table of Contents >>

Navigation:  API aanroepen >

Gebruikersvelden opvragen

Aanroep

Naam: GetUserFields

 

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

    <securityToken></securityToken>

    <tableName></tableName>

    <aspectType></aspectType>

    <filters>

      <filter>

        <field></field>

        <operator></operator>

        <value></value>

      </filter>

       ...

    </filters>

  </ns2:GetUserFields>

</S:Body>

</S:Envelope>

 

Verklaring

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

securityToken

string

verplicht

securityToken verkregen bij login

tableName

TableName

verplicht

Moet een waarde hebben uit TableName

Of vul * in om gebruikersvelden voor alle tabellen op te halen.

tabelnaam: HOURS (voor uren gebruikersvelden) of ASPECTS (voor aspect gebruikersvelden)

aspectType

AspectType

verplicht voor tableName "ASPECTS"

Moet een waarde hebben uit AspectType

Of vul * in om gebruikersvelden voor alle aspecten op te halen.

aspecttype

filters

List<Filter>

optioneel

Naast de tableName en aspectType filters kan via deze filters op specifieke gebruikersvelden worden gefilterd.

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

zie Filter

Voor ophalen van gewijzigde gegevens zie: Filter -> Voorbeeld

 

Limiet

Er kunnen maximaal 10000 gebruikersvelden per bevraging worden teruggestuurd.

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

 

Voorbeelden

hmtoggle_arrow1Gebruikersvelden opvragen met TableName en AspectType

 

Dit voorbeeld zal alle Gebruikersvelden voor tabel ASPECTS (aspecten) en 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:GetUserFields xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <tableName>ASPECTS</tableName>

    <aspectType>IT_MED</aspectType>

  </ns2:GetUserFields>

</S:Body>

</S:Envelope>

 
hmtoggle_arrow1Alle gebruikersvelden opvragen

 

Dit voorbeeld zal alle Gebruikersvelden voor alle tabellen en 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:GetUserFields xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <tableName>*</tableName>

    <aspectType>*</aspectType>

  </ns2:GetUserFields>

</S:Body>

</S:Envelope>

 

 

Antwoord

Naam: GetUserFieldsResponse

 

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

        <result>

           <error>false</error>

           <errorMessage/>

           <userFieldsItemList>

              <userFieldsItem>

                 <id></id>

                 <table></table>

                 <aspectType></aspectType>

                 <internalName></internalName>

                 <fieldName></fieldName>

                 <fieldType></fieldType>

                 <fieldTypeDescr></fieldTypeDescr>

                 <inUse></inUse>

                 <mandatory></mandatory>

              </userFieldsItem>

           </userFieldsItemList>

           ...

        </result>

  </ns2:GetUserFieldsResponse>

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

userFieldsItemList

List<UserFieldsItem>

Een lijst van gebruikersvelden