POST wrapper/list/add

(SLListRecordAdd) Adds a new Record to a Compliance List

Request Information

URI Parameters

None.

Body Parameters

Name	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.
listKey	A sequential number that uniquely identifies a list.	integer	None.
listRecord	The details of the List Record to be Added	SLListRecordAddModify	None.

Request Formats

application/json, text/json

Sample:

{
  "organizationName": "sample string 1",
  "userName": "sample string 2",
  "password": "sample string 3",
  "listKey": 4,
  "listRecord": {
    "listProfileKey": 1,
    "listProfileId": "sample string 2",
    "recordType": 0,
    "specificElement": "sample string 3",
    "persons": [
      {
        "type": "sample string 1",
        "fullName": "sample string 2"
      },
      {
        "type": "sample string 1",
        "fullName": "sample string 2"
      }
    ],
    "entities": [
      {
        "type": "sample string 1",
        "fullName": "sample string 2"
      },
      {
        "type": "sample string 1",
        "fullName": "sample string 2"
      }
    ],
    "vessels": [
      {
        "type": "sample string 1",
        "callSign": "sample string 2",
        "flag": "sample string 3",
        "owner": "sample string 4",
        "fullName": "sample string 5",
        "tonnage": "sample string 6",
        "vesseltype": "sample string 7",
        "grossRegisteredTonnage": "sample string 8"
      },
      {
        "type": "sample string 1",
        "callSign": "sample string 2",
        "flag": "sample string 3",
        "owner": "sample string 4",
        "fullName": "sample string 5",
        "tonnage": "sample string 6",
        "vesseltype": "sample string 7",
        "grossRegisteredTonnage": "sample string 8"
      }
    ],
    "addresses": [
      {
        "type": "sample string 1",
        "line1": "sample string 2",
        "line2": "sample string 3",
        "line3": "sample string 4",
        "line4": "sample string 5",
        "line5": "sample string 6",
        "cityLine": "sample string 7",
        "country": "sample string 8"
      },
      {
        "type": "sample string 1",
        "line1": "sample string 2",
        "line2": "sample string 3",
        "line3": "sample string 4",
        "line4": "sample string 5",
        "line5": "sample string 6",
        "cityLine": "sample string 7",
        "country": "sample string 8"
      }
    ],
    "dates": [
      {
        "type": "sample string 1",
        "value": "sample string 2"
      },
      {
        "type": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "idNumbers": [
      {
        "type": "sample string 1",
        "value": "sample string 2",
        "subtype": "sample string 3",
        "countryIssued": "sample string 4",
        "dateIssued": "sample string 5"
      },
      {
        "type": "sample string 1",
        "value": "sample string 2",
        "subtype": "sample string 3",
        "countryIssued": "sample string 4",
        "dateIssued": "sample string 5"
      }
    ],
    "physicalAttributes": [
      {
        "type": "sample string 1",
        "value": "sample string 2"
      },
      {
        "type": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "socialAttributes": [
      {
        "type": "sample string 1",
        "value": "sample string 2"
      },
      {
        "type": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "textInfo": [
      {
        "type": "sample string 1",
        "value": "sample string 2"
      },
      {
        "type": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "trackingInfo": [
      {
        "type": "sample string 1",
        "value": "sample string 2"
      },
      {
        "type": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "URLs": [
      {
        "type": "sample string 1",
        "value": "sample string 2"
      },
      {
        "type": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "isDeleted": 0
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LSTServicesListRecordAddResponse

Name	Description	Type	Additional information
status	The Current Status of the Client matches within FinScan [Pass, Pending, Fail, Error or Duplicate].	SLResultTypeEnum	None.
listProfileKey	A unique identifier for the List Record Profile just created.	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,
  "listProfileKey": 1,
  "message": "sample string 2",
  "version": "sample string 3",
  "isiReserved": "sample string 4"
}