POST wrapper/list/update
(SLListRecordUpdate) Updates a Record within a Compliance List
Request Information
URI Parameters
None.
Body Parameters
LSTServicesListRecordUpdateRequestName | 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. |
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", "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/xml, text/xml
Sample:
<LSTServicesListRecordUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup"> <listRecord> <URLs> <SLListRecordSimpleType> <type>sample string 1</type> <value>sample string 2</value> </SLListRecordSimpleType> <SLListRecordSimpleType> <type>sample string 1</type> <value>sample string 2</value> </SLListRecordSimpleType> </URLs> <addresses> <SLListRecordAddressType> <cityLine>sample string 7</cityLine> <country>sample string 8</country> <line1>sample string 2</line1> <line2>sample string 3</line2> <line3>sample string 4</line3> <line4>sample string 5</line4> <line5>sample string 6</line5> <type>sample string 1</type> </SLListRecordAddressType> <SLListRecordAddressType> <cityLine>sample string 7</cityLine> <country>sample string 8</country> <line1>sample string 2</line1> <line2>sample string 3</line2> <line3>sample string 4</line3> <line4>sample string 5</line4> <line5>sample string 6</line5> <type>sample string 1</type> </SLListRecordAddressType> </addresses> <dates> <SLListRecordSimpleType> <type>sample string 1</type> <value>sample string 2</value> </SLListRecordSimpleType> <SLListRecordSimpleType> <type>sample string 1</type> <value>sample string 2</value> </SLListRecordSimpleType> </dates> <entities> <SLListRecordPersonEntityType> <fullName>sample string 2</fullName> <type>sample string 1</type> </SLListRecordPersonEntityType> <SLListRecordPersonEntityType> <fullName>sample string 2</fullName> <type>sample string 1</type> </SLListRecordPersonEntityType> </entities> <idNumbers> <SLListRecordIdNumberType> <countryIssued>sample string 4</countryIssued> <dateIssued>sample string 5</dateIssued> <subtype>sample string 3</subtype> <type>sample string 1</type> <value>sample string 2</value> </SLListRecordIdNumberType> <SLListRecordIdNumberType> <countryIssued>sample string 4</countryIssued> <dateIssued>sample string 5</dateIssued> <subtype>sample string 3</subtype> <type>sample string 1</type> <value>sample string 2</value> </SLListRecordIdNumberType> </idNumbers> <isDeleted>No</isDeleted> <listProfileId>sample string 2</listProfileId> <listProfileKey>1</listProfileKey> <persons> <SLListRecordPersonEntityType> <fullName>sample string 2</fullName> <type>sample string 1</type> </SLListRecordPersonEntityType> <SLListRecordPersonEntityType> <fullName>sample string 2</fullName> <type>sample string 1</type> </SLListRecordPersonEntityType> </persons> <physicalAttributes> <SLListRecordSimpleType> <type>sample string 1</type> <value>sample string 2</value> </SLListRecordSimpleType> <SLListRecordSimpleType> <type>sample string 1</type> <value>sample string 2</value> </SLListRecordSimpleType> </physicalAttributes> <recordType>Individual</recordType> <socialAttributes> <SLListRecordSimpleType> <type>sample string 1</type> <value>sample string 2</value> </SLListRecordSimpleType> <SLListRecordSimpleType> <type>sample string 1</type> <value>sample string 2</value> </SLListRecordSimpleType> </socialAttributes> <specificElement>sample string 3</specificElement> <textInfo> <SLListRecordSimpleType> <type>sample string 1</type> <value>sample string 2</value> </SLListRecordSimpleType> <SLListRecordSimpleType> <type>sample string 1</type> <value>sample string 2</value> </SLListRecordSimpleType> </textInfo> <trackingInfo> <SLListRecordSimpleType> <type>sample string 1</type> <value>sample string 2</value> </SLListRecordSimpleType> <SLListRecordSimpleType> <type>sample string 1</type> <value>sample string 2</value> </SLListRecordSimpleType> </trackingInfo> <vessels> <SLListRecordVesselType> <callSign>sample string 2</callSign> <flag>sample string 3</flag> <fullName>sample string 5</fullName> <grossRegisteredTonnage>sample string 8</grossRegisteredTonnage> <owner>sample string 4</owner> <tonnage>sample string 6</tonnage> <type>sample string 1</type> <vesseltype>sample string 7</vesseltype> </SLListRecordVesselType> <SLListRecordVesselType> <callSign>sample string 2</callSign> <flag>sample string 3</flag> <fullName>sample string 5</fullName> <grossRegisteredTonnage>sample string 8</grossRegisteredTonnage> <owner>sample string 4</owner> <tonnage>sample string 6</tonnage> <type>sample string 1</type> <vesseltype>sample string 7</vesseltype> </SLListRecordVesselType> </vessels> </listRecord> <organizationName>sample string 1</organizationName> <password>sample string 3</password> <userName>sample string 2</userName> </LSTServicesListRecordUpdateRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
LSTServicesListRecordUpdateResponseName | Description | Type | Additional 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:
<LSTServicesListRecordUpdateResponse 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> </LSTServicesListRecordUpdateResponse>