Pre Post Scan API

The OnBoard Scheduler Pre Post Scan API api provides an https endpoint for transmitting the data needed to update the scan status 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/prepostscan/

Success
OBS will return a json formatted sucess message
{“ro_nbr“: “36052 “ , “sucess”:”36052 updated”}

{“Success”: “pre-scan prescan_completed updated in obs for RO 36052” }

{“Success”: “post-scan postscan_completed updated in obs for RO 36052” }

{“Success”: “Calibration Calibration updated in obs for RO 36052” }

{“Success”: “AdasTotal #(adasTotal)# updated in obs for RO #contactcheck.roNbr#” }

{“Success”: “preScanTotal #(preScanTotal)# updated in obs for RO #contactcheck.roNbr#” }

Error
OBS will return a json formatted error message

{ “error”:”Invalid Api Key” }

{“Error”: “ro_nbr not found. A valid ro_nbr is required to use the OBS update event endpoint” }

{“Error”: “pre-scan already completed for 36052 no update necessary” }

{“Error”: “Invalid prescan_completed correct values are 1 or 0” }

{“Error”: “post-scan already postscan_completed for 36052 no update necessary” }

{“Error”: “Calibration Calibration for 36052 no update necessary” }

{“Error”: “Invalid adasTotal total correct values are numeric with 2 decimal places” }

{“Error”: “adasTotal already (adasTotal) for ro_nbr no update necessary” }

{“Error”: “Invalid pre_scan_total total correct values are numeric with 2 decimal places” }

{“Error”: “preScanTotal already (preScanTotal) for ro_nbr no update necessary” }

{“Error”: “Invalid post_scan_total total correct values are numeric with 2 decimal places” }

{“Error”: “postScanTotal already (postScanTotal) for ro_nbr no update necessary” }

Fields

• company_api_key – required (if not using vendor_customer_id) – supplied by OBS – max 35-character string
• OR
• vendor_customer_id – required – use in place of OBS company_api_key – must be loaded into OBS prior – max 35-character string
• ro_nbr – required  string  max 25
• prescan_completed – int max 1 – accepted values 1 or 0
• postscan_completed– int max 1- accepted values 1 or 0
• calibration_completed- int max 1- accepted values 1 or 0
• adasTotal – decimal max 10 – 2 decimal 2 places
• preScanTotal- decimal max 10 – 2 decimal 2 places
• postScanTotal- decimal max 10 – 2 decimal 2 places

Example json data for updating current pre post scan status and totals

[

{

“ro_nbr“: “36052 “,
“company_api_key“: “43657FAFB65D157D987F4A5306566DA2“,
“prescan_completed”: “1”,
“postscan_completed”: “0”,
“adasTotal”:”125.00″,
“preScanTotal”:”40.00″,
“postScanTotal”:”80.00″

}

]

Example using vendor_customer_id

[

{

“ro_nbr“: “36052 “,

“vendor_customer_id“: “4K3“,

“prescan_completed”: “1”

}

]