GET Utility/GetHealthCheck?userKey={userKey}

Used as a health check for the API that it can connect to the API Connections database

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
userKey

The secrete key to allow this health check to be performed

 string

Required

Body Parameters

Response Information

Resource Description

Used as a health check for the API that it can connect to the API Connections database

AgvUtilityHealthCheck
NameDescriptionTypeAdditional Information
Status

0 - Success; 1 - An error occurred; 2 - An error occurred; 3 - Descriptive message, process was successful

 string
Message

Informational message that corresponds to the Status returned; 0 - Message will be "OK"; 1 - Detailed message returned to give user an indication of what went wrong; 2 - Less detailed message returned that may not mean anything to the user but that the application might use to take a corrective action; 3 - Not an error but something the user might need to know

 string
ApiVersion

The compiled version of the API

 string

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ApiVersion": "sample string 3"
}

application/xml, text/xml

Sample: 
<AgvUtilityHealthCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Utility">
  <ApiVersion>sample string 3</ApiVersion>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvUtilityHealthCheck>