GetUserPrograms

API Overview
Updated on
 
Delivers a list of all programs that are registered for the current user and for which
he/she possesses access rights.

Input

None

Output

<GetUserProgramsResponse xmlns="http://services.zanox.com/erp">
    <programs>
        <program id="10" xmlns="http://services.zanox.com/erp/User">
            <name>Zanox</name>
            <locktime>60</locktime>
            <permissions>
                <export trackingtype="3" />
                ...
                <import trackingtype="3" />
                ...
            </permissions>
            <erpprofil><![CDATA[<profile>...</profile>]]></erpprofil>
        </program>
        ...
    </programs>
</GetUserProgramsResponse>

Element Description

<programs>

Object Data type Description
<programs>   Contains n elements <program> as children
<program>    
id int Program ID
name normalizedstring Name of the Program
locktime int Lock wait time of the program, in minutes
<permissions>   List of the current user's access rights to
the available tracking types, differentiated by
import and export lists
<export>    
trackingtype unsignedbyte ID of the tracking type for which program
data may be exported
<import>    
trackingtype unsignedbyte ID of the tracking type for which program
data may be imported
<erpprofil>   ERP profile of the program (refer to the
section ERP profile)

 

Resource Information

Rate Limited? No
Requests per rate limit window N/A
Authentication Requires Authentication
Response Formats xml
Resource family programs
Response Object program
API Version 3.0.1.1

 










The lock wait time indicates the minimum temporal intervals in which individual data packages may be called up. By default, this is possible once per hour. Upon request, the lock wait time can be changed by the zanox Service.
A list of all available tracking types can be retrieved with the help of the GetTrackingTypes function.