POST wrapper/network/add

(SLNetworkMemberAdd) Adds a Client to an existing Network

Request Information

URI Parameters

None.

Body Parameters

LSTServicesNetworkMemberAddRequest
NameDescriptionTypeAdditional information
organizationName

The User's Organization Name.

string

None.

userName

The User's Name.

string

None.

password

The User's Password.

string

None.

networkKey

The Unique Key for the Network within FinScan.

integer

None.

members

The Members of the Network to be added.

Collection of SLNetworkMember

None.

Request Formats

application/json, text/json

Sample:
{
  "organizationName": "sample string 1",
  "userName": "sample string 2",
  "password": "sample string 3",
  "networkKey": 4,
  "members": [
    {
      "clientKey": 1,
      "applicationId": "sample string 2",
      "clientId": "sample string 3",
      "networkRelationshipType": "sample string 4"
    },
    {
      "clientKey": 1,
      "applicationId": "sample string 2",
      "clientId": "sample string 3",
      "networkRelationshipType": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<LSTServicesNetworkMemberAddRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup">
  <members>
    <SLNetworkMember>
      <applicationId>sample string 2</applicationId>
      <clientId>sample string 3</clientId>
      <clientKey>1</clientKey>
      <networkRelationshipType>sample string 4</networkRelationshipType>
    </SLNetworkMember>
    <SLNetworkMember>
      <applicationId>sample string 2</applicationId>
      <clientId>sample string 3</clientId>
      <clientKey>1</clientKey>
      <networkRelationshipType>sample string 4</networkRelationshipType>
    </SLNetworkMember>
  </members>
  <networkKey>4</networkKey>
  <organizationName>sample string 1</organizationName>
  <password>sample string 3</password>
  <userName>sample string 2</userName>
</LSTServicesNetworkMemberAddRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LSTServicesNetworkMemberAddResponse
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:
<LSTServicesNetworkMemberAddResponse 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>
</LSTServicesNetworkMemberAddResponse>