POST wrapper/network/create

(SLNetworkCreate) Creates a Network within a FinScan Organization

Request Information

URI Parameters

None.

Body Parameters

LSTServicesNetworkCreateRequest
NameDescriptionTypeAdditional information
organizationName

The User's Organization Name.

string

None.

userName

The User's Name.

string

None.

password

The User's Password.

string

None.

networkType

The Type of Network Generated [Unknown, Household or Network].

string

None.

members

The Members of the Network to be created.

Collection of SLNetworkMember

None.

Request Formats

application/json, text/json

Sample:
{
  "organizationName": "sample string 1",
  "userName": "sample string 2",
  "password": "sample string 3",
  "networkType": "sample string 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/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LSTServicesNetworkCreateResponse
NameDescriptionTypeAdditional information
status

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

SLResultTypeEnum

None.

networkKey

The Unique Key for the Network within FinScan.

integer

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