KMS, KMS-M2M Support

email: KMS@VisionX-online.com


Skip to end of metadata
Go to start of metadata

Summary of themes:On this page:
  1. Data export / import

REST-API

REST-API URL structure

Base KMS-M2M Rest API URL
  • $SERVER - server address where the KMS-M2M application is deployed e.g m2mproxy.net
  • $SERVICE - service identifier. A KMS-M2M REST service is a group REST functions to define a complex business logic. e.g. haccp1 service to get the archived HACCP files from the server
  • $FUNCTION - function identifier. A function in a REST service implements a specific part of the REST service business logic. e.g. downloadHaccpFiles
  • key=$KEY - private REST API key based on REST password set by customer and used by REST authentication
  • id=$ID - license identifier used by REST authentication
  • paramn=$VALUEn - optional function specific key=value pair list to pass named parameters to the specific REST function
  • A REST request can be POST type. In this case a function specific XML structure can be sent as the post data part of the REST request
  • For a REST request the KMS-M2M REST service can send XML and/or zip type response. Exact output structure is defined at function level

REST-API in the Customer license

The customer license defines what type of REST services can be available for the customer

REST service Haccp1

  • getHaccpList function returns the list of the downloadable HACCP files
  • downloadHaccpFiles function returns a zip file which contains the HACCP files requested in the input list
  • resetHaccpList function marks HACCP files listed in the input as downloaded from the server
getHaccpList function
GET request example
  • The response is an XML list of the downloadable HACCP files
  • date parameter is optional. If it's set then the response contains all HACCP files which date is equal or greater than the parameter value
  • If date parameter is not set then the response list contains the HACCP files which were never downloaded before. (A resetHaccpList function call can set the downloaded status for HACCP files) 

downloadHaccpFiles function
POST request example
  • The POST request must post an XML list with HACCP files to download (XML format is the same was used in getHaccpList as response)
  • The response is a zip file which contains the HACCP files listen in the posted XML structure
  • The response zip file contains a file named swe.xml as well. This file is a general response file which contains detailed error information if there were any error during the function execution.
resetHaccpList function
POST request example
  • The POST request must post an XML list with HACCP files to be marked as download (XML format is the same was used in getHaccpList as response)
  • The response is an XML structure with detailed error/status informations

HACCP data

The HACCP data is in XML file format and recorded for every charge separately.

XML definition

Level-1 token

Level-2 token

Level-3 token

Comment

haccp

 

 

 

 

Head

 

 

 

 

ChargeNumber

 

 

 

UnitType

 

 

 

UnitNumber

 

 

 

DateOfProgramStart

 

 

 

ProgramName

 

 

 

UnityOfTemp

Dimension of temperature 0=°C 1=°F

 

Events

 

 

 

 

EventID

Value definitions of events 

 

 

TimeRunning

 

 

 

Time

 

 

Data

 

records in every minutes

 

 

Mode

Value definitions of operations 

 

 

CookingTemp

 

 

 

CoreTempTarget

 

 

 

CoreTempActual

 

 

 

TimeRunning

 

 

 

StateEnergyOpt

 

 

 

StateHalfEnergy

 

back to the top

Value definitions of events

Value

 NameHACCP-Report
SCCwe 

0

not defined 

1

door or cover open ; Door opened 

2

door or cover closed ; Door closed 

3

stop with home ; end (HOME) 

4

stop with return ; end (RETURN) 

5

option5; Danger2

6

option6; Danger3

7

option7 ; Watchdog2

8

option8; Watchdog3
stop errror ; end (ERROR) 
10 start ELC ; start ELC 
11 restart ; restart (POWER) 
12 stop end ; end 
Value definitions of operations

Value

Name

HACCP-Report
SCCwe  

0

OFF

 

1

STEAM

; Mode STEAM 

2

HOT AIR

; Mode HOT AIR 

3

COMBI; Mode COMBI 

4

COOL DOWN

; Mode COOL DOWN 

5

reserved

 

6

reserved

 

7

reserved

 

8

reserved

 

back to the top

 

Links to other pages:

 


  • No labels