{ "openapi": "3.0.0", "info": { "title": "vWork API V5 (Stable Release)", "version": "", "description": "# Getting Started\n\n***We have broken our API documentation into three parts. The following documentation is for creating and managing everything except jobs.***\n\n***If you want to easily create jobs from your existing templates, then you should use our Templated Jobs API documentation. Please note: this is the recommended way of creating new jobs.***\n\n***If you need to search for, download, or update your jobs, then you should use our Jobs API documentation.***\n\n## What is it?\n\nWelcome to vWork’s API! Our API gives you a chance to add vWork’s dispatching functionality to other platforms. Dig into our API to integrate vWork with your existing workflow, or combine vWork with third party tools to make something new.\n\nThe base URL for our API is: https://api.vworkapp.com/\n\n## What does Stable mean?\n\nStable means that this version is final and is not going to change in the future, even if we add new features to the product.\n\n## What can you build?\n\nvWork’s API allows you to build our dispatching functionality into other software. For example, you can use our API so that our dispatch software works hand-in-hand with your CRM software.\n\nYou can also pull data from vWork’s API to produce a tailored management report.\n\n## Getting your API key\n\nYou need to have a vWork account with the API enabled to obtain an API key.\n\nIf you already have an API enabled vWork account, you can create your own API Key here on the integrations page.\n\nIf you do not yet have a vWork account, please get in touch with us.\n\n# Need More Help?\n\n## Where to get more help\n\nThere is a list of frequently asked questions on our helpdesk page as well as a brief intro to the vWork API. If you get stuck, please don't hesitate to send us an email at: support@vworkapp.com\n\n## Mailing List\n\nDo you want to be emailed when we make a change to the API? You can signup for notifications about the vWork API here. We don't email very often, but we will notify you about any changes, as well as notifications about both planned and unplanned outages.\n\n# Tech Notes\n\n## HTTP Compression\n\nBy default, the vWork API requires users to support gzip HTTP response compression on all requests. This is enabled by setting a 'Accept-Encoding: gzip' header on requests, and properly handling the 'Content-Encoding' header on responses. For more information please see http://en.wikipedia.org/wiki/HTTP_compression.\n\n_Failure to specify HTTP compression may result in requests being rejected with a HTTP response of type 406/Not Acceptable._\n\n## ISO8601 Format Note\n\nWhen providing dates you must supply them in the following ISO8601 format: YYYY-MM-DDTHH:MM:SS.\n\nThe API uses GMT by default. In order for you to receive localized results you must also supply a timezone on your ISO8601 date (e.g. 2011-12-25T22:32:07+10).\n\nFinally, you may need to url encode the date string depending on your environment (e.g. 2011-12-25T22%3A32%3A07%2B10)\n\n## Error Codes\n\nHere is an explanation of some of the error codes you may see when developing your integration.\n\n* HTTP 401 (Authorization Required) is returned if you don’t have permission to call this service. Check that your api_key is correct.\n\n* HTTP 404 (Not Found) is returned if the resource requested was not found.\n\n* HTTP 406 (Not Acceptable) is returned if the request did not include headers for http compression.\n\n* HTTP 422 (Unprocessable Entity) is returned if vWork wasn’t able to process the request body, for example when the XML is incorrectly formatted.\n\n* HTTP 429 (Too Many Requests) is returned if vWork is unable to process the number of requests you have sent, please throttle your queries and try again in a minute or two.\n\n* HTTP 500 (Server Error) is returned if a logic error was found, such as a required field is missing.\n\nPlease note, that quite often the reason for a 422 error is included in the body of the XML that is returned to you. This is often an excellent source of debugging information, here is a sample that says a date time custom field value was not a valid date and time.\n\n```\n\n\n \n custom_fields.custom_field\n 'tomorrow night' must be a valid ISO8601 value.\n \n\n```\n\n## Paging Results\n\nBy default, the API will return only the first 50 results for any query. The rest of the results are available but are on separate pages. The number of results and number of pages available are included in the header row.\n\nFor example, the request: `https://api.vworkapp.com/v4/jobs.xml?api_key=[API_KEY]` might show the following header: `` This indicates there were 112 results spread over three pages with a maximum of 50 entries per page, and that you are currently viewing page 1 of 3.\n\nYou are able to request more records per page using the per_page switch as per the following example: `https://api.vworkapp.com/v4/jobs.xml?api_key=[API_KEY]&per_page=200` or, request different pages like this: `https://api.vworkapp.com/v4/jobs.xml?api_key=[API_KEY]&page=2`\n\nPlease note, that when making multiple requests to view a dataset, it is possible for the underlying data to change in the intervening timeframe. (For example if a job was deleted between viewing page 1 and page 2, the number of total results would be different when viewing the second page.)\n\n## The Use of Templates\n\nThe vWork website promotes the use of templates for web users to create and manage their jobs. This makes it easy for web users to create the same job type over and over again.\n\nThe use of templates is not supported via our standard API. You define what a job looks like when you send the job XML to the API.\n\nHowever, there is a field in the API called \"template_name\", you can use this as a free text field to describe the job, it will be prominently displayed on both the website and the mobile app.\n\nIf you enter a template name that exists on the website, we will attempt to include this job in any alerts or reports that are run for that template.\n\nThis may or may not be possible, for example if a user has setup an alert for a step or custom field that exists in the web template but not in your API created job.\n\nWe also have an alternate API that can be used for creating jobs from templates. The documentation for this API can be found here: /v5-templated-jobs.json\n\n## Password Strength\n\nIt is possible to set a password for a user via the API. Many integrators want to know what the minimum requirements are for the password, or if they can re-use another password from an existing system.\n\nvWork does not have a prescribed password policy, instead we measure the password entropy and only allow passwords that would require over 10^8 guesses. We also disallow a list of 93,000 commonly used passwords.\n\nThe best way around this is to use a passphrase instead of a password, something like: “battery horse staple”. Easy to remember, Easy to type and highly secure.\n\n# Webhooks\n\n## What are Webhooks?\n\nFor general information about Webhooks, see http://en.wikipedia.org/wiki/Webhook\n\nTo minimise the requirement for a vWork API consumer to frequently poll the API for updates, vWork can send webhook callbacks to a predetermined endpoint URL when a change is made.\n\nDepending on the information contained in the webhook, the consumer may then choose to perform a GET on that specific resource to retrieve the updated resource.\n\n## What Webhooks are Available?\n\nYou can select to recieve a webhook when any of the following actions occur: Job Created, Job Assigned, Job Unassigned, Job Reassigned, Job Declined, Job Accepted, Job Rescheduled, Job Started, Job Completed, Job Deleted, Job Paused, Job Unpaused, Step Completed, Step Uncompleted, Custom Field Updated, Invoice Updated, User Created, User Updated, User Deleted, Proof of Delivery (POD) Created, and Proof of Delivery Deleted.\n\nNote that if a single action triggers multiple events (for example, creating an assigned job will trigger both a Job Created and a Job Assigned webhook), the order of these events is not guaranteed. But if multiple separate changes happen, those events will be sent in order.\n\nPlease also note, that the Job Reassigned webhook only triggers if the job is reassigned from the jobs tab or the mobile app. If a job is reassigned by dragging it to a new worker on the schedule, this will result in two webhooks, a Job Unassigned followed by a Job Assigned.\n\n## Setting up Webhooks\n\nYou can configure your webhook endpoint, select the format you prefer (JSON or XML), as well as select what actions should trigger a webhook to be sent, from the admin section of the vWork website: https://go.vworkapp.com/html_client/admin/webhooks\n\nThe callback endpoint will be provided and maintained by the API consumer, and should support SSL/TLS encryption.\n\nGiven the potential for a relatively high volume of callbacks, it is strongly advised that the consumer employ asynchronous background task execution and/or a message queueing pattern for handling incoming Webhook callback events. Platforms such as Delayed Job, Resque and RabbitMQ are some well-known examples of asynchronous processing platforms.\n\n(If you are using our legacy webhooks, turning on the new webhooks will not turn off the old ones. Please email support@vworkapp.com when you are ready for us to turn off the old webhooks. NB: If you update your webhook endpoint on the website, this will update the endpoint for both new and old webhooks.)\n\n## Sample Webhooks\n\nAn example of a Job Created XML webhook is below:\n\n```\n\n\n 617d4a74-7a19-11e6-bf7a-55542dc9080d\n job_created\n 2016-09-14T01:20:10Z\n Job\n 9876234\n 7829\n User\n 123\n\n```\n\nAn example of a Job Created JSON webhook is below:\n\n```\n{\n \"transaction_id\": \"617d4a74-7a19-11e6-bf7a-55542dc9080d\",\n \"event_type\": \"job_created\",\n \"event_time\": \"2016-09-14T01:20:10Z\",\n \"resource\": \"Job\",\n \"resource_id\": 9876234,\n \"account_id\": 7829,\n \"request_user_type\": \"User\",\n \"request_user_id\": 123\n}\n```\n\nAn example of a Step Completed XML webhook is below:\n\n```\n\n\n 63d75660-7a1a-11e6-8d5a-474090628a07\n step_completed\n 2016-09-14T01:27:24Z\n Step\n 25062292\n 8723\n User\n 123\n \n -36.86524165519692\n 174.7806050757642\n \n \n Start Job\n 2016-09-15T02:00:12Z\n 8626773\n \n\n```\n\nAn example of a Step Completed JSON webhook is below:\n\n```\n{\n \"transaction_id\": \"63d75660-7a1a-11e6-8d5a-474090628a07\",\n \"event_type\": \"step_completed\",\n \"event_time\": \"2016-09-14T01:27:24Z\",\n \"resource\": \"Step\",\n \"resource_id\": 25062292,\n \"account_id\": 8723,\n \"request_user_type\": \"User\",\n \"request_user_id\": 123,\n \"event_location\": {\n \"lat\": -36.86525719794106,\n \"lng\": 174.780580958473\n },\n \"data\": {\n \"step_name\": \"Start Job\",\n \"completed_at\": \"2016-09-15T02:58:31Z\",\n \"job_id\": 8621412\n }\n}\n```\n\n## Webhook Content\n\nWebhooks will always contain the following fields:\n\n* transaction_id - an internal vwork audit ID, can be ignored\n\n* event_type - the action that triggered the webhook\n\n* event_time - the time the server recieved the event, this may not be the time of the event (in UTC)\n\n* resource - the resource that was updated: job, custom field, proof of delivery, step or user.\n\n* resource_id - the vWork ID for the resource that was updated.\n\n* account_id - the ID of your vWork account (can be useful if you are recieving webhooks for multiple accounts.)\n\nIn addition, some webhooks may contain these extra fields:\n\n* request_user_type - Who triggered the action: a user, or a customer portal user. Will not be present for API events or automatic events (like an auto decline event).\n\n* request_user_id - The ID of the user who triggered the action. Will not be present for API events or automatic events (like an auto decline event).\n\n* resource_third_party_id - The 3rd Party ID for the resource that was updated. Only present when a 3rd Party ID exists.\n\n* data_worker_id - The ID of the worker the job is assigned to. Present on Job Accepted, Job Assigned and Job Reassigned Webhooks.\n\n* data_worker_name - The name of the worker the job is assigned to. Present on Job Accepted, Job Assigned and Job Reassigned Webhooks.\n\n* data_field_label - The label of the custom field that was updated. Only present on Custom Field Updated webhooks.\n\n* data_field_value - The new value of the custom field that was updated. Only present on Custom Field Updated webhooks.\n\n* data_field_type - The type of the custom field that was updated. Only present on Custom Field Updated webhooks.\n\n* event_location_lat - the lattitude of the worker's location when they completed the action. Only present on Step Completed, Step Uncompleted, Job Start and Job Complete when a location is available.\n\n* event_location_long - the longitude of the worker's location when they completed the action. Only present on Step Completed, Step Uncompleted, Job Start and Job Complete when a location is available.\n\n* data_step_name - The name of the step that was updated. Only present on Step Completed and Step Uncompleted webhooks.\n\n* data_completed_at - The time when the step was completed (in UTC). Only present on Step Completed webhook.\n\n* data_job_id - The job that the POD, step, or custom field is for. Only present on POD Created, POD Deleted, Custom Field Updated, Step Completed, and Step Uncompleted webhooks.\n\n* data_paused_at - The time when the job was paused (in UTC). Only present on Job Paused webhooks.\n\n* data_unpaused_at - The time when the job was unpaused (in UTC). Only present on Job Unpaused webhooks.\n\n* data_signed_at - When the POD was signed. Only present on POD Created and Deleted webhooks.\n\n* data_signed_by - Who Signed the POD. Only present on POD Created and Deleted webhooks.\n\n* data_name - The name of the user. Only present on User Created and User Updated webhooks.\n\n* data_email - The email address of the user. Only present on User Created and User Updated webhooks.\n\n* data_phone - The phone number of the user. Only present on User Created and User Updated webhooks.\n\n* data_notes - Any notes saved against the user. Only present on User Created and User Updated webhooks.\n\n## Webhook Reliability and Monitoring\n\nThe vWork Webhook notifier will expect a HTTP/200 status code in the HTTP response from the callback endpoint provided by the API consumer. If a non-200 response is received, or the endpoint cannot be reached, vWork will discard the callback event.\n\nCallbacks will always be sent in the order they were created; in the event of a single callback failure as described above, the failing callback will be discarded, but the Webhook notifier will attempt to send all subsequent callbacks in the normal manner.\n\nVarious factors could cause a callback to be discarded, such as an internet connection dropout or a momentary server problem. vWork recommends that the API consumer implement a low-frequency polling mechanism (e.g. hourly or daily) to “fill in” any data which may have been missed as a result of a discarded callback.\n\n## Security Layer - HMAC SHA\n\nWe implement a layer of security which is simple to consume. Using your api key and a \"signature\" that is calculated and sent with the Webhook, you can verify the contents of a Webhook as being authentic and un-tampered.\n\nWebhooks are signed with a signature generated by taking an HMAC-SHA-256 hex digest of the raw HTTP Body of the Webhook post, using your api key as the secret.\n\nThis signature will be sent with the Webhook post in the header X-Vwork-Webhook-Signature-Hmac-Sha-256. If you chose not to implement this measure, you can just ignore the header.\n\nAs an example, the HMAC signature is generated in Ruby with this code:\n\n```\nOpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), api_key, webhook.body)\n```\n\nIf your api key is 123 and the Webhook request body contents are:\n\n```\ntest\n```\n\nusing code like this:\n\n```\nOpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), '123', 'test')\n```\n\nthe signature for this Webhook would be:\n\n```\n7643b9dbcab60ae6ae32e5683e1fae1db105bd31f1f0b5d51e5b773235359ff0\n```\n\nPlease note, that when calculating the HMAC SHA we strip out all line breaks and whitespace from the body of the webhook, in order for you to get the same result, you will need to do the same.\n\n# Postman\n\n## What is Postman?\n\nPostman is an API development and testing tool. We encourage our customers to use Postman as a way of quickly learning the capabilities of the vWork API. vWork support staff can often provide sample Postman collections or Postman friendly XML samples to assist you.\n\nYou can download a copy from here: https://www.getpostman.com/", "x-logo": { "url": "./assets/vWork-Logo.png", "altText": "vWork" } }, "paths": { "/v5/users.xml": { "post": { "responses": { "201": { "description": "Created", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:39:38 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"2dbcb6a04f44419e584b939d643b66f1\"" }, "Status": { "schema": { "type": "string" }, "example": "201 Created" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "c984cbfd-2df1-4010-bad2-d5ef1e4d5412" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.586222" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F4426_6E78F2:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 66270\n \n George Smith\n george@example.com\n 1 555 111 1111\n Mack 3DC 12L V-TEC\n true\n \n 2021-03-09T01:37:54+00:00\n 2021-03-09T01:37:54+00:00\n \n \n none\n none\n none\n none\n none\n none\n none\n none\n none\n full\n full\n full\n full\n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Create A New User", "operationId": "create-a-new-user", "description": "Creates a new user in vWork.", "tags": [ "Users" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\nGeorge Smith\n\n\ngeorge@example.com\n1 555 111 1111\nMack 3DC 12L V-TEC\nfvw234r32qvrqe\n \n none\n none\n none\n none\n none\n none\n none\n none\n none\n full\n full\n full\n full\n \n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:43:06 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"6d5e8119257252130624e8cc1a78b813\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "6651d0a2-7f9f-4273-b876-f4544e22e0ca" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.401007" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F443A_6E7B90:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n\n 66270\n \n George Smith\n george@example.com\n 1 555 111 1111\n Mack 3DC 12L V-TEC\n true\n \n 2021-03-09T01:37:54+00:00\n 2021-03-09T01:37:54+00:00\n \n \n none\n none\n none\n none\n none\n none\n none\n none\n none\n full\n full\n full\n full\n \n\n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "List All Users", "operationId": "list-all-users", "description": "Lists all users, including their current permissions.", "tags": [ "Users" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/users/{id}.xml": { "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:47:22 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"197907f0f3634f315092aff1d7410394\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "6c906286-8b0d-493f-95cb-d9dea42220d2" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.081427" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F450A_6E96DB:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 66270\n \n George Smith\n george@example.com\n 1 555 111 1111\n Mack 3DC 12L V-TEC\n true\n \n 2021-03-09T01:37:54+00:00\n 2021-03-09T01:37:54+00:00\n \n \n none\n none\n none\n none\n none\n none\n none\n none\n none\n full\n full\n full\n full\n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Retrieve A Specific User", "operationId": "retrieve-a-specific-user", "description": "Shows a user and all their associated permissions.", "tags": [ "Users" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "use_third_party_id", "in": "query", "description": "Sets the the call to look for a Third Party ID instead of the vWork ID.", "required": false, "example": "1", "schema": { "type": "integer" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] }, "put": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:52:16 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"cd023b0b002846ec7649112cadaf3433\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "8b9fb0f1-7020-466e-955b-c1d4f1f5be11" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.105612" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F46FE_6ED87C:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 66270\n \n George Smith\n george@example.com\n 1 555 111 1111\n Mack 3DC 12L V-TEC\n true\n \n 2021-03-09T01:37:54+00:00\n 2021-03-09T01:37:54+00:00\n \n \n none\n none\n none\n none\n none\n none\n none\n none\n none\n full\n full\n full\n full\n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Update A Specific User", "operationId": "update-a-specific-user", "description": "Update an existing user's record. When updating a user you only need to specify the fields that you would like to change. All other fields will remain unchanged.\n\nTo update a user's phone number, you might send the following XML.\n\n```\n\n 1 555 111 1111\n\n```\n\nTo remove a user's phone number, you might send the following XML.\n\n```\n\n \n\n```\n\nTo update a user's mobile permissions and remove their web permissions, you might send the following XML.\n\n```\n\n \n none\n none\n none\n none\n none\n none\n none\n none\n none\n full\n full\n full\n full\n \n\n```", "tags": [ "Users" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "use_third_party_id", "in": "query", "description": "Sets the the call to look for a Third Party ID instead of the vWork ID.", "required": false, "example": "'1'", "schema": { "type": "integer" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n 1 555 111 2222\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "delete": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "no-cache" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 00:03:38 GMT" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "281aff47-d764-4085-817e-551a09e76ee1" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.580677" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CEA6_0A001312:01BB_575F49D1_A1625A:1EC7" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "summary": "Delete A Specific User", "operationId": "delete-a-specific-user", "description": "Deletes a user record.", "tags": [ "Users" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "use_third_party_id", "in": "query", "description": "Sets the the call to look for a Third Party ID instead of the vWork ID.", "required": false, "example": "1", "schema": { "type": "integer" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/customers.xml": { "post": { "responses": { "201": { "description": "Created", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 22:51:25 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"4af298ed89390aecf7df64e20427d6ad\"" }, "Status": { "schema": { "type": "string" }, "example": "201 Created" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "52b7672b-d4fe-4ec8-88d7-e1bf8271e139" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.265632" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CBEF_0A001312:01BB_575F38C6_719C90:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 1119086\n Joe's Plumbing\n \n ABC123\n \n Bob\n Lei\n 1 555 111 1111\n \n \n \n 23839050\n 2016-06-13T22:51:25+00:00\n 2016-06-13T22:51:25+00:00\n \n \n \n \n \n \n \n \n \n 880 Harrison Street, San Francisco, CA, 94107\n -37.779536\n -122.401503\n \n \n \n \n Cathy\n Knocks\n 1 555 111 1111\n 1 555 111 1111\n joe@acmeplumbers.com\n \n 23839051\n 2016-06-13T22:51:25+00:00\n 2016-06-13T22:51:25+00:00\n \n \n \n \n \n \n \n \n \n 880 Harrison Street, San Francisco, CA, 94107\n -37.779536\n -122.401503\n \n \n \n 2016-06-13T22:51:25+00:00\n 2016-06-13T22:51:25+00:00\n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Create A New Customer", "operationId": "create-a-new-customer", "description": "Creates a new customer in vWork. Customers can have a third_party_id set. This is useful for passing through an external id, such as from a CRM.", "tags": [ "Customers" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n Joe's Plumbing\n ABC123\n \n \n Cathy\n Knocks\n 1 555 111 1111\n 1 555 111 1111\n joe@acmeplumbers.com\n \n 880 Harrison Street, San Francisco, CA, 94107\n -37.779536\n -122.401503\n \n \n \n Bob\n Lei\n 1 555 111 1111\n \n 880 Harrison Street, San Francisco, CA, 94107\n -37.779536\n -122.401503\n \n \n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 22:51:25 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"4af298ed89390aecf7df64e20427d6ad\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "52b7672b-d4fe-4ec8-88d7-e1bf8271e139" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.265632" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CBEF_0A001312:01BB_575F38C6_719C90:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n \n 1119086\n Joe's Plumbing\n \n ABC123\n \n Bob\n Lei\n 1 555 111 1111\n \n \n \n 23839050\n 2016-06-13T22:51:25+00:00\n 2016-06-13T22:51:25+00:00\n \n \n \n \n \n \n \n \n \n 880 Harrison Street, San Francisco, CA, 94107\n -37.779536\n -122.401503\n \n \n \n \n Cathy\n Knocks\n 1 555 111 1111\n 1 555 111 1111\n joe@acmeplumbers.com\n \n 23839051\n 2016-06-13T22:51:25+00:00\n 2016-06-13T22:51:25+00:00\n \n \n \n \n \n \n \n \n \n 880 Harrison Street, San Francisco, CA, 94107\n -37.779536\n -122.401503\n \n \n \n 2016-06-13T22:51:25+00:00\n 2016-06-13T22:51:25+00:00\n \n \n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "List All Customers", "operationId": "list-all-customers", "description": "Lists all customers, including nested contacts for billing and delivery.\n\nIt also possible to change the sort order of the results of your query. You can sort by any of the following fields, in either ascending or descending order. Here are the examples:\n\nhttps://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=created_at&sort_dir=desc\nhttps://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=created_at&sort_dir=asc\nhttps://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=updated_at&sort_dir=desc\nhttps://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=updated_at&sort_dir=asc\nhttps://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=id&sort_dir=desc\nhttps://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=id&sort_dir=asc\nhttps://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=name&sort_dir=asc\nhttps://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=name&sort_dir=desc\nhttps://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=third_party_id&sort_dir=asc\nhttps://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=third_party_id&sort_dir=desc", "tags": [ "Customers" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/customers/{id}.xml": { "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:01:46 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"9b4e74990926e6cc627402b2aaab449d\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "51f4063c-55fd-4d82-8d5d-86643ebc858b" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.136054" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CC3A_0A001312:01BB_575F3B5A_6D4613:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 1119086\n Joe's Plumbing\n \n ABC123\n \n Bob\n Lei\n 1 555 111 1111\n \n \n \n 23839050\n 2016-06-13T22:51:25+00:00\n 2016-06-13T22:51:25+00:00\n \n \n \n \n \n \n \n \n \n 880 Harrison Street, San Francisco, CA, 94107\n -37.779536\n -122.401503\n \n \n \n \n Cathy\n Knocks\n 1 555 111 1111\n 1 555 111 1111\n joe@acmeplumbers.com\n \n 23839051\n 2016-06-13T22:51:25+00:00\n 2016-06-13T22:51:25+00:00\n \n \n \n \n \n \n \n \n \n 880 Harrison Street, San Francisco, CA, 94107\n -37.779536\n -122.401503\n \n \n \n 2016-06-13T22:51:25+00:00\n 2016-06-13T22:51:25+00:00\n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Retrieve A Specific Customer", "operationId": "retrieve-a-specific-customer", "description": "Retrieves the customer from vWork that has the given id.", "tags": [ "Customers" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "use_third_party_id", "in": "query", "description": "When set to true (e.g. 'true') the :id argument is taken to be the customer's third party id instead of the customer's vwork id.", "required": false, "example": "true", "schema": { "type": "boolean" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] }, "put": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:01:46 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"9b4e74990926e6cc627402b2aaab449d\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "51f4063c-55fd-4d82-8d5d-86643ebc858b" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.136054" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CC3A_0A001312:01BB_575F3B5A_6D4613:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 1119086\n Joe's Plumbing\n Beware of the dog.\n ABC123\n \n Bob\n Lei\n 1 555 111 1111\n \n \n \n 23839050\n 2016-06-13T22:51:25+00:00\n 2016-06-13T22:51:25+00:00\n \n \n \n \n \n \n \n \n \n 880 Harrison Street, San Francisco, CA, 94107\n -37.779536\n -122.401503\n \n \n \n \n Cathy\n Knocks\n 1 555 111 1111\n 1 555 111 1111\n joe@acmeplumbers.com\n \n 23839051\n 2016-06-13T22:51:25+00:00\n 2016-06-13T22:51:25+00:00\n \n \n \n \n \n \n \n \n \n 880 Harrison Street, San Francisco, CA, 94107\n -37.779536\n -122.401503\n \n \n \n 2016-06-13T22:51:25+00:00\n 2016-06-13T22:51:25+00:00\n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Update A Specific Customer", "operationId": "update-a-specific-customer", "description": "Updates an existing customer record. When updating a customer you only need to specify the fields that you would like to change. All other fields will remain unchanged. For example; to update the notes you might post XML formed as follows:\n\n```\n\n Beware of the dog.\n\n```", "tags": [ "Customers" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "use_third_party_id", "in": "query", "description": "When set to true (e.g. 'true') the :id argument is taken to be the job's third party id instead of the job's normal id.", "required": false, "example": "true", "schema": { "type": "boolean" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n Beware of the dog.\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "delete": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "no-cache" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:05:38 GMT" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "c868c52b-ac15-45c7-ac8b-81faf18882ac" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.372504" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CC3A_0A001312:01BB_575F3C34_6D66C5:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "summary": "Delete A Specific Customer", "operationId": "delete-a-specific-customer", "description": "Deletes the customer record with the given id. This cannot be undone.", "tags": [ "Customers" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "use_third_party_id", "in": "query", "description": "When set to true (e.g. 'true') the :id argument is taken to be the job's third party id instead of the job's normal id.", "required": false, "example": "true", "schema": { "type": "boolean" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/pick_lists.xml": { "post": { "responses": { "201": { "description": "Created", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 00:40:16 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"257f6792403fcefc322d57060c8f183e\"" }, "Location": { "schema": { "type": "string" }, "example": "https://api.vworkapp.com/api/v4/pick_lists/72077" }, "Status": { "schema": { "type": "string" }, "example": "201 Created" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "80f0a715-3dbb-4941-9304-bb4d9e5b8b6c" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.120963" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CFF3_0A001312:01BB_575F5266_7067FB:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 1234\n Package Status\n 2012-10-15T20:53:38+00:00\n 2012-10-15T20:53:38+00:00\n \n \n 2345\n Delivered\n 2012-10-15T20:53:38+00:00\n 2012-10-15T20:53:38+00:00\n \n \n 2346\n Not delivered\n 2012-10-15T20:53:38+00:00\n 2012-10-15T20:53:38+00:00\n \n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Create A New Pick List", "operationId": "create-a-new-pick-list", "description": "Creates a pick list in vWork. The response includes the pick list’s unique id assigned to it by vWork. This ID needs to be included when adding a pick list custom field to a job.", "tags": [ "Pick Lists" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n Package Status\n \n \n Delivered\n \n \n Not delivered\n \n \n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 00:45:48 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"e2230751adba24b473fc7d749eaf7e4c\"" }, "Location": { "schema": { "type": "string" }, "example": "https://api.vworkapp.com/api/v4/pick_lists" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "61b47c69-3e67-4f61-bfef-3e13b2af6e73" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.733719" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D00F_0A000ED8:01BB_575F53BB_753DA2:1E66" }, "-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n \n 1234\n Delivery status\n 2012-02-20T22:52:58+00:00\n 2012-02-22T10:14:02+00:00\n \n \n 2345\n Delivered\n 2012-02-20T22:52:58+00:00\n 2012-02-22T10:14:02+00:00\n \n \n 2346\n Not delivered\n 2012-02-20T22:52:58+00:00\n 2012-02-20T22:52:58+00:00\n \n \n \n \n 1235\n Reason\n 2012-02-21T11:01:22+00:00\n 2012-02-21T15:34:43+00:00\n \n \n 2347\n Damaged parcel\n 2012-02-21T11:01:22+00:00\n 2012-02-21T11:01:22+00:00\n \n \n 2348\n Recipient moved\n 2012-02-21T11:01:22+00:00\n 2012-02-21T15:34:43+00:00\n \n \n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "List All Pick Lists", "operationId": "list-all-pick-lists", "description": "Lists all pick lists in the account including their pick list items.", "tags": [ "Pick Lists" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/pick_lists/{id}.xml": { "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 00:45:48 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"e2230751adba24b473fc7d749eaf7e4c\"" }, "Location": { "schema": { "type": "string" }, "example": "https://api.vworkapp.com/api/v4/pick_lists" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "61b47c69-3e67-4f61-bfef-3e13b2af6e73" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.733719" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D00F_0A000ED8:01BB_575F53BB_753DA2:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 1234\n Delivery Status\n 2012-02-20T22:52:58+00:00\n 2012-02-22T10:14:02+00:00\n \n \n 2345\n Delivered\n 2012-02-20T22:52:58+00:00\n 2012-02-22T10:14:02+00:00\n \n \n 2346\n Not delivered\n 2012-02-20T22:52:58+00:00\n 2012-02-20T22:52:58+00:00\n \n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Retrieve A Specific Pick List", "operationId": "retrieve-a-specific-pick-list", "description": "Retrieves one pick list including its pick list items.", "tags": [ "Pick Lists" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] }, "put": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 00:59:33 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"c35e9a187b8bba57f18eca3de8a18a05\"" }, "Location": { "schema": { "type": "string" }, "example": "https://api.vworkapp.com/api/v4/pick_lists/58806" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "0b564407-6654-48c3-aeb0-f0d1e8f0e3ea" }, "X-Runtime": { "schema": { "type": "string" }, "example": "31.127951" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D00F_0A000ED8:01BB_575F565C_75931D:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 61461\n New Picklist Name Here\n 2015-07-09T02:30:22+00:00\n 2015-07-09T02:53:30+00:00\n \n \n 376744\n Delivered\n 2015-07-09T02:30:22+00:00\n 2015-07-09T02:30:22+00:00\n \n \n 376745\n Not delivered\n 2015-07-09T02:30:22+00:00\n 2015-07-09T02:30:22+00:00\n \n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Update A Specific Pick List", "operationId": "update-a-specific-pick-list", "description": "Updates an existing pick list within vWork that has the given id. If the pick list is in use by active jobs, they will also receive the new pick list items. Completed jobs will be unaffected.\n\nTo add a new value include a new `` element without an id.\n\nTo change an existing value you must include the unique id of that `` along with its new value.\n\nTo remove an existing value you must include the unique id of that `` along with an empty `` tag.\n\nHere are four common examples...\n\nTo rename a pick list, you might send the following XML in a PUT to an existing pick list.\n\n```\n\n Delivery Progress\n\n```\n\nTo add a new value to an existing pick list, you might send the following XML in a PUT to an existing pick list.\n\n```\n\n \n \n Not Delivered\n \n \n\n```\n\nTo remove a value from an existing pick list, you might send the following XML in a PUT to an existing pick list.\n\n```\n\n \n \n 1234\n \n \n \n\n```\n\nTo update an existing value in an existing pick list, you might send the following XML in a PUT to an existing pick list.\n\n```\n\n \n \n 2345\n Delivered\n \n \n\n```", "tags": [ "Pick Lists" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n New Picklist Name Here\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "delete": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "no-cache" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 01:01:44 GMT" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "c47f6bd3-d957-4d3d-bdeb-2ae7cfb96baf" }, "X-Runtime": { "schema": { "type": "string" }, "example": "33.017338" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D00F_0A000ED8:01BB_575F574F_75B4F1:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "summary": "Delete A Specific Pick List", "operationId": "delete-a-specific-pick-list", "description": "Deletes a pick list within vWork that has the given id. You can only delete a pick list if it's not current being used by active jobs.", "tags": [ "Pick Lists" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/groups.xml": { "post": { "responses": { "201": { "description": "Created", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 01:11:18 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"4595943a01847720b0e6b77d5a7a878a\"" }, "Location": { "schema": { "type": "string" }, "example": "https://api.vworkapp.com/api/v4/groups/2488" }, "Status": { "schema": { "type": "string" }, "example": "201 Created" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "9a87ec2e-4060-4eb7-ab93-8a264f8a1ffd" }, "X-Runtime": { "schema": { "type": "string" }, "example": "1.069870" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D0B8_0A001312:01BB_575F59B0_A393C8:1EC7" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 123\n Service Vehicles\n All mobile workers capable of handling business hours service call outs.\n 1,2,3\n 2012-08-27T01:49:07+00:00\n 2012-08-27T01:49:07+00:00\n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Create A New Group", "operationId": "create-a-new-group", "description": "Creates a new group in vWork.", "tags": [ "Groups" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n Service Vehicles\n All mobile workers capable of handling business hours service call outs.\n 1,2,3\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 01:12:42 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"b370ef7637b5a36d3b39fc40d3891740\"" }, "Location": { "schema": { "type": "string" }, "example": "https://api.vworkapp.com/api/v4/groups" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "13ec9527-6f4b-4c95-9567-eabb45980107" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.134730" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D0B8_0A001312:01BB_575F59B6_A3947F:1EC7" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n \n 123\n Service Vehicles\n All mobile workers capable of handling business hours service call outs.\n 1,2,3\n 2012-08-27T01:49:07+00:00\n 2012-08-27T01:49:07+00:00\n \n \n 321\n After Hours\n All mobile workers capable of handling after hours service call outs.\n 4,5,6\n 2012-08-27T02:02:11+00:00\n 2012-08-27T02:02:11+00:00\n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "List All Groups", "operationId": "list-all-groups", "description": "Lists all the groups in your account.", "tags": [ "Groups" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/groups/{id}.xml": { "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 01:13:57 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"1a6e72ab2cb185a59c99db7d7b167273\"" }, "Location": { "schema": { "type": "string" }, "example": "https://api.vworkapp.com/api/v4/groups/2488" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "ebef613a-a497-441f-bf4a-16222c9e09c5" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.091064" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D0B8_0A001312:01BB_575F5A0A_A39E07:1EC7" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 1849\n Service Vehicles\n All mobile workers capable of handling business hours service call outs.\n 34123\n 2015-07-09T03:51:43+00:00\n 2015-07-09T03:51:43+00:00\n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Retrieve A Specific Group", "operationId": "retrieve-a-specific-group", "description": "Retrieve a specific group from your account, including a list of all users in that group.", "tags": [ "Groups" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] }, "put": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 01:15:27 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"261218f409b138c3462fd8bc2f6141f8\"" }, "Location": { "schema": { "type": "string" }, "example": "https://api.vworkapp.com/api/v4/groups/3" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "4f54c69a-aace-4d84-ba13-aa77645f7861" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.039573" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D0B8_0A001312:01BB_575F5A55_A3A867:1EC7" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 1849\n The Night Shift\n All mobile workers capable of handling business hours service call outs.\n 34123\n 2015-07-09T03:51:43+00:00\n 2015-07-09T03:59:25+00:00\n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Update A Specific Group", "operationId": "update-a-specific-group", "description": "To rename an existing group, you might send the following XML as a PUT to a picklist.\n\n```\n\n The Night Shift\n\n```\n\nTo remove everyone from an existing group, you might send the following XML as a PUT to a picklist.\n\n```\n\n \n\n```\n\nTo update who is in the group, you might send the following XML as a PUT to a picklist.\n\n```\n\n 1,2,3,4,5,6\n\n```", "tags": [ "Groups" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n The Night Shift\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "delete": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "no-cache" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 01:16:34 GMT" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "bc62833c-887b-42f8-9b75-0b015a4b49c0" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.035184" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D0B8_0A001312:01BB_575F5AAF_A3B607:1EC7" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "summary": "Delete A Specific Group", "operationId": "delete-a-specific-group", "description": "Deletes a group.", "tags": [ "Groups" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/attachments/{attachment_id}.jpeg": { "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "private" }, "Content-Disposition": { "schema": { "type": "string" }, "example": "inline" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Content-Transfer-Encoding": { "schema": { "type": "string" }, "example": "binary" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 01:18:54 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"c53f11b5618e2a9f0d8c1c321b2f0c7e\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "b5aa1516-12bf-48ab-9c35-330359e53102" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.130267" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D0B8_0A001312:01BB_575F5AF2_A3BF29:1EC7" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "image/jpeg": { "examples": { "response": { "value": "Returns JPEG bitmap data\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Retrieve A Specific Attachment Image", "operationId": "retrieve-a-specific-attachment-image", "description": "Reads one attachment and returns a JPEG. You can find the attachment ID using the job API call.", "tags": [ "Attachments" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "attachment_id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/signatures/{signature_id}.png": { "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "private" }, "Content-Disposition": { "schema": { "type": "string" }, "example": "inline" }, "Content-Length": { "schema": { "type": "string" }, "example": "15797" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Content-Transfer-Encoding": { "schema": { "type": "string" }, "example": "binary" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 03:21:31 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"225373ffd545ae30c4bfd5c05a7560c2\"" }, "Last-Modified": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 03:13:27 GMT" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "2a2a3f48-5027-4fff-980a-df4fafe8c85c" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.112262" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D4AB_0A000ED8:01BB_575F782A_7A2D21:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "image/png": { "examples": { "response": { "value": "Returns PNG bitmap data\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Retrieve A Specific Signature Image", "operationId": "retrieve-a-specific-signature-image", "description": "Reads one signature and returns a PNG. You can find the signature ID using the job API call.", "tags": [ "Signatures" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "signature_id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/jobs/{id}/proof_of_delivery.png": { "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "private" }, "Content-Disposition": { "schema": { "type": "string" }, "example": "inline" }, "Content-Length": { "schema": { "type": "string" }, "example": "85115" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Content-Transfer-Encoding": { "schema": { "type": "string" }, "example": "binary" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 00:28:57 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"b3fbf37c5e99f04a601208a9945fb6e6\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "14e113a0-7d91-4d9e-ad76-ad6dc3227864" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.214161" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CF64_0A000ED8:01BB_575F4FC9_A22FE7:1EC7" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "image/png": { "examples": { "response": { "value": "Returns either JPG or PNG bitmap data (depending on whether a photo is attached to the signature)\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Retrieve A Specific POD Image", "operationId": "retrieve-a-specific-pod-image", "description": "Displays the Proof Of Delivery for a job. You are also able to access the POD via the job's third_party_id if it has one. The format can be either PNG or JPG depending on whether the worker has also attached a photo.", "tags": [ "Proof of Delivery" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "use_third_party_id", "in": "query", "description": "When set to true (e.g. 'true') the :id argument is taken to be the job's third party id instead of the job's vWork id.", "required": false, "example": "true", "schema": { "type": "boolean" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/pricebooks.xml": { "post": { "responses": { "201": { "description": "Created", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:39:38 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"2dbcb6a04f44419e584b939d643b66f1\"" }, "Status": { "schema": { "type": "string" }, "example": "201 Created" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "c984cbfd-2df1-4010-bad2-d5ef1e4d5412" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.586222" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F4426_6E78F2:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 1090\n test pricebook\n 1296\n pricebook\n \n \n 113124\n 1090\n 3\n Description 3\n 40.0\n \n \n 113125\n 1090\n 2\n Description 2\n 30.0\n \n \n 113126\n 1090\n 1\n Description 1\n 20.0\n \n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Create A New Pricebook", "operationId": "create-a-new-pricebook", "description": "Creates a new pricebook in vWork.", "tags": [ "Pricebooks" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n test pricebook\n pricebook\n \n \n 3\n Description 3\n 40.0\n \n \n 2\n Description 2\n 30.0\n \n \n 1\n Description 1\n 20.0\n \n \n " } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:43:06 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"6d5e8119257252130624e8cc1a78b813\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "6651d0a2-7f9f-4273-b876-f4544e22e0ca" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.401007" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F443A_6E7B90:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n\n 1090\n test pricebook\n 1296\n pricebook\n \n \n 113124\n 1090\n 3\n Description 3\n 40.0\n \n \n 113125\n 1090\n 2\n Description 2\n 30.0\n \n \n 113126\n 1090\n 1\n Description 1\n 20.0\n \n \n\n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "List All Pricebooks", "operationId": "list-all-pricebooks", "description": "Lists all pricebooks", "tags": [ "Pricebooks" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/pricebook/{id}.xml": { "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:47:22 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"197907f0f3634f315092aff1d7410394\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "6c906286-8b0d-493f-95cb-d9dea42220d2" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.081427" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F450A_6E96DB:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 1090\n test pricebook\n 1296\n pricebook\n \n \n 113124\n 1090\n 3\n Description 3\n 40.0\n \n \n 113125\n 1090\n 2\n Description 2\n 30.0\n \n \n 113126\n 1090\n 1\n Description 1\n 20.0\n \n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Retrieve A Specific Pricebook", "operationId": "retrieve-a-specific-pricebook", "description": "Shows a specific pricebook", "tags": [ "Pricebooks" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] }, "put": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:52:16 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"cd023b0b002846ec7649112cadaf3433\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "8b9fb0f1-7020-466e-955b-c1d4f1f5be11" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.105612" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F46FE_6ED87C:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 1090\n pricebook 75\n 1296\n pricebook\n \n \n 113124\n 1090\n 3\n Description 3\n 40.0\n \n \n 113125\n 1090\n 2\n Description 2\n 30.0\n \n \n 113126\n 1090\n 1\n Description 1\n 20.0\n \n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Update A Specific Pricebook", "operationId": "update-a-specific-pricebook", "description": "Update an existing pricebook. When updating a pricebook you only need to specify the fields that you would like to change. All other fields will remain unchanged.\n\nTo update a pricebook's name, you might send the following XML.\n\n```\n\n pricebook 75\n \n```\n\nTo remove a pricebook's description, you might send the following XML.\n\n```\n\n This is pricebook number 75\n \n```\n\nTo add an item to a pricebook, you might send the following XML.\n\n```\n\n\n \n \n 4\n Description 4\n 45.0\n \n \n \n```\n\nTo update an existing item, you would need to include the item ID in the PUT, as per below:\n\n```\n\n\n \n \n 89776\n 3\n Description 3\n 49.95\n \n \n\n```\n\nTo remove an existing item from a pricebook, you would PUT the following XML:\n\n```\n\n\n \n \n 89776\n <_destroy>true\n \n \n\n```", "tags": [ "Pricebooks" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n pricebook 75\n " } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "delete": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "no-cache" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 00:03:38 GMT" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "281aff47-d764-4085-817e-551a09e76ee1" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.580677" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CEA6_0A001312:01BB_575F49D1_A1625A:1EC7" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "summary": "Delete A Specific Pricebook", "operationId": "delete-a-specific-pricebook", "description": "Deletes a pricebook.", "tags": [ "Pricebooks" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/equipment.xml": { "post": { "responses": { "201": { "description": "Created", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:39:38 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"2dbcb6a04f44419e584b939d643b66f1\"" }, "Status": { "schema": { "type": "string" }, "example": "201 Created" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "c984cbfd-2df1-4010-bad2-d5ef1e4d5412" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.586222" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F4426_6E78F2:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 9552\n 1296\n The Forklift\n Picking it up and Putting it down\n QWERTYUIOP\n Crown\n 53476435482\n 1,501,4833\n 24,2008\n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Create A New Piece of Equipment", "operationId": "create-a-new-piece-of-equipment", "description": "Creates a new piece of equipment in vWork.", "tags": [ "Equipment" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n QWERTYUIOP\n The Forklift\n Crown\n Picking it up and Putting it down\n 53476435482\n 24,2008\n 1,4833,501\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:43:06 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"6d5e8119257252130624e8cc1a78b813\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "6651d0a2-7f9f-4273-b876-f4544e22e0ca" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.401007" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F443A_6E7B90:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n \n 9264\n 1296\n Pilot Vehicle 1\n \n vwork_520280906\n \n \n \n \n \n \n 9266\n 1296\n Truck 15\n \n vwork_931492492\n \n \n \n \n \n \n 9552\n 1296\n The Forklift\n Picking it up and Putting it down\n QWERTYUIOP\n Crown\n 53476435482\n 1,501,4833\n 24,2008\n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "List All Equipment", "operationId": "list-all-equipment", "description": "Lists all equipment", "tags": [ "Equipment" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/equipment/{id}.xml": { "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:47:22 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"197907f0f3634f315092aff1d7410394\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "6c906286-8b0d-493f-95cb-d9dea42220d2" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.081427" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F450A_6E96DB:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 9552\n 1296\n The Forklift\n Picking it up and Putting it down\n QWERTYUIOP\n Crown\n 53476435482\n 1,501,4833\n 24,2008\n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Retrieve A Specific Piece of Equipment", "operationId": "retrieve-a-specific-piece-of-equipment", "description": "Shows a specific piece of equipment", "tags": [ "Equipment" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "use_third_party_id", "in": "query", "description": "Sets the the call to look for a Third Party ID instead of the vWork ID.", "required": false, "example": "1", "schema": { "type": "integer" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] }, "put": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:52:16 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"cd023b0b002846ec7649112cadaf3433\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "8b9fb0f1-7020-466e-955b-c1d4f1f5be11" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.105612" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F46FE_6ED87C:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 9552\n 1296\n Forklift 2\n Picking it up and Putting it down\n QWERTYUIOP\n Crown\n 53476435482\n 1,501,4833\n 24,2008\n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Update A Specific Piece of Equipment", "operationId": "update-a-specific-piece-of-equipment", "description": "Update an existing piece of equipment. When updating equipment you only need to specify the fields that you would like to change. All other fields will remain unchanged.\n\nTo update the name of a piece of equipment, you might send the following XML.\n\n```\n\n Forklift 2\n \n```\n\nTo update the Third Party ID, you might send the following XML.\n\n```\n\n ABCDEF\n \n```", "tags": [ "Equipment" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "use_third_party_id", "in": "query", "description": "Sets the the call to look for a Third Party ID instead of the vWork ID.", "required": false, "example": "1", "schema": { "type": "integer" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n Forklift 2\n " } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "delete": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "no-cache" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 00:03:38 GMT" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "281aff47-d764-4085-817e-551a09e76ee1" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.580677" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CEA6_0A001312:01BB_575F49D1_A1625A:1EC7" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "summary": "Delete A Specific Piece of Equipment", "operationId": "delete-a-specific-piece-of-equipment", "description": "Deletes a piece of equipment.", "tags": [ "Equipment" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "use_third_party_id", "in": "query", "description": "Sets the the call to look for a Third Party ID instead of the vWork ID.", "required": false, "example": "1", "schema": { "type": "integer" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/assets.xml": { "post": { "responses": { "201": { "description": "Created", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:39:38 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"2dbcb6a04f44419e584b939d643b66f1\"" }, "Status": { "schema": { "type": "string" }, "example": "201 Created" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "c984cbfd-2df1-4010-bad2-d5ef1e4d5412" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.586222" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F4426_6E78F2:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 345232\n Milkshake\n Yard\n 123456\n A sample note\n 2908\n 123456\n \n Kelis\n 42.50\n true\n \n 84710961\n \n \n \n \n \n \n \n \n \n 200 Queen Street, Auckland, New Zealand\n -36.848616\n 174.765643\n \n 2021-03-10T06:02:09+00:00\n 2021-03-10T06:02:09+00:00\n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Create A New Asset", "operationId": "create-a-new-asset", "description": "Creates a new asset in vWork.", "tags": [ "Assets" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n Milkshake\n Yard\n 123456\n A sample note\n 2908\n 123456\n Kelis\n 42.50\n \n 200 Queen Street, Auckland, New Zealand\n -36.848616\n 174.765643\n \n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:43:06 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"6d5e8119257252130624e8cc1a78b813\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "6651d0a2-7f9f-4273-b876-f4544e22e0ca" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.401007" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F443A_6E7B90:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n \n 345232\n Milkshake\n Yard\n 123456\n A sample note\n 2908\n 123456\n \n Kelis\n 42.50\n true\n \n 84710961\n \n \n \n \n \n \n \n \n \n 200 Queen Street, Auckland, New Zealand\n -36.848616\n 174.765643\n \n 2021-03-10T06:02:09+00:00\n 2021-03-10T06:02:09+00:00\n \n\n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "List All Assets", "operationId": "list-all-assets", "description": "Lists all assets.", "tags": [ "Assets" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/assets/{id}.xml": { "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:47:22 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"197907f0f3634f315092aff1d7410394\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "6c906286-8b0d-493f-95cb-d9dea42220d2" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.081427" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F450A_6E96DB:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 345232\n Milkshake\n Yard\n 123456\n A sample note\n 2908\n 123456\n \n Kelis\n 42.50\n true\n \n 84710961\n \n \n \n \n \n \n \n \n \n 200 Queen Street, Auckland, New Zealand\n -36.848616\n 174.765643\n \n 2021-03-10T06:02:09+00:00\n 2021-03-10T06:02:09+00:00\n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Retrieve A Specific Asset", "operationId": "retrieve-a-specific-asset", "description": "Shows a specific asset", "tags": [ "Assets" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "use_third_party_id", "in": "query", "description": "Sets the the call to look for a Third Party ID instead of the vWork ID.", "required": false, "example": "1", "schema": { "type": "integer" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] }, "put": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Mon, 13 Jun 2016 23:52:16 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"cd023b0b002846ec7649112cadaf3433\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "8b9fb0f1-7020-466e-955b-c1d4f1f5be11" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.105612" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CD56_0A000ED8:01BB_575F46FE_6ED87C:1EB6" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 345232\n Milkshake\n Yard\n 123456\n A sample note\n 2908\n 123456\n \n Kelis\n 42.50\n false\n \n 84710961\n \n \n \n \n \n \n \n \n \n 200 Queen Street, Auckland, New Zealand\n -36.848616\n 174.765643\n \n 2021-03-10T06:02:09+00:00\n 2021-03-10T06:02:09+00:00\n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Update A Specific Asset", "operationId": "update-a-specific-asset", "description": "Update an existing asset's record. When updating an asset you only need to specify the fields that you would like to change. All other fields will remain unchanged.\n\nTo update an asset's group, you might send the following XML.\n\n```\n\n 2908\n\n```\n\nTo remove an asset's group, you might send the following XML.\n\n```\n\n \n\n```\n\nTo change the name of an asset, you might send the following XML.\n\n```\n\n Smith St Rose Garden\n\n```\n\nTo disable an asset, you might send the following XML.\n\n```\n\n false\n\n```", "tags": [ "Assets" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "use_third_party_id", "in": "query", "description": "Sets the the call to look for a Third Party ID instead of the vWork ID.", "required": false, "example": "'1'", "schema": { "type": "integer" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n false\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "delete": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "no-cache" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 00:03:38 GMT" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "281aff47-d764-4085-817e-551a09e76ee1" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.580677" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:CEA6_0A001312:01BB_575F49D1_A1625A:1EC7" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "summary": "Delete A Specific Asset", "operationId": "delete-a-specific-asset", "description": "Deletes an asset.", "tags": [ "Assets" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "use_third_party_id", "in": "query", "description": "Sets the the call to look for a Third Party ID instead of the vWork ID.", "required": false, "example": "1", "schema": { "type": "integer" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/messaging.xml": { "post": { "responses": { "201": { "description": "Created", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 01:39:45 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"7b93b83bd74711eb7c647fa765ff6c31\"" }, "Location": { "schema": { "type": "string" }, "example": "https://api.vworkapp.com/api/v4/messaging/ded86e04-31d0-11e6-927a-37a1480f7e3a.xml" }, "Status": { "schema": { "type": "string" }, "example": "201 Created" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "dd33e07d-7734-40a6-ae2c-bfb7da9dc884" }, "X-Runtime": { "schema": { "type": "string" }, "example": "1.087328" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D1C2_0A001312:01BB_575F605A_76FF74:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n ded86e04-31d0-11e6-927a-37a1480f7e3a\n \n 123\n false\n \n Sample Thread\n Sample Message\n \n 2016-06-14T01:39:44Z\n 2016-06-14T01:39:44Z\n 2016-06-14T01:39:45Z\n \n \n 23275dfc-086d-11e4-a5ac-174e8ef2ef84\n 23268152-086d-11e4-a5ac-174e8ef2ef84\n \n Joe Bloggs\n \n \n Sample Message\n 2014-07-10 20:02:36 UTC\n 2014-07-11 08:02:36 +1200\n \n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Create A New Message Thread", "operationId": "create-a-new-message-thread", "description": "Creates a new message thread (including an initial message) in vWork.", "tags": [ "Message Threads" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n \n 123\n Sample Thread\n \n \n \n Joe Bloggs\n Sample Message\n \n \n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 01:44:03 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"b63f609270b27bc15b28397ea16f8a00\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "b0dc67b2-e2b4-452a-916f-805bd12628dc" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.975847" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D1C2_0A001312:01BB_575F6061_770069:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n \n ded86e04-31d0-11e6-927a-37a1480f7e3a\n \n 123\n false\n \n Sample Thread\n Sample Message\n \n 2016-06-14T01:39:44Z\n 2016-06-14T01:39:44Z\n 2016-06-14T01:39:45Z\n \n \n 23275dfc-086d-11e4-a5ac-174e8ef2ef84\n 23268152-086d-11e4-a5ac-174e8ef2ef84\n \n Joe Bloggs\n \n \n Sample Message\n 2014-07-10 20:02:36 UTC\n 2014-07-11 08:02:36 +1200\n \n \n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "List All Message Threads", "operationId": "list-all-message-threads", "description": "Lists threads.", "tags": [ "Message Threads" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/messaging/{id}.xml": { "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 01:47:03 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"29262ad6f9badc69e0ba9cf7ee0a2433\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "21fc9e13-9d65-4d3c-b7b8-f5d3394aab05" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.038802" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D1C2_0A001312:01BB_575F6209_773E50:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n ded86e04-31d0-11e6-927a-37a1480f7e3a\n \n 123\n false\n \n Sample Thread\n Sample Message\n \n 2016-06-14T01:39:44Z\n 2016-06-14T01:39:44Z\n 2016-06-14T01:39:45Z\n \n \n 23275dfc-086d-11e4-a5ac-174e8ef2ef84\n 23268152-086d-11e4-a5ac-174e8ef2ef84\n \n Joe Bloggs\n \n \n Sample Message\n 2014-07-10 20:02:36 UTC\n 2014-07-11 08:02:36 +1200\n \n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Retrieve A Specific Message Thread", "operationId": "retrieve-a-specific-message-thread", "description": "Retrieves a thread and all it's associated messages.", "tags": [ "Message Threads" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] }, "delete": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "no-cache" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 01:48:38 GMT" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "9dbad255-1d04-4942-96f0-38f23a3bd6e6" }, "X-Runtime": { "schema": { "type": "string" }, "example": "3.945302" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D1C2_0A001312:01BB_575F6217_774037:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "summary": "Delete A Specific Message Thread", "operationId": "delete-a-specific-message-thread", "description": "Completely removes thread. Removes all messages related to thread. (This action is not undoable, proceed with caution).", "tags": [ "Message Threads" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/messaging/{thread_id}/messages.xml": { "post": { "responses": { "201": { "description": "Created", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 01:56:40 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"58e045bce12037d329682fa016e0485f\"" }, "Location": { "schema": { "type": "string" }, "example": "https://api.vworkapp.com/api/v4/messaging/acfe5d7a-1188-11e6-9d29-595cf99ba95b/messages/3c27e588-31d3-11e6-927a-37a1480f7e3a.xml" }, "Status": { "schema": { "type": "string" }, "example": "201 Created" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "9b50ea5a-cd40-4c20-a702-b4299e688932" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.513173" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D1C2_0A001312:01BB_575F6382_776FF0:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 23275dfc-086d-11e4-a5ac-174e8ef2ef84\n 23268152-086d-11e4-a5ac-174e8ef2ef84\n 3\n Joe Bloggs\n 3\n \n This is a new message\n 2014-07-10 20:02:36 UTC\n 2014-07-11 08:02:36 +1200\n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Create A New Message", "operationId": "create-a-new-message", "description": "Creates a new message for an existing thread in vWork.", "tags": [ "Messages" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "thread_id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n This is a new message\n 3\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 01:59:17 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"99d66c28bfd0dd358bd4280b4bd71b19\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "10515063-495a-4404-832d-8b92ca703858" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.035260" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D1C2_0A001312:01BB_575F6458_778982:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n \n 23275dfc-086d-11e4-a5ac-174e8ef2ef84\n 23268152-086d-11e4-a5ac-174e8ef2ef84\n 3\n Joe Bloggs\n 3\n \n This is a new message\n 2014-07-10 20:02:36 UTC\n 2014-07-11 08:02:36 +1200\n \n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "List All Messages", "operationId": "list-all-messages", "description": "Lists all messages in a specifc thread.", "tags": [ "Messages" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "thread_id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/messaging/{thread_id}/messages/{id}.xml": { "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 02:01:07 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"23cdcff949c6326969601f967e777893\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "677a61c4-a9e6-4128-9e2e-6b07568f0457" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.047095" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D1C2_0A001312:01BB_575F6541_77ADA4:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 23275dfc-086d-11e4-a5ac-174e8ef2ef84\n 23268152-086d-11e4-a5ac-174e8ef2ef84\n 3\n Joe Bloggs\n 3\n \n This is a new message\n 2014-07-10 20:02:36 UTC\n 2014-07-11 08:02:36 +1200\n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Retrieve A Specific Message", "operationId": "retrieve-a-specific-message", "description": "Retrieves a specific message", "tags": [ "Messages" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "thread_id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] }, "delete": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "no-cache" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 02:04:46 GMT" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "4e0203ca-8bc2-4220-9310-e00ea720f01e" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.117428" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D1C2_0A001312:01BB_575F6639_77CF51:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "summary": "Delete A Specific Message", "operationId": "delete-a-specific-message", "description": "Completely removes a message from a thread. (This action is not able to be undone, proceed with caution).", "tags": [ "Messages" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "thread_id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/tags.xml": { "post": { "responses": { "201": { "description": "Created", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 02:41:25 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"852a96824f66ae37c18df704c0efb80a\"" }, "Status": { "schema": { "type": "string" }, "example": "201 Created" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "e583c836-b1d8-4e4c-836e-20e07aec2b23" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.046924" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D37C_0A000ED8:01BB_575F6EC3_78E6B6:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 27\n CDL\n Commercial Driver's License\n true\n \n 2016-06-14T02:41:25Z\n 2016-06-14T02:41:25Z\n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Create A New Tag", "operationId": "create-a-new-tag", "description": "Creates a new tag in vWork.", "tags": [ "HS - Managing Tags" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n CDL\n Commercial Driver's License\n true\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 02:46:38 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"6eebea1fbbc660a5f8895255856037e3\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "f068e8b1-4928-4f26-9afc-6b233768b46d" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.072989" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D37C_0A000ED8:01BB_575F6FC1_790749:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n \n 27\n CDL\n Commercial Driver's License\n true\n \n 2016-06-14T02:41:25Z\n 2016-06-14T02:41:25Z\n \n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "List All Tags", "operationId": "list-all-tags", "description": "Lists all tags present in the account.", "tags": [ "HS - Managing Tags" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } }, "/v5/tags/{id}.xml": { "get": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 02:48:32 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"852a96824f66ae37c18df704c0efb80a\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "bdc6eba9-24bd-4150-9007-80f83e0aad83" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.057500" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D37C_0A000ED8:01BB_575F700E_79114E:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 27\n CDL\n Commercial Driver's License\n true\n \n 2016-06-14T02:41:25Z\n 2016-06-14T02:41:25Z\n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Retrieve A Specific Tag", "operationId": "retrieve-a-specific-tag", "description": "Retrieves the tag from vWork that has the given id.", "tags": [ "HS - Managing Tags" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] }, "put": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "max-age=0, private, must-revalidate" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 02:50:27 GMT" }, "ETag": { "schema": { "type": "string" }, "example": "W/\"4cf43ee41a81cbf5d4d2e2d20a14e0d5\"" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "76e28818-faa8-416f-892c-3ef77f455ab5" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.082651" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D37C_0A000ED8:01BB_575F70EE_792F80:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } }, "content": { "application/xml; charset=utf-8": { "examples": { "response": { "value": "\n\n 27\n License\n Commercial Driver's License\n true\n \n 2016-06-14T02:41:25Z\n 2016-06-14T02:50:27Z\n\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "summary": "Update A Specific Tag", "operationId": "update-a-specific-tag", "description": "Updates an existing tag. When updating a tag you only need to specify the fields that you would like to change. All other fields will remain unchanged. For example; to update the name you might PUT the following XML to an existing tag.\n\n```\n\n License\n\n```", "tags": [ "HS - Managing Tags" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ], "requestBody": { "content": { "application/xml; charset=utf-8": { "examples": { "request": { "value": "\n\n License\n" } }, "schema": { "type": "string", "description": "Raw XML payload — see the example." } } } } }, "delete": { "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "no-cache" }, "Content-Encoding": { "schema": { "type": "string" }, "example": "gzip" }, "Content-Security-Policy": { "schema": { "type": "string" }, "example": "frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com; form-action: google.com google-analytics.com googleapis.com gstatic.com vworkapp.com vworkapp.co.uk vwork.io intercom.io intercomcdn.com zopim.com fastly.net nr-data.net typekit.net status.io maxcdn.bootstrapcdn.com code.jquery.com kissmetrics.com ssl.mousestats.com" }, "Date": { "schema": { "type": "string" }, "example": "Tue, 14 Jun 2016 02:53:15 GMT" }, "Status": { "schema": { "type": "string" }, "example": "200 OK" }, "Strict-Transport-Security": { "schema": { "type": "string" }, "example": "max-age=31536000" }, "Transfer-Encoding": { "schema": { "type": "string" }, "example": "chunked" }, "X-Content-Type-Options": { "schema": { "type": "string" }, "example": "nosniff" }, "X-Frame-Options": { "schema": { "type": "string" }, "example": "SAMEORIGIN" }, "X-Request-Id": { "schema": { "type": "string" }, "example": "21068ac0-1234-4123-8860-8067f0c73c6e" }, "X-Runtime": { "schema": { "type": "string" }, "example": "0.053361" }, "X-Unique-ID": { "schema": { "type": "string" }, "example": "CA7C7B8A:D37C_0A000ED8:01BB_575F7190_794B58:1E66" }, "X-XSS-Protection": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "summary": "Delete A Specific Tag", "operationId": "delete-a-specific-tag", "description": "Deletes the tag with the given id. This cannot be undone.", "tags": [ "HS - Managing Tags" ], "parameters": [ { "name": "api_key", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Encoding", "in": "header", "description": "Must be `gzip`. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).", "required": true, "example": "gzip", "schema": { "type": "string", "enum": [ "gzip" ] } } ] } } }, "tags": [ { "name": "Jobs", "description": "As the creation and management of jobs is such an extensive topic, we have split this out into two full documents of their own.\n\nIf you want to easily create jobs from your existing templates, then you should use our Templated Jobs API documentation. Please note: this is the recommended way of creating new jobs.\n\nIf you need to search for, download, or update your jobs, then you should use our Jobs API documentation.\n\nThese APIs can (and should) be used in combination. For example, creating your jobs with the templated jobs API and then updating them or retrieving updates using our standard jobs API." }, { "name": "Users", "description": "The users API route allows you to control all vWork users (either mobile workers, dispatchers or admins). Users can be workers using the vWork mobile app or dispatchers using the vWork website. The following web services can be used to create, update, delete and search for users within vWork.\n\nHere are the fields you can use when making a user request:\n\nName | Type | Description\n--- | --- | ---\nname|String|Unique name of user, cannot be blank.\nthird_party_id|String|Your unique ID for the user. (optional)\nemail|String|Unique email of user, cannot be blank.\nphone|String|Mobile phone number of user. (Be sure to include the country code)\nnotes|String|Ancillary information about the user. (optional)\npassword|String|Password of user (Please refer to the tech note regarding password strength at the top of this doc).\ngroup_ids|String|Comma-separated list of ids of groups this user shall be a member of. (optional)\npermissions|Array|Array of permissions that allow the user to access various parts of vWork\n\nWhen retrieving a user from vWork, you may also see these additional fields in the response. (Depending on what optional features are enabled on your account, you may also see: tags, capacity, start location or end location. More information on these options are available further down this document under the route optimisation and health and safety headings)\n\nName | Type | Description\n--- | --- | ---\nid|Integer|The unique ID of the user.\nupdated_at|DateTime|Time user was last updated.\ncreated_at|DateTime|Time user was created.\nlatest_telemetry|Object|Latest telemetry for user.\nheading|Decimal|Direction (angle) the user is heading to.\nlat|Decimal|Latitude.\nlng|Decimal|Longitude.\nrecorded_at|DateTime|Point of time when telemetry was recorded.\nspeed|Decimal|Speed in kilometers per hour (km/h).\nshift_on|Boolean|Is the worker currently on shift.\n\n**Permissions**\n\nA user in vWork can be granted access to certain areas and actions by using the following permissions:\n\nName | Available Permissions | Description\n--- | --- | ---\njobs|full, none, read|Allows the user to access the jobs tab on the vWork website.\nschedule|full, none, read|Allows the user to access the schedule tab on the vWork website.\nmap|full, none, read|Allows the user to access the map tab on the vWork website.\nreports|full, none|Allows the user to access the reports tab on the vWork website.\ncustomers|full, none, read|Allows the user to access the customers tab on the vWork website.\nequipment|full, none, read|Allows the user to access the equipment tab on the vWork website if the equipment module is enabled for the account.\nquotes|full, none, read|Allows the user to access the quotes tab on the vWork website if the quotes module is enabled for the account. (Also allows the user to create quotes from the mobile device when combined with mobile_jobs_create.)\nmessaging|full, none|Allows the user to access the messaging tab on the vWork website. (Also allows all mobile users to message users with this permission.)\nadmin|full, none|Allows full administration of the vWork account, content and settings.\nmobile|full, none|This permission enables the worker to use the mobile application. This must be set to full for the worker to use the vWork mobile apps. If any of the other mobile permissions are enabled this will be set to 'full' automatically. \nmobile_jobs_create|full, none|This permission allows the worker to create jobs using the mobile application, setting create will enable mobile automatically. \nmobile_jobs_assign|full, none|This permission allows the worker to assign jobs using the mobile application, setting assign will enable mobile and create automatically.\nmobile_invoice|full, none, read|This permission allows the worker to work with invoices using the mobile application." }, { "name": "Customers", "description": "Customers are who you complete jobs for. You can specify a customer's first and last name, phone number, contact details, and billing information. The following web services can be used to create, update, delete and search for customers within vWork.\n\nHere are the fields you can use when making a customer request:\n\nName | Type | Description\n--- | --- | ---\nname|String|The customer's name. Can be either a person's full name or an organization's name.\nthird_party_id|String|A user defined ID for this customer. Although it's not required, this ID should be unique. If you do not supply one, vWork will create one.\nnotes |String|A text entry for notes about this customer.\ndelivery_contact| |The address and contact details for visiting the customer.\ndelivery_contact.first_name|String|The contact's first name.\ndelivery_contact.last_name|String|The contact's last name.\ndelivery_contact.phone|String|The contact's phone number.\ndelivery_contact.mobile|String|The contact's mobile phone number. (Be sure to include the country code.)\ndelivery_contact.email|String|The contact's email address.\ndelivery_location.formatted_address|String|The formatted address of this location.\ndelivery_location.lat|Decimal|The latitude of the location.\ndelivery_location.lng|Decimal|The longitude of the location.\nbilling_contact| |The address and contact details for billing the customer.\nbilling_contact.first_name|String|The contact's first name.\nbilling_contact.last_name|String|The contact's last name.\nbilling_contact.phone|String|The contact's phone number.\nbilling_contact.mobile|String|The contact's mobile phone number. (Be sure to include the country code.)\nbilling_contact.email|String|The contact's email address.\nbilling_location.formatted_address|String|The formatted address of this location.\nbilling_location.lat|Decimal|The latitude of the location.\nbilling_location.lng|Decimal|The longitude of the location.\n\nWhen retrieving a customer from vWork, you may also see these additional fields in the response:\n\nName | Type | Description\n--- | --- | ---\nid|Integer|Unique ID of customer.\ncreated_at|DateTime|Time customer was created.\nupdated_at|DateTime|Time customer was last updated.\ndeleted_at|DateTime|Time customer was deleted. (will be blank as deleted customers are not available via the API.)" }, { "name": "Customer Custom Fields", "description": "We have an optional feature that will allow you to add extra custom fields to your customer records. This is turned off by default, but you can speak to your account manager about getting this turned on.\n\nThe custom fields are structured in the same way they are for jobs. The number of fields, the type of fields and the field permissions are defined before you start adding data. This work needs to be done in the admin section of the vWork website.\n\nOnce this is done, you can populate the values via the API. To do so, you include the field name and value in a POST or a PUT to a customer.\n\n```\n \n \n Customer's Mother's Maiden Name\n Smith\n \n \n```\n\nPlease note, that the values you supply will need to match the type of custom field in use. For example, you could not populate a number custom field with text.\n\nIf you do not have access to the website, you can perform a GET on an customer to see the custom field structure that has been defined for your assets.", "x-displayName": "Customer's Custom Fields" }, { "name": "Customer Pricebook", "description": "We have an optional feature that will allow you to assign specific pricebooks to specific customers. This is turned off by default, but you can speak to your account manager about getting this turned on.\n\nOnce this is done, you can see the pricebook ID on the customer GET as follows:\n\n```\n 54\n```\n\nYou can also populate the values via the API. To do so, you include the pricebook ID in a POST or a PUT to a customer.\n\n```\n \n 1188\n \n\n```\n\nPlease note, that the values you supply will need to match the ID of a pricebook in your account.\n\nIf you do not have access to the website, you can perform a GET on the pricebooks endpoint to retrieve a list of valid pricebook IDs for your account.\n\nWhen this feature is enabled, and you create a job for this customer, the job will automatically inherit the customer pricebook if invoicing is enabled. (But you can over ride this by specifying an alternate pricebook ID in the POST.", "x-displayName": "Customer's Pricebook" }, { "name": "Pick Lists", "description": "A pick list is a type of custom field within a Job. It contains a set of pre-defined items a user can choose from when filling out the custom field.\n\nvWork supports both single value pick lists where a user can only choose one value, as well as multi-value pick lists where user's can select more than one value. Any of the pick lists defined in the account can be set to either single or multi-value when they are added to a job. You can also set a default value for a pick list when you add it to a job.\n\nThe following calls allow you to administer the pick lists that are available in your account.\n\nHere are the fields you can use when making a pick list request:\n\nName | Type | Description\n--- | --- | ---\nname|String|A human readable name used to identify the pick list in the vWork admin.\npick_list_items|Array|An array of values to populate the pick list\npick_list_item.value|String|The value to include in the pick list\n\nWhen retrieving a pick list from vWork, you may also see these additional fields in the response:\n\nName | Type | Description\n--- | --- | ---\nid|Integer|The unique identifier for this pick list. Auto-generated by vWork.\ncreated_at|DateTime|The date and time when this pick list was created. Format: ISO 8601.\nupdated_at|DateTime|The date and time when this pick list was last updated. Format: ISO 8601.\npick_list_items|Array|Array containing all items of that pick list.\npick_list_item|Object|One pick list item object.\npick_list_item.id|Integer|The unique identifier for this pick list item. Auto-generated by vWork.\npick_list_item.value|String|The text for this item.\npick_list_item.created_at|DateTime|The date and time when this pick list item was created. Format: ISO 8601.\npick_list_item.updated_at|DateTime|The date and time when this pick list item was last updated. Format: ISO 8601." }, { "name": "Groups", "description": "vWork supports groups, allowing you to separate your workers into different teams. (For example: sales and service, electricians and plumbers, North and South, Chicago and Detroit, etc…)\n\n* Workers can belong to multiple groups, allowing them to receive work from different dispatchers.\n\n* Dispatchers can belong to multiple groups, allowing them to manage multiple workforces.\n\n* Dispatchers must belong to a group in order to see it.\n\n* Groups support multiple time zones. For example, a San Francisco group operating on Pacific time and a Colorado group operating on Central time. (This time zone offset cannot be set via the API, it needs to be set on the web app settings page.)\n\n* Please ensure that all users belong to at least one group.\n\n* Please note that groups is not enabled by default on all accounts. This feature needs to be enabled by our operations team.\n\nHere are the fields you can use when making a group request:\n\nName | Type | Description\n--- | --- | ---\nname|String|The group's name.\ndescription|String|The group's description.\nuser_ids|String|Comma-separated list of ids of users you want to associate with this group.\n\nWhen retrieving a group from vWork, you may also see these additional fields in the response:\n\nName | Type | Description\n--- | --- | ---\ngroup|Object|Group record.\nid|Integer|Unique ID of group.\ncreated_at|DateTime|Time group was created.\nupdated_at|DateTime|Time group was last updated." }, { "name": "Attachments", "description": "An attachment is a file that belongs to an image custom field for a job. An image attachment is always of type JPEG.\n\nThe API only allows the retrieval of these images. It is not possible to update, edit or delete attachments via the API.\n\nWe do not currently support the download of PDF attachments, but this will be available soon." }, { "name": "Signatures", "description": "A signature is a file that belongs to a signature custom field for a job. A signature attachment is always of type PNG. (Please note, this API call does not refer to the Proof of Delivery signature which is present on all jobs by default.)\n\nThe API only allows the retrieval of these images. It is not possible to update, edit or delete signatures via the API." }, { "name": "Proof of Delivery", "description": "The vWork mobile app allows workers to collect Proof of Delivery signatures from customers when completing any job. They also have the option of saving a photo with the signature at the same time. This combination of photo, signature, name and time is referred to as a POD or Proof of Delivery.\n\nThe API only allows the retrieval of these images. It is not possible to update, edit or delete PODs via the API.\n\n(Please note: that this call references the default POD signature field that appears on all jobs, and does not include any extra signature custom fields that you may have added to your jobs.)" }, { "name": "Pricebooks", "description": "Pricebooks are simply an easy way to define what items are available to be added to an invoice.\n\nPricebooks can contain up to 2000 items, each item has a code, description and unit cost.\n\nWeb users can select a pricebook for each of their templates. When using the API, you can either inherit the pricebook from the template, or specify the pricebook for each job you create.\n\nIf you are using our customer specific pricebooks features, you can also inherit the pricebook from the customer record.\n\nThe following web services can be used to create, update, delete and search for pricebooks within vWork.\n\nHere are the fields you can use when making a pricebook request:\n\nName | Type | Description\n--- | --- | ---\nname|String|Unique name of pricebook, cannot be blank.\ndescription|String|A user friendly description of the pricebook, should not be blank.\npricebook_items|Array|An array of values to populate the pricebook\npricebook_item.code|String|The item code to include in the pick list\npricebook_item.description|String|The item description to include in the pick list\npricebook_item.price|String|The item value to include in the pick list\n\nWhen retrieving a priceboook from vWork, you may also see these additional fields in the response.\n\nName | Type | Description\n--- | --- | ---\nid|Integer|The unique ID of the pricebook. Auto-generated by vWork.\npricebook_id|Integer|The unique ID of the pricebook. Auto-generated by vWork.\naccount_id|Integer|The unique ID of your account. Auto-generated by vWork.\nitem id|Integer|The unique ID of each item in the pricebook. Auto-generated by vWork." }, { "name": "Equipment", "description": "Equipment is an optional feature that allows dispatchers to schedule both mobile workers and equipment required for jobs.\n\nFor example, you may need to schedule Bob, the Forklift, Truck 23 and Trailer 15 for a specific job.\n\nOnce this feature is enabled and your equipment has been setup, you can then assign equipment to your jobs as needed.\n\nThe following web services can be used to create, update, delete and search for equipment within vWork.\n\nHere are the fields you can use when making an equipment request:\n\nName | Type | Description\n--- | --- | ---\nname|String|Unique name of equipment, this is what will be displayed on the schedule, cannot be blank.\nthird_party_id|String|Your unique ID for the equipment. (optional)\nmodel|String|A description of the equipment. (optional)\nnotes|String|Ancillary information about the equipment. (optional)\nserial|String|The serial number of the equipment. (optional)\ntag_ids|String|Comma-separated list of ids of tags this equipment shall have.* (optional)\ngroup_ids|String|Comma-separated list of ids of groups this equipment shall be a member of. (optional)\n\n*Assigning a tag to a piece of equipment means that only users with that same tag will be allowed to use that equipment. For example, if you assign a Heavy Vehicle License tag to a truck, then only users with a Heavy Vehicle License tag will be able to be assigned to that truck (and therefore that job).\n\nWhen retrieving equipment from vWork, you may also see these additional fields in the response.\n\nName | Type | Description\n--- | --- | ---\nid|Integer|The unique ID of the equipment. Auto-generated by vWork.\naccount_id|Integer|The unique ID of your account. Auto-generated by vWork." }, { "name": "Assets", "description": "Assets is an optional feature that allows you to maintain a database of customer owned assets and information associated with them.\n\nThe following web services can be used to create, update, delete and search for assets within vWork.\n\nHere are the fields you can use when making an asset request:\n\nName | Type | Description\n--- | --- | ---\nname|String|Unique name of asset, cannot be blank.\nthird_party_id|String|Your unique ID for the asset. (optional)\nmodel|String|A description of the asset. (optional)\nserial|String|The serial number of the asset. (optional)\nnotes|String|Ancillary information about the asset. (optional)\ngroup_ids|String|Comma-separated list of ids of groups this asset shall be a member of. (optional)\ncustomer_id|String|The unique ID of the customer who owns the asset.\ncost|Decimal|The hourly cost of the asset (optional, not currently used)\nlocation.formatted_address|String|The formatted address of this location.\nlocation.lat|Decimal|The latitude of the location.\nlocation.lng|Decimal|The longitude of the location.\nenabled|Boolean|Whether the asset is enabled or disbled. It is not possible to create jobs for disabled assets.\n\nWhen retrieving an asset from vWork, you may also see these additional fields in the response. (Depending on what optional features are enabled on your account, you may also see: tags, hazards, time windows, or line items. More information on these options is available in the following sections.)\n\nName | Type | Description\n--- | --- | ---\nid|Integer|The unique ID of the asset.\nattachment_id|Integer|The unique ID of the asset's attached image. This can only be upload via the web interface." }, { "name": "Asset Custom Fields", "description": "The custom fields are structured in the same way they are for jobs. The number of fields, the type of fields and the field permissions are defined before you start adding data. This work needs to be done in the admin section of the vWork website.\n\nOnce this is done, you can populate the values via the API. To do so, you include the field name and value in a POST or a PUT to the asset.\n\n```\n\n\n \n \n Last Service\n July 15th 2020\n \n \n \n```\n\nPlease note, that the values you supply will need to match the type of custom field in use. For example, you could not populate a number custom field with text.\n\nIf you do not have access to the website, you can perform a GET on an asset to see the custom field structure that has been defined for your assets." }, { "name": "Asset Time Windows", "description": "Time windows are an optional feature that is enabled with route optimisation.\n\nTime windows allow you to define times when jobs can't be done. (eg: We can't mow the sportsfield on Saturday and Sunday mornings between 8am and 1 pm becuase of the soccer games.) This is an exclusion time slot and can be added to an asset like so:\n\n```\n\n \n 28800\n 46800\n 6\n \n \n 28800\n 46800\n 0\n \n\ntrue\n```\n\nThe days of the week start from Sunday as day 0, so Monday is day 1 and Sunday is day 6.\n\nThe start time and end time are in seconds from midnight, so 8am is 28800 and 1pm is 46800.\n\nYou can also define times when jobs must be done. (We only have access to the forklift between 9 and 12 on Mon, Wed and Fri.) This is an inclusion time slot and can be added to a job like so:\n\n```\n\n \n 32400\n 43200\n 1\n \n \n 32400\n 43200\n 3\n \n \n 32400\n 43200\n 5\n \n\nfalse\n```\n\nThe day and time logic works the same way, but negative time windows are set to false instead of true.\n\nIf these time windows are added to an asset (either by the webapp or the API) we will prevent jobs associated with that asset from breaking these rules when they are being optimised.\n\nWe will also warn dispatchers if they manually schedule a job that breaks one of these rules, but won't prevent it.\n\nIf you wish to remove a time window from an asset, you would PUT the following XML:\n\n```\n\n\n \n \n 5198001\n <_destroy>true\n \n \n \n```\n\nIf you wish to remove all time windows from an asset, then you can PUT an empty array, like so:\n\n```\n\n\n \n \n \n```" }, { "name": "Asset Tags", "description": "Tags are a subset of vWork's Health and Safety module and are generally not enabled by default.\n\nTags need to be defined in your account before they can be added to your assets. This can be done via the website or via the Tags API route. This section of the documentation assumes some tags already exist for your account.\n\nOnce created, you can add specific tags to your assets. Jobs associated with an asset will inherit the tags from the asset. This will prevent your dispatchers from assigning jobs to workers that do not have the required qualifications for a certain job.\n\nIf you need to include a tag on the asset, you can PUT or POST an array of tag IDs in the job XML.\n\nThe following example adds tag 123 and tag 456 to the asset.\n\n```\n\n \n 123\n \n \n 456\n \n\n```\n\nTo remove 1 tag from an asset, you would PUT the following XML to the asset. (In this situation, you reference the tag ID from the asset, not the tag ID from the account.)\n\n```\n\n\n \n \n 11407022\n <_destroy>true\n \n \n \n```\n\nIf you wish to remove all tags from an asset, then you can PUT an empty array, like so:\n\n```\n\n\n \n \n \n```\n\nYou can retrieve a list of tags for your account via the API using the tags route." }, { "name": "Asset Hazards", "description": "If you are using the Health and Safety module, you can also allow your dispatchers to identify and record hazards on an asset. Workers will not be able to complete the job until they acknowledge the hazards identified.\n\nWhile it is possible to add default hazards to the web interface, these are only for dispatcher or worker use. If you wish to add hazards to an asset via the API, you do not reference the existing hazards in the account, you include them in the XML for the asset.\n\nTo post an unpopulated hazard called \"Risk of Explosion\" to an asset, you would include the following XML in either the job PUT or POST. In this example, vWork would automatically create the other required fields for the hazard and force the mobile worker to fill them in before completing the job.\n\n```\ntrue\n\n \n Risk of Explosion\n \n\n```\n\nIf you wanted to create the entire hazard and specify more details for the worker, you would include the following XML in either the job PUT or POST. In this case, vWork would only prompt the worker to acknowledge the hazard as the values have already been pre-defined. (The worker still has the option of editing these values if they need to.)\n\n```\ntrue\n\n \n Risk of Explosion\n \n \n risk_picklist\n \n High\n \n \n risk_picklist\n \n Low\n \n \n control_picklist\n \n Eliminate the Hazard\n \n \n text\n \n Shut down all power feeds to circuits being worked on.\n \n \n text\n \n Fred Smith\n \n \n \n\n```\n\nTo remove a hazard from an asset, you would PUT the following XML to the asset.\n\n```\n\n\n \n \n 1733042\n <_destroy>true\n \n \n \n```\n\nTo remove all hazards from an asset, you can PUT an empty hazard array, like so:\n\n```\n\n\n \n \n \n```" }, { "name": "Asset Line Items", "description": "If invoicing is enabled for your account, you can add invoice line items to an asset.\n\nTo do so, you need to specify the following XML in a POST or PUT to the asset.\n\nvWork will then include these line items in any jobs for the asset where invoicing is enabled.\n\n```\n\n\n \n \n \n foo\n bar\n 100.0\n 1.0\n 1.0\n \n \n \n \n```\n\nIf you wish to edit an existing item, please submit the full array of invoice line items with the updated information, like so:\n\n```\n\n\n \n \n \n foo\n bar2\n 100.0\n 1.0\n 1.0\n \n \n bar\n whatsit2\n 100.0\n 1.0\n 1.0\n \n \n \n \n```\n\nIf you wish to remove one line item from an asset, please submit the full array minus the line item you wish to remove as per the example above.\n\nIf you wish to remove all line items from an asset, please use the destroy command in a POST as per the example below, and include the specific IDs:\n\n```\n\n\n \n 1865860\n \n \n 3550124\n <_destroy>true\n \n \n 3550125\n <_destroy>true\n \n \n \n\n```" }, { "name": "Message Threads", "description": "Messages are sent from worker to dispatcher and vice versa. Messages are contained within a message thread.\n\nYou can add or delete messages threads using this API.\n\nIf you add a Job ID, we will automatically send it to the workers for that job, you do not need to specify the worker ID.\n\nHere are the fields you can use when making a message request:\n\nName | Type | Description\n--- | --- | ---\njob_id|Integer|An optional job ID that the message thread relates to.\njob_third_party_id|String|An optional job Third Party ID that the message thread relates to.\nuser_ids|String|Comma-separated list of ids of users you want to the message to be available to. \nsubject|String|The subject for the thread.\nmessages|Array|An array of messages to add to the thread.\nmessage.from_user_id|Integer|User ID for initial thread message. (Optional)\nmessage.from_user_name|String|User name of message creator. Only used (and required) if from_user_id is blank.\nmessage.body|String|The body for the inital thread message.\n\nWhen retrieving a message from vWork, you may also see these additional fields in the response:\n\nName | Type | Description\n--- | --- | ---\nid|Integer|Unique ID of thread.\nsummary|Boolean|Summary of latest thread contents (Used internally and set automatically.)\nlast_reply_user_id|Boolean|User ID of last reply.\nlast_reply_at|Boolean|Time thread was last replied to.\ncreated_at|DateTime|Time thread was created.\nupdated_at|DateTime|Time thread was last updated.\nmessages|Array|An array of all messages in the thread.\ncreated_by_user_id|Boolean|User ID of thread creator.\nmessage.id|String|Unique Message ID.\nmessage.read_by_user_ids|String|Comma-separated list of IDs of users that have read the message.\nmessage.received_by_user_ids|String|Comma-separated list of IDs of users that have received this message on their mobile devices.\nmessage.created_at|DateTime|Time message was created.\nmessage.updated_at|DateTime|Time message was last updated." }, { "name": "Messages", "description": "Messages are sent from worker to dispatcher and vice versa. You can add, edit or delete messages using this API. Messages exist within a message thread.\n\nHere are the fields you can use when making a message request:\n\nName | Type | Description\n--- | --- | ---\nbody|String|Message content\nfrom_user_id|Boolean|User ID that posts this message\nfrom_user_name|Boolean|User name of message creator. If from_user_id is blank then this can be any value you like, but will be mandatory.\n\nWhen retrieving a message from vWork, you may also see these additional fields in the response:\n\nName | Type | Description\n--- | --- | ---\nmessage|Object|Message record\nid|Integer|Unique ID of message\nthread_id|String|Messages Thread ID\nread_by_user_ids|String|Comma-separated list of ids of users that have read this message.\nreceived_by_user_ids|String|Comma-separated list of ids of users that have received this message.\ncreated_at|DateTime|Time thread was created.\nupdated_at|DateTime|Time thread was last updated." }, { "name": "Route Optimisation - User Management", "description": "If you are using our route optimisation module, you will see some extra optional fields on your users. These include a start location, end location and a capacity.\n\nThese locations are used by our route optimisation module to try and start and end routes at pre-determined locations, usually a worker's home or an office location. To set these for a user that does not have a location set already, you can include the following XML in a PUT or a POST to a User.\n\n```\n \n 18 Railway Street, Newmarket, Auckland, New Zealand\n -36.865387\n 174.780437\n \n\n \n 18 Railway Street, Newmarket, Auckland, New Zealand\n -36.865387\n 174.780437\n \n```\n\nHowever, if you are replacing an existing location in a PUT, you will need to include the current location ID as per this example:\n\n```\n\n \n 27570362\n 18 Railway Street, Newmarket, Auckland, New Zealand\n -36.865387\n 174.780437\n \n\n```\n\nCapacity settings are also turned on when route optimisation is enabled. This feature allows you to set a capacity allowed for a user and a capacity required on a job. The vWork optimisation module will then prevent overloading a vehicle.\n\nCapacity can be measured however you like: meals, boxes, pallets, tonnes, cubic metres, etc. But you need to use the same metric on both users and jobs. You cannot use capacity to solve complex load planning problems.\n\nFor example, a user with a small van could carry 100 meals, and a customer may order 12 meals in a job. You would then need to add a capacity of \"100\" for the user, and a capacity of \"12\" on the job.\n\nTo set capacity for a user simply include the value in a PUT or POST to the user, like so:\n\n```\n100\n```" }, { "name": "Route Optimisation - Job Options", "description": "When you are using route optimisation, there are two optional items you can include in your job data, alongside the mandatory job location. These include job capacity and job time slots.\n\nIf you are creating jobs from scratch you can view the documentation for these options here.\n\nIf you are creating jobs via the API and referencing an existing job template in your account, then you can find the relevant documentation here." }, { "name": "HS - Managing Tags", "description": "Tags and Hazards are part of the optional vWork Health and Safety module. If you are not using this module, you can ignore this section of the API documentation.\n\nYou can add specific tags to your workers and jobs. This will prevent jobs being assigned to workers that do not have the required qualification for a certain job. (For example, you can tag a job as requiring a certified electrician and then tag your electricians with this same tag.)\n\nTags need to be defined in your account before they can be added to your workers or jobs. This can be done via the website or via the API.\n\nTags may have a description as well as an expiry date. If you say that a tag requires an expiry date, the expiry date is added to the tag when it is associated with the user. (For example, Bob may have a commercial driver's license that expires on Jan 1, 2020.)\n\nHere are the fields you can use when making a tag request:\n\nName | Type | Description\n--- | --- | ---\nname | String | The name of the tag.\ndescription | String | A description of the tag.\nexpires | Boolean | Whether or not an expiry date is required when adding the tag to a user.\n\nWhen retrieving a tag from vWork, you may also see these additional fields in the response:\n\nName | Type | Description\n--- | --- | ---\nid|Integer|Unique ID of the tag, used when adding a tag to a job or a user.\ncreated_at|DateTime|Time tag was created.\nupdated_at|DateTime|Time tag was last updated.\ncreated_by_user_id|Integer|User ID of the user who created the tag. (Set to Nil if created via the API.)", "x-displayName": "H&S - Managing Tags" }, { "name": "HS - Tagging Users", "description": "Tags need to be defined in your account before they can be added to your users. This can be done via the website or via the API. This section of the documentation assumes some tags already exist for your account.\n\nTo add tag 12 to one of your users, with an expiry date and an explanatory note, you would include the following XML in either the user PUT or POST.\n\n```\n\n \n 12\n Some notes to save against the tagging\n 2017-05-30T12:00:00Z\n \n\n```\n\nIf you wanted to update the user's tag with some new content, like a note, you would include the following XML in a user PUT. (In this situation, you reference the tag ID from the user, not the tag ID from the account.)\n\n```\n\n \n 109\n Some updated notes\n \n\n```\n\nTo remove tag 109 from user 12345, you would send a DELETE command to the following URL. (In this situation, you reference the tag ID from the user, not the tag ID from the account.)\n\n```\nhttps://api.vworkapp.com/api/v4/user/12345/taggings/109.xml?api_key=123\n```", "x-displayName": "H&S - Tagging Users" }, { "name": "HS - Tagging Jobs", "description": "You can also add tags to jobs, details for how to do this can be found in our Jobs API documentation.\n\nIf you are using our Templated Jobs API, tags will be automatically inherited from the template.", "x-displayName": "H&S - Tagging Jobs" } ], "servers": [ { "url": "https://api.vworkapp.com" } ], "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "in": "query", "name": "api_key", "description": "Get your key at https://go.vworkapp.com/html_client/admin/api" } } }, "security": [ { "apiKey": [] } ], "x-tagGroups": [ { "name": "Reference", "tags": [ "Jobs", "Users", "Customers", "Customer Custom Fields", "Customer Pricebook", "Pick Lists", "Groups", "Attachments", "Signatures", "Proof of Delivery", "Pricebooks", "Equipment", "Assets", "Asset Custom Fields", "Asset Time Windows", "Asset Tags", "Asset Hazards", "Asset Line Items", "Message Threads", "Messages", "Route Optimisation - User Management", "Route Optimisation - Job Options", "HS - Managing Tags", "HS - Tagging Users", "HS - Tagging Jobs" ] } ] }