POST api/SmartRegistry/eNote/ChangeData/ssn
Provides the ability to update the ssn for eNotes.
Request Information
URI Parameters
None.
Body Parameters
The eNote document and SSN information.
ESignSystems.SmartSAFE.Models.SmartRegistry.UpdateSSNRequestName | Description | Type | Additional information |
---|---|---|---|
Documents |
Gets or sets a list of eNotes. |
Collection of ESignSystems.SmartSAFE.Models.SmartRegistry.DocumentBorrowerSSN |
None. |
ClientId |
Gets or sets the client identifier. |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "Documents": [ { "DocumentId": 1, "Borrowers": [ { "BorrowerId": "sample string 1", "SSN": "sample string 2" }, { "BorrowerId": "sample string 1", "SSN": "sample string 2" } ] }, { "DocumentId": 1, "Borrowers": [ { "BorrowerId": "sample string 1", "SSN": "sample string 2" }, { "BorrowerId": "sample string 1", "SSN": "sample string 2" } ] } ], "ClientId": 1 }
application/xml, text/xml
Sample:
<UpdateSSNRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry"> <ClientId>1</ClientId> <Documents> <DocumentBorrowerSSN> <Borrowers xmlns:d4p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartDocuments"> <d4p1:BorrowerSSN> <d4p1:BorrowerId>sample string 1</d4p1:BorrowerId> <d4p1:SSN>sample string 2</d4p1:SSN> </d4p1:BorrowerSSN> <d4p1:BorrowerSSN> <d4p1:BorrowerId>sample string 1</d4p1:BorrowerId> <d4p1:SSN>sample string 2</d4p1:SSN> </d4p1:BorrowerSSN> </Borrowers> <DocumentId>1</DocumentId> </DocumentBorrowerSSN> <DocumentBorrowerSSN> <Borrowers xmlns:d4p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartDocuments"> <d4p1:BorrowerSSN> <d4p1:BorrowerId>sample string 1</d4p1:BorrowerId> <d4p1:SSN>sample string 2</d4p1:SSN> </d4p1:BorrowerSSN> <d4p1:BorrowerSSN> <d4p1:BorrowerId>sample string 1</d4p1:BorrowerId> <d4p1:SSN>sample string 2</d4p1:SSN> </d4p1:BorrowerSSN> </Borrowers> <DocumentId>1</DocumentId> </DocumentBorrowerSSN> </Documents> </UpdateSSNRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of ESignSystems.ERegistry.Models.ResponseModelName | Description | Type | Additional information |
---|---|---|---|
MIN | string |
None. |
|
DocumentName | string |
None. |
|
Success | boolean |
None. |
|
ResponseMessages | Collection of ESignSystems.ERegistry.Models.ResponseMessageModel |
None. |
Response Formats
application/json, text/json
Sample:
[ { "MIN": "sample string 1", "DocumentName": "sample string 2", "Success": true, "ResponseMessages": [ { "MIN": "sample string 1", "StatusCode": "sample string 2", "StatusName": "sample string 3", "StatusDescription": "sample string 4", "Success": true, "TransferIdentifier": "sample string 6", "TrackingNumber": "sample string 7", "Error": true }, { "MIN": "sample string 1", "StatusCode": "sample string 2", "StatusName": "sample string 3", "StatusDescription": "sample string 4", "Success": true, "TransferIdentifier": "sample string 6", "TrackingNumber": "sample string 7", "Error": true } ] }, { "MIN": "sample string 1", "DocumentName": "sample string 2", "Success": true, "ResponseMessages": [ { "MIN": "sample string 1", "StatusCode": "sample string 2", "StatusName": "sample string 3", "StatusDescription": "sample string 4", "Success": true, "TransferIdentifier": "sample string 6", "TrackingNumber": "sample string 7", "Error": true }, { "MIN": "sample string 1", "StatusCode": "sample string 2", "StatusName": "sample string 3", "StatusDescription": "sample string 4", "Success": true, "TransferIdentifier": "sample string 6", "TrackingNumber": "sample string 7", "Error": true } ] } ]
application/xml, text/xml
Sample:
<ArrayOfResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.ERegistry.Models"> <ResponseModel> <DocumentName>sample string 2</DocumentName> <MIN>sample string 1</MIN> <ResponseMessages> <ResponseMessageModel> <Error>true</Error> <MIN>sample string 1</MIN> <StatusCode>sample string 2</StatusCode> <StatusDescription>sample string 4</StatusDescription> <StatusName>sample string 3</StatusName> <Success>true</Success> <TrackingNumber>sample string 7</TrackingNumber> <TransferIdentifier>sample string 6</TransferIdentifier> </ResponseMessageModel> <ResponseMessageModel> <Error>true</Error> <MIN>sample string 1</MIN> <StatusCode>sample string 2</StatusCode> <StatusDescription>sample string 4</StatusDescription> <StatusName>sample string 3</StatusName> <Success>true</Success> <TrackingNumber>sample string 7</TrackingNumber> <TransferIdentifier>sample string 6</TransferIdentifier> </ResponseMessageModel> </ResponseMessages> <Success>true</Success> </ResponseModel> <ResponseModel> <DocumentName>sample string 2</DocumentName> <MIN>sample string 1</MIN> <ResponseMessages> <ResponseMessageModel> <Error>true</Error> <MIN>sample string 1</MIN> <StatusCode>sample string 2</StatusCode> <StatusDescription>sample string 4</StatusDescription> <StatusName>sample string 3</StatusName> <Success>true</Success> <TrackingNumber>sample string 7</TrackingNumber> <TransferIdentifier>sample string 6</TransferIdentifier> </ResponseMessageModel> <ResponseMessageModel> <Error>true</Error> <MIN>sample string 1</MIN> <StatusCode>sample string 2</StatusCode> <StatusDescription>sample string 4</StatusDescription> <StatusName>sample string 3</StatusName> <Success>true</Success> <TrackingNumber>sample string 7</TrackingNumber> <TransferIdentifier>sample string 6</TransferIdentifier> </ResponseMessageModel> </ResponseMessages> <Success>true</Success> </ResponseModel> </ArrayOfResponseModel>