ORTEC Detective X - Request; Response; Resources; System Information

ORTEC
®
Detective
®
X Handheld Radioisotope Identifier 1107231N / 082020
86
http://<IP Address>/remote/v1/remote/Start
Figure 111. Example Start Acquisition via Internet Browser Interface
A.4 REQUEST
The request URL format includes a version number to assure structural stability and account for extensibility,
endpoint changes, field deprecations etc.
http://<ip-address>/remote/v1/{resource-path}
The API requests are using: GET, POST, PUT and DELETE HTTP methods. When submitting a POST or PUT
request, the Content-type header should be set to application/json and the charset=UTF-8 (Optional).
A.5 RESPONSE
All the API responses are in JSON format. The response uses standard HTTP status codes to indicate success
or failure of API calls. Each API response is wrapped in a standard payload that contains the results of the API
call, and in some cases may contain some additional information and metadata. Here is an example of
successful response:
{
--- JSON payload ---
}
A.6 RESOURCES
The resource is based on the following functionality parts: system information, live data access, and remote
control.
A.7 SYSTEM INFORMATION
GET http://<ip-address>/remote/v1/instrumentInformation
Returns instrument information record.
Available response representations:
 Record example:
{
"InstrumentInformation": {
"Manufacturer": "ORTEC",
"ModelName": "DetectiveX",