GET api/InsuranceProviders/{insuranceProviderId}/Users?includeInactive={includeInactive}

Return all users in a insuranceProvider

Request Information

URI Parameters

NameDescriptionTypeAdditional information
insuranceProviderId

integer

Required

includeInactive

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

List of Users for a InsuranceProvider

ServiceResultTypedOfListOfInsuranceUserProfile
NameDescriptionTypeAdditional information
Code

integer

None.

Errors

Collection of string

None.

Data

Collection of InsuranceUserProfile

None.

Response Formats

application/json, text/json

Sample:
{
  "Code": 1,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Data": [
    {
      "CanViewLumpSum": true,
      "CanViewOther": true,
      "Companies": [
        {
          "CompanyId": 1,
          "CompanyName": "sample string 2",
          "CompanyCode": "sample string 3",
          "IsActive": true,
          "CompanyAbbr": "sample string 5"
        },
        {
          "CompanyId": 1,
          "CompanyName": "sample string 2",
          "CompanyCode": "sample string 3",
          "IsActive": true,
          "CompanyAbbr": "sample string 5"
        }
      ],
      "UserId": 3,
      "Username": "sample string 4",
      "EmailAddress": "sample string 5",
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "RoleId": 8,
      "Role": "sample string 9",
      "IsActive": true
    },
    {
      "CanViewLumpSum": true,
      "CanViewOther": true,
      "Companies": [
        {
          "CompanyId": 1,
          "CompanyName": "sample string 2",
          "CompanyCode": "sample string 3",
          "IsActive": true,
          "CompanyAbbr": "sample string 5"
        },
        {
          "CompanyId": 1,
          "CompanyName": "sample string 2",
          "CompanyCode": "sample string 3",
          "IsActive": true,
          "CompanyAbbr": "sample string 5"
        }
      ],
      "UserId": 3,
      "Username": "sample string 4",
      "EmailAddress": "sample string 5",
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "RoleId": 8,
      "Role": "sample string 9",
      "IsActive": true
    }
  ]
}

text/html

Sample:
{"Code":1,"Errors":["sample string 1","sample string 2"],"Data":[{"CanViewLumpSum":true,"CanViewOther":true,"Companies":[{"CompanyId":1,"CompanyName":"sample string 2","CompanyCode":"sample string 3","IsActive":true,"CompanyAbbr":"sample string 5"},{"CompanyId":1,"CompanyName":"sample string 2","CompanyCode":"sample string 3","IsActive":true,"CompanyAbbr":"sample string 5"}],"UserId":3,"Username":"sample string 4","EmailAddress":"sample string 5","FirstName":"sample string 6","LastName":"sample string 7","RoleId":8,"Role":"sample string 9","IsActive":true},{"CanViewLumpSum":true,"CanViewOther":true,"Companies":[{"CompanyId":1,"CompanyName":"sample string 2","CompanyCode":"sample string 3","IsActive":true,"CompanyAbbr":"sample string 5"},{"CompanyId":1,"CompanyName":"sample string 2","CompanyCode":"sample string 3","IsActive":true,"CompanyAbbr":"sample string 5"}],"UserId":3,"Username":"sample string 4","EmailAddress":"sample string 5","FirstName":"sample string 6","LastName":"sample string 7","RoleId":8,"Role":"sample string 9","IsActive":true}]}

application/xml, text/xml

Sample:
<ServiceResultTypedOfArrayOfInsuranceUserProfileYj8O1tFc 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:InsuranceUserProfile>
      <d2p1:EmailAddress>sample string 5</d2p1:EmailAddress>
      <d2p1:FirstName>sample string 6</d2p1:FirstName>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:LastName>sample string 7</d2p1:LastName>
      <d2p1:Role>sample string 9</d2p1:Role>
      <d2p1:RoleId>8</d2p1:RoleId>
      <d2p1:UserId>3</d2p1:UserId>
      <d2p1:Username>sample string 4</d2p1:Username>
      <d2p1:CanViewLumpSum>true</d2p1:CanViewLumpSum>
      <d2p1:CanViewOther>true</d2p1:CanViewOther>
      <d2p1:Companies>
        <d2p1:Company>
          <d2p1:CompanyAbbr>sample string 5</d2p1:CompanyAbbr>
          <d2p1:CompanyCode>sample string 3</d2p1:CompanyCode>
          <d2p1:CompanyId>1</d2p1:CompanyId>
          <d2p1:CompanyName>sample string 2</d2p1:CompanyName>
          <d2p1:IsActive>true</d2p1:IsActive>
        </d2p1:Company>
        <d2p1:Company>
          <d2p1:CompanyAbbr>sample string 5</d2p1:CompanyAbbr>
          <d2p1:CompanyCode>sample string 3</d2p1:CompanyCode>
          <d2p1:CompanyId>1</d2p1:CompanyId>
          <d2p1:CompanyName>sample string 2</d2p1:CompanyName>
          <d2p1:IsActive>true</d2p1:IsActive>
        </d2p1:Company>
      </d2p1:Companies>
    </d2p1:InsuranceUserProfile>
    <d2p1:InsuranceUserProfile>
      <d2p1:EmailAddress>sample string 5</d2p1:EmailAddress>
      <d2p1:FirstName>sample string 6</d2p1:FirstName>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:LastName>sample string 7</d2p1:LastName>
      <d2p1:Role>sample string 9</d2p1:Role>
      <d2p1:RoleId>8</d2p1:RoleId>
      <d2p1:UserId>3</d2p1:UserId>
      <d2p1:Username>sample string 4</d2p1:Username>
      <d2p1:CanViewLumpSum>true</d2p1:CanViewLumpSum>
      <d2p1:CanViewOther>true</d2p1:CanViewOther>
      <d2p1:Companies>
        <d2p1:Company>
          <d2p1:CompanyAbbr>sample string 5</d2p1:CompanyAbbr>
          <d2p1:CompanyCode>sample string 3</d2p1:CompanyCode>
          <d2p1:CompanyId>1</d2p1:CompanyId>
          <d2p1:CompanyName>sample string 2</d2p1:CompanyName>
          <d2p1:IsActive>true</d2p1:IsActive>
        </d2p1:Company>
        <d2p1:Company>
          <d2p1:CompanyAbbr>sample string 5</d2p1:CompanyAbbr>
          <d2p1:CompanyCode>sample string 3</d2p1:CompanyCode>
          <d2p1:CompanyId>1</d2p1:CompanyId>
          <d2p1:CompanyName>sample string 2</d2p1:CompanyName>
          <d2p1:IsActive>true</d2p1:IsActive>
        </d2p1:Company>
      </d2p1:Companies>
    </d2p1:InsuranceUserProfile>
  </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>
</ServiceResultTypedOfArrayOfInsuranceUserProfileYj8O1tFc>