PUT api/LMS/UserGroups/DefaultAction   LMS   All Services

This service adds a user to a user group.

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]

Parameters

NameDescriptionAdditional informationType
modelList 
An array list of user groups with what user is joining it.

Define this parameter in the request body.

 JoinUserGroupDTO[]
JoinUserGroupDTO:
PropertyNameTypeRequiredDescription
FullName String Mandatory Maximum length: 500 chars
LoginName String Optional Maximum length: 50 chars
Message String Optional

Request body formats

application/json, text/json

Sample: 
[
  {
    "FullName": "sample string 1",
    "LoginName": "sample string 2",
    "Message": "sample string 3"
  },
  {
    "FullName": "sample string 1",
    "LoginName": "sample string 2",
    "Message": "sample string 3"
  },
  {
    "FullName": "sample string 1",
    "LoginName": "sample string 2",
    "Message": "sample string 3"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfJoinUserGroupDTO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <JoinUserGroupDTO>
    <FullName>sample string 1</FullName>
    <LoginName>sample string 2</LoginName>
    <Message>sample string 3</Message>
  </JoinUserGroupDTO>
  <JoinUserGroupDTO>
    <FullName>sample string 1</FullName>
    <LoginName>sample string 2</LoginName>
    <Message>sample string 3</Message>
  </JoinUserGroupDTO>
  <JoinUserGroupDTO>
    <FullName>sample string 1</FullName>
    <LoginName>sample string 2</LoginName>
    <Message>sample string 3</Message>
  </JoinUserGroupDTO>
</ArrayOfJoinUserGroupDTO>

Return Type

Return typeJoinUserGroupDTO[]
JoinUserGroupDTO:
PropertyNameTypeRequiredDescription
FullName String Mandatory Maximum length: 500 chars
LoginName String Optional Maximum length: 50 chars
Message String Optional

Response Information

Response body formats

application/json, text/json

Sample: 
[
  {
    "FullName": "sample string 1",
    "LoginName": "sample string 2",
    "Message": "sample string 3"
  },
  {
    "FullName": "sample string 1",
    "LoginName": "sample string 2",
    "Message": "sample string 3"
  },
  {
    "FullName": "sample string 1",
    "LoginName": "sample string 2",
    "Message": "sample string 3"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfJoinUserGroupDTO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <JoinUserGroupDTO>
    <FullName>sample string 1</FullName>
    <LoginName>sample string 2</LoginName>
    <Message>sample string 3</Message>
  </JoinUserGroupDTO>
  <JoinUserGroupDTO>
    <FullName>sample string 1</FullName>
    <LoginName>sample string 2</LoginName>
    <Message>sample string 3</Message>
  </JoinUserGroupDTO>
  <JoinUserGroupDTO>
    <FullName>sample string 1</FullName>
    <LoginName>sample string 2</LoginName>
    <Message>sample string 3</Message>
  </JoinUserGroupDTO>
</ArrayOfJoinUserGroupDTO>