POST api/resident/validateclient

This is used to validate that the connection to the api is valid.

Request Information

Parameters

NameDescriptionAdditional information
request
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "ManagementFirmName": "sample string 1"
}

application/xml, text/xml

Sample:
<BaseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <ManagementFirmName>sample string 1</ManagementFirmName>
</BaseRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

application/json, text/json

Sample:
{
  "Code": "sample string 1",
  "Message": "sample string 2",
  "Description": "sample string 3",
  "Link": "sample string 4"
}

application/xml, text/xml

Sample:
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <Code>sample string 1</Code>
  <Description>sample string 3</Description>
  <Link>sample string 4</Link>
  <Message>sample string 2</Message>
</Response>