api.users

/api/users/

GET /api/users/

Description:

Provides a list of all users
can_lock requires_lock has_etag requires_etag
False False False False

Request:

<!-- No XML Request. -->

Response:

<users>
    <user uri="/users/X/" id="X" full_render="false">
        <username>[str]</username>
        <password>[str]</password>
        <pin>********</pin> <!-- rendered with ******** as value if pin set, otherwise empty tag -->
        <name>
            <first>[str]</last>
            <last>[str]</last>
        </name>
        <email>[str]</email>
        <account_locked>[bool]</account_locked>
        <privilege_group uri="/privilege_groups/Y/" id="Y" full_render="false">
            <name>[str]</name>
            <type>[enum: administrator | manager | normal]</type>
        </privilege_group>
        <read_eula>[bool]</read_eula>
        <internal_user>[bool]</internal_user>
        <active>[bool]</active>
    </user>
    [...]
</users>

/api/users/(d+)/

GET /api/users/(d+)/

Description:

Return the details of a specific user
can_lock requires_lock has_etag requires_etag
False False False False

Request:

<!-- No XML Request. -->

Response:

<user uri="/users/X/" id="X" full_render="true">
    <username>[str]</username>
    <password>[str]</password>
    <pin>********</pin> <!-- always rendered with ******** as value -->
    <name>
        <first>[str]</first>
        <last>[str]</last>
    </name>
    <email>[str]</email>
    <account_locked>[bool]</account_locked>
    <privilege_group uri="/privilege_groups/Y/" id="Y" full_render="false">
        <name>[str]</name>
        <type>[enum: administrator | manager | normal]</type>
    </privilege_group>
    <read_eula>[bool]</read_eula>
    <hidden>[bool]</hidden>
    <enabled>[bool]</enabled>
    <phone>[str]</phone>
    <product uri="/products/Z/" id="Z"/>
    <product_code>[str]</product_code>
    <open_to_pos>[bool]</open_to_pos>
    <gsx_apple_id>[str]</gsx_apple_id>
    <gsx_tech_id>[str]</gsx_tech_id>
    <can_open_from_otr>[bool]</can_open_from_otr>
    <can_discount>[bool]</can_discount>
    <internal_user>[bool]</internal_user>
    <active>[bool]</active>
    <expired>[bool]</expired>
    <display_welcome>[bool]</display_welcome>
</user>