This endpoint is used to verify you are sending the correct 'Authorization' header to the GoPlant API. Please contact your GoPlant administrator for your API basic authorization credentials.

URL: http://demo.goplant.mobi/api/svc/Historian/Test
Method: POST
Authorization: Basic

• Username: [Contact The GoPlant Administrator]
• Password: [Contact The GoPlant Administrator]

Headers:

• Content-Type: application/json

Body:

• Below are the default parameters that most of our endpoints will require.
• RowStart and RowCount are used for paging thru large record sets. The maximum number of rows that can be returned at any one time is 1000.
• RowStart: This is a zero based row number of the row to start with.
• RowCount: The number of rows to return starting from the RowStart.
• ReturnType: How you would like to receive the response. JSON and XML are supported.
• Note: StartDatetime and EndDateTime are always UTC.
• StartDatetimeUTC: Will return responses answered AFTER this UTC date / time.
• EndDatetimeUTC: Will return responses answered BEFORE this UTC date / time.
• ResponseID: The Last Response ID you received. This endpoint will return records after this Response ID.
• TagSourceCodeName: The external tag source code you would like to request.
• Individual endpoints may have other parameters such as RecordID etc.
• Note: For endpoints that allow a date parameter, you can now use "StartDatetimeSG" or "EndDatetimeSG" to pass storage group timestamps. See the home page for more details.

Accept Body Example:

{
	"RowStart": 0,
	"RowCount": 1000,
	"ReturnType": "json",
	"ResponseID": 500,
	"StartDatetimeUTC":"5/1/2018 15:00",
	"EndDatetimeUTC": "6/1/2018 15:00",
	"EndpointVersion": null (null = latest 1.x)
}

Status: 200
Type: JSON
Body:

• Status Object: Holds status information about your request.
  • HTTPStatusCode: HTTP Status ID of the request.
  • HTTPStatus: HTTP Status string representation. EX. 'OK'
  • RowStart: The zero based first row that was returned.
  • RowsReturned: The actual number of rows returned in the Data object.
  • LastIdReturned: The Last Response ID Returned by this request. This is useful for the next call when you want new records.
  • RequestBegin: The UTC timestamp API received the request.
  • StopWatch: The elapsed time the API call.
  • APIversion: GoPlant internal API version.
  • EndpointVersionReturned: The endpoint version that was returned based on the request. ex. If no endpoint version was requested, this will show the latest 1.x version.
  • ExternalRequest: The request object that was passed. Includes the endpoint version that was requested and the actual endpoint version that was returned.
    • "EndpointVersion": null
    • "EndpointVersionReturned": 1.1
• Data Object: Holds the actual data that you are requesting.

Response Example:

{
    "status": {
        "HTTPStatusCode": 200,
        "HTTPStatus": "Welcome. You have successfully accessed the API.",
        "RowStart": 0,
        "RowsReturned": 0,
        "LastIdReturned": 0,
        "RequestBegin": "2019-03-27T20:17:51.3778288Z",
        "StopWatch": {
            "IsRunning": true,
            "Elapsed": "00:00:00.0044530",
            "ElapsedMilliseconds": 4,
            "ElapsedTicks": 50865
        },
        "APIversion": "5.7.4.0",
        "EndpointVersionReturned": 1,
        "ExternalRequest": {
            "RowStart": 0,
            "RowCount": 1000,
            "StartDatetimeUTC": "2018-05-01T15:00:00",
            "EndDatetimeUTC": "2018-06-01T15:00:00",
            "ResponseID": 500,
            "TagSourceCodeName": "DYNAMO",
            "ReturnType": 1,
            "EndpointVersion": null,
            "EndpointVersionReturned": 1
        }
    },
    "data": null
}

• If you do not provide a basic authorization header you will get an empty body with a status of 401 Unauthorized.
• If your basic authorization header Username or Password is incorrect, you will get this message with a status of 401 Unauthorized.

  {"message": "Unauthorized API access"}

• If you do not supply a json object in your body, you will get this message with a status of 500 Internal Server Error.

  {"message": "Missing body in post."}

• If you pass a RowStart less than zero, you will get this message with a status of 500 Internal Server Error.

  {"message": "RowStart cannot be less than 0."}

• If you pass a RowCount less than zero, you will get this message with a status of 500 Internal Server Error.

  {"message": "RowCount cannot be less than 0."}

• If TagSourceCodeName is required and you do not pass it, you will get this message with a status of 500 Internal Server Error.

  {"message": "You must pass a source code name."}

• If a Start, End or last update date / time is required but not passed, you will get this message with a status of 500 Internal Server Error.

  {"message": "StartDatetimeUTC cannot be null"}

  OR

  {"message": "EndDatetimeUTC cannot be null"}

  OR

  {"message": "LastUpdateUTC cannot be null"}

• If you pass an invalid version number, you will get this type of response.

  {"message": "ResponsesBetweenResponseDate Error: Invalid Version Requested [1.1].   at ...

                        
curl -X POST \
  http://localhost:9080/api/svc/Historian/Test \
  -H 'Authorization: Basic R29QbGFudEV4dGVybmFsQWNjZXNzOjc3NjRFRDE3Q0QyODRGNzhBNDYy' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -d '{
	"RowStart":0,
	"RowCount": 10,
	"ReturnType": "json",
	"StartDatetime":"5/1/2018 15:00",
	"EndDatetime": "6/1/2018 15:00"
}'
                    

                        
var client = new RestClient("http://localhost:9080/api/svc/Historian/Test");
var request = new RestRequest(Method.POST);
request.AddHeader("Cache-Control", "no-cache");
request.AddHeader("Authorization", "Basic R29QbGFudEV4dGVybmFsQWNjZXNzOjc3NjRFRDE3Q0QyODRGNzhBNDYy");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("undefined", "{\n\t\"RowStart\":0,\n\t\"RowCount\": 10,\n\t\"ReturnType\": \"json\",\n\t\"StartDatetime\":\"5/1/2018 15:00\",\n\t\"EndDatetime\": \"6/1/2018 15:00\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
                    

                        
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://localhost:9080/api/svc/Historian/Test",
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic R29QbGFudEV4dGVybmFsQWNjZXNzOjc3NjRFRDE3Q0QyODRGNzhBNDYy",
    "Cache-Control": "no-cache"
  },
  "processData": false,
  "data": "{\n\t\"RowStart\":0,\n\t\"RowCount\": 10,\n\t\"ReturnType\": \"json\",\n\t\"StartDatetime\":\"5/1/2018 15:00\",\n\t\"EndDatetime\": \"6/1/2018 15:00\"\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});