Ping API Method

Testing the API Response

Ping Without Headers

This API pings the Web API and provides a response. It is used only to determine if the service is responding to requests and echoes the string or input parameter.

Structure of API Call:

GET /v1/ping/{test string}

GET /v1/ping/123xyz

Request

Parameter	Datatype	Required	Description
input	String	Yes	Some custom text (i.e., 123)

Response

Parameter	Datatype	Description
Output	String	The text you entered as input

<string      
			xmlns="http://schemas.microsoft.com/2003/10/Serialization/"> 123
</string>

Ping With Headers

This API pings the Web API and performs the following:

Determines if the service is responding to requests·
Determines if headers are valid
Determines if encryption/hashing is working correctly on both ends
Echoes the input parameter

Structure of API call:

GET /pingwithheaders/{id}

Sample Request – Headers

{
    x-gdn-ipaddress:127.0.0.1 x-gdn-encryptiontype:1
    x-gdn-devicetype:1
    x-gdn-programnumber:Bahu-BC2019 x-gdn-channeltype:1
    x-gdn-messageid:ba435239-26f0-4678-b95e-f7f55f723dd4
    x-gdn-signature:6EB2CCC767CC360FC43957F05A4C88023C6B746B298821D6661055441B453735
    x-gdn-timestamp:2020-06-18T06:07:44Z x-gdn-sessionid:null
    x-gdn-deviceid:b329954c-ff60-4c0e-8f48-21b0978ec9cd x-gdn-latitude:25.78
    x-gdn-longitude:288.11
}

Request Parameters

Parameter	Datatype	Required	Description
input	String	Yes	Some custom text (i.e., 123)

Response

Parameter	Datatype	Description
Output	String	The text you entered as input

<string      
			xmlns="http://schemas.microsoft.com/2003/10/Serialization/"> 123
</string>