OnBoard Scheduler Reporting API

The OnBoard Scheduler reporting api provides an https post endpoint for a list of open, completed or all events from OnBoard Scheduler. Use this endpoint to get a list of events in OnBoard Scheduler. When a successful post is sent to OBS it will return a list formatted in json.

To use the api you will need a Vendor account with OBS, please contact us to get setup.

Vendor API Key
Supplied from OBS include in post header         apikey = vendorapikey

HEADER apikey value=”vendorapikey supplied by OBS”
HEADER Content-Type value-“application/json; charset=utf-8”

Endpoint
https://onboardscheduler.com/api/ver_1/reporting/

Success
OBS will return a json formatted list of the list requested

Error
OBS will return a json formatted error message

Fields

• shop_api_key – required – supplied by obs – string max 50
• list_type string value of the list you would like to receive accepted values are scheduledin or  scheduledout or calendar id a unique numeric number supplied by OBS or retrieved through our list API
• event_type – optional – string value of the type of events you would like to receive accepted values are all or open or completed
• start_date – optional a date formatted mm/dd/yyyy – if omitted todays date will be used
• end_date – optional a date formatted mm/dd/yyyy – if omitted todays date will be used
  If start dates and end dates are the same OBS will return events for that day

Data Schema

application/json;
JSON is the expected format. Post as application/json in you header and send the json data in the body of the post. The body will need to contain the json string. The endpoint accepts an array and each object request must contain the shops api key.

Example json data to send

[
{
“shop_api_key”: “theOBSshopAPIkey”,
“list_type”: “scheduledout”,
“start_date”:”07/01/2021″,
“end_date”:”07/01/2021″,
“event_type”:”completed”
}
]

Example returned data

[

   {

      "List_type":"scheduledin",

      "id":64351201104,

      "calendarname":"SCHEDULED IN",

      "eventdate":"{ts '2021-06-22 08:00:00'}",

      "completed":"{ts '2021-06-22 21:13:31'}",

      "ronbr":"65844",

      "status":"BODY",

      "jobtotal":"8748.09",

      "totalhours":"103",

      "workfileid":"",

      "name":"Scooby Do",

      "ymm":"2016 Mercedes S500",

      "vin":"SJDKNHJFVOAQKLP",

      "serviceWriter":"JOE HIGGS",

      "source":"CASUALTY INS CO",

      "canceledevent":"1",

      "totalloss":""

   },

   {

      "List_type":"scheduledin",

      "id":1204059,

      "calendarname":"SCHEDULED IN",

      "eventdate":"{ts '2021-06-21 08:00:00'}",

      "completed":"{ts '2021-06-21 18:33:58'}",

      "ronbr":"65845",

      "status":"BODY",

      "jobtotal":"3625.03",

      "workfileid":"",

      "name":"Mark Tester",

      "ymm":"2017 Toyota SR5 Tundra",

      "vin":"",

      "serviceWriter":"PAUL ROGERS",

      "source":"ISURANCE",

      "canceledevent":"",

      "totalloss":"1"

 }
 ]