Get Work Order Info / Status
  • 28 Jul 2020
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Get Work Order Info / Status

  • Dark
    Light
  • PDF

Article summary

Get Work Order Info / Status

Type

  • Get


Example:

  • https://ws.cenpoint.com/cpwc.wc?custcode=bogusCustCode&token=bogusToken&appName=sweetAppName&prg=cpapi&proc=getWOInfo&woId=0000000023


Base URL (includes authentication + end point)

  •  https://ws.cenpoint.com/cpwc.wc?custcode=<<Company Code>>&token=<<API Key>>&appName=<<YourAppName>>&prg=cpapi&proc=getWOInfo


Parameters: 

  • NameTypeDescriptionExample
    woIdStringWO Id to get status for. Must be 10 characters long0000000023


Returns:

  • Array of Work Orders for the specified jobs id
    • NOTE: all dates / times are returned in the time zone of the branch
    • NOTE: All times are returned in 24 hour format
    • {"VFPData":{"rows":[{"jobsid":"0000000021","woid":"0000000023","status":"Completed","statusinfo":"2018-06-15T09:33:00","createdbyname":"Admin Administrator","techid":"0000000006","techname":"John Smith"}]}}

    • Returned Fields:
      NameTypeDescriptionExample
      jobsidString10 character id for the job the work order is tied to0000000021
      woidString10 character id for a specific work order0000000023
      statusStringEither:
      - Scheduled
      - Started
      - Arrived
      - Departed
      - Completed
      - Job Cancelled
      - Job Deleted
      Completed
      statusinfoStringAdditional info about the status, may be the date / time of the status or some other information about it2018-06-15T09:33:00
      createdbynameStringName of the CenPoint user that created the woAdmin Administrator
      techidString10 character id for the CenPoint user that is scheduled to perform the work0000000006
      techname
      StringName of the CenPoint user that is scheduled to perform the workJohn Smith
  • Or Error Message
    • {"errorCode":"-5","errorDesc":"No results found"}

What's Next