POST wrapper/user/getall
(SLUserGetAll) Gets the Users for a FinScan Organization
Request Information
URI Parameters
None.
Body Parameters
LSTServicesUserGetAllRequestName | Description | Type | Additional information |
---|---|---|---|
organizationName |
The User's Organization Name. |
string |
None. |
userName |
The User's Name. |
string |
None. |
password |
The User's Password. |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "organizationName": "sample string 1", "userName": "sample string 2", "password": "sample string 3" }
application/xml, text/xml
Sample:
<LSTServicesUserGetAllRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup"> <organizationName>sample string 1</organizationName> <password>sample string 3</password> <userName>sample string 2</userName> </LSTServicesUserGetAllRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
LSTServicesUserGetAllResponseName | Description | Type | Additional information |
---|---|---|---|
status |
The Current Status of the User Get within FinScan [Pass or Error]. |
SLResultTypeEnum |
None. |
code |
A Code Value for the Status/Message returned. |
SLWrapperCodes |
None. |
message |
String containing information on the User Get status/results including Error details. |
string |
None. |
users |
A list of Users for the Organization |
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, "code": 0, "message": "sample string 1", "users": [ "sample string 1", "sample string 2" ], "version": "sample string 2", "isiReserved": "sample string 3" }
application/xml, text/xml
Sample:
<LSTServicesUserGetAllResponse 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> <users xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </users> <version>sample string 2</version> </LSTServicesUserGetAllResponse>