GET api/HandshakeTest?apiKey={apiKey}

test connectivity

Request Information

URI Parameters

Name	Description	Type	Additional information
apiKey		string	Required

Body Parameters

None.

Response Information

Resource Description

BasicApiResponse

Name	Type	Additional information
Body	string	None.
RequestId	string	None.
ResponseId	string	None.
RequestDate	date	None.
ResponseDate	date	None.
ResponseDateEst	date	None.
Warnings	Collection of Warning	None.
Errors	Collection of Warning	None.
ResponseCode	string	None.
RecordsRemaining	integer	None.
CompleteProgress	decimal number	None.
Category	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Body": "sample string 1",
  "RequestId": "sample string 2",
  "ResponseId": "sample string 3",
  "RequestDate": "2024-12-03T16:37:41.0673331+00:00",
  "ResponseDate": "2024-12-03T16:37:41.0673331+00:00",
  "ResponseDateEst": "2024-12-03T16:37:41.0673331+00:00",
  "Warnings": [
    {
      "Code": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "Code": "sample string 1",
      "Message": "sample string 2"
    }
  ],
  "Errors": [
    {
      "Code": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "Code": "sample string 1",
      "Message": "sample string 2"
    }
  ],
  "ResponseCode": "sample string 7",
  "RecordsRemaining": 1,
  "CompleteProgress": 1.0,
  "Category": "sample string 8"
}

text/html

Sample:

{"Body":"sample string 1","RequestId":"sample string 2","ResponseId":"sample string 3","RequestDate":"2024-12-03T16:37:41.0673331+00:00","ResponseDate":"2024-12-03T16:37:41.0673331+00:00","ResponseDateEst":"2024-12-03T16:37:41.0673331+00:00","Warnings":[{"Code":"sample string 1","Message":"sample string 2"},{"Code":"sample string 1","Message":"sample string 2"}],"Errors":[{"Code":"sample string 1","Message":"sample string 2"},{"Code":"sample string 1","Message":"sample string 2"}],"ResponseCode":"sample string 7","RecordsRemaining":1,"CompleteProgress":1.0,"Category":"sample string 8"}

application/xml, text/xml

Sample:

<BasicApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicApi.Model">
  <Category>sample string 8</Category>
  <CompleteProgress>1</CompleteProgress>
  <Errors>
    <Warning>
      <Code>sample string 1</Code>
      <Message>sample string 2</Message>
    </Warning>
    <Warning>
      <Code>sample string 1</Code>
      <Message>sample string 2</Message>
    </Warning>
  </Errors>
  <RecordsRemaining>1</RecordsRemaining>
  <RequestDate>2024-12-03T16:37:41.0673331+00:00</RequestDate>
  <RequestId>sample string 2</RequestId>
  <ResponseCode>sample string 7</ResponseCode>
  <ResponseDate>2024-12-03T16:37:41.0673331+00:00</ResponseDate>
  <ResponseDateEst>2024-12-03T16:37:41.0673331+00:00</ResponseDateEst>
  <ResponseId>sample string 3</ResponseId>
  <Warnings>
    <Warning>
      <Code>sample string 1</Code>
      <Message>sample string 2</Message>
    </Warning>
    <Warning>
      <Code>sample string 1</Code>
      <Message>sample string 2</Message>
    </Warning>
  </Warnings>
  <Body>sample string 1</Body>
</BasicApiResponse>