GET api/SmartRegistry/Connectivity/{clientId}

Sends a connectivity request to MERS using the provided client's settings.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

The client Id

integer

Required

Body Parameters

None.

Response Information

Resource Description

The responses from the connectivity request.

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>