GET api/LMS/UserGroups/DefaultAction   LMS   All Services

This service gets all User Groups from the system. Does not include deleted User Groups

Request Information

Headers

Fields Type M/O/C Definition
AccountLoginName String(50) Mandatory Login name of an account used for logging into Galaxy application to perform the service call
AccountPassword String(50) Mandatory Password of an account used for logging into Galaxy application to perform the service call
SourceSystemID String(50) Mandatory Name or ID of application or system that initiated the call.
DomainID String(50) Mandatory Name or ID of the domain that the call is being made to. (Value will be 1, if the site only has one domain)
Accept String Optional Format in which client expects the response: [application/json] (default), [application/xml]
ContentType String Optional Format in which client is sending the request: [application/json] (default), [application/xml]

Return Type

Return typeUserGroupDTO[]
UserGroupDTO:
PropertyNameTypeRequiredDescription
UserGroupID Int32 Display
Name String Mandatory Maximum length: 100 chars
Note String Optional
ParentID Nullable<Int32> Optional
SequenceNo Nullable<Int32> Optional
TreeIndex String Optional Maximum length: 500 chars
DomainID Int32 Mandatory
FullPath String Display

Response Information

Response body formats

application/json, text/json

Sample: 
[
  {
    "UserGroupID": 1,
    "Name": "sample string 2",
    "Note": "sample string 3",
    "ParentID": 1,
    "SequenceNo": 1,
    "TreeIndex": "sample string 4",
    "DomainID": 5,
    "FullPath": "sample string 6"
  },
  {
    "UserGroupID": 1,
    "Name": "sample string 2",
    "Note": "sample string 3",
    "ParentID": 1,
    "SequenceNo": 1,
    "TreeIndex": "sample string 4",
    "DomainID": 5,
    "FullPath": "sample string 6"
  },
  {
    "UserGroupID": 1,
    "Name": "sample string 2",
    "Note": "sample string 3",
    "ParentID": 1,
    "SequenceNo": 1,
    "TreeIndex": "sample string 4",
    "DomainID": 5,
    "FullPath": "sample string 6"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfUserGroupDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LMS.API.Service.Models.LMS">
  <UserGroupDTO>
    <DomainID>5</DomainID>
    <Name>sample string 2</Name>
    <Note>sample string 3</Note>
    <ParentID>1</ParentID>
    <SequenceNo>1</SequenceNo>
    <TreeIndex>sample string 4</TreeIndex>
  </UserGroupDTO>
  <UserGroupDTO>
    <DomainID>5</DomainID>
    <Name>sample string 2</Name>
    <Note>sample string 3</Note>
    <ParentID>1</ParentID>
    <SequenceNo>1</SequenceNo>
    <TreeIndex>sample string 4</TreeIndex>
  </UserGroupDTO>
  <UserGroupDTO>
    <DomainID>5</DomainID>
    <Name>sample string 2</Name>
    <Note>sample string 3</Note>
    <ParentID>1</ParentID>
    <SequenceNo>1</SequenceNo>
    <TreeIndex>sample string 4</TreeIndex>
  </UserGroupDTO>
</ArrayOfUserGroupDTO>