User

User(
    string Username
)

Get an user’s information.

Request

Request Data:

  • (string) Username (required) – the user’s login username.
{
    "Username": <string>
}

Response

{
    "Result": {
        "Added": <string>,
        "Contact": {
            "ContactID": <int>,
            "Email": <string>,
            "FirstName": <string>,
            "LastName": <string>,
            "PhoneNumbers": [
                {
                    "Number": <string>,
                    "PhoneNumberID": <int>,
                    "Type": <int>
                },
                {
                    "Number": <string>,
                    "PhoneNumberID": <int>,
                    "Type": <int>
                },
                {
                    "Number": <string>,
                    "PhoneNumberID": <int>,
                    "Type": <int>
                },
                {
                    "Number": <string>,
                    "PhoneNumberID": <int>,
                    "Type": <int>
                }
            ],
            "Salutation": <string>,
            "Title": <string>
        },
        "Fields": [
            {
                "Field": <string>,
                "Value": <string>
            },
            <... More Fields>
        ],
        "LastLogon": {
            "Browser": <string>,
            "IP": <string>,
            "When": <string>
        },
        "Locked": <bool>,
        "Logon": <bool>,
        "Modified": <string>,
        "Role": <string>,
        "RoleID": <int>,
        "StaffID": <int>,
        "Username": <string>
    }
}

Errors

  • “User not found”
  • “Permission denied”
%d bloggers like this: