Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
https://www.commcarehq.org/a/demo/api/v1/users/?format=xml&limit=5

Sample output:

JSON:

 

Code Block
languagejavascript
{users: [{
    meta: {
        limit: 2,
        next: null,
        offset: 0,
        previous: null,
        total_count: 29
    },
    objects: [{
      {  type: "user",
        id: "3c5a623af057e23a32ae4000cf291339",
        username: "jdoe@example.commcarehq.org",
        first_name: "John",
        last_name: "Doe",
        default_phone_number: "+50253311399",
        email: "jdoe@example.org",
        phone_numbers: [
          "+50253311399",
          "+50253314588"
        ],
        groups: [

         "9a0accdba29e01a61ea099394737c4fb",
 
        "b4ccdba29e01a61ea099394737c4fbf7"
        ],
        user_data: {
            "chw_id": "13/43/DFA"
        }
    }, {
       { type: "user",
        id: "3c5a623af057e23a32ae4000cf2943248",
        username: "jsmith@example.commcarehq.org",
        first_name: "Jane",
        last_name: "Smith",
        default_phone_number: "+50253311388",
        email: "jsmith@example.org",
        phone_numbers: [

         "+50253311388"
        ],
        groups: [],
        user_data: {
            "village": "Patna",
	
            "husband_name": "Bob Smith"
      }
    },
    ...}]
]}

 

XML:

Code Block
languagehtml/xml
<users>
    <user id="3c5a623af057e23a32ae4000cf291339" >
        <username>jdoe@example.commcarehq.org</username>
        <first_name>John</first_name>
        <last_name>Doe</last_name>
        <default_phone_number>+50253311399</default_phone_number>
        <email>jdoe@example.org</email>
        <phone_numbers>
            <phone_number>+50253311399</phone_number>
            <phone_number>+50253314588</phone_number>
        </phone_numbers>
        <groups>
            <group id="9a0accdba29e01a61ea099394737c4fb" />
            <group id="b4ccdba29e01a61ea099394737c4fbf7" /> 
        </groups>
        <user_data>
                <chw_id>13/43/DFA</chw_id>
        </user_data>
    </user>
    <user id="3c5a623af057e23a32ae4000cf2943248">
        <username>jsmith@example.commcarehq.org</username>
        <first_name>Jane</first_name>
        <last_name>Smith</last_name>
        <default_phone_number>+50253311388</default_phone_number>
        <email>jsmith@example.org</email>
        <phone_numbers>
            <phone_number>+50253311388</phone_number>
        </phone_numbers>
        <groups />
        <user_data>
                <village>Patna</village>
                <husband_name>Bob Smith</husband_name>
        </user_data>
    </user>
    ...
</users>