GET User/GetUser?userIdToFilterBy={userIdToFilterBy}

Returns a list of users.

Request Information

URI Parameters

Name	Description	Type	Additional Information
userIdToFilterBy	Optional filter for a specific user id	string	Default value is string.Empty

Body Parameters

Response Information

Resource Description

Returns a list of users.

AgvUser

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
SessionID	Session id that will need to be used in the header of each API call.	string
Users	JSON dictionary of (Agvance) User	Collection of User
CompanyName	CompanyName.	string
AgvanceVersion	Agvance Version.	string

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "SessionID": "sample string 3",
  "Users": [
    {
      "AgvanceUserID": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "LoginName": "sample string 4",
      "UseriD": "sample string 5"
    },
    {
      "AgvanceUserID": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "LoginName": "sample string 4",
      "UseriD": "sample string 5"
    }
  ],
  "CompanyName": "sample string 4",
  "AgvanceVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<AgvUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.User">
  <AgvanceVersion>sample string 5</AgvanceVersion>
  <CompanyName>sample string 4</CompanyName>
  <Message>sample string 2</Message>
  <SessionID>sample string 3</SessionID>
  <Status>sample string 1</Status>
  <Users>
    <AgvUser.User>
      <AgvanceUserID>sample string 1</AgvanceUserID>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <LoginName>sample string 4</LoginName>
      <UseriD>sample string 5</UseriD>
    </AgvUser.User>
    <AgvUser.User>
      <AgvanceUserID>sample string 1</AgvanceUserID>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <LoginName>sample string 4</LoginName>
      <UseriD>sample string 5</UseriD>
    </AgvUser.User>
  </Users>
</AgvUser>