Webservices - List of Appointments

03 August,2022

 

 
REQUEST

{

   "Proxy": {   

      "Function":"HeliosWs",

      "HostName":"xxxxx",

      "UserName":"yyyyy",

      "Password":"zzzzz",

      "ReportName":"webservice"

   },

 

   "AuthenticationType":"SYSTEM",

   "UserName":"16984205",

   "Password":"8G56A2NrB",  

   "Function":"GetAppointmentList",

   "ResourceGroup":"",

   "ResourceType":"",

   "ResourceId":"",

   "Date":"2018-06-29T00:00:00Z",

   "FromDate":"",

   "ToDate":"",

   "Deactivated":false

}

 
 
RESPONSE

{

   "AppointmentList":    [

            {

         "Code": "10",

         "Index": "1000",

         "ResourceType": "1010",

         "ResourceId": "10",

         "ResourceName": "Per Jensen",

         "Active": true,

         "Date": "2018-06-29T00:00:00Z",

         "PunchIn": "07:45",

         "PunchOut": "13:30",

         "BreakStart1": "09:30",

         "BreakEnd1": "09:45",

         "BreakStart2": "12:00",

         "BreakEnd2": "12:30",

         "AppointmentList":          [

                        {

               "StartTime": "07:45",

               "EndTime": "09:30",

               "OrderNo": 37620

            },

                        {

               "StartTime": "09:45",

               "EndTime": "12:00",

               "OrderNo": 37534

            }

         ],

         "AbsenceList": [         {

            "StartTime": "12:30",

            "EndTime": "13:30",

            "Description": "Tandlæge"

         }]

      },

            {

         "Code": "102",

         "Index": "2000",

         "ResourceType": "1020",

         "ResourceId": "7939",

         "ResourceName": "Mitsubishi ASX 1,6 Invite L",

         "Active": true,

         "Date": "2018-06-29T00:00:00Z",

         "AppointmentList": [         {

            "StartTime": "07:45",

            "EndTime": "13:30",

            "OrderNo": 37620

         }]

      }

   ],

   "WebserviceInfo":    {

      "Name": "HELIOSWEBSERVICE",

      "Version": 1,

      "Build": 2001

   },

   "AuthenticationType": "SYSTEM",

   "ErrorCode": 0,

   "ErrorText": "",

   "Success": true,

   "Proxy":    {

      "AgentName": "WSPROXY",

      "AgentVersion": "1.10.1112",

      "AgentCopyright": "Copyright (C) 2017-2018 Torben Ring. All rights reserved.",

      "ErrorCode": 0,

      "Success": true

   }

}

 
COMMENTS

 

  • ResourceGroup can be set to reduce the amount of data in the response.

  • ResourceType can be set to EMPLOYEE or VEHICLE to reduce the amount of data in the response.

  • ResourceId can be set to reduce the amount of data in the response.

  • If Deactivated is set to True, deactivated employees and/or vehicles will be included in the response.

  • FromDate and ToDate can be used to retrieve data for a longer period of time.

  • If data for more than one day is retrieved, punch in, punch out and break times will not be retrieved for employees.