OnBoard Scheduler Update API

You are here:
< Back

The OnBoard Scheduler update event api provides an https endpoint for transmitting the data needed to update an event in OnBoard Scheduler(OBS) form another source. When a successful post is sent to OBS an event will be updated in the scheduler. Only 1 update per http post.

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 = sampleapikey

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

Success
OBS will return a http 200

Error
OBS will return a json formatted error message

Fields

  • obs_event_id – required – supplied by obs –  35-character string
  • ro_nbr – string  max 25
  • customer_name – string  max 50
  • email – string max 100
  • phone – numeric   no dashes no spaces 10 or 11 digit us phone number
  • ymm – Optional combine vehicle year, make and model as 1 string max 100
  • vyear – Vehicle year numeric max 4
  • vmake- string max 25
  • vmodel – string max 50
  • vcolor –  string max 25
  • vin –  string max 17
  • claim_nbr – string max 25
  • paint_hours – decimal max 11 2 decimal points
  • body_hours – decimal max 11 2 decimal points
  • mechanical_hours – decimal max 11 2 decimal points
  • frame_hours – decimal max 11 2 decimal points
  • total_hours – decimal max 11 2 decimal points
  • job_total – decimal max 11 2 decimal points
  • paint_material – decimal max 11 2 decimal points
  • service_writer – string max 50 , will need to match what’s in obs, to get a list see our list api
  • repair_type – string max 50 , will need to match what’s in obs, to get a list see our list api
  • source – string max 50 will need to match what’s in obs, to get a list see our list api
  • status – string max 50 will need to match what’s in obs, to get a list see our list api
  • rental – string values yes or no
  • total_loss – string values yes or no
  • note – string max 50
  • event_date_time datetime in customers timezone 24 hour formatted
    2digitmonth/2digitday/4didgityear  2digithours:2digitminutes  EX: 09/15/2020 16:00

The only required field in the json file is the obs_event_id

To update status , service_writer, repair_types, or source  you can use our list api to get the current list we have for the customer account or  we will need to map your list to OBS list. Please supply us with a list and we will map the list on our end. For now this will be a manually reviewed process. We will be looking at adding an api in the future

 

Example json data for updating current status

[

{

“obs_event_id “: “fromOBS obs_event_id “,

“status”: “Current Status Either from the OBS status list api or your status”

}

]

Previous OnBoard Scheduler List API
Table of Contents

Post Your Comment Here