Archive for Apr, 2011

Tips and Tricks: New API search options.

We’ve added a new feature to the API. You can now search on jobs using the following additional filters:

  • state: Now lets you search by the state of a job. The possible values are: unallocated, allocated, assigned, not_started, started, completed.

  • worker_third_party_id: Filter jobs by their assigned worker by specifying the worker’s third_party_id.

  • search: Additionally the search parameter has been extended to accept the following new options:

    • @worker_third_party_id: Search on jobs that have an assigned worker with a third_party_id equal to the given parameter.

    • @state: Search on jobs that have a state equal to one of the following states values: unallocated, allocated, assigned.

    • @progress_state: Search on jobs that have a progress_state equal to one of the following: not_started, started, completed.

    • @template_name: Search on jobs that have a template_name equal the given parameter.

Here’s an example of the new filters in use:

http://api.vworkapp.com/api/2.0/jobs.xml?state=started&search=@tworker_third_party_id:123,@template_name:Delivery

This example would return all jobs that have are started, have been assigned to worker 123, and have a template_name of Delivery.

If you haven’t seen the vWorkApp API yet (and this type of thing pushes your buttons), then you can check out the full documentation here