POST api/SmartRegistry/eNote/Register

Provides the ability to register eNotes.

Request Information

URI Parameters

None.

Body Parameters

The registration information.

ESignSystems.SmartSAFE.Models.SmartRegistry.RegisterENoteModel
NameDescriptionTypeAdditional information
RegistrationMethodId

Gets or sets the registration method identifier.

 integer

Required
RegistrationTypeId

Gets or sets the registration type identifier.

 integer

Required
ServicerMERSOrgId

Gets or sets the servicer MERS organization identifier.

 string

Required

Max length: 7

Min length: 7
ControllerMERSOrgId

Gets or sets the controller MERS organization identifier.

 string

Required

Max length: 7

Min length: 7
LocationMERSOrgId

Gets or sets the controller MERS organization identifier.

 string

Required

Max length: 7

Min length: 7
DelegateeForTransferMERSOrgId

Gets or sets the delegatee for transfer MERS organization identifier.

 string

Max length: 7

Min length: 7
SecuredPartyMERSOrgId

Gets or sets the secured party MERS organization identifier.

 string

Max length: 7

Min length: 7
SecuredPartyDelegateeMERSOrgId

Gets or sets the secured party delegatee MERS organization identifier.

 string

Max length: 7

Min length: 7
RegisterDocuments

Gets or sets a list of documents to register.

 Collection of ESignSystems.SmartSAFE.Models.SmartRegistry.DocumentBorrowerSSN

None.
ClientId

Gets or sets the client identifier.

 integer

None.
EDeliverToRightsHolders

Gets or sets a value indicating whether to eDeliver the eNote to the rights holders.

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "RegistrationMethodId": 1,
  "RegistrationTypeId": 1,
  "ServicerMERSOrgId": "sample string 1",
  "ControllerMERSOrgId": "sample string 2",
  "LocationMERSOrgId": "sample string 3",
  "DelegateeForTransferMERSOrgId": "sample string 4",
  "SecuredPartyMERSOrgId": "sample string 5",
  "SecuredPartyDelegateeMERSOrgId": "sample string 6",
  "RegisterDocuments": [
    {
      "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,
  "EDeliverToRightsHolders": true
}

application/xml, text/xml

Sample: 
<RegisterENoteModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry">
  <ClientId>1</ClientId>
  <ControllerMERSOrgId>sample string 2</ControllerMERSOrgId>
  <DelegateeForTransferMERSOrgId>sample string 4</DelegateeForTransferMERSOrgId>
  <EDeliverToRightsHolders>true</EDeliverToRightsHolders>
  <LocationMERSOrgId>sample string 3</LocationMERSOrgId>
  <RegisterDocuments>
    <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>
  </RegisterDocuments>
  <RegistrationMethodId>1</RegistrationMethodId>
  <RegistrationTypeId>1</RegistrationTypeId>
  <SecuredPartyDelegateeMERSOrgId>sample string 6</SecuredPartyDelegateeMERSOrgId>
  <SecuredPartyMERSOrgId>sample string 5</SecuredPartyMERSOrgId>
  <ServicerMERSOrgId>sample string 1</ServicerMERSOrgId>
</RegisterENoteModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Operation Result.

Collection of ESignSystems.ERegistry.Models.ResponseModel
NameDescriptionTypeAdditional 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>