POST wrapper/group/get

(SLGroupGet) Gets the details for a Group within a FinScan Organization

Request Information

URI Parameters

None.

Body Parameters

LSTServicesGroupGetRequest
NameDescriptionTypeAdditional information
organizationName

The User's Organization Name.

string

None.

userName

The User's Name.

string

None.

password

The User's Password.

string

None.

groupOrganizationName

The Organization Name for which the Group is to be retrieved.

string

None.

groupName

The Name of the Group to be retrieved.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "organizationName": "sample string 1",
  "userName": "sample string 2",
  "password": "sample string 3",
  "groupOrganizationName": "sample string 4",
  "groupName": "sample string 5"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LSTServicesGroupGetResponse
NameDescriptionTypeAdditional information
status

The Current Status of the Group FinScan [Pass or Error].

SLResultTypeEnum

None.

message

String containing information on the status/results including Error details.

string

None.

groupComment

The Comment for the Group.

string

None.

groupWelcomeMessage

The Welcome message displayed to members of the Group at Login.

string

None.

groupNewUsersDefaultGroup

Whether the Group is a Default Group for New Users

SLYesNoEnum

None.

groupUserNames

The Users within the Group.

Collection of string

None.

groupRights

THe Rights granted to the Group.

Collection of string

None.

version

The version of the Wrapper.

string

None.

isiReserved

A field used to return debugging information.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "status": 0,
  "message": "sample string 1",
  "groupComment": "sample string 2",
  "groupWelcomeMessage": "sample string 3",
  "groupNewUsersDefaultGroup": 0,
  "groupUserNames": [
    "sample string 1",
    "sample string 2"
  ],
  "groupRights": [
    "sample string 1",
    "sample string 2"
  ],
  "version": "sample string 4",
  "isiReserved": "sample string 5"
}