Get Many

Get user documents with different options.

Request

POST https://test-uni.cloudplan.biz/api/user/get_many

{
    "user_ids": [...]        //(list of strings, optional) return exactly these user_ids
    "include_images": false  //(bool, optional) include profile b64 encoded profile include_images
    "email": ...             //(string, optional) return exactly one user with this email address
}

Reply

{
    "result": true/false,
    "user": [..]           //list of user documents
}

Example 0 - get with IDs

REQUEST
{
    "user_ids":["56A23EB6998F303B134C1C0A723447B0","56A23D90E7EC5FC6555CF21E9702AB20"]
}

REPLY
{
    "result": true,
    "user": [
        {
            "username": "Frank",
            "name": "bruegmann",
            "email": "f.bruegmann@cloudplan.net",
            "firstname": "frank",
            "user_id": "56A23D90E7EC5FC6555CF21E9702AB20",
            "reachability": "online",
            "status_mode": "online",
            "public": "public",
            "image_id": "5EA28F38DB930F67D1332909215CDEA1",
            "supervisor": []
        },
        {
            "username": "Heye",
            "name": "Everts",
            "email": "h.everts@cloudplan.net",
            "firstname": "Heye",
            "user_id": "56A23EB6998F303B134C1C0A723447B0",
            "reachability": "online",
            "status_mode": "online",
            "public": "public",
            "image_id": "5DA97E2880405A4CC1BBB892BDCE99E6",
            "supervisor": false
        }
    ]
}

Example 1 - get by email

REQUEST
{
    "email":"h.everts@cloudplan.net"
}

REPLY
{
    "result": true,
    "user": [
        {
            "username": "Heye",
            "name": "Everts",
            "email": "h.everts@cloudplan.net",
            "firstname": "Heye",
            "user_id": "56A23EB6998F303B134C1C0A723447B0",
            "reachability": "online",
            "status_mode": "online",
            "public": "public",
            "image_id": "5DA97E2880405A4CC1BBB892BDCE99E6",
            "supervisor": false
        }
    ]
}

Example 2 - get all for organisation

REQUEST
{}

REPLY
{
    "result": true,
    "user": [
        {
            "username": "",
            "name": "",
            "email": "testuser8@cloudplan.net",
            "firstname": "",
            "user_id": "56A24FC24A86E627412FA99BDA54E057",
            "reachability": "offline",
            "status_mode": "status_mode",
            "public": "public",
            "image_id": "",
            "supervisor": false
        },
        ...
        ...
        SOME DOCUMENTS ARE REMOVED HERE TO KEEP THE
        DOCUMENTATION SHORTER
        ...
        ...
        {
            "username": "",
            "name": "",
            "email": "niels556@bitesser.de",
            "firstname": "",
            "user_id": "5F5244074938ECA4A20B97A4086CADDC",
            "reachability": "offline",
            "status_mode": "status_mode",
            "public": "public",
            "image_id": "",
            "supervisor": false
        }
    ]
}

Error Codes

none