GET api/UserAccount/GetByUsername/{username}

Gets a single user

Request Information

URI Parameters

NameDescriptionTypeMandatory when
username

string

Always Required

Body Parameters

None.

Response Information

Resource Description

JsonResponseModelOfUser
NameDescriptionTypeMandatory when
ResponseCode

integer

ResponseMessage

string

Data

User

Response Formats

application/json, text/json

Sample:
{
  "ResponseCode": 200,
  "ResponseMessage": "User user@example.com.",
  "Data": {
    "Name": "John",
    "Surname": "Doe",
    "Email": "user@example.com",
    "Username": "user@example.com",
    "EmployeeNumber": "",
    "OldUsername": "",
    "RolePerModule": {
      "Audit": "ADMINISTRATOR",
      "Delegation": "ADMIN"
    },
    "Positions": null
  }
}

text/xml

Sample:
<JsonResponseModelOfUserCyyWUdKo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RGS.API.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QAP.API.ModelsForClient">
    <d2p1:Email>user@example.com</d2p1:Email>
    <d2p1:EmployeeNumber></d2p1:EmployeeNumber>
    <d2p1:Name>John</d2p1:Name>
    <d2p1:OldUsername></d2p1:OldUsername>
    <d2p1:Positions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:RolePerModule xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>Audit</d3p1:Key>
        <d3p1:Value>ADMINISTRATOR</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>Delegation</d3p1:Key>
        <d3p1:Value>ADMIN</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:RolePerModule>
    <d2p1:Surname>Doe</d2p1:Surname>
    <d2p1:Username>user@example.com</d2p1:Username>
  </Data>
  <ResponseCode>200</ResponseCode>
  <ResponseMessage>User user@example.com.</ResponseMessage>
</JsonResponseModelOfUserCyyWUdKo>

Error Response Causes

  • Invalid API credentials
  • No user exists with the given username