POST wrapper/group/update

(SLGroupUpdate) Updates a Group within a FinScan Organization

Request Information

URI Parameters

None.

Body Parameters

LSTServicesGroupUpdateRequest
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 updated.

 string

None.
groupName

The Name of the Group to be updated.

 string

None.
groupAddUserNames

The Users to be added to the Group.

 Collection of string

None.
groupRemoveUserNames

The Users to be removed from the Group.

 Collection of string

None.
groupAddRights

The Rights to be granted to the Group.

 Collection of string

None.
groupRemoveRights

The Rights to be removed from 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",
  "groupAddUserNames": [
    "sample string 1",
    "sample string 2"
  ],
  "groupRemoveUserNames": [
    "sample string 1",
    "sample string 2"
  ],
  "groupAddRights": [
    "sample string 1",
    "sample string 2"
  ],
  "groupRemoveRights": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample: 
<LSTServicesGroupUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup">
  <groupAddRights xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </groupAddRights>
  <groupAddUserNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </groupAddUserNames>
  <groupName>sample string 5</groupName>
  <groupOrganizationName>sample string 4</groupOrganizationName>
  <groupRemoveRights xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </groupRemoveRights>
  <groupRemoveUserNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </groupRemoveUserNames>
  <organizationName>sample string 1</organizationName>
  <password>sample string 3</password>
  <userName>sample string 2</userName>
</LSTServicesGroupUpdateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LSTServicesGroupUpdateResponse
NameDescriptionTypeAdditional information
status

The Current Status of the Client matches within FinScan [Pass, Pending, Fail, Error or Duplicate].

 SLResultTypeEnum

None.
code

A Code Value for the Status/Message returned.

 SLWrapperCodes

None.
message

String containing information on the Search 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,
  "code": 0,
  "message": "sample string 1",
  "version": "sample string 2",
  "isiReserved": "sample string 3"
}

application/xml, text/xml

Sample: 
<LSTServicesGroupUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup">
  <code>SUCCESS</code>
  <isiReserved>sample string 3</isiReserved>
  <message>sample string 1</message>
  <status>PASS</status>
  <version>sample string 2</version>
</LSTServicesGroupUpdateResponse>