Webservices - Insert an Appointment

The webservice is used to insert an appointment in the planner.

03 August,2022

 

 
REQUEST

{

   "Proxy": {   

      "Function":"HeliosWs",

      "HostName":"xxxxx",

      "UserName":"yyyyy",

      "Password":"zzzzz",

      "ReportName":"webservice"

   },

 

   "AuthenticationType":"SYSTEM",

   "UserName":"16984205",

   "Password":"8G56A2NrB",

   "Function":"InsertAppointment",

   "ResourceType":"EMPLOYEE",

   "ResourceID":"16",

   "OrderNo":"37621",

   "Date":"2018-08-19T00:00:00Z",

   "StartTime":"08:00",

   "EndTime":"14:30",

   "CustomerName":"",

   "CustomerPhone":"",

   "CustomerMobile":"",

   "VehicleRegNo":"",

   "VehicleMake":"",

   "VehicleModel":"",

   "AppointmentText":"",

   "AppointmentStatus":""

}

 

 
RESPONSE

{

   "WebserviceInfo": {

      "Name": "HELIOSWEBSERVICE",

      "Version": 1,

      "Build": 2074

   },

   "AuthenticationType": "SYSTEM",

   "ErrorCode": 0,

   "ErrorText": "",

   "Success": "true",

   "Proxy": {

   "AgentName": "WSPROXY",

   "AgentVersion": "1.80.1210 x86-64",

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

   "ErrorCode": 0,

   "Success": true

   }

}

 

 
ERRORS

  • Missing data - Date not in request.
  • Missing data - Start time not in request.
  • Invalid data - Date is current date but start time is too early.
  • Not found - Order No. in request but not found in Helios.
  • Invalid data - Order is closed.
  • Invalid data - Order is deactivated.
  • Invalid data - Invalid resource type.
  • Not found - Resource ID not found.
  • Not found - Appointment Status not found.
 
 
COMMENTS

  • If Order No. is included, vehicle and customer data will be retrieved from the order
  •