GET api/Companies/{companyId}/Users?includeInactive={includeInactive}

Return all users in a company

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId		integer	Required
includeInactive		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

List of Users for a Company

ServiceResultTypedOfListOfUserProfile

Name	Type	Additional information
Code	integer	None.
Errors	Collection of string	None.
Data	Collection of UserProfile	None.

Response Formats

application/json, text/json

Sample:

{
  "Code": 1,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Data": [
    {
      "UserId": 1,
      "Username": "sample string 2",
      "EmailAddress": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "RoleId": 6,
      "Role": "sample string 7",
      "IsActive": true
    },
    {
      "UserId": 1,
      "Username": "sample string 2",
      "EmailAddress": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "RoleId": 6,
      "Role": "sample string 7",
      "IsActive": true
    }
  ]
}

text/html

Sample:

{"Code":1,"Errors":["sample string 1","sample string 2"],"Data":[{"UserId":1,"Username":"sample string 2","EmailAddress":"sample string 3","FirstName":"sample string 4","LastName":"sample string 5","RoleId":6,"Role":"sample string 7","IsActive":true},{"UserId":1,"Username":"sample string 2","EmailAddress":"sample string 3","FirstName":"sample string 4","LastName":"sample string 5","RoleId":6,"Role":"sample string 7","IsActive":true}]}

application/xml, text/xml

Sample:

<ServiceResultTypedOfArrayOfUserProfileYj8O1tFc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSW.Common.Models">
  <Code>1</Code>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TTMWM_MECLAIM_API.ViewModels">
    <d2p1:UserProfile>
      <d2p1:EmailAddress>sample string 3</d2p1:EmailAddress>
      <d2p1:FirstName>sample string 4</d2p1:FirstName>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:LastName>sample string 5</d2p1:LastName>
      <d2p1:Role>sample string 7</d2p1:Role>
      <d2p1:RoleId>6</d2p1:RoleId>
      <d2p1:UserId>1</d2p1:UserId>
      <d2p1:Username>sample string 2</d2p1:Username>
    </d2p1:UserProfile>
    <d2p1:UserProfile>
      <d2p1:EmailAddress>sample string 3</d2p1:EmailAddress>
      <d2p1:FirstName>sample string 4</d2p1:FirstName>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:LastName>sample string 5</d2p1:LastName>
      <d2p1:Role>sample string 7</d2p1:Role>
      <d2p1:RoleId>6</d2p1:RoleId>
      <d2p1:UserId>1</d2p1:UserId>
      <d2p1:Username>sample string 2</d2p1:Username>
    </d2p1:UserProfile>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
</ServiceResultTypedOfArrayOfUserProfileYj8O1tFc>