Get user fields

<< Click to Display Table of Contents >>

Navigation:  API requests >

Get user fields

API request

Name: GetUserFields

 

API request structure

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

 

Explanation

Tag/field name

Type

Remark

Description

securityToken

string

mandatory

securityToken obtained at log in

tableName

TableName

mandatory

Must have a value from TableName

or use * to get user fields for all tables

table name: HOURS (for hours user fields) or ASPECTS (for aspect user fields).

aspectType

AspectType

mandatory for table name "ASPECTS"

Must have a value from AspectType

or use * to get user fields for all aspects.

aspect type

filters

List<Filter>

optional

Apart from the tableName or aspectType filter this filter can be used for filtering on specific aspect fields.

filter list for User fields fields (check Response structure and Explanation below)

See also Filter

For only fetching the changed data check the: Filter -> Example

 

Limit

A maximum of 10000 user fields can be returned per request.

If the request will yield more than 10000 user fields, no user fields will be returned and it will be reported in the errorMessage field of the response.

 

Examples

hmtoggle_arrow1Get user fields with TableName en AspectType

 

This example will get all User fields of table ASPECTS with an AspectType IT_MED (employees):

<?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_arrow1Get all user fields

 

This example will get all User fields for all tables and all aspects:

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

 

 

API response

Name: GetUserFieldsResponse

 

API response structure

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

 

Explanation

Tag/field name

Type

result

RequestResult

Tag/field name

Type

Description

error

boolean

false if there are no errors, true if there are errors

errorMessage

string

error message, only used when error = true

userFieldsItemList

List<UserFieldsItem>

A list of user fields