GET api/UserAccount/List?username={username}

Gets a list of all users (If username is provided returns single user)

Request Information

URI Parameters

Name	Description	Type	Mandatory when
username		string

Body Parameters

None.

Response Information

Resource Description

JsonResponseModelOfListOfUser

Name	Description	Type	Mandatory when
ResponseCode		integer
ResponseMessage		string
Data		Collection of User

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 200,
  "ResponseMessage": "List of users within a customer.",
  "Data": [
    {
      "Name": "John",
      "Surname": "Doe",
      "Email": "user@example.com",
      "Username": "user@example.com",
      "EmployeeNumber": "",
      "OldUsername": "user@example.com",
      "RolePerModule": null,
      "Positions": null
    },
    {
      "Name": "John1",
      "Surname": "De",
      "Email": "user1@example.com",
      "Username": "user1@example.com",
      "EmployeeNumber": "",
      "OldUsername": "user1@example.com",
      "RolePerModule": null,
      "Positions": null
    },
    {
      "Name": "John2",
      "Surname": "De2",
      "Email": "user2@example.com",
      "Username": "user2@example.com",
      "EmployeeNumber": "",
      "OldUsername": "user2@example.com",
      "RolePerModule": null,
      "Positions": null
    }
  ]
}

text/xml

Sample:

<JsonResponseModelOfArrayOfUserCyyWUdKo 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:User>
      <d2p1:Email>user@example.com</d2p1:Email>
      <d2p1:EmployeeNumber></d2p1:EmployeeNumber>
      <d2p1:Name>John</d2p1:Name>
      <d2p1:OldUsername>user@example.com</d2p1:OldUsername>
      <d2p1:Positions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:RolePerModule xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:Surname>Doe</d2p1:Surname>
      <d2p1:Username>user@example.com</d2p1:Username>
    </d2p1:User>
    <d2p1:User>
      <d2p1:Email>user1@example.com</d2p1:Email>
      <d2p1:EmployeeNumber></d2p1:EmployeeNumber>
      <d2p1:Name>John1</d2p1:Name>
      <d2p1:OldUsername>user1@example.com</d2p1:OldUsername>
      <d2p1:Positions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:RolePerModule xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:Surname>De</d2p1:Surname>
      <d2p1:Username>user1@example.com</d2p1:Username>
    </d2p1:User>
    <d2p1:User>
      <d2p1:Email>user2@example.com</d2p1:Email>
      <d2p1:EmployeeNumber></d2p1:EmployeeNumber>
      <d2p1:Name>John2</d2p1:Name>
      <d2p1:OldUsername>user2@example.com</d2p1:OldUsername>
      <d2p1:Positions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:RolePerModule xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:Surname>De2</d2p1:Surname>
      <d2p1:Username>user2@example.com</d2p1:Username>
    </d2p1:User>
  </Data>
  <ResponseCode>200</ResponseCode>
  <ResponseMessage>List of users within a customer.</ResponseMessage>
</JsonResponseModelOfArrayOfUserCyyWUdKo>

Error Response Causes

Invalid API credentials