POST wrapper/group/create

(SLGroupCreate) Creates a Group within a FinScan Organization

Request Information

URI Parameters

None.

Body Parameters

LSTServicesGroupCreateRequest
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 in which the Group is to be created.

 string

None.
groupName

The Name of the Group to be created.

 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 will be a Default Group for New Users

 SLYesNoEnum

None.
groupUserNames

The Users to be added to the Group.

 Collection of string

None.
groupRights

The Rights to granted to the Group.

 Collection of 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",
  "groupComment": "sample string 6",
  "groupWelcomeMessage": "sample string 7",
  "groupNewUsersDefaultGroup": 0,
  "groupUserNames": [
    "sample string 1",
    "sample string 2"
  ],
  "groupRights": [
    "sample string 1",
    "sample string 2"
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LSTServicesGroupCreateResponse
NameDescriptionTypeAdditional information
status

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

 SLResultTypeEnum

None.
message

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

 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",
  "version": "sample string 2",
  "isiReserved": "sample string 3"
}