Back end Users API

Introduction

This page presents the API presented by the backend for the user-related operations.

Request User Details

• Permissions required: None
• Address: /api/Users/Get
• Request JSON:

    {
        "UserID": "id of the user",
    }

• Response JSON:

    {
        "status": "'ok' if the user was found, 'fail' if not",

        "FirstName": "first name of the user",
        "LastName": "last name of the user",
        "DateJoined": "date the user joined",
        "Email": "email of the user. Field appears if the email is public",
        "Username": "Username of the user"
    }

Get UserID from Username

Request User Details

• Permissions required: None
• Address: /api/Users/GetByUsername
• Request JSON:

    {
        "Username": "username of the user",
    }

• Response JSON:

    {
        "status": "'ok' if the user was found, 'fail' if not",
        
        "UserID": "id of the user",
        "FirstName": "first name of the user",
        "LastName": "last name of the user",
        "DateJoined": "date the user joined",
        "Email": "email of the user. Field appears if the email is public",
        "Username": "Username of the user"
    }