{"items":[{"type":"link","label":"vWork API V5 (Stable Release)","link":"/v5","routeSlug":"/v5","content":{"contentType":"overview","meta":{"name":"vWork API V5 (Stable Release)"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"v5.json","url":"/_bundle/v5.json?download"},{"kind":"download","label":"v5.yaml","url":"/_bundle/v5.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.vworkapp.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"vWork API V5 (Stable Release)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/v5"}],"sectionId":"/v5"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/getting-started"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We have broken our API documentation into three parts. The following documentation is for creating and managing everything except jobs."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to easily create jobs from your existing templates, then you should use our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/v5-templated-jobs"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Templated Jobs API documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  Please note: this is the recommended way of creating new jobs."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you need to search for, download, or update your jobs, then you should use our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/v5-jobs"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jobs API documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"sectionId":"/v5/section/getting-started"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/getting-started/what-is-it"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What is it?"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Welcome 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base URL for our API is:  https://api.vworkapp.com/"},"children":[]}]}]}]}],"sectionId":"/v5/section/getting-started/what-is-it"}],"sectionId":"/v5/section/getting-started/what-is-it"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/getting-started/what-does-stable-mean"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What does Stable mean?"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stable means that this version is final and is not going to change in the future, even if we add new features to the product."},"children":[]}]}]}]}],"sectionId":"/v5/section/getting-started/what-does-stable-mean"}],"sectionId":"/v5/section/getting-started/what-does-stable-mean"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/getting-started/what-can-you-build"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What can you build?"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vWork’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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also pull data from vWork’s API to produce a tailored management report."},"children":[]}]}]}]}],"sectionId":"/v5/section/getting-started/what-can-you-build"}],"sectionId":"/v5/section/getting-started/what-can-you-build"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/getting-started/getting-your-api-key"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting your API key"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to have a vWork account with the API enabled to obtain an API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you already have an API enabled vWork account, you can create your own API Key "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://go.vworkapp.com/html_client/admin/api"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here on the integrations page"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not yet have a vWork account, please "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.vworkapp.com/contact-us"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"get in touch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with us."},"children":[]}]}]}]}],"sectionId":"/v5/section/getting-started/getting-your-api-key"}],"sectionId":"/v5/section/getting-started/getting-your-api-key"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/need-more-help"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Need More Help?"},"children":[]}]}]}]}],"sectionId":"/v5/section/need-more-help"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/need-more-help/where-to-get-more-help"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where to get more help"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is a list of frequently asked questions on our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.vworkapp.com/forums/20898176"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"helpdesk"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page as well as "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://help.vworkapp.com/hc/en-us/articles/204087140"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a brief intro to the vWork API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you get stuck, please don't hesitate to send us an email at: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"mailto:support@vworkapp.com"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"support@vworkapp.com"},"children":[]}]}]}]}]}],"sectionId":"/v5/section/need-more-help/where-to-get-more-help"}],"sectionId":"/v5/section/need-more-help/where-to-get-more-help"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/need-more-help/mailing-list"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mailing List"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do you want to be emailed when we make a change to the API? You can "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.vworkapp.com/api_notes"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"signup for notifications about the vWork API here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". We don't email very often, but we will notify you about any changes, as well as notifications about both planned and unplanned outages."},"children":[]}]}]}]}],"sectionId":"/v5/section/need-more-help/mailing-list"}],"sectionId":"/v5/section/need-more-help/mailing-list"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/tech-notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tech Notes"},"children":[]}]}]}]}],"sectionId":"/v5/section/tech-notes"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/tech-notes/http-compression"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Compression"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure to specify HTTP compression may result in requests being rejected with a HTTP response of type 406/Not Acceptable."},"children":[]}]}]}]}]}],"sectionId":"/v5/section/tech-notes/http-compression"}],"sectionId":"/v5/section/tech-notes/http-compression"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/tech-notes/iso8601-format-note"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 Format Note"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When providing dates you must supply them in the following ISO8601 format: YYYY-MM-DDTHH:MM:SS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 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)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finally, you may need to url encode the date string depending on your environment (e.g. 2011-12-25T22%3A32%3A07%2B10)"},"children":[]}]}]}]}],"sectionId":"/v5/section/tech-notes/iso8601-format-note"}],"sectionId":"/v5/section/tech-notes/iso8601-format-note"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/tech-notes/error-codes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is an explanation of some of the error codes you may see when developing your integration."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP 401 (Authorization Required) is returned if you don’t have permission to call this service. Check that your api_key is correct."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP 404 (Not Found) is returned if the resource requested was not found."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP 406 (Not Acceptable) is returned if the request did not include headers for http compression."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP 422 (Unprocessable Entity) is returned if vWork wasn’t able to process the request body, for example when the XML is incorrectly formatted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP 500 (Server Error) is returned if a logic error was found, such as a required field is missing."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version='1.0' encoding='utf-8' ?>\n<errors>\n    <error>\n        <attribute>custom_fields.custom_field</attribute>\n        <message>&#39;tomorrow night&#39; must be a valid ISO8601 value.</message>\n    </error>\n</errors>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version='1.0' encoding='utf-8' ?>\n<errors>\n    <error>\n        <attribute>custom_fields.custom_field</attribute>\n        <message>&#39;tomorrow night&#39; must be a valid ISO8601 value.</message>\n    </error>\n</errors>\n"},"children":[]}]}]}],"sectionId":"/v5/section/tech-notes/error-codes"}],"sectionId":"/v5/section/tech-notes/error-codes"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/tech-notes/paging-results"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging Results"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the request: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.vworkapp.com/v4/jobs.xml?api_key=[API_KEY]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" might show the following header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<jobs type=\"array\" current_page=\"1\" per_page=\"50\" total_pages=\"3\" total_entries=\"112\">"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You are able to request more records per page using the per_page switch as per the following example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.vworkapp.com/v4/jobs.xml?api_key=[API_KEY]&per_page=200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or, request different pages like this: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.vworkapp.com/v4/jobs.xml?api_key=[API_KEY]&page=2"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please 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.)"},"children":[]}]}]}]}],"sectionId":"/v5/section/tech-notes/paging-results"}],"sectionId":"/v5/section/tech-notes/paging-results"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/tech-notes/the-use-of-templates"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Use of Templates"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We 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"},"children":[]}]}]}]}],"sectionId":"/v5/section/tech-notes/the-use-of-templates"}],"sectionId":"/v5/section/tech-notes/the-use-of-templates"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/tech-notes/password-strength"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Password Strength"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vWork 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 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."},"children":[]}]}]}]}],"sectionId":"/v5/section/tech-notes/password-strength"}],"sectionId":"/v5/section/tech-notes/password-strength"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]}]}]}],"sectionId":"/v5/section/webhooks"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/webhooks/what-are-webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What are Webhooks?"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For general information about Webhooks, see http://en.wikipedia.org/wiki/Webhook"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending 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."},"children":[]}]}]}]}],"sectionId":"/v5/section/webhooks/what-are-webhooks"}],"sectionId":"/v5/section/webhooks/what-are-webhooks"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/webhooks/what-webhooks-are-available"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What Webhooks are Available?"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please 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."},"children":[]}]}]}]}],"sectionId":"/v5/section/webhooks/what-webhooks-are-available"}],"sectionId":"/v5/section/webhooks/what-webhooks-are-available"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/webhooks/setting-up-webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting up Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You 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"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback endpoint will be provided and maintained by the API consumer, and should support SSL/TLS encryption."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Given 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(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.)"},"children":[]}]}]}]}],"sectionId":"/v5/section/webhooks/setting-up-webhooks"}],"sectionId":"/v5/section/webhooks/setting-up-webhooks"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/webhooks/sample-webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sample Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An example of a Job Created XML webhook is below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\"?>\n<event>\n  <transaction_id>617d4a74-7a19-11e6-bf7a-55542dc9080d</transaction_id>\n  <event_type>job_created</event_type>\n  <event_time>2016-09-14T01:20:10Z</event_time>\n  <resource>Job</resource>\n  <resource_id>9876234</resource_id>\n  <account_id>7829</account_id>\n  <request_user_type>User</request_user_type>\n  <request_user_id>123</request_user_id>\n</event>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\"?>\n<event>\n  <transaction_id>617d4a74-7a19-11e6-bf7a-55542dc9080d</transaction_id>\n  <event_type>job_created</event_type>\n  <event_time>2016-09-14T01:20:10Z</event_time>\n  <resource>Job</resource>\n  <resource_id>9876234</resource_id>\n  <account_id>7829</account_id>\n  <request_user_type>User</request_user_type>\n  <request_user_id>123</request_user_id>\n</event>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An example of a Job Created JSON webhook is below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\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"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\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"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An example of a Step Completed XML webhook is below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\"?>\n<event>\n  <transaction_id>63d75660-7a1a-11e6-8d5a-474090628a07</transaction_id>\n  <event_type>step_completed</event_type>\n  <event_time>2016-09-14T01:27:24Z</event_time>\n  <resource>Step</resource>\n  <resource_id>25062292</resource_id>\n  <account_id>8723</account_id>\n  <request_user_type>User</request_user_type>\n  <request_user_id>123</request_user_id>\n  <event_location>\n    <lat>-36.86524165519692</lat>\n    <lng>174.7806050757642</lng>\n  </event_location>\n  <data>\n    <step_name>Start Job</step_name>\n    <completed_at>2016-09-15T02:00:12Z</completed_at>\n    <job_id>8626773</job_id>\n  </data>\n</event>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\"?>\n<event>\n  <transaction_id>63d75660-7a1a-11e6-8d5a-474090628a07</transaction_id>\n  <event_type>step_completed</event_type>\n  <event_time>2016-09-14T01:27:24Z</event_time>\n  <resource>Step</resource>\n  <resource_id>25062292</resource_id>\n  <account_id>8723</account_id>\n  <request_user_type>User</request_user_type>\n  <request_user_id>123</request_user_id>\n  <event_location>\n    <lat>-36.86524165519692</lat>\n    <lng>174.7806050757642</lng>\n  </event_location>\n  <data>\n    <step_name>Start Job</step_name>\n    <completed_at>2016-09-15T02:00:12Z</completed_at>\n    <job_id>8626773</job_id>\n  </data>\n</event>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An example of a Step Completed JSON webhook is below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\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"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\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"},"children":[]}]}]}],"sectionId":"/v5/section/webhooks/sample-webhooks"}],"sectionId":"/v5/section/webhooks/sample-webhooks"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/webhooks/webhook-content"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Content"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks will always contain the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction_id - an internal vwork audit ID, can be ignored"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"event_type - the action that triggered the webhook"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"event_time - the time the server recieved the event, this may not be the time of the event (in UTC)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource - the resource that was updated: job, custom field, proof of delivery, step or user."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource_id - the vWork ID for the resource that was updated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account_id - the ID of your vWork account (can be useful if you are recieving webhooks for multiple accounts.)"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition, some webhooks may contain these extra fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource_third_party_id - The 3rd Party ID for the resource that was updated. Only present when a 3rd Party ID exists."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_worker_id - The ID of the worker the job is assigned to. Present on Job Accepted, Job Assigned and Job Reassigned Webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_worker_name - The name of the worker the job is assigned to. Present on Job Accepted, Job Assigned and Job Reassigned Webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_field_label - The label of the custom field that was updated. Only present on Custom Field Updated webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_field_value - The new value of the custom field that was updated. Only present on Custom Field Updated webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_field_type - The type of the custom field that was updated. Only present on Custom Field Updated webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_step_name - The name of the step that was updated. Only present on Step Completed and Step Uncompleted webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_completed_at - The time when the step was completed (in UTC). Only present on Step Completed webhook."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_paused_at - The time when the job was paused (in UTC). Only present on Job Paused webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_unpaused_at - The time when the job was unpaused (in UTC). Only present on Job Unpaused webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_signed_at - When the POD was signed. Only present on POD Created and Deleted webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_signed_by - Who Signed the POD. Only present on POD Created and Deleted webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_name - The name of the user. Only present on User Created and User Updated webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_email - The email address of the user. Only present on User Created and User Updated webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_phone - The phone number of the user. Only present on User Created and User Updated webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data_notes - Any notes saved against the user. Only present on User Created and User Updated webhooks."},"children":[]}]}]}]}]}]}],"sectionId":"/v5/section/webhooks/webhook-content"}],"sectionId":"/v5/section/webhooks/webhook-content"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/webhooks/webhook-reliability-and-monitoring"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Reliability and Monitoring"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Callbacks 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Various 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."},"children":[]}]}]}]}],"sectionId":"/v5/section/webhooks/webhook-reliability-and-monitoring"}],"sectionId":"/v5/section/webhooks/webhook-reliability-and-monitoring"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/webhooks/security-layer-hmac-sha"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security Layer - HMAC SHA"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As an example, the HMAC signature is generated in Ruby with this code:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), api_key, webhook.body)\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), api_key, webhook.body)\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your api key is 123 and the Webhook request body contents are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<job><name>test</name></job>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<job><name>test</name></job>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"using code like this:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), '123', '<job><name>test</name></job>')\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), '123', '<job><name>test</name></job>')\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the signature for this Webhook would be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"7643b9dbcab60ae6ae32e5683e1fae1db105bd31f1f0b5d51e5b773235359ff0\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"7643b9dbcab60ae6ae32e5683e1fae1db105bd31f1f0b5d51e5b773235359ff0\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please 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."},"children":[]}]}]}]}],"sectionId":"/v5/section/webhooks/security-layer-hmac-sha"}],"sectionId":"/v5/section/webhooks/security-layer-hmac-sha"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/postman"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman"},"children":[]}]}]}]}],"sectionId":"/v5/section/postman"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/postman/what-is-postman"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What is Postman?"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can download a copy from here: https://www.getpostman.com/"},"children":[]}]}]}]}],"sectionId":"/v5/section/postman/what-is-postman"}],"sectionId":"/v5/section/postman/what-is-postman"}]}]}},{"type":"group","label":"Getting Started","link":"/v5/section/getting-started","routeSlug":"/v5/section/getting-started","items":[{"type":"link","label":"What is it?","link":"/v5/section/getting-started/what-is-it","routeSlug":"/v5/section/getting-started/what-is-it","content":null},{"type":"link","label":"What does Stable mean?","link":"/v5/section/getting-started/what-does-stable-mean","routeSlug":"/v5/section/getting-started/what-does-stable-mean","content":null},{"type":"link","label":"What can you build?","link":"/v5/section/getting-started/what-can-you-build","routeSlug":"/v5/section/getting-started/what-can-you-build","content":null},{"type":"link","label":"Getting your API key","link":"/v5/section/getting-started/getting-your-api-key","routeSlug":"/v5/section/getting-started/getting-your-api-key","content":null}],"content":null},{"type":"group","label":"Need More Help?","link":"/v5/section/need-more-help","routeSlug":"/v5/section/need-more-help","items":[{"type":"link","label":"Where to get more help","link":"/v5/section/need-more-help/where-to-get-more-help","routeSlug":"/v5/section/need-more-help/where-to-get-more-help","content":null},{"type":"link","label":"Mailing List","link":"/v5/section/need-more-help/mailing-list","routeSlug":"/v5/section/need-more-help/mailing-list","content":null}],"content":null},{"type":"group","label":"Tech Notes","link":"/v5/section/tech-notes","routeSlug":"/v5/section/tech-notes","items":[{"type":"link","label":"HTTP Compression","link":"/v5/section/tech-notes/http-compression","routeSlug":"/v5/section/tech-notes/http-compression","content":null},{"type":"link","label":"ISO8601 Format Note","link":"/v5/section/tech-notes/iso8601-format-note","routeSlug":"/v5/section/tech-notes/iso8601-format-note","content":null},{"type":"link","label":"Error Codes","link":"/v5/section/tech-notes/error-codes","routeSlug":"/v5/section/tech-notes/error-codes","content":null},{"type":"link","label":"Paging Results","link":"/v5/section/tech-notes/paging-results","routeSlug":"/v5/section/tech-notes/paging-results","content":null},{"type":"link","label":"The Use of Templates","link":"/v5/section/tech-notes/the-use-of-templates","routeSlug":"/v5/section/tech-notes/the-use-of-templates","content":null},{"type":"link","label":"Password Strength","link":"/v5/section/tech-notes/password-strength","routeSlug":"/v5/section/tech-notes/password-strength","content":null}],"content":null},{"type":"group","label":"Webhooks","link":"/v5/section/webhooks","routeSlug":"/v5/section/webhooks","items":[{"type":"link","label":"What are Webhooks?","link":"/v5/section/webhooks/what-are-webhooks","routeSlug":"/v5/section/webhooks/what-are-webhooks","content":null},{"type":"link","label":"What Webhooks are Available?","link":"/v5/section/webhooks/what-webhooks-are-available","routeSlug":"/v5/section/webhooks/what-webhooks-are-available","content":null},{"type":"link","label":"Setting up Webhooks","link":"/v5/section/webhooks/setting-up-webhooks","routeSlug":"/v5/section/webhooks/setting-up-webhooks","content":null},{"type":"link","label":"Sample Webhooks","link":"/v5/section/webhooks/sample-webhooks","routeSlug":"/v5/section/webhooks/sample-webhooks","content":null},{"type":"link","label":"Webhook Content","link":"/v5/section/webhooks/webhook-content","routeSlug":"/v5/section/webhooks/webhook-content","content":null},{"type":"link","label":"Webhook Reliability and Monitoring","link":"/v5/section/webhooks/webhook-reliability-and-monitoring","routeSlug":"/v5/section/webhooks/webhook-reliability-and-monitoring","content":null},{"type":"link","label":"Security Layer - HMAC SHA","link":"/v5/section/webhooks/security-layer-hmac-sha","routeSlug":"/v5/section/webhooks/security-layer-hmac-sha","content":null}],"content":null},{"type":"group","label":"Postman","link":"/v5/section/postman","routeSlug":"/v5/section/postman","items":[{"type":"link","label":"What is Postman?","link":"/v5/section/postman/what-is-postman","routeSlug":"/v5/section/postman/what-is-postman","content":null}],"content":null},{"type":"separator","label":"Reference","content":null},{"type":"group","label":"Jobs","link":"/v5/jobs","routeSlug":"/v5/jobs","items":[],"content":{"contentType":"group","meta":{"name":"Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Jobs","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As the creation and management of jobs is such an extensive topic, we have split this out into two full documents of their own."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to easily create jobs from your existing templates, then you should use our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/v5-templated-jobs"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Templated Jobs API documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  Please note: this is the recommended way of creating new jobs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you need to search for, download, or update your jobs, then you should use our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/v5-jobs"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jobs API documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These 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."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs"}],"panels":[]}]}},{"type":"group","label":"Users","link":"/v5/users","routeSlug":"/v5/users","items":[{"label":"Create A New User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/users/create-a-new-user","routeSlug":"/v5/users/create-a-new-user","metadata":{"seo":{"title":"Create A New User","description":"Creates a new user in vWork."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-a-new-user","name":"Create A New User","isWebhook":false,"pointer":"/paths/~1v5~1users.xml/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A New User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new user in vWork."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1users.xml/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1users.xml/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1users.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1users.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1users.xml/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/users.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1users.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["201"],"pointer":"/v5/users.xml","href":"users/create-a-new-user","openApiOperationId":"create-a-new-user","summary":"Create A New User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1users.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1users.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1users.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1users.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_69"}],"pointer":"/paths/~1v5~1users.xml/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_68","exampleIds":["paths/~1v5~1users.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1users.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/create-a-new-user"}],"panels":[]}]},"httpPath":"/v5/users.xml"},{"label":"List All Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/users/list-all-users","routeSlug":"/v5/users/list-all-users","metadata":{"seo":{"title":"List All Users","description":"Lists all users, including their current permissions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-all-users","name":"List All Users","isWebhook":false,"pointer":"/paths/~1v5~1users.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all users, including their current permissions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1users.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1users.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/users.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/users.xml","href":"users/list-all-users","openApiOperationId":"list-all-users","summary":"List All Users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1users.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1users.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_70"}],"pointer":"/paths/~1v5~1users.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1users.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1users.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/list-all-users"}],"panels":[]}]},"httpPath":"/v5/users.xml"},{"label":"Retrieve A Specific User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/users/retrieve-a-specific-user","routeSlug":"/v5/users/retrieve-a-specific-user","metadata":{"seo":{"title":"Retrieve A Specific User","description":"Shows a user and all their associated permissions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-a-specific-user","name":"Retrieve A Specific User","isWebhook":false,"pointer":"/paths/~1v5~1users~1{id}.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve A Specific User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Shows a user and all their associated permissions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1users~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true},{"name":"use_third_party_id","in":"query","schemaId":"schema_71","description":"Sets the the call to look for a Third Party ID instead of the vWork ID.","example":"1"}],"pointer":"/paths/~1v5~1users~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1users~1{id}.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/users/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"},{"name":"use_third_party_id","in":"query","required":false,"example":"1","schemaId":"schema_71"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/users/{id}.xml","href":"users/retrieve-a-specific-user","openApiOperationId":"retrieve-a-specific-user","summary":"Retrieve A Specific User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1users~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1users~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_72"}],"pointer":"/paths/~1v5~1users~1{id}.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1users~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1users~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/retrieve-a-specific-user"}],"panels":[]}]},"httpPath":"/v5/users/{id}.xml"},{"label":"Update A Specific User","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/users/update-a-specific-user","routeSlug":"/v5/users/update-a-specific-user","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-a-specific-user","name":"Update A Specific User","isWebhook":false,"pointer":"/paths/~1v5~1users~1{id}.xml/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update A Specific User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a user's phone number, you might send the following XML."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<user>\n    <phone>1 555 111 1111</phone>\n</user>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<user>\n    <phone>1 555 111 1111</phone>\n</user>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remove a user's phone number, you might send the following XML."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<user>\n    <phone></phone>\n</user>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<user>\n    <phone></phone>\n</user>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a user's mobile permissions and remove their web permissions, you might send the following XML."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<user>\n   <permissions>\n        <admin>none</admin>\n        <schedule>none</schedule>\n        <map>none</map>\n        <reports>none</reports>\n        <jobs>none</jobs>\n        <customers>none</customers>\n        <quotes>none</quotes>\n        <equipment>none</equipment>\n        <messaging>none</messaging>\n        <mobile>full</mobile>\n        <mobile_jobs_create>full</mobile_jobs_create>\n        <mobile_jobs_assign>full</mobile_jobs_assign>\n        <mobile_invoice>full</mobile_invoice>\n    </permissions>\n</user>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<user>\n   <permissions>\n        <admin>none</admin>\n        <schedule>none</schedule>\n        <map>none</map>\n        <reports>none</reports>\n        <jobs>none</jobs>\n        <customers>none</customers>\n        <quotes>none</quotes>\n        <equipment>none</equipment>\n        <messaging>none</messaging>\n        <mobile>full</mobile>\n        <mobile_jobs_create>full</mobile_jobs_create>\n        <mobile_jobs_assign>full</mobile_jobs_assign>\n        <mobile_invoice>full</mobile_invoice>\n    </permissions>\n</user>\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1users~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true},{"name":"use_third_party_id","in":"query","schemaId":"schema_71","description":"Sets the the call to look for a Third Party ID instead of the vWork ID.","example":"'1'"}],"pointer":"/paths/~1v5~1users~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1users~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1users~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1users~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1users~1{id}.xml/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v5/users/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"},{"name":"use_third_party_id","in":"query","required":false,"example":"'1'","schemaId":"schema_71"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1users~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["200"],"pointer":"/v5/users/{id}.xml","href":"users/update-a-specific-user","openApiOperationId":"update-a-specific-user","summary":"Update A Specific User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1users~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1users~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1users~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1users~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_73"}],"pointer":"/paths/~1v5~1users~1{id}.xml/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1users~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1users~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/update-a-specific-user"}],"panels":[]}]},"httpPath":"/v5/users/{id}.xml"},{"label":"Delete A Specific User","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/users/delete-a-specific-user","routeSlug":"/v5/users/delete-a-specific-user","metadata":{"seo":{"title":"Delete A Specific User","description":"Deletes a user record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-a-specific-user","name":"Delete A Specific User","isWebhook":false,"pointer":"/paths/~1v5~1users~1{id}.xml/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete A Specific User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a user record."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1users~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true},{"name":"use_third_party_id","in":"query","schemaId":"schema_71","description":"Sets the the call to look for a Third Party ID instead of the vWork ID.","example":"1"}],"pointer":"/paths/~1v5~1users~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1users~1{id}.xml/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v5/users/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"},{"name":"use_third_party_id","in":"query","required":false,"example":"1","schemaId":"schema_71"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/users/{id}.xml","href":"users/delete-a-specific-user","openApiOperationId":"delete-a-specific-user","summary":"Delete A Specific User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"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"}},"headerSchemaId":"schema_74"}],"pointer":"/paths/~1v5~1users~1{id}.xml/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/delete-a-specific-user"}],"panels":[]}]},"httpPath":"/v5/users/{id}.xml"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here are the fields you can use when making a user request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique name of user, cannot be blank."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"third_party_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your unique ID for the user. (optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique email of user, cannot be blank."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mobile phone number of user. (Be sure to include the country code)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ancillary information about the user. (optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Password of user (Please refer to the tech note regarding password strength at the top of this doc)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"group_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of ids of groups this user shall be a member of. (optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permissions"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of permissions that allow the user to access various parts of vWork"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When 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)"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the user."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time user was last updated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time user was created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"latest_telemetry"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Latest telemetry for user."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"heading"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction (angle) the user is heading to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lat"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Latitude."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lng"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Longitude."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recorded_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Point of time when telemetry was recorded."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"speed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Speed in kilometers per hour (km/h)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shift_on"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is the worker currently on shift."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permissions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A user in vWork can be granted access to certain areas and actions by using the following permissions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available Permissions"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jobs"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full, none, read"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the user to access the jobs tab on the vWork website."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"schedule"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full, none, read"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the user to access the schedule tab on the vWork website."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"map"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full, none, read"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the user to access the map tab on the vWork website."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reports"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full, none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the user to access the reports tab on the vWork website."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customers"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full, none, read"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the user to access the customers tab on the vWork website."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equipment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full, none, read"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the user to access the equipment tab on the vWork website if the equipment module is enabled for the account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quotes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full, none, read"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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.)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"messaging"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full, none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the user to access the messaging tab on the vWork website. (Also allows all mobile users to message users with this permission.)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"admin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full, none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows full administration of the vWork account, content and settings."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mobile"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full, none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mobile_jobs_create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full, none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This permission allows the worker to create jobs using the mobile application, setting create will enable mobile automatically."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mobile_jobs_assign"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full, none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This permission allows the worker to assign jobs using the mobile application, setting assign will enable mobile and create automatically."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mobile_invoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full, none, read"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This permission allows the worker to work with invoices using the mobile application."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/users.xml","summary":"Create A New User","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/create-a-new-user","deprecated":false},{"title":"/v5/users.xml","summary":"List All Users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/list-all-users","deprecated":false},{"title":"/v5/users/{id}.xml","summary":"Retrieve A Specific User","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/retrieve-a-specific-user","deprecated":false},{"title":"/v5/users/{id}.xml","summary":"Update A Specific User","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/update-a-specific-user","deprecated":false},{"title":"/v5/users/{id}.xml","summary":"Delete A Specific User","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/delete-a-specific-user","deprecated":false}]}]}]}]}},{"type":"group","label":"Customers","link":"/v5/customers","routeSlug":"/v5/customers","items":[{"label":"Create A New Customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/customers/create-a-new-customer","routeSlug":"/v5/customers/create-a-new-customer","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-a-new-customer","name":"Create A New Customer","isWebhook":false,"pointer":"/paths/~1v5~1customers.xml/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A New Customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1customers.xml/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1customers.xml/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1customers.xml/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/customers.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["201"],"pointer":"/v5/customers.xml","href":"customers/create-a-new-customer","openApiOperationId":"create-a-new-customer","summary":"Create A New Customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_75"}],"pointer":"/paths/~1v5~1customers.xml/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_68","exampleIds":["paths/~1v5~1customers.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/create-a-new-customer"}],"panels":[]}]},"httpPath":"/v5/customers.xml"},{"label":"List All Customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/customers/list-all-customers","routeSlug":"/v5/customers/list-all-customers","metadata":{"seo":{"title":"List All Customers","description":"Lists all customers, including nested contacts for billing and delivery."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-all-customers","name":"List All Customers","isWebhook":false,"pointer":"/paths/~1v5~1customers.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Customers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all customers, including nested contacts for billing and delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It 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:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=created_at&sort_dir=desc"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=created_at&sort_dir=asc"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=updated_at&sort_dir=desc"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=updated_at&sort_dir=asc"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=id&sort_dir=desc"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=id&sort_dir=asc"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=name&sort_dir=asc"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=name&sort_dir=desc"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=third_party_id&sort_dir=asc"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://go.vworkapp.com/api/v5/customers.xml?api_key={{apikey}}&sort_by=third_party_id&sort_dir=desc"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1customers.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1customers.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/customers.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/customers.xml","href":"customers/list-all-customers","openApiOperationId":"list-all-customers","summary":"List All Customers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_76"}],"pointer":"/paths/~1v5~1customers.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1customers.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/list-all-customers"}],"panels":[]}]},"httpPath":"/v5/customers.xml"},{"label":"Retrieve A Specific Customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/customers/retrieve-a-specific-customer","routeSlug":"/v5/customers/retrieve-a-specific-customer","metadata":{"seo":{"title":"Retrieve A Specific Customer","description":"Retrieves the customer from vWork that has the given id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-a-specific-customer","name":"Retrieve A Specific Customer","isWebhook":false,"pointer":"/paths/~1v5~1customers~1{id}.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve A Specific Customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the customer from vWork that has the given id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1customers~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true},{"name":"use_third_party_id","in":"query","schemaId":"schema_77","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.","example":"true"}],"pointer":"/paths/~1v5~1customers~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1customers~1{id}.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/customers/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"},{"name":"use_third_party_id","in":"query","required":false,"example":"true","schemaId":"schema_77"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/customers/{id}.xml","href":"customers/retrieve-a-specific-customer","openApiOperationId":"retrieve-a-specific-customer","summary":"Retrieve A Specific Customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_78"}],"pointer":"/paths/~1v5~1customers~1{id}.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1customers~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/retrieve-a-specific-customer"}],"panels":[]}]},"httpPath":"/v5/customers/{id}.xml"},{"label":"Update A Specific Customer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/customers/update-a-specific-customer","routeSlug":"/v5/customers/update-a-specific-customer","metadata":{"seo":{"title":"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:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-a-specific-customer","name":"Update A Specific Customer","isWebhook":false,"pointer":"/paths/~1v5~1customers~1{id}.xml/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update A Specific Customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<customer>\n    <notes>Beware of the dog.</notes>\n</customer>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<customer>\n    <notes>Beware of the dog.</notes>\n</customer>\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1customers~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true},{"name":"use_third_party_id","in":"query","schemaId":"schema_77","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.","example":"true"}],"pointer":"/paths/~1v5~1customers~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1customers~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1customers~1{id}.xml/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v5/customers/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"},{"name":"use_third_party_id","in":"query","required":false,"example":"true","schemaId":"schema_77"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["200"],"pointer":"/v5/customers/{id}.xml","href":"customers/update-a-specific-customer","openApiOperationId":"update-a-specific-customer","summary":"Update A Specific Customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_78"}],"pointer":"/paths/~1v5~1customers~1{id}.xml/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1customers~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1customers~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/update-a-specific-customer"}],"panels":[]}]},"httpPath":"/v5/customers/{id}.xml"},{"label":"Delete A Specific Customer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/customers/delete-a-specific-customer","routeSlug":"/v5/customers/delete-a-specific-customer","metadata":{"seo":{"title":"Delete A Specific Customer","description":"Deletes the customer record with the given id. This cannot be undone."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-a-specific-customer","name":"Delete A Specific Customer","isWebhook":false,"pointer":"/paths/~1v5~1customers~1{id}.xml/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete A Specific Customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the customer record with the given id. This cannot be undone."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1customers~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true},{"name":"use_third_party_id","in":"query","schemaId":"schema_77","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.","example":"true"}],"pointer":"/paths/~1v5~1customers~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1customers~1{id}.xml/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v5/customers/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"},{"name":"use_third_party_id","in":"query","required":false,"example":"true","schemaId":"schema_77"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/customers/{id}.xml","href":"customers/delete-a-specific-customer","openApiOperationId":"delete-a-specific-customer","summary":"Delete A Specific Customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"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"}},"headerSchemaId":"schema_79"}],"pointer":"/paths/~1v5~1customers~1{id}.xml/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/delete-a-specific-customer"}],"panels":[]}]},"httpPath":"/v5/customers/{id}.xml"}],"content":{"contentType":"group","meta":{"name":"Customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here are the fields you can use when making a customer request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer's name. Can be either a person's full name or an organization's name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"third_party_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A text entry for notes about this customer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery_contact"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address and contact details for visiting the customer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery_contact.first_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact's first name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery_contact.last_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact's last name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery_contact.phone"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact's phone number."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery_contact.mobile"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact's mobile phone number. (Be sure to include the country code.)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery_contact.email"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact's email address."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery_location.formatted_address"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The formatted address of this location."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery_location.lat"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The latitude of the location."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery_location.lng"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The longitude of the location."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing_contact"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address and contact details for billing the customer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing_contact.first_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact's first name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing_contact.last_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact's last name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing_contact.phone"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact's phone number."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing_contact.mobile"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact's mobile phone number. (Be sure to include the country code.)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing_contact.email"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact's email address."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing_location.formatted_address"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The formatted address of this location."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing_location.lat"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The latitude of the location."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing_location.lng"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The longitude of the location."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When retrieving a customer from vWork, you may also see these additional fields in the response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of customer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time customer was created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time customer was last updated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time customer was deleted. (will be blank as deleted customers are not available via the API.)"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/customers.xml","summary":"Create A New Customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/create-a-new-customer","deprecated":false},{"title":"/v5/customers.xml","summary":"List All Customers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/list-all-customers","deprecated":false},{"title":"/v5/customers/{id}.xml","summary":"Retrieve A Specific Customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/retrieve-a-specific-customer","deprecated":false},{"title":"/v5/customers/{id}.xml","summary":"Update A Specific Customer","prefix":{"name":"put","color":"put"},"badges":[],"link":"/customers/update-a-specific-customer","deprecated":false},{"title":"/v5/customers/{id}.xml","summary":"Delete A Specific Customer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customers/delete-a-specific-customer","deprecated":false}]}]}]}]}},{"type":"group","label":"Customer's Custom Fields","link":"/v5/customer-custom-fields","routeSlug":"/v5/customer-custom-fields","items":[],"content":{"contentType":"group","meta":{"name":"Customer Custom Fields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer's Custom Fields","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"    <custom_fields type=\"array\">\n        <custom_field>\n            <name>Customer's Mother's Maiden Name</name>\n            <value>Smith</value>\n        </custom_field>\n    </custom_fields>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"    <custom_fields type=\"array\">\n        <custom_field>\n            <name>Customer's Mother's Maiden Name</name>\n            <value>Smith</value>\n        </custom_field>\n    </custom_fields>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If 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."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-custom-fields"}],"panels":[]}]}},{"type":"group","label":"Customer's Pricebook","link":"/v5/customer-pricebook","routeSlug":"/v5/customer-pricebook","items":[],"content":{"contentType":"group","meta":{"name":"Customer Pricebook"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer's Pricebook","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once this is done, you can see the pricebook ID on the customer GET as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"    <pricebook_id>54</pricebook_id>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"    <pricebook_id>54</pricebook_id>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"    <customer>\n        <pricebook_id>1188</pricebook_id>\n    </customer>\n\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"    <customer>\n        <pricebook_id>1188</pricebook_id>\n    </customer>\n\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note, that the values you supply will need to match the ID of a pricebook in your account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When 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."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-pricebook"}],"panels":[]}]}},{"type":"group","label":"Pick Lists","link":"/v5/pick-lists","routeSlug":"/v5/pick-lists","items":[{"label":"Create A New Pick List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/pick-lists/create-a-new-pick-list","routeSlug":"/v5/pick-lists/create-a-new-pick-list","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-a-new-pick-list","name":"Create A New Pick List","isWebhook":false,"pointer":"/paths/~1v5~1pick_lists.xml/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A New Pick List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pick_lists.xml/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1pick_lists.xml/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1pick_lists.xml/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/pick_lists.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["201"],"pointer":"/v5/pick_lists.xml","href":"pick-lists/create-a-new-pick-list","openApiOperationId":"create-a-new-pick-list","summary":"Create A New Pick List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_80"}],"pointer":"/paths/~1v5~1pick_lists.xml/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pick-lists/create-a-new-pick-list"}],"panels":[]}]},"httpPath":"/v5/pick_lists.xml"},{"label":"List All Pick Lists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/pick-lists/list-all-pick-lists","routeSlug":"/v5/pick-lists/list-all-pick-lists","metadata":{"seo":{"title":"List All Pick Lists","description":"Lists all pick lists in the account including their pick list items."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-all-pick-lists","name":"List All Pick Lists","isWebhook":false,"pointer":"/paths/~1v5~1pick_lists.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Pick Lists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all pick lists in the account including their pick list items."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pick_lists.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1pick_lists.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/pick_lists.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/pick_lists.xml","href":"pick-lists/list-all-pick-lists","openApiOperationId":"list-all-pick-lists","summary":"List All Pick Lists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_81"}],"pointer":"/paths/~1v5~1pick_lists.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pick-lists/list-all-pick-lists"}],"panels":[]}]},"httpPath":"/v5/pick_lists.xml"},{"label":"Retrieve A Specific Pick List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/pick-lists/retrieve-a-specific-pick-list","routeSlug":"/v5/pick-lists/retrieve-a-specific-pick-list","metadata":{"seo":{"title":"Retrieve A Specific Pick List","description":"Retrieves one pick list including its pick list items."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-a-specific-pick-list","name":"Retrieve A Specific Pick List","isWebhook":false,"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve A Specific Pick List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves one pick list including its pick list items."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/pick_lists/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/pick_lists/{id}.xml","href":"pick-lists/retrieve-a-specific-pick-list","openApiOperationId":"retrieve-a-specific-pick-list","summary":"Retrieve A Specific Pick List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_82"}],"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pick-lists/retrieve-a-specific-pick-list"}],"panels":[]}]},"httpPath":"/v5/pick_lists/{id}.xml"},{"label":"Update A Specific Pick List","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/pick-lists/update-a-specific-pick-list","routeSlug":"/v5/pick-lists/update-a-specific-pick-list","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-a-specific-pick-list","name":"Update A Specific Pick List","isWebhook":false,"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update A Specific Pick List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To add a new value include a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<pick_list_item>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" element without an id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change an existing value you must include the unique id of that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<pick_list_item>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" along with its new value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remove an existing value you must include the unique id of that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<pick_list_item>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" along with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<value/>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tag."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here are four common examples..."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To rename a pick list, you might send the following XML in a PUT to an existing pick list."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<pick_list>\n    <name>Delivery Progress</name>\n</pick_list>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<pick_list>\n    <name>Delivery Progress</name>\n</pick_list>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To add a new value to an existing pick list, you might send the following XML in a PUT to an existing pick list."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<pick_list>\n    <pick_list_items type=\"array\">\n        <pick_list_item>\n            <value>Not Delivered</value>\n        </pick_list_item>\n    </pick_list_items>\n</pick_list>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<pick_list>\n    <pick_list_items type=\"array\">\n        <pick_list_item>\n            <value>Not Delivered</value>\n        </pick_list_item>\n    </pick_list_items>\n</pick_list>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remove a value from an existing pick list, you might send the following XML in a PUT to an existing pick list."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<pick_list>\n    <pick_list_items type=\"array\">\n        <pick_list_item>\n            <id>1234</id>\n            <value/>\n        </pick_list_item>\n   </pick_list_items>\n</pick_list>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<pick_list>\n    <pick_list_items type=\"array\">\n        <pick_list_item>\n            <id>1234</id>\n            <value/>\n        </pick_list_item>\n   </pick_list_items>\n</pick_list>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update an existing value in an existing pick list, you might send the following XML in a PUT to an existing pick list."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<pick_list>\n    <pick_list_items type=\"array\">\n        <pick_list_item>\n            <id>2345</id>\n            <value>Delivered</value>\n        </pick_list_item>\n   </pick_list_items>\n</pick_list>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<pick_list>\n    <pick_list_items type=\"array\">\n        <pick_list_item>\n            <id>2345</id>\n            <value>Delivered</value>\n        </pick_list_item>\n   </pick_list_items>\n</pick_list>\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v5/pick_lists/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["200"],"pointer":"/v5/pick_lists/{id}.xml","href":"pick-lists/update-a-specific-pick-list","openApiOperationId":"update-a-specific-pick-list","summary":"Update A Specific Pick List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_83"}],"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pick_lists~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pick-lists/update-a-specific-pick-list"}],"panels":[]}]},"httpPath":"/v5/pick_lists/{id}.xml"},{"label":"Delete A Specific Pick List","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/pick-lists/delete-a-specific-pick-list","routeSlug":"/v5/pick-lists/delete-a-specific-pick-list","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-a-specific-pick-list","name":"Delete A Specific Pick List","isWebhook":false,"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete A Specific Pick List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v5/pick_lists/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/pick_lists/{id}.xml","href":"pick-lists/delete-a-specific-pick-list","openApiOperationId":"delete-a-specific-pick-list","summary":"Delete A Specific Pick List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"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"}},"headerSchemaId":"schema_84"}],"pointer":"/paths/~1v5~1pick_lists~1{id}.xml/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pick-lists/delete-a-specific-pick-list"}],"panels":[]}]},"httpPath":"/v5/pick_lists/{id}.xml"}],"content":{"contentType":"group","meta":{"name":"Pick Lists"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pick Lists","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vWork 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following calls allow you to administer the pick lists that are available in your account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here are the fields you can use when making a pick list request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable name used to identify the pick list in the vWork admin."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pick_list_items"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of values to populate the pick list"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pick_list_item.value"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value to include in the pick list"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When retrieving a pick list from vWork, you may also see these additional fields in the response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for this pick list. Auto-generated by vWork."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when this pick list was created. Format: ISO 8601."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when this pick list was last updated. Format: ISO 8601."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pick_list_items"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array containing all items of that pick list."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pick_list_item"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One pick list item object."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pick_list_item.id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for this pick list item. Auto-generated by vWork."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pick_list_item.value"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The text for this item."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pick_list_item.created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when this pick list item was created. Format: ISO 8601."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pick_list_item.updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when this pick list item was last updated. Format: ISO 8601."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/pick_lists.xml","summary":"Create A New Pick List","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pick-lists/create-a-new-pick-list","deprecated":false},{"title":"/v5/pick_lists.xml","summary":"List All Pick Lists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pick-lists/list-all-pick-lists","deprecated":false},{"title":"/v5/pick_lists/{id}.xml","summary":"Retrieve A Specific Pick List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pick-lists/retrieve-a-specific-pick-list","deprecated":false},{"title":"/v5/pick_lists/{id}.xml","summary":"Update A Specific Pick List","prefix":{"name":"put","color":"put"},"badges":[],"link":"/pick-lists/update-a-specific-pick-list","deprecated":false},{"title":"/v5/pick_lists/{id}.xml","summary":"Delete A Specific Pick List","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pick-lists/delete-a-specific-pick-list","deprecated":false}]}]}]}]}},{"type":"group","label":"Groups","link":"/v5/groups","routeSlug":"/v5/groups","items":[{"label":"Create A New Group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/groups/create-a-new-group","routeSlug":"/v5/groups/create-a-new-group","metadata":{"seo":{"title":"Create A New Group","description":"Creates a new group in vWork."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-a-new-group","name":"Create A New Group","isWebhook":false,"pointer":"/paths/~1v5~1groups.xml/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A New Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new group in vWork."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1groups.xml/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1groups.xml/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1groups.xml/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/groups.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["201"],"pointer":"/v5/groups.xml","href":"groups/create-a-new-group","openApiOperationId":"create-a-new-group","summary":"Create A New Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_85"}],"pointer":"/paths/~1v5~1groups.xml/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_68","exampleIds":["paths/~1v5~1groups.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/create-a-new-group"}],"panels":[]}]},"httpPath":"/v5/groups.xml"},{"label":"List All Groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/groups/list-all-groups","routeSlug":"/v5/groups/list-all-groups","metadata":{"seo":{"title":"List All Groups","description":"Lists all the groups in your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-all-groups","name":"List All Groups","isWebhook":false,"pointer":"/paths/~1v5~1groups.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all the groups in your account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1groups.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1groups.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/groups.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/groups.xml","href":"groups/list-all-groups","openApiOperationId":"list-all-groups","summary":"List All Groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_86"}],"pointer":"/paths/~1v5~1groups.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1groups.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/list-all-groups"}],"panels":[]}]},"httpPath":"/v5/groups.xml"},{"label":"Retrieve A Specific Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/groups/retrieve-a-specific-group","routeSlug":"/v5/groups/retrieve-a-specific-group","metadata":{"seo":{"title":"Retrieve A Specific Group","description":"Retrieve a specific group from your account, including a list of all users in that group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-a-specific-group","name":"Retrieve A Specific Group","isWebhook":false,"pointer":"/paths/~1v5~1groups~1{id}.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve A Specific Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific group from your account, including a list of all users in that group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1groups~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1groups~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1groups~1{id}.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/groups/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/groups/{id}.xml","href":"groups/retrieve-a-specific-group","openApiOperationId":"retrieve-a-specific-group","summary":"Retrieve A Specific Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_87"}],"pointer":"/paths/~1v5~1groups~1{id}.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1groups~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/retrieve-a-specific-group"}],"panels":[]}]},"httpPath":"/v5/groups/{id}.xml"},{"label":"Update A Specific Group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/groups/update-a-specific-group","routeSlug":"/v5/groups/update-a-specific-group","metadata":{"seo":{"title":"Update A Specific Group","description":"To rename an existing group, you might send the following XML as a PUT to a picklist."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-a-specific-group","name":"Update A Specific Group","isWebhook":false,"pointer":"/paths/~1v5~1groups~1{id}.xml/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update A Specific Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To rename an existing group, you might send the following XML as a PUT to a picklist."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<group>\n    <name>The Night Shift</name>\n</group>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<group>\n    <name>The Night Shift</name>\n</group>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remove everyone from an existing group, you might send the following XML as a PUT to a picklist."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<group>\n    <user_ids></user_ids>\n</group>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<group>\n    <user_ids></user_ids>\n</group>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update who is in the group, you might send the following XML as a PUT to a picklist."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<group>\n    <user_ids>1,2,3,4,5,6</user_ids>\n</group>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<group>\n    <user_ids>1,2,3,4,5,6</user_ids>\n</group>\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1groups~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1groups~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1groups~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1groups~1{id}.xml/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v5/groups/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["200"],"pointer":"/v5/groups/{id}.xml","href":"groups/update-a-specific-group","openApiOperationId":"update-a-specific-group","summary":"Update A Specific Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_88"}],"pointer":"/paths/~1v5~1groups~1{id}.xml/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1groups~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1groups~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/update-a-specific-group"}],"panels":[]}]},"httpPath":"/v5/groups/{id}.xml"},{"label":"Delete A Specific Group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/groups/delete-a-specific-group","routeSlug":"/v5/groups/delete-a-specific-group","metadata":{"seo":{"title":"Delete A Specific Group","description":"Deletes a group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-a-specific-group","name":"Delete A Specific Group","isWebhook":false,"pointer":"/paths/~1v5~1groups~1{id}.xml/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete A Specific Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1groups~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1groups~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1groups~1{id}.xml/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v5/groups/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/groups/{id}.xml","href":"groups/delete-a-specific-group","openApiOperationId":"delete-a-specific-group","summary":"Delete A Specific Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"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"}},"headerSchemaId":"schema_89"}],"pointer":"/paths/~1v5~1groups~1{id}.xml/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/delete-a-specific-group"}],"panels":[]}]},"httpPath":"/v5/groups/{id}.xml"}],"content":{"contentType":"group","meta":{"name":"Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Groups","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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…)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workers can belong to multiple groups, allowing them to receive work from different dispatchers."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispatchers can belong to multiple groups, allowing them to manage multiple workforces."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispatchers must belong to a group in order to see it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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.)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please ensure that all users belong to at least one group."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that groups is not enabled by default on all accounts. This feature needs to be enabled by our operations team."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here are the fields you can use when making a group request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The group's name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The group's description."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of ids of users you want to associate with this group."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When retrieving a group from vWork, you may also see these additional fields in the response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"group"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Group record."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of group."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time group was created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time group was last updated."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/groups.xml","summary":"Create A New Group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/groups/create-a-new-group","deprecated":false},{"title":"/v5/groups.xml","summary":"List All Groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/groups/list-all-groups","deprecated":false},{"title":"/v5/groups/{id}.xml","summary":"Retrieve A Specific Group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/groups/retrieve-a-specific-group","deprecated":false},{"title":"/v5/groups/{id}.xml","summary":"Update A Specific Group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/groups/update-a-specific-group","deprecated":false},{"title":"/v5/groups/{id}.xml","summary":"Delete A Specific Group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/groups/delete-a-specific-group","deprecated":false}]}]}]}]}},{"type":"group","label":"Attachments","link":"/v5/attachments","routeSlug":"/v5/attachments","items":[{"label":"Retrieve A Specific Attachment Image","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/attachments/retrieve-a-specific-attachment-image","routeSlug":"/v5/attachments/retrieve-a-specific-attachment-image","metadata":{"seo":{"title":"Retrieve A Specific Attachment Image","description":"Reads one attachment and returns a JPEG. You can find the attachment ID using the job API call."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-a-specific-attachment-image","name":"Retrieve A Specific Attachment Image","isWebhook":false,"pointer":"/paths/~1v5~1attachments~1{attachment_id}.jpeg/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve A Specific Attachment Image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reads one attachment and returns a JPEG. You can find the attachment ID using the job API call."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"attachment_id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1attachments~1{attachment_id}.jpeg/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1attachments~1{attachment_id}.jpeg/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1attachments~1{attachment_id}.jpeg/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/attachments/{attachment_id}.jpeg","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"attachment_id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/attachments/{attachment_id}.jpeg","href":"attachments/retrieve-a-specific-attachment-image","openApiOperationId":"retrieve-a-specific-attachment-image","summary":"Retrieve A Specific Attachment Image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"image/jpeg","mediaTypes":["image/jpeg"],"mediaTypeContent":{"image/jpeg":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1attachments~1{attachment_id}.jpeg/get/responses/200/content/image~1jpeg/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1attachments~1{attachment_id}.jpeg/get/responses/200/content/image~1jpeg/examples/response"],"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"}},"headerSchemaId":"schema_90"}],"pointer":"/paths/~1v5~1attachments~1{attachment_id}.jpeg/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1attachments~1{attachment_id}.jpeg/get/responses/200/content/image~1jpeg/examples/response"],"mediaTypes":["image/jpeg"],"mediaTypeContent":{"image/jpeg":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1attachments~1{attachment_id}.jpeg/get/responses/200/content/image~1jpeg/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/retrieve-a-specific-attachment-image"}],"panels":[]}]},"httpPath":"/v5/attachments/{attachment_id}.jpeg"}],"content":{"contentType":"group","meta":{"name":"Attachments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attachments","showPageActions":true},{"nodeType":"markdoc","content":"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."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/attachments/{attachment_id}.jpeg","summary":"Retrieve A Specific Attachment Image","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attachments/retrieve-a-specific-attachment-image","deprecated":false}]}]}]}]}},{"type":"group","label":"Signatures","link":"/v5/signatures","routeSlug":"/v5/signatures","items":[{"label":"Retrieve A Specific Signature Image","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/signatures/retrieve-a-specific-signature-image","routeSlug":"/v5/signatures/retrieve-a-specific-signature-image","metadata":{"seo":{"title":"Retrieve A Specific Signature Image","description":"Reads one signature and returns a PNG. You can find the signature ID using the job API call."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-a-specific-signature-image","name":"Retrieve A Specific Signature Image","isWebhook":false,"pointer":"/paths/~1v5~1signatures~1{signature_id}.png/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve A Specific Signature Image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reads one signature and returns a PNG. You can find the signature ID using the job API call."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"signature_id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1signatures~1{signature_id}.png/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1signatures~1{signature_id}.png/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1signatures~1{signature_id}.png/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/signatures/{signature_id}.png","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"signature_id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/signatures/{signature_id}.png","href":"signatures/retrieve-a-specific-signature-image","openApiOperationId":"retrieve-a-specific-signature-image","summary":"Retrieve A Specific Signature Image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"image/png","mediaTypes":["image/png"],"mediaTypeContent":{"image/png":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1signatures~1{signature_id}.png/get/responses/200/content/image~1png/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1signatures~1{signature_id}.png/get/responses/200/content/image~1png/examples/response"],"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"}},"headerSchemaId":"schema_91"}],"pointer":"/paths/~1v5~1signatures~1{signature_id}.png/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1signatures~1{signature_id}.png/get/responses/200/content/image~1png/examples/response"],"mediaTypes":["image/png"],"mediaTypeContent":{"image/png":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1signatures~1{signature_id}.png/get/responses/200/content/image~1png/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/signatures/retrieve-a-specific-signature-image"}],"panels":[]}]},"httpPath":"/v5/signatures/{signature_id}.png"}],"content":{"contentType":"group","meta":{"name":"Signatures"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Signatures","showPageActions":true},{"nodeType":"markdoc","content":"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."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/signatures/{signature_id}.png","summary":"Retrieve A Specific Signature Image","prefix":{"name":"get","color":"get"},"badges":[],"link":"/signatures/retrieve-a-specific-signature-image","deprecated":false}]}]}]}]}},{"type":"group","label":"Proof of Delivery","link":"/v5/proof-of-delivery","routeSlug":"/v5/proof-of-delivery","items":[{"label":"Retrieve A Specific POD Image","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/proof-of-delivery/retrieve-a-specific-pod-image","routeSlug":"/v5/proof-of-delivery/retrieve-a-specific-pod-image","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-a-specific-pod-image","name":"Retrieve A Specific POD Image","isWebhook":false,"pointer":"/paths/~1v5~1jobs~1{id}~1proof_of_delivery.png/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve A Specific POD Image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1jobs~1{id}~1proof_of_delivery.png/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true},{"name":"use_third_party_id","in":"query","schemaId":"schema_77","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.","example":"true"}],"pointer":"/paths/~1v5~1jobs~1{id}~1proof_of_delivery.png/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1jobs~1{id}~1proof_of_delivery.png/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/jobs/{id}/proof_of_delivery.png","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"},{"name":"use_third_party_id","in":"query","required":false,"example":"true","schemaId":"schema_77"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/jobs/{id}/proof_of_delivery.png","href":"proof-of-delivery/retrieve-a-specific-pod-image","openApiOperationId":"retrieve-a-specific-pod-image","summary":"Retrieve A Specific POD Image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"image/png","mediaTypes":["image/png"],"mediaTypeContent":{"image/png":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1jobs~1{id}~1proof_of_delivery.png/get/responses/200/content/image~1png/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1jobs~1{id}~1proof_of_delivery.png/get/responses/200/content/image~1png/examples/response"],"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"}},"headerSchemaId":"schema_92"}],"pointer":"/paths/~1v5~1jobs~1{id}~1proof_of_delivery.png/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1jobs~1{id}~1proof_of_delivery.png/get/responses/200/content/image~1png/examples/response"],"mediaTypes":["image/png"],"mediaTypeContent":{"image/png":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1jobs~1{id}~1proof_of_delivery.png/get/responses/200/content/image~1png/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-of-delivery/retrieve-a-specific-pod-image"}],"panels":[]}]},"httpPath":"/v5/jobs/{id}/proof_of_delivery.png"}],"content":{"contentType":"group","meta":{"name":"Proof of Delivery"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proof of Delivery","showPageActions":true},{"nodeType":"markdoc","content":"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.)"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/jobs/{id}/proof_of_delivery.png","summary":"Retrieve A Specific POD Image","prefix":{"name":"get","color":"get"},"badges":[],"link":"/proof-of-delivery/retrieve-a-specific-pod-image","deprecated":false}]}]}]}]}},{"type":"group","label":"Pricebooks","link":"/v5/pricebooks","routeSlug":"/v5/pricebooks","items":[{"label":"Create A New Pricebook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/pricebooks/create-a-new-pricebook","routeSlug":"/v5/pricebooks/create-a-new-pricebook","metadata":{"seo":{"title":"Create A New Pricebook","description":"Creates a new pricebook in vWork."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-a-new-pricebook","name":"Create A New Pricebook","isWebhook":false,"pointer":"/paths/~1v5~1pricebooks.xml/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A New Pricebook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new pricebook in vWork."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pricebooks.xml/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1pricebooks.xml/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebooks.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebooks.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1pricebooks.xml/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/pricebooks.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebooks.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["201"],"pointer":"/v5/pricebooks.xml","href":"pricebooks/create-a-new-pricebook","openApiOperationId":"create-a-new-pricebook","summary":"Create A New Pricebook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebooks.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebooks.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebooks.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebooks.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_69"}],"pointer":"/paths/~1v5~1pricebooks.xml/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebooks.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebooks.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pricebooks/create-a-new-pricebook"}],"panels":[]}]},"httpPath":"/v5/pricebooks.xml"},{"label":"List All Pricebooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/pricebooks/list-all-pricebooks","routeSlug":"/v5/pricebooks/list-all-pricebooks","metadata":{"seo":{"title":"List All Pricebooks","description":"Lists all pricebooks"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-all-pricebooks","name":"List All Pricebooks","isWebhook":false,"pointer":"/paths/~1v5~1pricebooks.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Pricebooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all pricebooks"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pricebooks.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1pricebooks.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/pricebooks.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/pricebooks.xml","href":"pricebooks/list-all-pricebooks","openApiOperationId":"list-all-pricebooks","summary":"List All Pricebooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebooks.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebooks.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_70"}],"pointer":"/paths/~1v5~1pricebooks.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebooks.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebooks.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pricebooks/list-all-pricebooks"}],"panels":[]}]},"httpPath":"/v5/pricebooks.xml"},{"label":"Retrieve A Specific Pricebook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/pricebooks/retrieve-a-specific-pricebook","routeSlug":"/v5/pricebooks/retrieve-a-specific-pricebook","metadata":{"seo":{"title":"Retrieve A Specific Pricebook","description":"Shows a specific pricebook"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-a-specific-pricebook","name":"Retrieve A Specific Pricebook","isWebhook":false,"pointer":"/paths/~1v5~1pricebook~1{id}.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve A Specific Pricebook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Shows a specific pricebook"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pricebook~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pricebook~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1pricebook~1{id}.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/pricebook/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/pricebook/{id}.xml","href":"pricebooks/retrieve-a-specific-pricebook","openApiOperationId":"retrieve-a-specific-pricebook","summary":"Retrieve A Specific Pricebook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebook~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebook~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_72"}],"pointer":"/paths/~1v5~1pricebook~1{id}.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebook~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebook~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pricebooks/retrieve-a-specific-pricebook"}],"panels":[]}]},"httpPath":"/v5/pricebook/{id}.xml"},{"label":"Update A Specific Pricebook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/pricebooks/update-a-specific-pricebook","routeSlug":"/v5/pricebooks/update-a-specific-pricebook","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-a-specific-pricebook","name":"Update A Specific Pricebook","isWebhook":false,"pointer":"/paths/~1v5~1pricebook~1{id}.xml/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update A Specific Pricebook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a pricebook's name, you might send the following XML."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<pricebook>\n    <name>pricebook 75</name>\n</pricebook>  \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<pricebook>\n    <name>pricebook 75</name>\n</pricebook>  \n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remove a pricebook's description, you might send the following XML."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<pricebook>\n    <description>This is pricebook number 75</description>\n</pricebook>  \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<pricebook>\n    <description>This is pricebook number 75</description>\n</pricebook>  \n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To add an item to a pricebook, you might send the following XML."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pricebook>\n    <pricebook_items type=\"array\">\n        <pricebook_item>\n            <code>4</code>\n            <description>Description 4</description>\n            <price>45.0</price>\n        </pricebook_item>\n    </pricebook_items>\n</pricebook>  \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pricebook>\n    <pricebook_items type=\"array\">\n        <pricebook_item>\n            <code>4</code>\n            <description>Description 4</description>\n            <price>45.0</price>\n        </pricebook_item>\n    </pricebook_items>\n</pricebook>  \n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update an existing item, you would need to include the item ID in the PUT, as per below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pricebook>\n    <pricebook_items type=\"array\">\n        <pricebook_item>\n            <id>89776</id>\n            <code>3</code>\n            <description>Description 3</description>\n            <price>49.95</price>\n        </pricebook_item>\n    </pricebook_items>\n</pricebook>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pricebook>\n    <pricebook_items type=\"array\">\n        <pricebook_item>\n            <id>89776</id>\n            <code>3</code>\n            <description>Description 3</description>\n            <price>49.95</price>\n        </pricebook_item>\n    </pricebook_items>\n</pricebook>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remove an existing item from a pricebook, you would PUT the following XML:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pricebook>\n    <pricebook_items type=\"array\">\n        <pricebook_item>\n            <id>89776</id>\n            <_destroy>true</_destroy>\n        </pricebook_item>\n    </pricebook_items>\n</pricebook>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pricebook>\n    <pricebook_items type=\"array\">\n        <pricebook_item>\n            <id>89776</id>\n            <_destroy>true</_destroy>\n        </pricebook_item>\n    </pricebook_items>\n</pricebook>\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pricebook~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pricebook~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1pricebook~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebook~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebook~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1pricebook~1{id}.xml/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v5/pricebook/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebook~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["200"],"pointer":"/v5/pricebook/{id}.xml","href":"pricebooks/update-a-specific-pricebook","openApiOperationId":"update-a-specific-pricebook","summary":"Update A Specific Pricebook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebook~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebook~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebook~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebook~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_73"}],"pointer":"/paths/~1v5~1pricebook~1{id}.xml/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebook~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1pricebook~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pricebooks/update-a-specific-pricebook"}],"panels":[]}]},"httpPath":"/v5/pricebook/{id}.xml"},{"label":"Delete A Specific Pricebook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/pricebooks/delete-a-specific-pricebook","routeSlug":"/v5/pricebooks/delete-a-specific-pricebook","metadata":{"seo":{"title":"Delete A Specific Pricebook","description":"Deletes a pricebook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-a-specific-pricebook","name":"Delete A Specific Pricebook","isWebhook":false,"pointer":"/paths/~1v5~1pricebook~1{id}.xml/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete A Specific Pricebook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a pricebook."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pricebook~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1pricebook~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1pricebook~1{id}.xml/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v5/pricebook/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/pricebook/{id}.xml","href":"pricebooks/delete-a-specific-pricebook","openApiOperationId":"delete-a-specific-pricebook","summary":"Delete A Specific Pricebook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"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"}},"headerSchemaId":"schema_74"}],"pointer":"/paths/~1v5~1pricebook~1{id}.xml/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pricebooks/delete-a-specific-pricebook"}],"panels":[]}]},"httpPath":"/v5/pricebook/{id}.xml"}],"content":{"contentType":"group","meta":{"name":"Pricebooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pricebooks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricebooks are simply an easy way to define what items are available to be added to an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricebooks can contain up to 2000 items, each item has a code, description and unit cost."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are using our customer specific pricebooks features, you can also inherit the pricebook from the customer record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following web services can be used to create, update, delete and search for pricebooks within vWork."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here are the fields you can use when making a pricebook request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique name of pricebook, cannot be blank."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A user friendly description of the pricebook, should not be blank."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricebook_items"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of values to populate the pricebook"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricebook_item.code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The item code to include in the pick list"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricebook_item.description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The item description to include in the pick list"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricebook_item.price"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The item value to include in the pick list"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When retrieving a priceboook from vWork, you may also see these additional fields in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the pricebook. Auto-generated by vWork."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricebook_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the pricebook. Auto-generated by vWork."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of your account. Auto-generated by vWork."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of each item in the pricebook. Auto-generated by vWork."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/pricebooks.xml","summary":"Create A New Pricebook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pricebooks/create-a-new-pricebook","deprecated":false},{"title":"/v5/pricebooks.xml","summary":"List All Pricebooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pricebooks/list-all-pricebooks","deprecated":false},{"title":"/v5/pricebook/{id}.xml","summary":"Retrieve A Specific Pricebook","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pricebooks/retrieve-a-specific-pricebook","deprecated":false},{"title":"/v5/pricebook/{id}.xml","summary":"Update A Specific Pricebook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/pricebooks/update-a-specific-pricebook","deprecated":false},{"title":"/v5/pricebook/{id}.xml","summary":"Delete A Specific Pricebook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pricebooks/delete-a-specific-pricebook","deprecated":false}]}]}]}]}},{"type":"group","label":"Equipment","link":"/v5/equipment","routeSlug":"/v5/equipment","items":[{"label":"Create A New Piece of Equipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/equipment/create-a-new-piece-of-equipment","routeSlug":"/v5/equipment/create-a-new-piece-of-equipment","metadata":{"seo":{"title":"Create A New Piece of Equipment","description":"Creates a new piece of equipment in vWork."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-a-new-piece-of-equipment","name":"Create A New Piece of Equipment","isWebhook":false,"pointer":"/paths/~1v5~1equipment.xml/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A New Piece of Equipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new piece of equipment in vWork."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1equipment.xml/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1equipment.xml/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1equipment.xml/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/equipment.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["201"],"pointer":"/v5/equipment.xml","href":"equipment/create-a-new-piece-of-equipment","openApiOperationId":"create-a-new-piece-of-equipment","summary":"Create A New Piece of Equipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_69"}],"pointer":"/paths/~1v5~1equipment.xml/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/equipment/create-a-new-piece-of-equipment"}],"panels":[]}]},"httpPath":"/v5/equipment.xml"},{"label":"List All Equipment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/equipment/list-all-equipment","routeSlug":"/v5/equipment/list-all-equipment","metadata":{"seo":{"title":"List All Equipment","description":"Lists all equipment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-all-equipment","name":"List All Equipment","isWebhook":false,"pointer":"/paths/~1v5~1equipment.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Equipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all equipment"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1equipment.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1equipment.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/equipment.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/equipment.xml","href":"equipment/list-all-equipment","openApiOperationId":"list-all-equipment","summary":"List All Equipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_70"}],"pointer":"/paths/~1v5~1equipment.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/equipment/list-all-equipment"}],"panels":[]}]},"httpPath":"/v5/equipment.xml"},{"label":"Retrieve A Specific Piece of Equipment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/equipment/retrieve-a-specific-piece-of-equipment","routeSlug":"/v5/equipment/retrieve-a-specific-piece-of-equipment","metadata":{"seo":{"title":"Retrieve A Specific Piece of Equipment","description":"Shows a specific piece of equipment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-a-specific-piece-of-equipment","name":"Retrieve A Specific Piece of Equipment","isWebhook":false,"pointer":"/paths/~1v5~1equipment~1{id}.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve A Specific Piece of Equipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Shows a specific piece of equipment"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1equipment~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true},{"name":"use_third_party_id","in":"query","schemaId":"schema_71","description":"Sets the the call to look for a Third Party ID instead of the vWork ID.","example":"1"}],"pointer":"/paths/~1v5~1equipment~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1equipment~1{id}.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/equipment/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"},{"name":"use_third_party_id","in":"query","required":false,"example":"1","schemaId":"schema_71"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/equipment/{id}.xml","href":"equipment/retrieve-a-specific-piece-of-equipment","openApiOperationId":"retrieve-a-specific-piece-of-equipment","summary":"Retrieve A Specific Piece of Equipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_72"}],"pointer":"/paths/~1v5~1equipment~1{id}.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/equipment/retrieve-a-specific-piece-of-equipment"}],"panels":[]}]},"httpPath":"/v5/equipment/{id}.xml"},{"label":"Update A Specific Piece of Equipment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/equipment/update-a-specific-piece-of-equipment","routeSlug":"/v5/equipment/update-a-specific-piece-of-equipment","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-a-specific-piece-of-equipment","name":"Update A Specific Piece of Equipment","isWebhook":false,"pointer":"/paths/~1v5~1equipment~1{id}.xml/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update A Specific Piece of Equipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update the name of a piece of equipment, you might send the following XML."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<equipment>\n    <name>Forklift 2</name>\n</equipment> \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<equipment>\n    <name>Forklift 2</name>\n</equipment> \n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update the Third Party ID, you might send the following XML."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<equipment>\n    <third_party_id>ABCDEF</third_party_id>\n</equipment> \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<equipment>\n    <third_party_id>ABCDEF</third_party_id>\n</equipment> \n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1equipment~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true},{"name":"use_third_party_id","in":"query","schemaId":"schema_71","description":"Sets the the call to look for a Third Party ID instead of the vWork ID.","example":"1"}],"pointer":"/paths/~1v5~1equipment~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1equipment~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1equipment~1{id}.xml/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v5/equipment/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"},{"name":"use_third_party_id","in":"query","required":false,"example":"1","schemaId":"schema_71"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["200"],"pointer":"/v5/equipment/{id}.xml","href":"equipment/update-a-specific-piece-of-equipment","openApiOperationId":"update-a-specific-piece-of-equipment","summary":"Update A Specific Piece of Equipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_73"}],"pointer":"/paths/~1v5~1equipment~1{id}.xml/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1equipment~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/equipment/update-a-specific-piece-of-equipment"}],"panels":[]}]},"httpPath":"/v5/equipment/{id}.xml"},{"label":"Delete A Specific Piece of Equipment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/equipment/delete-a-specific-piece-of-equipment","routeSlug":"/v5/equipment/delete-a-specific-piece-of-equipment","metadata":{"seo":{"title":"Delete A Specific Piece of Equipment","description":"Deletes a piece of equipment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-a-specific-piece-of-equipment","name":"Delete A Specific Piece of Equipment","isWebhook":false,"pointer":"/paths/~1v5~1equipment~1{id}.xml/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete A Specific Piece of Equipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a piece of equipment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1equipment~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true},{"name":"use_third_party_id","in":"query","schemaId":"schema_71","description":"Sets the the call to look for a Third Party ID instead of the vWork ID.","example":"1"}],"pointer":"/paths/~1v5~1equipment~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1equipment~1{id}.xml/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v5/equipment/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"},{"name":"use_third_party_id","in":"query","required":false,"example":"1","schemaId":"schema_71"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/equipment/{id}.xml","href":"equipment/delete-a-specific-piece-of-equipment","openApiOperationId":"delete-a-specific-piece-of-equipment","summary":"Delete A Specific Piece of Equipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"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"}},"headerSchemaId":"schema_74"}],"pointer":"/paths/~1v5~1equipment~1{id}.xml/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/equipment/delete-a-specific-piece-of-equipment"}],"panels":[]}]},"httpPath":"/v5/equipment/{id}.xml"}],"content":{"contentType":"group","meta":{"name":"Equipment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Equipment","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equipment is an optional feature that allows dispatchers to schedule both mobile workers and equipment required for jobs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, you may need to schedule Bob, the Forklift, Truck 23 and Trailer 15 for a specific job."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once this feature is enabled and your equipment has been setup, you can then assign equipment to your jobs as needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following web services can be used to create, update, delete and search for equipment within vWork."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here are the fields you can use when making an equipment request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique name of equipment, this is what will be displayed on the schedule, cannot be blank."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"third_party_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your unique ID for the equipment. (optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"model"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the equipment. (optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ancillary information about the equipment. (optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serial"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The serial number of the equipment. (optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tag_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of ids of tags this equipment shall have.* (optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"group_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of ids of groups this equipment shall be a member of. (optional)"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*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)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When retrieving equipment from vWork, you may also see these additional fields in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the equipment. Auto-generated by vWork."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of your account. Auto-generated by vWork."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/equipment.xml","summary":"Create A New Piece of Equipment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/equipment/create-a-new-piece-of-equipment","deprecated":false},{"title":"/v5/equipment.xml","summary":"List All Equipment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/equipment/list-all-equipment","deprecated":false},{"title":"/v5/equipment/{id}.xml","summary":"Retrieve A Specific Piece of Equipment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/equipment/retrieve-a-specific-piece-of-equipment","deprecated":false},{"title":"/v5/equipment/{id}.xml","summary":"Update A Specific Piece of Equipment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/equipment/update-a-specific-piece-of-equipment","deprecated":false},{"title":"/v5/equipment/{id}.xml","summary":"Delete A Specific Piece of Equipment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/equipment/delete-a-specific-piece-of-equipment","deprecated":false}]}]}]}]}},{"type":"group","label":"Assets","link":"/v5/assets","routeSlug":"/v5/assets","items":[{"label":"Create A New Asset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/assets/create-a-new-asset","routeSlug":"/v5/assets/create-a-new-asset","metadata":{"seo":{"title":"Create A New Asset","description":"Creates a new asset in vWork."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-a-new-asset","name":"Create A New Asset","isWebhook":false,"pointer":"/paths/~1v5~1assets.xml/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A New Asset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new asset in vWork."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1assets.xml/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1assets.xml/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1assets.xml/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/assets.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["201"],"pointer":"/v5/assets.xml","href":"assets/create-a-new-asset","openApiOperationId":"create-a-new-asset","summary":"Create A New Asset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_69"}],"pointer":"/paths/~1v5~1assets.xml/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_68","exampleIds":["paths/~1v5~1assets.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/create-a-new-asset"}],"panels":[]}]},"httpPath":"/v5/assets.xml"},{"label":"List All Assets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/assets/list-all-assets","routeSlug":"/v5/assets/list-all-assets","metadata":{"seo":{"title":"List All Assets","description":"Lists all assets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-all-assets","name":"List All Assets","isWebhook":false,"pointer":"/paths/~1v5~1assets.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Assets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all assets."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1assets.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1assets.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/assets.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/assets.xml","href":"assets/list-all-assets","openApiOperationId":"list-all-assets","summary":"List All Assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_70"}],"pointer":"/paths/~1v5~1assets.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1assets.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/list-all-assets"}],"panels":[]}]},"httpPath":"/v5/assets.xml"},{"label":"Retrieve A Specific Asset","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/assets/retrieve-a-specific-asset","routeSlug":"/v5/assets/retrieve-a-specific-asset","metadata":{"seo":{"title":"Retrieve A Specific Asset","description":"Shows a specific asset"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-a-specific-asset","name":"Retrieve A Specific Asset","isWebhook":false,"pointer":"/paths/~1v5~1assets~1{id}.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve A Specific Asset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Shows a specific asset"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1assets~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true},{"name":"use_third_party_id","in":"query","schemaId":"schema_71","description":"Sets the the call to look for a Third Party ID instead of the vWork ID.","example":"1"}],"pointer":"/paths/~1v5~1assets~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1assets~1{id}.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/assets/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"},{"name":"use_third_party_id","in":"query","required":false,"example":"1","schemaId":"schema_71"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/assets/{id}.xml","href":"assets/retrieve-a-specific-asset","openApiOperationId":"retrieve-a-specific-asset","summary":"Retrieve A Specific Asset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_72"}],"pointer":"/paths/~1v5~1assets~1{id}.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1assets~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/retrieve-a-specific-asset"}],"panels":[]}]},"httpPath":"/v5/assets/{id}.xml"},{"label":"Update A Specific Asset","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/assets/update-a-specific-asset","routeSlug":"/v5/assets/update-a-specific-asset","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-a-specific-asset","name":"Update A Specific Asset","isWebhook":false,"pointer":"/paths/~1v5~1assets~1{id}.xml/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update A Specific Asset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update an asset's group, you might send the following XML."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<asset>\n <group_ids>2908</group_ids>\n</asset>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<asset>\n <group_ids>2908</group_ids>\n</asset>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remove an asset's group, you might send the following XML."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<asset>\n <group_ids></group_ids>\n</asset>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<asset>\n <group_ids></group_ids>\n</asset>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change the name of an asset, you might send the following XML."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<asset>\n    <name>Smith St Rose Garden</name>\n</asset>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<asset>\n    <name>Smith St Rose Garden</name>\n</asset>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To disable an asset, you might send the following XML."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<asset>\n    <enabled>false</enabled>\n</asset>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<asset>\n    <enabled>false</enabled>\n</asset>\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1assets~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true},{"name":"use_third_party_id","in":"query","schemaId":"schema_71","description":"Sets the the call to look for a Third Party ID instead of the vWork ID.","example":"'1'"}],"pointer":"/paths/~1v5~1assets~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1assets~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1assets~1{id}.xml/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v5/assets/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"},{"name":"use_third_party_id","in":"query","required":false,"example":"'1'","schemaId":"schema_71"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["200"],"pointer":"/v5/assets/{id}.xml","href":"assets/update-a-specific-asset","openApiOperationId":"update-a-specific-asset","summary":"Update A Specific Asset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_73"}],"pointer":"/paths/~1v5~1assets~1{id}.xml/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1assets~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1assets~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/update-a-specific-asset"}],"panels":[]}]},"httpPath":"/v5/assets/{id}.xml"},{"label":"Delete A Specific Asset","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/assets/delete-a-specific-asset","routeSlug":"/v5/assets/delete-a-specific-asset","metadata":{"seo":{"title":"Delete A Specific Asset","description":"Deletes an asset."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-a-specific-asset","name":"Delete A Specific Asset","isWebhook":false,"pointer":"/paths/~1v5~1assets~1{id}.xml/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete A Specific Asset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an asset."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1assets~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true},{"name":"use_third_party_id","in":"query","schemaId":"schema_71","description":"Sets the the call to look for a Third Party ID instead of the vWork ID.","example":"1"}],"pointer":"/paths/~1v5~1assets~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1assets~1{id}.xml/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v5/assets/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"},{"name":"use_third_party_id","in":"query","required":false,"example":"1","schemaId":"schema_71"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/assets/{id}.xml","href":"assets/delete-a-specific-asset","openApiOperationId":"delete-a-specific-asset","summary":"Delete A Specific Asset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"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"}},"headerSchemaId":"schema_74"}],"pointer":"/paths/~1v5~1assets~1{id}.xml/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/delete-a-specific-asset"}],"panels":[]}]},"httpPath":"/v5/assets/{id}.xml"}],"content":{"contentType":"group","meta":{"name":"Assets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assets","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assets is an optional feature that allows you to maintain a database of customer owned assets and information associated with them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following web services can be used to create, update, delete and search for assets within vWork."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here are the fields you can use when making an asset request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique name of asset, cannot be blank."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"third_party_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your unique ID for the asset. (optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"model"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the asset. (optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serial"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The serial number of the asset. (optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ancillary information about the asset. (optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"group_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of ids of groups this asset shall be a member of.  (optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the customer who owns the asset."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cost"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hourly cost of the asset (optional, not currently used)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"location.formatted_address"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The formatted address of this location."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"location.lat"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The latitude of the location."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"location.lng"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The longitude of the location."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the asset is enabled or disbled. It is not possible to create jobs for disabled assets."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When 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.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the asset."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attachment_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the asset's attached image.  This can only be upload via the web interface."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/assets.xml","summary":"Create A New Asset","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/create-a-new-asset","deprecated":false},{"title":"/v5/assets.xml","summary":"List All Assets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/list-all-assets","deprecated":false},{"title":"/v5/assets/{id}.xml","summary":"Retrieve A Specific Asset","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/retrieve-a-specific-asset","deprecated":false},{"title":"/v5/assets/{id}.xml","summary":"Update A Specific Asset","prefix":{"name":"put","color":"put"},"badges":[],"link":"/assets/update-a-specific-asset","deprecated":false},{"title":"/v5/assets/{id}.xml","summary":"Delete A Specific Asset","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/assets/delete-a-specific-asset","deprecated":false}]}]}]}]}},{"type":"group","label":"Asset Custom Fields","link":"/v5/asset-custom-fields","routeSlug":"/v5/asset-custom-fields","items":[],"content":{"contentType":"group","meta":{"name":"Asset Custom Fields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Custom Fields","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <custom_fields type=\"array\">\n        <custom_field>\n            <name>Last Service</name>\n            <value>July 15th 2020</value>\n        </custom_field>\n    </custom_fields>\n</asset>    \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <custom_fields type=\"array\">\n        <custom_field>\n            <name>Last Service</name>\n            <value>July 15th 2020</value>\n        </custom_field>\n    </custom_fields>\n</asset>    \n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If 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."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-custom-fields"}],"panels":[]}]}},{"type":"group","label":"Asset Time Windows","link":"/v5/asset-time-windows","routeSlug":"/v5/asset-time-windows","items":[],"content":{"contentType":"group","meta":{"name":"Asset Time Windows"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Time Windows","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time windows are an optional feature that is enabled with route optimisation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time 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:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<time_windows type=\"array\">\n    <time_window>\n        <start_time>28800</start_time>\n        <end_time>46800</end_time>\n        <day_of_week>6</day_of_week>\n    </time_window>\n    <time_window>\n        <start_time>28800</start_time>\n        <end_time>46800</end_time>\n        <day_of_week>0</day_of_week>\n    </time_window>\n</time_windows>\n<negative_time_windows>true</negative_time_windows>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<time_windows type=\"array\">\n    <time_window>\n        <start_time>28800</start_time>\n        <end_time>46800</end_time>\n        <day_of_week>6</day_of_week>\n    </time_window>\n    <time_window>\n        <start_time>28800</start_time>\n        <end_time>46800</end_time>\n        <day_of_week>0</day_of_week>\n    </time_window>\n</time_windows>\n<negative_time_windows>true</negative_time_windows>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The days of the week start from Sunday as day 0, so Monday is day 1 and Sunday is day 6."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start time and end time are in seconds from midnight, so 8am is 28800 and 1pm is 46800."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You 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:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<time_windows type=\"array\">\n    <time_window>\n        <start_time>32400</start_time>\n        <end_time>43200</end_time>\n        <day_of_week>1</day_of_week>\n    </time_window>\n        <time_window>\n        <start_time>32400</start_time>\n        <end_time>43200</end_time>\n        <day_of_week>3</day_of_week>\n    </time_window>\n    <time_window>\n        <start_time>32400</start_time>\n        <end_time>43200</end_time>\n        <day_of_week>5</day_of_week>\n    </time_window>\n</time_windows>\n<negative_time_windows>false</negative_time_windows>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<time_windows type=\"array\">\n    <time_window>\n        <start_time>32400</start_time>\n        <end_time>43200</end_time>\n        <day_of_week>1</day_of_week>\n    </time_window>\n        <time_window>\n        <start_time>32400</start_time>\n        <end_time>43200</end_time>\n        <day_of_week>3</day_of_week>\n    </time_window>\n    <time_window>\n        <start_time>32400</start_time>\n        <end_time>43200</end_time>\n        <day_of_week>5</day_of_week>\n    </time_window>\n</time_windows>\n<negative_time_windows>false</negative_time_windows>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day and time logic works the same way, but negative time windows are set to false instead of true."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We will also warn dispatchers if they manually schedule a job that breaks one of these rules, but won't prevent it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you wish to remove a time window from an asset, you would PUT the following XML:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <time_windows type=\"array\">\n        <time_window>\n            <id>5198001</id>\n            <_destroy>true</_destroy>\n        </time_window>\n    </time_windows>\n</asset>   \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <time_windows type=\"array\">\n        <time_window>\n            <id>5198001</id>\n            <_destroy>true</_destroy>\n        </time_window>\n    </time_windows>\n</asset>   \n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you wish to remove all time windows from an asset, then you can PUT an empty array, like so:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <time_windows type=\"array\">\n    </time_windows>\n</asset>    \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <time_windows type=\"array\">\n    </time_windows>\n</asset>    \n"},"children":[]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-time-windows"}],"panels":[]}]}},{"type":"group","label":"Asset Tags","link":"/v5/asset-tags","routeSlug":"/v5/asset-tags","items":[],"content":{"contentType":"group","meta":{"name":"Asset Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Tags","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags are a subset of vWork's Health and Safety module and are generally not enabled by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you need to include a tag on the asset, you can PUT or POST an array of tag IDs in the job XML."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following example adds tag 123 and tag 456 to the asset."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<taggings type=\"array\">\n  <tagging>\n  <tag_id>123</tag_id>\n  </tagging>\n    <tagging>\n  <tag_id>456</tag_id>\n  </tagging>\n</taggings>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<taggings type=\"array\">\n  <tagging>\n  <tag_id>123</tag_id>\n  </tagging>\n    <tagging>\n  <tag_id>456</tag_id>\n  </tagging>\n</taggings>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To 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.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <taggings type=\"array\">\n        <tagging>\n            <id>11407022</id>\n            <_destroy>true</_destroy>\n        </tagging>\n    </taggings>\n</asset>   \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <taggings type=\"array\">\n        <tagging>\n            <id>11407022</id>\n            <_destroy>true</_destroy>\n        </tagging>\n    </taggings>\n</asset>   \n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you wish to remove all tags from an asset, then you can PUT an empty array, like so:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <taggings type=\"array\">\n    </taggings>\n</asset>    \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <taggings type=\"array\">\n    </taggings>\n</asset>    \n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve a list of tags for your account via the API using the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/v5/hs-managing-tags"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tags route"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-tags"}],"panels":[]}]}},{"type":"group","label":"Asset Hazards","link":"/v5/asset-hazards","routeSlug":"/v5/asset-hazards","items":[],"content":{"contentType":"group","meta":{"name":"Asset Hazards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Hazards","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<enable_hazards>true</enable_hazards>\n<hazards type=\"array\">\n    <hazard>\n        <description>Risk of Explosion</description>\n    </hazard>\n</hazards>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<enable_hazards>true</enable_hazards>\n<hazards type=\"array\">\n    <hazard>\n        <description>Risk of Explosion</description>\n    </hazard>\n</hazards>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If 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.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<enable_hazards>true</enable_hazards>\n<hazards type=\"array\">\n    <hazard>\n            <description>Risk of Explosion</description>\n            <fields type=\"array\">\n                <field>\n                    <type>risk_picklist</type>\n                    <label>Initial Risk</label>\n                    <value>High</value>\n                </field>\n                <field>\n                    <type>risk_picklist</type>\n                    <label>Residual Risk</label>\n                    <value>Low</value>\n                </field>\n                <field>\n                    <type>control_picklist</type>\n                    <label>Control Type</label>\n                    <value>Eliminate the Hazard</value>\n                </field>\n                <field>\n                    <type>text</type>\n                    <label>Controls Required</label>\n                    <value>Shut down all power feeds to circuits being worked on.</value>\n                </field>\n                <field>\n                    <type>text</type>\n                    <label>Person Responsible</label>\n                    <value>Fred Smith</value>\n                </field>\n            </fields>\n    </hazard>\n</hazards>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<enable_hazards>true</enable_hazards>\n<hazards type=\"array\">\n    <hazard>\n            <description>Risk of Explosion</description>\n            <fields type=\"array\">\n                <field>\n                    <type>risk_picklist</type>\n                    <label>Initial Risk</label>\n                    <value>High</value>\n                </field>\n                <field>\n                    <type>risk_picklist</type>\n                    <label>Residual Risk</label>\n                    <value>Low</value>\n                </field>\n                <field>\n                    <type>control_picklist</type>\n                    <label>Control Type</label>\n                    <value>Eliminate the Hazard</value>\n                </field>\n                <field>\n                    <type>text</type>\n                    <label>Controls Required</label>\n                    <value>Shut down all power feeds to circuits being worked on.</value>\n                </field>\n                <field>\n                    <type>text</type>\n                    <label>Person Responsible</label>\n                    <value>Fred Smith</value>\n                </field>\n            </fields>\n    </hazard>\n</hazards>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remove a hazard from an asset, you would PUT the following XML to the asset."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <hazards type=\"array\">\n        <hazard>\n            <id>1733042</id>\n            <_destroy>true</_destroy>\n        </hazard>\n    </hazards>\n</asset>   \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <hazards type=\"array\">\n        <hazard>\n            <id>1733042</id>\n            <_destroy>true</_destroy>\n        </hazard>\n    </hazards>\n</asset>   \n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remove all hazards from an asset, you can PUT an empty hazard array, like so:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <hazards type=\"array\">\n    </hazards>\n</asset>    \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <hazards type=\"array\">\n    </hazards>\n</asset>    \n"},"children":[]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-hazards"}],"panels":[]}]}},{"type":"group","label":"Asset Line Items","link":"/v5/asset-line-items","routeSlug":"/v5/asset-line-items","items":[],"content":{"contentType":"group","meta":{"name":"Asset Line Items"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Line Items","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If invoicing is enabled for your account, you can add invoice line items to an asset."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To do so, you need to specify the following XML in a POST or PUT to the asset."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vWork will then include these line items in any jobs for the asset where invoicing is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <invoice>\n        <line_items type=\"array\">\n            <line_item>\n                <code>foo</code>\n                <description>bar</description>\n                <unit_cost>100.0</unit_cost>\n                <requested_quantity>1.0</requested_quantity>\n                <actual_quantity>1.0</actual_quantity>\n            </line_item>\n        </line_items>\n    </invoice>\n</asset>    \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <invoice>\n        <line_items type=\"array\">\n            <line_item>\n                <code>foo</code>\n                <description>bar</description>\n                <unit_cost>100.0</unit_cost>\n                <requested_quantity>1.0</requested_quantity>\n                <actual_quantity>1.0</actual_quantity>\n            </line_item>\n        </line_items>\n    </invoice>\n</asset>    \n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you wish to edit an existing item, please submit the full array of invoice line items with the updated information, like so:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <invoice>\n        <line_items type=\"array\">\n            <line_item>\n                <code>foo</code>\n                <description>bar2</description>\n                <unit_cost>100.0</unit_cost>\n                <requested_quantity>1.0</requested_quantity>\n                <actual_quantity>1.0</actual_quantity>\n            </line_item>\n            <line_item>\n                <code>bar</code>\n                <description>whatsit2</description>\n                <unit_cost>100.0</unit_cost>\n                <requested_quantity>1.0</requested_quantity>\n                <actual_quantity>1.0</actual_quantity>\n            </line_item>\n        </line_items>\n    </invoice>\n</asset>    \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <invoice>\n        <line_items type=\"array\">\n            <line_item>\n                <code>foo</code>\n                <description>bar2</description>\n                <unit_cost>100.0</unit_cost>\n                <requested_quantity>1.0</requested_quantity>\n                <actual_quantity>1.0</actual_quantity>\n            </line_item>\n            <line_item>\n                <code>bar</code>\n                <description>whatsit2</description>\n                <unit_cost>100.0</unit_cost>\n                <requested_quantity>1.0</requested_quantity>\n                <actual_quantity>1.0</actual_quantity>\n            </line_item>\n        </line_items>\n    </invoice>\n</asset>    \n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If 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:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n   <invoice>\n        <id>1865860</id>\n        <line_items type=\"array\">\n            <line_item>\n                <id>3550124</id>\n                <_destroy>true</_destroy>\n            </line_item>\n            <line_item>\n                <id>3550125</id>\n                <_destroy>true</_destroy>\n            </line_item>\n        </line_items>\n    </invoice>\n</asset>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n   <invoice>\n        <id>1865860</id>\n        <line_items type=\"array\">\n            <line_item>\n                <id>3550124</id>\n                <_destroy>true</_destroy>\n            </line_item>\n            <line_item>\n                <id>3550125</id>\n                <_destroy>true</_destroy>\n            </line_item>\n        </line_items>\n    </invoice>\n</asset>\n"},"children":[]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-line-items"}],"panels":[]}]}},{"type":"group","label":"Message Threads","link":"/v5/message-threads","routeSlug":"/v5/message-threads","items":[{"label":"Create A New Message Thread","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/message-threads/create-a-new-message-thread","routeSlug":"/v5/message-threads/create-a-new-message-thread","metadata":{"seo":{"title":"Create A New Message Thread","description":"Creates a new message thread (including an initial message) in vWork."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-a-new-message-thread","name":"Create A New Message Thread","isWebhook":false,"pointer":"/paths/~1v5~1messaging.xml/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A New Message Thread","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new message thread (including an initial message) in vWork."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1messaging.xml/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1messaging.xml/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1messaging.xml/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/messaging.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["201"],"pointer":"/v5/messaging.xml","href":"message-threads/create-a-new-message-thread","openApiOperationId":"create-a-new-message-thread","summary":"Create A New Message Thread"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_93"}],"pointer":"/paths/~1v5~1messaging.xml/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/message-threads/create-a-new-message-thread"}],"panels":[]}]},"httpPath":"/v5/messaging.xml"},{"label":"List All Message Threads","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/message-threads/list-all-message-threads","routeSlug":"/v5/message-threads/list-all-message-threads","metadata":{"seo":{"title":"List All Message Threads","description":"Lists threads."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-all-message-threads","name":"List All Message Threads","isWebhook":false,"pointer":"/paths/~1v5~1messaging.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Message Threads","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists threads."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1messaging.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1messaging.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/messaging.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/messaging.xml","href":"message-threads/list-all-message-threads","openApiOperationId":"list-all-message-threads","summary":"List All Message Threads"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_94"}],"pointer":"/paths/~1v5~1messaging.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/message-threads/list-all-message-threads"}],"panels":[]}]},"httpPath":"/v5/messaging.xml"},{"label":"Retrieve A Specific Message Thread","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/message-threads/retrieve-a-specific-message-thread","routeSlug":"/v5/message-threads/retrieve-a-specific-message-thread","metadata":{"seo":{"title":"Retrieve A Specific Message Thread","description":"Retrieves a thread and all it's associated messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-a-specific-message-thread","name":"Retrieve A Specific Message Thread","isWebhook":false,"pointer":"/paths/~1v5~1messaging~1{id}.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve A Specific Message Thread","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a thread and all it's associated messages."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1messaging~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1messaging~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1messaging~1{id}.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/messaging/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/messaging/{id}.xml","href":"message-threads/retrieve-a-specific-message-thread","openApiOperationId":"retrieve-a-specific-message-thread","summary":"Retrieve A Specific Message Thread"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_95"}],"pointer":"/paths/~1v5~1messaging~1{id}.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/message-threads/retrieve-a-specific-message-thread"}],"panels":[]}]},"httpPath":"/v5/messaging/{id}.xml"},{"label":"Delete A Specific Message Thread","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/message-threads/delete-a-specific-message-thread","routeSlug":"/v5/message-threads/delete-a-specific-message-thread","metadata":{"seo":{"title":"Delete A Specific Message Thread","description":"Completely removes thread. Removes all messages related to thread. (This action is not undoable, proceed with caution)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-a-specific-message-thread","name":"Delete A Specific Message Thread","isWebhook":false,"pointer":"/paths/~1v5~1messaging~1{id}.xml/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete A Specific Message Thread","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completely removes thread. Removes all messages related to thread. (This action is not undoable, proceed with caution)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1messaging~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1messaging~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1messaging~1{id}.xml/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v5/messaging/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/messaging/{id}.xml","href":"message-threads/delete-a-specific-message-thread","openApiOperationId":"delete-a-specific-message-thread","summary":"Delete A Specific Message Thread"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"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"}},"headerSchemaId":"schema_96"}],"pointer":"/paths/~1v5~1messaging~1{id}.xml/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/message-threads/delete-a-specific-message-thread"}],"panels":[]}]},"httpPath":"/v5/messaging/{id}.xml"}],"content":{"contentType":"group","meta":{"name":"Message Threads"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Message Threads","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Messages are sent from worker to dispatcher and vice versa. Messages are contained within a message thread."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add or delete messages threads using this API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here are the fields you can use when making a message request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"job_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional job ID that the message thread relates to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"job_third_party_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional job Third Party ID that the message thread relates to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of ids of users you want to the message to be available to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subject"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subject for the thread."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"messages"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of messages to add to the thread."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message.from_user_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User ID for initial thread message. (Optional)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message.from_user_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name of message creator. Only used (and required) if from_user_id is blank."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message.body"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body for the inital thread message."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When retrieving a message from vWork, you may also see these additional fields in the response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of thread."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"summary"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Summary of latest thread contents (Used internally and set automatically.)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last_reply_user_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User ID of last reply."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last_reply_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time thread was last replied to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time thread was created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time thread was last updated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"messages"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of all messages in the thread."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_by_user_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User ID of thread creator."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message.id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique Message ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message.read_by_user_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of IDs of users that have read the message."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message.received_by_user_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of IDs of users that have received this message on their mobile devices."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message.created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time message was created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message.updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time message was last updated."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/messaging.xml","summary":"Create A New Message Thread","prefix":{"name":"post","color":"post"},"badges":[],"link":"/message-threads/create-a-new-message-thread","deprecated":false},{"title":"/v5/messaging.xml","summary":"List All Message Threads","prefix":{"name":"get","color":"get"},"badges":[],"link":"/message-threads/list-all-message-threads","deprecated":false},{"title":"/v5/messaging/{id}.xml","summary":"Retrieve A Specific Message Thread","prefix":{"name":"get","color":"get"},"badges":[],"link":"/message-threads/retrieve-a-specific-message-thread","deprecated":false},{"title":"/v5/messaging/{id}.xml","summary":"Delete A Specific Message Thread","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/message-threads/delete-a-specific-message-thread","deprecated":false}]}]}]}]}},{"type":"group","label":"Messages","link":"/v5/messages","routeSlug":"/v5/messages","items":[{"label":"Create A New Message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/messages/create-a-new-message","routeSlug":"/v5/messages/create-a-new-message","metadata":{"seo":{"title":"Create A New Message","description":"Creates a new message for an existing thread in vWork."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-a-new-message","name":"Create A New Message","isWebhook":false,"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages.xml/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A New Message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new message for an existing thread in vWork."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"thread_id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/messaging/{thread_id}/messages.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"thread_id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["201"],"pointer":"/v5/messaging/{thread_id}/messages.xml","href":"messages/create-a-new-message","openApiOperationId":"create-a-new-message","summary":"Create A New Message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_97"}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/create-a-new-message"}],"panels":[]}]},"httpPath":"/v5/messaging/{thread_id}/messages.xml"},{"label":"List All Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/messages/list-all-messages","routeSlug":"/v5/messages/list-all-messages","metadata":{"seo":{"title":"List All Messages","description":"Lists all messages in a specifc thread."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-all-messages","name":"List All Messages","isWebhook":false,"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all messages in a specifc thread."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"thread_id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages.xml/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/messaging/{thread_id}/messages.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"thread_id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/messaging/{thread_id}/messages.xml","href":"messages/list-all-messages","openApiOperationId":"list-all-messages","summary":"List All Messages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_98"}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/list-all-messages"}],"panels":[]}]},"httpPath":"/v5/messaging/{thread_id}/messages.xml"},{"label":"Retrieve A Specific Message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/messages/retrieve-a-specific-message","routeSlug":"/v5/messages/retrieve-a-specific-message","metadata":{"seo":{"title":"Retrieve A Specific Message","description":"Retrieves a specific message"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-a-specific-message","name":"Retrieve A Specific Message","isWebhook":false,"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve A Specific Message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specific message"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"thread_id","in":"path","schemaId":"schema_66","description":"","required":true},{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/messaging/{thread_id}/messages/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"thread_id","in":"path","required":true,"schemaId":"schema_66"},{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/messaging/{thread_id}/messages/{id}.xml","href":"messages/retrieve-a-specific-message","openApiOperationId":"retrieve-a-specific-message","summary":"Retrieve A Specific Message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_99"}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/retrieve-a-specific-message"}],"panels":[]}]},"httpPath":"/v5/messaging/{thread_id}/messages/{id}.xml"},{"label":"Delete A Specific Message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/messages/delete-a-specific-message","routeSlug":"/v5/messages/delete-a-specific-message","metadata":{"seo":{"title":"Delete A Specific Message","description":"Completely removes a message from a thread. (This action is not able to be undone, proceed with caution)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-a-specific-message","name":"Delete A Specific Message","isWebhook":false,"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete A Specific Message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completely removes a message from a thread. (This action is not able to be undone, proceed with caution)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"thread_id","in":"path","schemaId":"schema_66","description":"","required":true},{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v5/messaging/{thread_id}/messages/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"thread_id","in":"path","required":true,"schemaId":"schema_66"},{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/messaging/{thread_id}/messages/{id}.xml","href":"messages/delete-a-specific-message","openApiOperationId":"delete-a-specific-message","summary":"Delete A Specific Message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"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"}},"headerSchemaId":"schema_100"}],"pointer":"/paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/delete-a-specific-message"}],"panels":[]}]},"httpPath":"/v5/messaging/{thread_id}/messages/{id}.xml"}],"content":{"contentType":"group","meta":{"name":"Messages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Messages","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here are the fields you can use when making a message request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"body"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message content"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from_user_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User ID that posts this message"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from_user_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name of message creator. If from_user_id is blank then this can be any value you like, but will be mandatory."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When retrieving a message from vWork, you may also see these additional fields in the response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message record"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of message"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"thread_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Messages Thread ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read_by_user_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of ids of users that have read this message."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"received_by_user_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of ids of users that have received this message."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time thread was created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time thread was last updated."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/messaging/{thread_id}/messages.xml","summary":"Create A New Message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/messages/create-a-new-message","deprecated":false},{"title":"/v5/messaging/{thread_id}/messages.xml","summary":"List All Messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/messages/list-all-messages","deprecated":false},{"title":"/v5/messaging/{thread_id}/messages/{id}.xml","summary":"Retrieve A Specific Message","prefix":{"name":"get","color":"get"},"badges":[],"link":"/messages/retrieve-a-specific-message","deprecated":false},{"title":"/v5/messaging/{thread_id}/messages/{id}.xml","summary":"Delete A Specific Message","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/messages/delete-a-specific-message","deprecated":false}]}]}]}]}},{"type":"group","label":"Route Optimisation - User Management","link":"/v5/route-optimisation-user-management","routeSlug":"/v5/route-optimisation-user-management","items":[],"content":{"contentType":"group","meta":{"name":"Route Optimisation - User Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Route Optimisation - User Management","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"    <start_location>\n        <formatted_address>18 Railway Street, Newmarket, Auckland, New Zealand</formatted_address>\n        <lat>-36.865387</lat>\n        <lng>174.780437</lng>\n    </start_location>\n\n    <end_location>\n        <formatted_address>18 Railway Street, Newmarket, Auckland, New Zealand</formatted_address>\n        <lat>-36.865387</lat>\n        <lng>174.780437</lng>\n    <end_location>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"    <start_location>\n        <formatted_address>18 Railway Street, Newmarket, Auckland, New Zealand</formatted_address>\n        <lat>-36.865387</lat>\n        <lng>174.780437</lng>\n    </start_location>\n\n    <end_location>\n        <formatted_address>18 Railway Street, Newmarket, Auckland, New Zealand</formatted_address>\n        <lat>-36.865387</lat>\n        <lng>174.780437</lng>\n    <end_location>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, if you are replacing an existing location in a PUT, you will need to include the current location ID as per this example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<user>\n   <start_location>\n        <id>27570362</id>\n        <formatted_address>18 Railway Street, Newmarket, Auckland, New Zealand</formatted_address>\n        <lat>-36.865387</lat>\n        <lng>174.780437</lng>\n    </start_location>\n</user>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<user>\n   <start_location>\n        <id>27570362</id>\n        <formatted_address>18 Railway Street, Newmarket, Auckland, New Zealand</formatted_address>\n        <lat>-36.865387</lat>\n        <lng>174.780437</lng>\n    </start_location>\n</user>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capacity 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capacity 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To set capacity for a user simply include the value in a PUT or POST to the user, like so:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<capacity>100</capacity>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<capacity>100</capacity>\n"},"children":[]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/route-optimisation-user-management"}],"panels":[]}]}},{"type":"group","label":"Route Optimisation - Job Options","link":"/v5/route-optimisation-job-options","routeSlug":"/v5/route-optimisation-job-options","items":[],"content":{"contentType":"group","meta":{"name":"Route Optimisation - Job Options"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Route Optimisation - Job Options","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are creating jobs from scratch you can view the documentation for these options "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/v5-jobs/jobs-and-time-windows"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are creating jobs via the API and referencing an existing job template in your account, then you can find the relevant documentation "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/v5-templated-jobs/jobs-and-time-windows"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/route-optimisation-job-options"}],"panels":[]}]}},{"type":"group","label":"H&S - Managing Tags","link":"/v5/hs-managing-tags","routeSlug":"/v5/hs-managing-tags","items":[{"label":"Create A New Tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/hs-managing-tags/create-a-new-tag","routeSlug":"/v5/hs-managing-tags/create-a-new-tag","metadata":{"seo":{"title":"Create A New Tag","description":"Creates a new tag in vWork."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-a-new-tag","name":"Create A New Tag","isWebhook":false,"pointer":"/paths/~1v5~1tags.xml/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A New Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new tag in vWork."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1tags.xml/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1tags.xml/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1tags.xml/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v5/tags.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["201"],"pointer":"/v5/tags.xml","href":"hs-managing-tags/create-a-new-tag","openApiOperationId":"create-a-new-tag","summary":"Create A New Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_101"}],"pointer":"/paths/~1v5~1tags.xml/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_68","exampleIds":["paths/~1v5~1tags.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hs-managing-tags/create-a-new-tag"}],"panels":[]}]},"httpPath":"/v5/tags.xml"},{"label":"List All Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/hs-managing-tags/list-all-tags","routeSlug":"/v5/hs-managing-tags/list-all-tags","metadata":{"seo":{"title":"List All Tags","description":"Lists all tags present in the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-all-tags","name":"List All Tags","isWebhook":false,"pointer":"/paths/~1v5~1tags.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all tags present in the account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1tags.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1tags.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/tags.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/tags.xml","href":"hs-managing-tags/list-all-tags","openApiOperationId":"list-all-tags","summary":"List All Tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_102"}],"pointer":"/paths/~1v5~1tags.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1tags.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hs-managing-tags/list-all-tags"}],"panels":[]}]},"httpPath":"/v5/tags.xml"},{"label":"Retrieve A Specific Tag","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/hs-managing-tags/retrieve-a-specific-tag","routeSlug":"/v5/hs-managing-tags/retrieve-a-specific-tag","metadata":{"seo":{"title":"Retrieve A Specific Tag","description":"Retrieves the tag from vWork that has the given id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-a-specific-tag","name":"Retrieve A Specific Tag","isWebhook":false,"pointer":"/paths/~1v5~1tags~1{id}.xml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve A Specific Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the tag from vWork that has the given id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1tags~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1tags~1{id}.xml/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1tags~1{id}.xml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v5/tags/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/tags/{id}.xml","href":"hs-managing-tags/retrieve-a-specific-tag","openApiOperationId":"retrieve-a-specific-tag","summary":"Retrieve A Specific Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_103"}],"pointer":"/paths/~1v5~1tags~1{id}.xml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1tags~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hs-managing-tags/retrieve-a-specific-tag"}],"panels":[]}]},"httpPath":"/v5/tags/{id}.xml"},{"label":"Update A Specific Tag","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/hs-managing-tags/update-a-specific-tag","routeSlug":"/v5/hs-managing-tags/update-a-specific-tag","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-a-specific-tag","name":"Update A Specific Tag","isWebhook":false,"pointer":"/paths/~1v5~1tags~1{id}.xml/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update A Specific Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<tag>\n    <name>License</name>\n</tag>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<tag>\n    <name>License</name>\n</tag>\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1tags~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1tags~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1tags~1{id}.xml/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"pointer":"/paths/~1v5~1tags~1{id}.xml/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v5/tags/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"requestBody":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"responseCodes":["200"],"pointer":"/v5/tags/{id}.xml","href":"hs-managing-tags/update-a-specific-tag","openApiOperationId":"update-a-specific-tag","summary":"Update A Specific Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeSchemas":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/xml; charset=utf-8","mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"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"}},"headerSchemaId":"schema_104"}],"pointer":"/paths/~1v5~1tags~1{id}.xml/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v5~1tags~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"],"mediaTypes":["application/xml; charset=utf-8"],"mediaTypeContent":{"application/xml; charset=utf-8":{"schemaId":"schema_68","exampleIds":["paths/~1v5~1tags~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hs-managing-tags/update-a-specific-tag"}],"panels":[]}]},"httpPath":"/v5/tags/{id}.xml"},{"label":"Delete A Specific Tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v5/hs-managing-tags/delete-a-specific-tag","routeSlug":"/v5/hs-managing-tags/delete-a-specific-tag","metadata":{"seo":{"title":"Delete A Specific Tag","description":"Deletes the tag with the given id. This cannot be undone."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-a-specific-tag","name":"Delete A Specific Tag","isWebhook":false,"pointer":"/paths/~1v5~1tags~1{id}.xml/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete A Specific Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the tag with the given id. This cannot be undone."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"query","paramName":"api_key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1tags~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_key","in":"query","schemaId":"schema_66","description":"","required":true}],"pointer":"/paths/~1v5~1tags~1{id}.xml/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Encoding","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression)."},"children":[]}]}]}],"required":true,"example":"gzip"}],"pointer":"/paths/~1v5~1tags~1{id}.xml/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v5/tags/{id}.xml","servers":[{"url":"https://api.vworkapp.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[{"name":"api_key","in":"query","required":true,"schemaId":"schema_66"}],"querystring":[],"header":[{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api_key","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v5/tags/{id}.xml","href":"hs-managing-tags/delete-a-specific-tag","openApiOperationId":"delete-a-specific-tag","summary":"Delete A Specific Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.vworkapp.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"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"}},"headerSchemaId":"schema_105"}],"pointer":"/paths/~1v5~1tags~1{id}.xml/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hs-managing-tags/delete-a-specific-tag"}],"panels":[]}]},"httpPath":"/v5/tags/{id}.xml"}],"content":{"contentType":"group","meta":{"name":"HS - Managing Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"H&S - Managing Tags","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You 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.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags 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.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here are the fields you can use when making a tag request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the tag."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the tag."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expires"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether or not an expiry date is required when adding the tag to a user."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When retrieving a tag from vWork, you may also see these additional fields in the response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of the tag, used when adding a tag to a job or a user."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time tag was created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time tag was last updated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_by_user_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User ID of the user who created the tag. (Set to Nil if created via the API.)"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v5/tags.xml","summary":"Create A New Tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/hs-managing-tags/create-a-new-tag","deprecated":false},{"title":"/v5/tags.xml","summary":"List All Tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hs-managing-tags/list-all-tags","deprecated":false},{"title":"/v5/tags/{id}.xml","summary":"Retrieve A Specific Tag","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hs-managing-tags/retrieve-a-specific-tag","deprecated":false},{"title":"/v5/tags/{id}.xml","summary":"Update A Specific Tag","prefix":{"name":"put","color":"put"},"badges":[],"link":"/hs-managing-tags/update-a-specific-tag","deprecated":false},{"title":"/v5/tags/{id}.xml","summary":"Delete A Specific Tag","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/hs-managing-tags/delete-a-specific-tag","deprecated":false}]}]}]}]}},{"type":"group","label":"H&S - Tagging Users","link":"/v5/hs-tagging-users","routeSlug":"/v5/hs-tagging-users","items":[],"content":{"contentType":"group","meta":{"name":"HS - Tagging Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"H&S - Tagging Users","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<taggings type=\"array\">\n    <tagging>\n        <tag_id>12</tag_id>\n        <notes>Some notes to save against the tagging</notes>\n        <expires_at>2017-05-30T12:00:00Z</expires_at>\n    </tagging>\n</taggings>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<taggings type=\"array\">\n    <tagging>\n        <tag_id>12</tag_id>\n        <notes>Some notes to save against the tagging</notes>\n        <expires_at>2017-05-30T12:00:00Z</expires_at>\n    </tagging>\n</taggings>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If 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.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<taggings type=\"array\">\n    <tagging>\n        <id>109</id>\n        <notes>Some updated notes</notes>\n    </tagging>\n</taggings>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<taggings type=\"array\">\n    <tagging>\n        <id>109</id>\n        <notes>Some updated notes</notes>\n    </tagging>\n</taggings>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To 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.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"https://api.vworkapp.com/api/v4/user/12345/taggings/109.xml?api_key=123\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"https://api.vworkapp.com/api/v4/user/12345/taggings/109.xml?api_key=123\n"},"children":[]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hs-tagging-users"}],"panels":[]}]}},{"type":"group","label":"H&S - Tagging Jobs","link":"/v5/hs-tagging-jobs","routeSlug":"/v5/hs-tagging-jobs","items":[],"content":{"contentType":"group","meta":{"name":"HS - Tagging Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"H&S - Tagging Jobs","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also add tags to jobs, details for how to do this can be found in our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/v5-jobs/jobs-and-tags"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Jobs API documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are using our Templated Jobs API, tags will be automatically inherited from the template."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hs-tagging-jobs"}],"panels":[]}]}}],"store":{"schemaStore":{"schema_66":{"kind":"json-schema","data":{"type":"string"},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"string","enum":["gzip"]},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Raw XML payload — see the example."},"children":[]}]}]}]},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Security-Policy":{"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":{"type":"string","example":"Mon, 13 Jun 2016 23:39:38 GMT"},"ETag":{"type":"string","example":"W/\"2dbcb6a04f44419e584b939d643b66f1\""},"Status":{"type":"string","example":"201 Created"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"c984cbfd-2df1-4010-bad2-d5ef1e4d5412"},"X-Runtime":{"type":"string","example":"0.586222"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:CD56_0A000ED8:01BB_575F4426_6E78F2:1EB6"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Mon, 13 Jun 2016 23:43:06 GMT"},"ETag":{"type":"string","example":"W/\"6d5e8119257252130624e8cc1a78b813\""},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"6651d0a2-7f9f-4273-b876-f4544e22e0ca"},"X-Runtime":{"type":"string","example":"0.401007"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:CD56_0A000ED8:01BB_575F443A_6E7B90:1EB6"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Mon, 13 Jun 2016 23:47:22 GMT"},"ETag":{"type":"string","example":"W/\"197907f0f3634f315092aff1d7410394\""},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"6c906286-8b0d-493f-95cb-d9dea42220d2"},"X-Runtime":{"type":"string","example":"0.081427"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:CD56_0A000ED8:01BB_575F450A_6E96DB:1EB6"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Mon, 13 Jun 2016 23:52:16 GMT"},"ETag":{"type":"string","example":"W/\"cd023b0b002846ec7649112cadaf3433\""},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"8b9fb0f1-7020-466e-955b-c1d4f1f5be11"},"X-Runtime":{"type":"string","example":"0.105612"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:CD56_0A000ED8:01BB_575F46FE_6ED87C:1EB6"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"no-cache"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 00:03:38 GMT"},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"281aff47-d764-4085-817e-551a09e76ee1"},"X-Runtime":{"type":"string","example":"0.580677"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:CEA6_0A001312:01BB_575F49D1_A1625A:1EC7"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Security-Policy":{"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":{"type":"string","example":"Mon, 13 Jun 2016 22:51:25 GMT"},"ETag":{"type":"string","example":"W/\"4af298ed89390aecf7df64e20427d6ad\""},"Status":{"type":"string","example":"201 Created"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"52b7672b-d4fe-4ec8-88d7-e1bf8271e139"},"X-Runtime":{"type":"string","example":"0.265632"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:CBEF_0A001312:01BB_575F38C6_719C90:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Security-Policy":{"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":{"type":"string","example":"Mon, 13 Jun 2016 22:51:25 GMT"},"ETag":{"type":"string","example":"W/\"4af298ed89390aecf7df64e20427d6ad\""},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"52b7672b-d4fe-4ec8-88d7-e1bf8271e139"},"X-Runtime":{"type":"string","example":"0.265632"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:CBEF_0A001312:01BB_575F38C6_719C90:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Mon, 13 Jun 2016 23:01:46 GMT"},"ETag":{"type":"string","example":"W/\"9b4e74990926e6cc627402b2aaab449d\""},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"51f4063c-55fd-4d82-8d5d-86643ebc858b"},"X-Runtime":{"type":"string","example":"0.136054"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:CC3A_0A001312:01BB_575F3B5A_6D4613:1EB6"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"no-cache"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Mon, 13 Jun 2016 23:05:38 GMT"},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"c868c52b-ac15-45c7-ac8b-81faf18882ac"},"X-Runtime":{"type":"string","example":"0.372504"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:CC3A_0A001312:01BB_575F3C34_6D66C5:1EB6"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 00:40:16 GMT"},"ETag":{"type":"string","example":"W/\"257f6792403fcefc322d57060c8f183e\""},"Location":{"type":"string","example":"https://api.vworkapp.com/api/v4/pick_lists/72077"},"Status":{"type":"string","example":"201 Created"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"80f0a715-3dbb-4941-9304-bb4d9e5b8b6c"},"X-Runtime":{"type":"string","example":"0.120963"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:CFF3_0A001312:01BB_575F5266_7067FB:1EB6"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 00:45:48 GMT"},"ETag":{"type":"string","example":"W/\"e2230751adba24b473fc7d749eaf7e4c\""},"Location":{"type":"string","example":"https://api.vworkapp.com/api/v4/pick_lists"},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"61b47c69-3e67-4f61-bfef-3e13b2af6e73"},"X-Runtime":{"type":"string","example":"0.733719"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D00F_0A000ED8:01BB_575F53BB_753DA2:1E66"},"-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 00:45:48 GMT"},"ETag":{"type":"string","example":"W/\"e2230751adba24b473fc7d749eaf7e4c\""},"Location":{"type":"string","example":"https://api.vworkapp.com/api/v4/pick_lists"},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"61b47c69-3e67-4f61-bfef-3e13b2af6e73"},"X-Runtime":{"type":"string","example":"0.733719"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D00F_0A000ED8:01BB_575F53BB_753DA2:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 00:59:33 GMT"},"ETag":{"type":"string","example":"W/\"c35e9a187b8bba57f18eca3de8a18a05\""},"Location":{"type":"string","example":"https://api.vworkapp.com/api/v4/pick_lists/58806"},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"0b564407-6654-48c3-aeb0-f0d1e8f0e3ea"},"X-Runtime":{"type":"string","example":"31.127951"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D00F_0A000ED8:01BB_575F565C_75931D:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"no-cache"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 01:01:44 GMT"},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"c47f6bd3-d957-4d3d-bdeb-2ae7cfb96baf"},"X-Runtime":{"type":"string","example":"33.017338"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D00F_0A000ED8:01BB_575F574F_75B4F1:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 01:11:18 GMT"},"ETag":{"type":"string","example":"W/\"4595943a01847720b0e6b77d5a7a878a\""},"Location":{"type":"string","example":"https://api.vworkapp.com/api/v4/groups/2488"},"Status":{"type":"string","example":"201 Created"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"9a87ec2e-4060-4eb7-ab93-8a264f8a1ffd"},"X-Runtime":{"type":"string","example":"1.069870"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D0B8_0A001312:01BB_575F59B0_A393C8:1EC7"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_85"},"schema_86":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 01:12:42 GMT"},"ETag":{"type":"string","example":"W/\"b370ef7637b5a36d3b39fc40d3891740\""},"Location":{"type":"string","example":"https://api.vworkapp.com/api/v4/groups"},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"13ec9527-6f4b-4c95-9567-eabb45980107"},"X-Runtime":{"type":"string","example":"0.134730"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D0B8_0A001312:01BB_575F59B6_A3947F:1EC7"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_86"},"schema_87":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 01:13:57 GMT"},"ETag":{"type":"string","example":"W/\"1a6e72ab2cb185a59c99db7d7b167273\""},"Location":{"type":"string","example":"https://api.vworkapp.com/api/v4/groups/2488"},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"ebef613a-a497-441f-bf4a-16222c9e09c5"},"X-Runtime":{"type":"string","example":"0.091064"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D0B8_0A001312:01BB_575F5A0A_A39E07:1EC7"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_87"},"schema_88":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 01:15:27 GMT"},"ETag":{"type":"string","example":"W/\"261218f409b138c3462fd8bc2f6141f8\""},"Location":{"type":"string","example":"https://api.vworkapp.com/api/v4/groups/3"},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"4f54c69a-aace-4d84-ba13-aa77645f7861"},"X-Runtime":{"type":"string","example":"0.039573"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D0B8_0A001312:01BB_575F5A55_A3A867:1EC7"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_88"},"schema_89":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"no-cache"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 01:16:34 GMT"},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"bc62833c-887b-42f8-9b75-0b015a4b49c0"},"X-Runtime":{"type":"string","example":"0.035184"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D0B8_0A001312:01BB_575F5AAF_A3B607:1EC7"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"private"},"Content-Disposition":{"type":"string","example":"inline"},"Content-Security-Policy":{"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":{"type":"string","example":"binary"},"Date":{"type":"string","example":"Tue, 14 Jun 2016 01:18:54 GMT"},"ETag":{"type":"string","example":"W/\"c53f11b5618e2a9f0d8c1c321b2f0c7e\""},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"b5aa1516-12bf-48ab-9c35-330359e53102"},"X-Runtime":{"type":"string","example":"0.130267"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D0B8_0A001312:01BB_575F5AF2_A3BF29:1EC7"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"private"},"Content-Disposition":{"type":"string","example":"inline"},"Content-Length":{"type":"string","example":"15797"},"Content-Security-Policy":{"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":{"type":"string","example":"binary"},"Date":{"type":"string","example":"Tue, 14 Jun 2016 03:21:31 GMT"},"ETag":{"type":"string","example":"W/\"225373ffd545ae30c4bfd5c05a7560c2\""},"Last-Modified":{"type":"string","example":"Tue, 14 Jun 2016 03:13:27 GMT"},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"2a2a3f48-5027-4fff-980a-df4fafe8c85c"},"X-Runtime":{"type":"string","example":"0.112262"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D4AB_0A000ED8:01BB_575F782A_7A2D21:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"private"},"Content-Disposition":{"type":"string","example":"inline"},"Content-Length":{"type":"string","example":"85115"},"Content-Security-Policy":{"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":{"type":"string","example":"binary"},"Date":{"type":"string","example":"Tue, 14 Jun 2016 00:28:57 GMT"},"ETag":{"type":"string","example":"W/\"b3fbf37c5e99f04a601208a9945fb6e6\""},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"14e113a0-7d91-4d9e-ad76-ad6dc3227864"},"X-Runtime":{"type":"string","example":"0.214161"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:CF64_0A000ED8:01BB_575F4FC9_A22FE7:1EC7"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 01:39:45 GMT"},"ETag":{"type":"string","example":"W/\"7b93b83bd74711eb7c647fa765ff6c31\""},"Location":{"type":"string","example":"https://api.vworkapp.com/api/v4/messaging/ded86e04-31d0-11e6-927a-37a1480f7e3a.xml"},"Status":{"type":"string","example":"201 Created"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"dd33e07d-7734-40a6-ae2c-bfb7da9dc884"},"X-Runtime":{"type":"string","example":"1.087328"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D1C2_0A001312:01BB_575F605A_76FF74:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 01:44:03 GMT"},"ETag":{"type":"string","example":"W/\"b63f609270b27bc15b28397ea16f8a00\""},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"b0dc67b2-e2b4-452a-916f-805bd12628dc"},"X-Runtime":{"type":"string","example":"0.975847"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D1C2_0A001312:01BB_575F6061_770069:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 01:47:03 GMT"},"ETag":{"type":"string","example":"W/\"29262ad6f9badc69e0ba9cf7ee0a2433\""},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"21fc9e13-9d65-4d3c-b7b8-f5d3394aab05"},"X-Runtime":{"type":"string","example":"0.038802"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D1C2_0A001312:01BB_575F6209_773E50:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"no-cache"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 01:48:38 GMT"},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"9dbad255-1d04-4942-96f0-38f23a3bd6e6"},"X-Runtime":{"type":"string","example":"3.945302"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D1C2_0A001312:01BB_575F6217_774037:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 01:56:40 GMT"},"ETag":{"type":"string","example":"W/\"58e045bce12037d329682fa016e0485f\""},"Location":{"type":"string","example":"https://api.vworkapp.com/api/v4/messaging/acfe5d7a-1188-11e6-9d29-595cf99ba95b/messages/3c27e588-31d3-11e6-927a-37a1480f7e3a.xml"},"Status":{"type":"string","example":"201 Created"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"9b50ea5a-cd40-4c20-a702-b4299e688932"},"X-Runtime":{"type":"string","example":"0.513173"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D1C2_0A001312:01BB_575F6382_776FF0:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_97"},"schema_98":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 01:59:17 GMT"},"ETag":{"type":"string","example":"W/\"99d66c28bfd0dd358bd4280b4bd71b19\""},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"10515063-495a-4404-832d-8b92ca703858"},"X-Runtime":{"type":"string","example":"0.035260"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D1C2_0A001312:01BB_575F6458_778982:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_98"},"schema_99":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 02:01:07 GMT"},"ETag":{"type":"string","example":"W/\"23cdcff949c6326969601f967e777893\""},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"677a61c4-a9e6-4128-9e2e-6b07568f0457"},"X-Runtime":{"type":"string","example":"0.047095"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D1C2_0A001312:01BB_575F6541_77ADA4:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_99"},"schema_100":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"no-cache"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 02:04:46 GMT"},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"4e0203ca-8bc2-4220-9310-e00ea720f01e"},"X-Runtime":{"type":"string","example":"0.117428"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D1C2_0A001312:01BB_575F6639_77CF51:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 02:41:25 GMT"},"ETag":{"type":"string","example":"W/\"852a96824f66ae37c18df704c0efb80a\""},"Status":{"type":"string","example":"201 Created"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"e583c836-b1d8-4e4c-836e-20e07aec2b23"},"X-Runtime":{"type":"string","example":"0.046924"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D37C_0A000ED8:01BB_575F6EC3_78E6B6:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 02:46:38 GMT"},"ETag":{"type":"string","example":"W/\"6eebea1fbbc660a5f8895255856037e3\""},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"f068e8b1-4928-4f26-9afc-6b233768b46d"},"X-Runtime":{"type":"string","example":"0.072989"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D37C_0A000ED8:01BB_575F6FC1_790749:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 02:48:32 GMT"},"ETag":{"type":"string","example":"W/\"852a96824f66ae37c18df704c0efb80a\""},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"bdc6eba9-24bd-4150-9007-80f83e0aad83"},"X-Runtime":{"type":"string","example":"0.057500"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D37C_0A000ED8:01BB_575F700E_79114E:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"max-age=0, private, must-revalidate"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 02:50:27 GMT"},"ETag":{"type":"string","example":"W/\"4cf43ee41a81cbf5d4d2e2d20a14e0d5\""},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"76e28818-faa8-416f-892c-3ef77f455ab5"},"X-Runtime":{"type":"string","example":"0.082651"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D37C_0A000ED8:01BB_575F70EE_792F80:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"type":"object","properties":{"Cache-Control":{"type":"string","example":"no-cache"},"Content-Encoding":{"type":"string","example":"gzip"},"Content-Security-Policy":{"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":{"type":"string","example":"Tue, 14 Jun 2016 02:53:15 GMT"},"Status":{"type":"string","example":"200 OK"},"Strict-Transport-Security":{"type":"string","example":"max-age=31536000"},"Transfer-Encoding":{"type":"string","example":"chunked"},"X-Content-Type-Options":{"type":"string","example":"nosniff"},"X-Frame-Options":{"type":"string","example":"SAMEORIGIN"},"X-Request-Id":{"type":"string","example":"21068ac0-1234-4123-8860-8067f0c73c6e"},"X-Runtime":{"type":"string","example":"0.053361"},"X-Unique-ID":{"type":"string","example":"CA7C7B8A:D37C_0A000ED8:01BB_575F7190_794B58:1E66"},"X-XSS-Protection":{"type":"string","example":"1; mode=block"}}},"id":"schema_105"}},"exampleStore":{"paths/~1v5~1users.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<user>\n<name>George Smith</name>\n<group_ids></group_ids>\n<third_party_id></third_party_id>\n<email>george@example.com</email>\n<phone>1 555 111 1111</phone>\n<notes>Mack 3DC 12L V-TEC</notes>\n<password>fvw234r32qvrqe</password>\n    <permissions>\n        <admin>none</admin>\n        <schedule>none</schedule>\n        <map>none</map>\n        <reports>none</reports>\n        <jobs>none</jobs>\n        <customers>none</customers>\n        <quotes>none</quotes>\n        <equipment>none</equipment>\n        <messaging>none</messaging>\n        <mobile>full</mobile>\n        <mobile_jobs_create>full</mobile_jobs_create>\n        <mobile_jobs_assign>full</mobile_jobs_assign>\n        <mobile_invoice>full</mobile_invoice>\n    </permissions>\n</user>","key":"request","summary":"request","id":"paths/~1v5~1users.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1users.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<user>\n    <id readonly=\"readonly\">66270</id>\n    <group_ids></group_ids>\n    <name>George Smith</name>\n    <email>george@example.com</email>\n    <phone>1 555 111 1111</phone>\n    <notes>Mack 3DC 12L V-TEC</notes>\n    <shift_on>true</shift_on>\n    <third_party_id></third_party_id>\n    <created_at readonly=\"readonly\">2021-03-09T01:37:54+00:00</created_at>\n    <updated_at readonly=\"readonly\">2021-03-09T01:37:54+00:00</updated_at>\n    <latest_telemetry></latest_telemetry>\n    <permissions>\n        <admin>none</admin>\n        <schedule>none</schedule>\n        <map>none</map>\n        <reports>none</reports>\n        <jobs>none</jobs>\n        <customers>none</customers>\n        <quotes>none</quotes>\n        <equipment>none</equipment>\n        <messaging>none</messaging>\n        <mobile>full</mobile>\n        <mobile_jobs_create>full</mobile_jobs_create>\n        <mobile_jobs_assign>full</mobile_jobs_assign>\n        <mobile_invoice>full</mobile_invoice>\n    </permissions>\n</user>\n","key":"response","summary":"response","id":"paths/~1v5~1users.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1users.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<users type=\"array\">\n<user>\n    <id readonly=\"readonly\">66270</id>\n    <group_ids></group_ids>\n    <name>George Smith</name>\n    <email>george@example.com</email>\n    <phone>1 555 111 1111</phone>\n    <notes>Mack 3DC 12L V-TEC</notes>\n    <shift_on>true</shift_on>\n    <third_party_id></third_party_id>\n    <created_at readonly=\"readonly\">2021-03-09T01:37:54+00:00</created_at>\n    <updated_at readonly=\"readonly\">2021-03-09T01:37:54+00:00</updated_at>\n    <latest_telemetry></latest_telemetry>\n    <permissions>\n        <admin>none</admin>\n        <schedule>none</schedule>\n        <map>none</map>\n        <reports>none</reports>\n        <jobs>none</jobs>\n        <customers>none</customers>\n        <quotes>none</quotes>\n        <equipment>none</equipment>\n        <messaging>none</messaging>\n        <mobile>full</mobile>\n        <mobile_jobs_create>full</mobile_jobs_create>\n        <mobile_jobs_assign>full</mobile_jobs_assign>\n        <mobile_invoice>full</mobile_invoice>\n    </permissions>\n</user>\n</users>\n","key":"response","summary":"response","id":"paths/~1v5~1users.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1users~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<user>\n    <id readonly=\"readonly\">66270</id>\n    <group_ids></group_ids>\n    <name>George Smith</name>\n    <email>george@example.com</email>\n    <phone>1 555 111 1111</phone>\n    <notes>Mack 3DC 12L V-TEC</notes>\n    <shift_on>true</shift_on>\n    <third_party_id></third_party_id>\n    <created_at readonly=\"readonly\">2021-03-09T01:37:54+00:00</created_at>\n    <updated_at readonly=\"readonly\">2021-03-09T01:37:54+00:00</updated_at>\n    <latest_telemetry></latest_telemetry>\n    <permissions>\n        <admin>none</admin>\n        <schedule>none</schedule>\n        <map>none</map>\n        <reports>none</reports>\n        <jobs>none</jobs>\n        <customers>none</customers>\n        <quotes>none</quotes>\n        <equipment>none</equipment>\n        <messaging>none</messaging>\n        <mobile>full</mobile>\n        <mobile_jobs_create>full</mobile_jobs_create>\n        <mobile_jobs_assign>full</mobile_jobs_assign>\n        <mobile_invoice>full</mobile_invoice>\n    </permissions>\n</user>\n","key":"response","summary":"response","id":"paths/~1v5~1users~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1users~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<user>\n    <phone>1 555 111 2222</phone>\n</user>","key":"request","summary":"request","id":"paths/~1v5~1users~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1users~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<user>\n    <id readonly=\"readonly\">66270</id>\n    <group_ids></group_ids>\n    <name>George Smith</name>\n    <email>george@example.com</email>\n    <phone>1 555 111 1111</phone>\n    <notes>Mack 3DC 12L V-TEC</notes>\n    <shift_on>true</shift_on>\n    <third_party_id></third_party_id>\n    <created_at readonly=\"readonly\">2021-03-09T01:37:54+00:00</created_at>\n    <updated_at readonly=\"readonly\">2021-03-09T01:37:54+00:00</updated_at>\n    <latest_telemetry></latest_telemetry>\n    <permissions>\n        <admin>none</admin>\n        <schedule>none</schedule>\n        <map>none</map>\n        <reports>none</reports>\n        <jobs>none</jobs>\n        <customers>none</customers>\n        <quotes>none</quotes>\n        <equipment>none</equipment>\n        <messaging>none</messaging>\n        <mobile>full</mobile>\n        <mobile_jobs_create>full</mobile_jobs_create>\n        <mobile_jobs_assign>full</mobile_jobs_assign>\n        <mobile_invoice>full</mobile_invoice>\n    </permissions>\n</user>\n","key":"response","summary":"response","id":"paths/~1v5~1users~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1customers.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<customer>\n    <name>Joe's Plumbing</name>\n    <third_party_id>ABC123</third_party_id>\n    <notes/>\n    <delivery_contact>\n        <first_name>Cathy</first_name>\n        <last_name>Knocks</last_name>\n        <phone>1 555 111 1111</phone>\n        <mobile>1 555 111 1111</mobile>\n        <email>joe@acmeplumbers.com</email>\n        <location>\n            <formatted_address>880 Harrison Street, San Francisco, CA, 94107</formatted_address>\n            <lat>-37.779536</lat>\n            <lng>-122.401503</lng>\n        </location>\n    </delivery_contact>\n    <billing_contact>\n        <first_name>Bob</first_name>\n        <last_name>Lei</last_name>\n        <phone>1 555 111 1111</phone>\n        <location>\n            <formatted_address>880 Harrison Street, San Francisco, CA, 94107</formatted_address>\n            <lat>-37.779536</lat>\n            <lng>-122.401503</lng>\n        </location>\n    </billing_contact>\n</customer>","key":"request","summary":"request","id":"paths/~1v5~1customers.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1customers.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<customer>\n    <id>1119086</id>\n    <name>Joe's Plumbing</name>\n    <notes/>\n    <third_party_id>ABC123</third_party_id>\n    <billing_contact>\n        <first_name>Bob</first_name>\n        <last_name>Lei</last_name>\n        <phone>1 555 111 1111</phone>\n        <mobile/>\n        <email/>\n        <location>\n            <id type=\"integer\">23839050</id>\n            <created_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</created_at>\n            <updated_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</updated_at>\n            <address1/>\n            <address2/>\n            <suburb/>\n            <city/>\n            <post_code/>\n            <country/>\n            <province/>\n            <region/>\n            <state/>\n            <formatted_address>880 Harrison Street, San Francisco, CA, 94107</formatted_address>\n            <lat type=\"decimal\">-37.779536</lat>\n            <lng type=\"decimal\">-122.401503</lng>\n            <deleted_at type=\"datetime\"/>\n        </location>\n    </billing_contact>\n    <delivery_contact>\n        <first_name>Cathy</first_name>\n        <last_name>Knocks</last_name>\n        <phone>1 555 111 1111</phone>\n        <mobile>1 555 111 1111</mobile>\n        <email>joe@acmeplumbers.com</email>\n        <location>\n            <id type=\"integer\">23839051</id>\n            <created_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</created_at>\n            <updated_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</updated_at>\n            <address1/>\n            <address2/>\n            <suburb/>\n            <city/>\n            <post_code/>\n            <country/>\n            <province/>\n            <region/>\n            <state/>\n            <formatted_address>880 Harrison Street, San Francisco, CA, 94107</formatted_address>\n            <lat type=\"decimal\">-37.779536</lat>\n            <lng type=\"decimal\">-122.401503</lng>\n            <deleted_at type=\"datetime\"/>\n        </location>\n    </delivery_contact>\n    <updated_at>2016-06-13T22:51:25+00:00</updated_at>\n    <created_at>2016-06-13T22:51:25+00:00</created_at>\n    <deleted_at/>\n</customer>\n","key":"response","summary":"response","id":"paths/~1v5~1customers.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1customers.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<customers type=\"array\" current_page=\"1\" per_page=\"1\" total_pages=\"1\" total_entries=\"1\">\n    <customer>\n        <id>1119086</id>\n        <name>Joe's Plumbing</name>\n        <notes/>\n        <third_party_id>ABC123</third_party_id>\n        <billing_contact>\n            <first_name>Bob</first_name>\n            <last_name>Lei</last_name>\n            <phone>1 555 111 1111</phone>\n            <mobile/>\n            <email/>\n            <location>\n                <id type=\"integer\">23839050</id>\n                <created_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</created_at>\n                <updated_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</updated_at>\n                <address1/>\n                <address2/>\n                <suburb/>\n                <city/>\n                <post_code/>\n                <country/>\n                <province/>\n                <region/>\n                <state/>\n                <formatted_address>880 Harrison Street, San Francisco, CA, 94107</formatted_address>\n                <lat type=\"decimal\">-37.779536</lat>\n                <lng type=\"decimal\">-122.401503</lng>\n                <deleted_at type=\"datetime\"/>\n            </location>\n        </billing_contact>\n        <delivery_contact>\n            <first_name>Cathy</first_name>\n            <last_name>Knocks</last_name>\n            <phone>1 555 111 1111</phone>\n            <mobile>1 555 111 1111</mobile>\n            <email>joe@acmeplumbers.com</email>\n            <location>\n                <id type=\"integer\">23839051</id>\n                <created_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</created_at>\n                <updated_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</updated_at>\n                <address1/>\n                <address2/>\n                <suburb/>\n                <city/>\n                <post_code/>\n                <country/>\n                <province/>\n                <region/>\n                <state/>\n                <formatted_address>880 Harrison Street, San Francisco, CA, 94107</formatted_address>\n                <lat type=\"decimal\">-37.779536</lat>\n                <lng type=\"decimal\">-122.401503</lng>\n                <deleted_at type=\"datetime\"/>\n            </location>\n        </delivery_contact>\n        <updated_at>2016-06-13T22:51:25+00:00</updated_at>\n        <created_at>2016-06-13T22:51:25+00:00</created_at>\n        <deleted_at/>\n    </customer>\n</customers>","key":"response","summary":"response","id":"paths/~1v5~1customers.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1customers~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<customer>\n    <id>1119086</id>\n    <name>Joe's Plumbing</name>\n    <notes/>\n    <third_party_id>ABC123</third_party_id>\n    <billing_contact>\n        <first_name>Bob</first_name>\n        <last_name>Lei</last_name>\n        <phone>1 555 111 1111</phone>\n        <mobile/>\n        <email/>\n        <location>\n            <id type=\"integer\">23839050</id>\n            <created_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</created_at>\n            <updated_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</updated_at>\n            <address1/>\n            <address2/>\n            <suburb/>\n            <city/>\n            <post_code/>\n            <country/>\n            <province/>\n            <region/>\n            <state/>\n            <formatted_address>880 Harrison Street, San Francisco, CA, 94107</formatted_address>\n            <lat type=\"decimal\">-37.779536</lat>\n            <lng type=\"decimal\">-122.401503</lng>\n            <deleted_at type=\"datetime\"/>\n        </location>\n    </billing_contact>\n    <delivery_contact>\n        <first_name>Cathy</first_name>\n        <last_name>Knocks</last_name>\n        <phone>1 555 111 1111</phone>\n        <mobile>1 555 111 1111</mobile>\n        <email>joe@acmeplumbers.com</email>\n        <location>\n            <id type=\"integer\">23839051</id>\n            <created_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</created_at>\n            <updated_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</updated_at>\n            <address1/>\n            <address2/>\n            <suburb/>\n            <city/>\n            <post_code/>\n            <country/>\n            <province/>\n            <region/>\n            <state/>\n            <formatted_address>880 Harrison Street, San Francisco, CA, 94107</formatted_address>\n            <lat type=\"decimal\">-37.779536</lat>\n            <lng type=\"decimal\">-122.401503</lng>\n            <deleted_at type=\"datetime\"/>\n        </location>\n    </delivery_contact>\n    <updated_at>2016-06-13T22:51:25+00:00</updated_at>\n    <created_at>2016-06-13T22:51:25+00:00</created_at>\n    <deleted_at/>\n</customer>\n","key":"response","summary":"response","id":"paths/~1v5~1customers~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1customers~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<customer>\n    <notes>Beware of the dog.</notes>\n</customer>","key":"request","summary":"request","id":"paths/~1v5~1customers~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1customers~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<customer>\n    <id>1119086</id>\n    <name>Joe's Plumbing</name>\n    <notes>Beware of the dog.</notes>\n    <third_party_id>ABC123</third_party_id>\n    <billing_contact>\n        <first_name>Bob</first_name>\n        <last_name>Lei</last_name>\n        <phone>1 555 111 1111</phone>\n        <mobile/>\n        <email/>\n        <location>\n            <id type=\"integer\">23839050</id>\n            <created_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</created_at>\n            <updated_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</updated_at>\n            <address1/>\n            <address2/>\n            <suburb/>\n            <city/>\n            <post_code/>\n            <country/>\n            <province/>\n            <region/>\n            <state/>\n            <formatted_address>880 Harrison Street, San Francisco, CA, 94107</formatted_address>\n            <lat type=\"decimal\">-37.779536</lat>\n            <lng type=\"decimal\">-122.401503</lng>\n            <deleted_at type=\"datetime\"/>\n        </location>\n    </billing_contact>\n    <delivery_contact>\n        <first_name>Cathy</first_name>\n        <last_name>Knocks</last_name>\n        <phone>1 555 111 1111</phone>\n        <mobile>1 555 111 1111</mobile>\n        <email>joe@acmeplumbers.com</email>\n        <location>\n            <id type=\"integer\">23839051</id>\n            <created_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</created_at>\n            <updated_at type=\"datetime\" readonly=\"readonly\">2016-06-13T22:51:25+00:00</updated_at>\n            <address1/>\n            <address2/>\n            <suburb/>\n            <city/>\n            <post_code/>\n            <country/>\n            <province/>\n            <region/>\n            <state/>\n            <formatted_address>880 Harrison Street, San Francisco, CA, 94107</formatted_address>\n            <lat type=\"decimal\">-37.779536</lat>\n            <lng type=\"decimal\">-122.401503</lng>\n            <deleted_at type=\"datetime\"/>\n        </location>\n    </delivery_contact>\n    <updated_at>2016-06-13T22:51:25+00:00</updated_at>\n    <created_at>2016-06-13T22:51:25+00:00</created_at>\n    <deleted_at/>\n</customer>\n","key":"response","summary":"response","id":"paths/~1v5~1customers~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1pick_lists.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pick_list>\n    <name>Package Status</name>\n    <pick_list_items type=\"array\">\n        <pick_list_item>\n            <value>Delivered</value>\n        </pick_list_item>\n        <pick_list_item>\n            <value>Not delivered</value>\n        </pick_list_item>\n    </pick_list_items>\n</pick_list>","key":"request","summary":"request","id":"paths/~1v5~1pick_lists.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1pick_lists.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pick_list>\n    <id>1234</id>\n    <name>Package Status</name>\n    <created_at>2012-10-15T20:53:38+00:00</created_at>\n    <updated_at>2012-10-15T20:53:38+00:00</updated_at>\n    <pick_list_items type=\"array\">\n        <pick_list_item>\n            <id>2345</id>\n            <value>Delivered</value>\n            <created_at>2012-10-15T20:53:38+00:00</created_at>\n            <updated_at>2012-10-15T20:53:38+00:00</updated_at>\n        </pick_list_item>\n        <pick_list_item>\n            <id>2346</id>\n            <value>Not delivered</value>\n            <created_at>2012-10-15T20:53:38+00:00</created_at>\n            <updated_at>2012-10-15T20:53:38+00:00</updated_at>\n        </pick_list_item>\n    </pick_list_items>\n</pick_list>\n","key":"response","summary":"response","id":"paths/~1v5~1pick_lists.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1pick_lists.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pick_lists type=\"array\">\n    <pick_list>\n        <id>1234</id>\n        <name>Delivery status</name>\n        <created_at>2012-02-20T22:52:58+00:00</created_at>\n        <updated_at>2012-02-22T10:14:02+00:00</updated_at>\n        <pick_list_items type=\"array\">\n            <pick_list_item>\n                <id>2345</id>\n                <value>Delivered</value>\n                <created_at>2012-02-20T22:52:58+00:00</created_at>\n                <updated_at>2012-02-22T10:14:02+00:00</updated_at>\n            </pick_list_item>\n            <pick_list_item>\n                <id>2346</id>\n                <value>Not delivered</value>\n                <created_at>2012-02-20T22:52:58+00:00</created_at>\n                <updated_at>2012-02-20T22:52:58+00:00</updated_at>\n            </pick_list_item>\n        </pick_list_items>\n    </pick_list>\n    <pick_list>\n        <id>1235</id>\n        <name>Reason</name>\n        <created_at>2012-02-21T11:01:22+00:00</created_at>\n        <updated_at>2012-02-21T15:34:43+00:00</updated_at>\n        <pick_list_items type=\"array\">\n            <pick_list_item>\n                <id>2347</id>\n                <value>Damaged parcel</value>\n                <created_at>2012-02-21T11:01:22+00:00</created_at>\n                <updated_at>2012-02-21T11:01:22+00:00</updated_at>\n            </pick_list_item>\n            <pick_list_item>\n                <id>2348</id>\n                <value>Recipient moved</value>\n                <created_at>2012-02-21T11:01:22+00:00</created_at>\n                <updated_at>2012-02-21T15:34:43+00:00</updated_at>\n            </pick_list_item>\n        </pick_list_items>\n    </pick_list>\n</pick_lists>\n","key":"response","summary":"response","id":"paths/~1v5~1pick_lists.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1pick_lists~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pick_list>\n    <id>1234</id>\n    <name>Delivery Status</name>\n    <created_at>2012-02-20T22:52:58+00:00</created_at>\n    <updated_at>2012-02-22T10:14:02+00:00</updated_at>\n    <pick_list_items type=\"array\">\n        <pick_list_item>\n            <id>2345</id>\n            <value>Delivered</value>\n            <created_at>2012-02-20T22:52:58+00:00</created_at>\n            <updated_at>2012-02-22T10:14:02+00:00</updated_at>\n        </pick_list_item>\n        <pick_list_item>\n            <id>2346</id>\n            <value>Not delivered</value>\n            <created_at>2012-02-20T22:52:58+00:00</created_at>\n            <updated_at>2012-02-20T22:52:58+00:00</updated_at>\n        </pick_list_item>\n    </pick_list_items>\n</pick_list>\n","key":"response","summary":"response","id":"paths/~1v5~1pick_lists~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1pick_lists~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pick_list>\n    <name>New Picklist Name Here</name>\n</pick_list>","key":"request","summary":"request","id":"paths/~1v5~1pick_lists~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1pick_lists~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pick_list>\n    <id>61461</id>\n    <name>New Picklist Name Here</name>\n    <created_at>2015-07-09T02:30:22+00:00</created_at>\n    <updated_at>2015-07-09T02:53:30+00:00</updated_at>\n    <pick_list_items type=\"array\">\n        <pick_list_item>\n            <id>376744</id>\n            <value>Delivered</value>\n            <created_at>2015-07-09T02:30:22+00:00</created_at>\n            <updated_at>2015-07-09T02:30:22+00:00</updated_at>\n        </pick_list_item>\n        <pick_list_item>\n            <id>376745</id>\n            <value>Not delivered</value>\n            <created_at>2015-07-09T02:30:22+00:00</created_at>\n            <updated_at>2015-07-09T02:30:22+00:00</updated_at>\n        </pick_list_item>\n    </pick_list_items>\n</pick_list>\n","key":"response","summary":"response","id":"paths/~1v5~1pick_lists~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1groups.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<group>\n    <name>Service Vehicles</name>\n    <description>All mobile workers capable of handling business hours service call outs.</description>\n    <user_ids>1,2,3</user_ids>\n</group>","key":"request","summary":"request","id":"paths/~1v5~1groups.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1groups.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<group>\n    <id>123</id>\n    <name>Service Vehicles</name>\n    <description>All mobile workers capable of handling business hours service call outs.</description>\n    <user_ids>1,2,3</user_ids>\n    <created_at>2012-08-27T01:49:07+00:00</created_at>\n    <updated_at>2012-08-27T01:49:07+00:00</updated_at>\n</group>\n","key":"response","summary":"response","id":"paths/~1v5~1groups.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1groups.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<groups type=\"array\">\n    <group>\n        <id>123</id>\n        <name>Service Vehicles</name>\n        <description>All mobile workers capable of handling business hours service call outs.</description>\n        <user_ids>1,2,3</user_ids>\n        <created_at>2012-08-27T01:49:07+00:00</created_at>\n        <updated_at>2012-08-27T01:49:07+00:00</updated_at>\n    </group>\n    <group>\n        <id>321</id>\n        <name>After Hours</name>\n        <description>All mobile workers capable of handling after hours service call outs.</description>\n        <user_ids>4,5,6</user_ids>\n        <created_at>2012-08-27T02:02:11+00:00</created_at>\n        <updated_at>2012-08-27T02:02:11+00:00</updated_at>\n    </group>\n</groups>\n","key":"response","summary":"response","id":"paths/~1v5~1groups.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1groups~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<group>\n    <id>1849</id>\n    <name>Service Vehicles</name>\n    <description>All mobile workers capable of handling business hours service call outs.</description>\n    <user_ids>34123</user_ids>\n    <created_at>2015-07-09T03:51:43+00:00</created_at>\n    <updated_at>2015-07-09T03:51:43+00:00</updated_at>\n</group>\n","key":"response","summary":"response","id":"paths/~1v5~1groups~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1groups~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<group>\n    <name>The Night Shift</name>\n</group>","key":"request","summary":"request","id":"paths/~1v5~1groups~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1groups~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<group>\n    <id>1849</id>\n    <name>The Night Shift</name>\n    <description>All mobile workers capable of handling business hours service call outs.</description>\n    <user_ids>34123</user_ids>\n    <created_at>2015-07-09T03:51:43+00:00</created_at>\n    <updated_at>2015-07-09T03:59:25+00:00</updated_at>\n</group>\n","key":"response","summary":"response","id":"paths/~1v5~1groups~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1attachments~1{attachment_id}.jpeg/get/responses/200/content/image~1jpeg/examples/response":{"value":"Returns JPEG bitmap data\n","key":"response","summary":"response","id":"paths/~1v5~1attachments~1{attachment_id}.jpeg/get/responses/200/content/image~1jpeg/examples/response"},"paths/~1v5~1signatures~1{signature_id}.png/get/responses/200/content/image~1png/examples/response":{"value":"Returns PNG bitmap data\n","key":"response","summary":"response","id":"paths/~1v5~1signatures~1{signature_id}.png/get/responses/200/content/image~1png/examples/response"},"paths/~1v5~1jobs~1{id}~1proof_of_delivery.png/get/responses/200/content/image~1png/examples/response":{"value":"Returns either JPG or PNG bitmap data (depending on whether a photo is attached to the signature)\n","key":"response","summary":"response","id":"paths/~1v5~1jobs~1{id}~1proof_of_delivery.png/get/responses/200/content/image~1png/examples/response"},"paths/~1v5~1pricebooks.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pricebook>\n    <name>test pricebook</name>\n    <description>pricebook</description>\n    <pricebook_items type=\"array\">\n        <pricebook_item>\n            <code>3</code>\n            <description>Description 3</description>\n            <price>40.0</price>\n        </pricebook_item>\n        <pricebook_item>\n            <code>2</code>\n            <description>Description 2</description>\n            <price>30.0</price>\n        </pricebook_item>\n        <pricebook_item>\n            <code>1</code>\n            <description>Description 1</description>\n            <price>20.0</price>\n        </pricebook_item>\n    </pricebook_items>\n</pricebook>  ","key":"request","summary":"request","id":"paths/~1v5~1pricebooks.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1pricebooks.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pricebook>\n    <id readonly=\"readonly\">1090</id>\n    <name>test pricebook</name>\n    <account_id>1296</account_id>\n    <description>pricebook</description>\n    <pricebook_items type=\"array\">\n        <pricebook_item>\n            <id readonly=\"readonly\">113124</id>\n            <pricebook_id>1090</pricebook_id>\n            <code>3</code>\n            <description>Description 3</description>\n            <price>40.0</price>\n        </pricebook_item>\n        <pricebook_item>\n            <id readonly=\"readonly\">113125</id>\n            <pricebook_id>1090</pricebook_id>\n            <code>2</code>\n            <description>Description 2</description>\n            <price>30.0</price>\n        </pricebook_item>\n        <pricebook_item>\n            <id readonly=\"readonly\">113126</id>\n            <pricebook_id>1090</pricebook_id>\n            <code>1</code>\n            <description>Description 1</description>\n            <price>20.0</price>\n        </pricebook_item>\n    </pricebook_items>\n</pricebook>\n","key":"response","summary":"response","id":"paths/~1v5~1pricebooks.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1pricebooks.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pricebooks type=\"array\">\n<pricebook>\n    <id readonly=\"readonly\">1090</id>\n    <name>test pricebook</name>\n    <account_id>1296</account_id>\n    <description>pricebook</description>\n    <pricebook_items type=\"array\">\n        <pricebook_item>\n            <id readonly=\"readonly\">113124</id>\n            <pricebook_id>1090</pricebook_id>\n            <code>3</code>\n            <description>Description 3</description>\n            <price>40.0</price>\n        </pricebook_item>\n        <pricebook_item>\n            <id readonly=\"readonly\">113125</id>\n            <pricebook_id>1090</pricebook_id>\n            <code>2</code>\n            <description>Description 2</description>\n            <price>30.0</price>\n        </pricebook_item>\n        <pricebook_item>\n            <id readonly=\"readonly\">113126</id>\n            <pricebook_id>1090</pricebook_id>\n            <code>1</code>\n            <description>Description 1</description>\n            <price>20.0</price>\n        </pricebook_item>\n    </pricebook_items>\n</pricebook>\n</pricebooks>\n","key":"response","summary":"response","id":"paths/~1v5~1pricebooks.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1pricebook~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pricebook>\n    <id readonly=\"readonly\">1090</id>\n    <name>test pricebook</name>\n    <account_id>1296</account_id>\n    <description>pricebook</description>\n    <pricebook_items type=\"array\">\n        <pricebook_item>\n            <id readonly=\"readonly\">113124</id>\n            <pricebook_id>1090</pricebook_id>\n            <code>3</code>\n            <description>Description 3</description>\n            <price>40.0</price>\n        </pricebook_item>\n        <pricebook_item>\n            <id readonly=\"readonly\">113125</id>\n            <pricebook_id>1090</pricebook_id>\n            <code>2</code>\n            <description>Description 2</description>\n            <price>30.0</price>\n        </pricebook_item>\n        <pricebook_item>\n            <id readonly=\"readonly\">113126</id>\n            <pricebook_id>1090</pricebook_id>\n            <code>1</code>\n            <description>Description 1</description>\n            <price>20.0</price>\n        </pricebook_item>\n    </pricebook_items>\n</pricebook>\n","key":"response","summary":"response","id":"paths/~1v5~1pricebook~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1pricebook~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pricebook>\n    <name>pricebook 75</name>\n</pricebook>  ","key":"request","summary":"request","id":"paths/~1v5~1pricebook~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1pricebook~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<pricebook>\n    <id readonly=\"readonly\">1090</id>\n    <name>pricebook 75</name>\n    <account_id>1296</account_id>\n    <description>pricebook</description>\n    <pricebook_items type=\"array\">\n        <pricebook_item>\n            <id readonly=\"readonly\">113124</id>\n            <pricebook_id>1090</pricebook_id>\n            <code>3</code>\n            <description>Description 3</description>\n            <price>40.0</price>\n        </pricebook_item>\n        <pricebook_item>\n            <id readonly=\"readonly\">113125</id>\n            <pricebook_id>1090</pricebook_id>\n            <code>2</code>\n            <description>Description 2</description>\n            <price>30.0</price>\n        </pricebook_item>\n        <pricebook_item>\n            <id readonly=\"readonly\">113126</id>\n            <pricebook_id>1090</pricebook_id>\n            <code>1</code>\n            <description>Description 1</description>\n            <price>20.0</price>\n        </pricebook_item>\n    </pricebook_items>\n</pricebook>\n","key":"response","summary":"response","id":"paths/~1v5~1pricebook~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1equipment.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<equipment>\n    <third_party_id>QWERTYUIOP</third_party_id>\n    <name>The Forklift</name>\n    <model>Crown</model>\n    <notes>Picking it up and Putting it down</notes>\n    <serial>53476435482</serial>\n    <tag_ids>24,2008</tag_ids>\n    <group_ids>1,4833,501</group_ids>\n</equipment>","key":"request","summary":"request","id":"paths/~1v5~1equipment.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1equipment.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<equipment>\n    <id readonly=\"readonly\">9552</id>\n    <account_id readonly=\"readonly\">1296</account_id>\n    <name>The Forklift</name>\n    <notes>Picking it up and Putting it down</notes>\n    <third_party_id>QWERTYUIOP</third_party_id>\n    <model>Crown</model>\n    <serial>53476435482</serial>\n    <group_ids>1,501,4833</group_ids>\n    <tag_ids>24,2008</tag_ids>\n</equipment>\n","key":"response","summary":"response","id":"paths/~1v5~1equipment.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1equipment.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<equipments type=\"array\">\n    <equipment>\n        <id readonly=\"readonly\">9264</id>\n        <account_id readonly=\"readonly\">1296</account_id>\n        <name>Pilot Vehicle 1</name>\n        <notes></notes>\n        <third_party_id>vwork_520280906</third_party_id>\n        <model></model>\n        <serial></serial>\n        <group_ids></group_ids>\n        <tag_ids></tag_ids>\n    </equipment>\n    <equipment>\n        <id readonly=\"readonly\">9266</id>\n        <account_id readonly=\"readonly\">1296</account_id>\n        <name>Truck 15</name>\n        <notes></notes>\n        <third_party_id>vwork_931492492</third_party_id>\n        <model></model>\n        <serial></serial>\n        <group_ids></group_ids>\n        <tag_ids></tag_ids>\n    </equipment>\n    <equipment>\n        <id readonly=\"readonly\">9552</id>\n        <account_id readonly=\"readonly\">1296</account_id>\n        <name>The Forklift</name>\n        <notes>Picking it up and Putting it down</notes>\n        <third_party_id>QWERTYUIOP</third_party_id>\n        <model>Crown</model>\n        <serial>53476435482</serial>\n        <group_ids>1,501,4833</group_ids>\n        <tag_ids>24,2008</tag_ids>\n    </equipment>\n</equipments>\n","key":"response","summary":"response","id":"paths/~1v5~1equipment.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1equipment~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<equipment>\n    <id readonly=\"readonly\">9552</id>\n    <account_id readonly=\"readonly\">1296</account_id>\n    <name>The Forklift</name>\n    <notes>Picking it up and Putting it down</notes>\n    <third_party_id>QWERTYUIOP</third_party_id>\n    <model>Crown</model>\n    <serial>53476435482</serial>\n    <group_ids>1,501,4833</group_ids>\n    <tag_ids>24,2008</tag_ids>\n</equipment>\n","key":"response","summary":"response","id":"paths/~1v5~1equipment~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1equipment~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<equipment>\n    <name>Forklift 2</name>\n</equipment> ","key":"request","summary":"request","id":"paths/~1v5~1equipment~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1equipment~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<equipment>\n    <id readonly=\"readonly\">9552</id>\n    <account_id readonly=\"readonly\">1296</account_id>\n    <name>Forklift 2</name>\n    <notes>Picking it up and Putting it down</notes>\n    <third_party_id>QWERTYUIOP</third_party_id>\n    <model>Crown</model>\n    <serial>53476435482</serial>\n    <group_ids>1,501,4833</group_ids>\n    <tag_ids>24,2008</tag_ids>\n</equipment>\n","key":"response","summary":"response","id":"paths/~1v5~1equipment~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1assets.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <name>Milkshake</name>\n    <model>Yard</model>\n    <serial>123456</serial>\n    <notes>A sample note</notes>\n    <group_ids>2908</group_ids>\n    <customer_id>123456</customer_id>\n    <third_party_id>Kelis</third_party_id>\n    <cost>42.50</cost>\n    <location>\n        <formatted_address>200 Queen Street, Auckland, New Zealand</formatted_address>\n        <lat>-36.848616</lat>\n        <lng>174.765643</lng>\n    </location>\n</asset>","key":"request","summary":"request","id":"paths/~1v5~1assets.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1assets.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <id readonly=\"readonly\">345232</id>\n    <name>Milkshake</name>\n    <model>Yard</model>\n    <serial>123456</serial>\n    <notes>A sample note</notes>\n    <group_ids>2908</group_ids>\n    <customer_id>123456</customer_id>\n    <attachment_id></attachment_id>\n    <third_party_id>Kelis</third_party_id>\n    <cost>42.50</cost>\n    <enabled>true</enabled>\n    <location>\n        <id type=\"integer\">84710961</id>\n        <address1></address1>\n        <address2></address2>\n        <suburb></suburb>\n        <city></city>\n        <post_code></post_code>\n        <country></country>\n        <province></province>\n        <region></region>\n        <state></state>\n        <formatted_address>200 Queen Street, Auckland, New Zealand</formatted_address>\n        <lat type=\"decimal\">-36.848616</lat>\n        <lng type=\"decimal\">174.765643</lng>\n        <deleted_at type=\"datetime\"></deleted_at>\n        <created_at type=\"datetime\" readonly=\"readonly\">2021-03-10T06:02:09+00:00</created_at>\n        <updated_at type=\"datetime\" readonly=\"readonly\">2021-03-10T06:02:09+00:00</updated_at>\n    </location>\n</asset>\n","key":"response","summary":"response","id":"paths/~1v5~1assets.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1assets.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<assets type=\"array\" current_page=\"1\" per_page=\"1\" total_pages=\"1\" total_entries=\"1\">\n   <asset>\n    <id readonly=\"readonly\">345232</id>\n    <name>Milkshake</name>\n    <model>Yard</model>\n    <serial>123456</serial>\n    <notes>A sample note</notes>\n    <group_ids>2908</group_ids>\n    <customer_id>123456</customer_id>\n    <attachment_id></attachment_id>\n    <third_party_id>Kelis</third_party_id>\n    <cost>42.50</cost>\n    <enabled>true</enabled>\n    <location>\n        <id type=\"integer\">84710961</id>\n        <address1></address1>\n        <address2></address2>\n        <suburb></suburb>\n        <city></city>\n        <post_code></post_code>\n        <country></country>\n        <province></province>\n        <region></region>\n        <state></state>\n        <formatted_address>200 Queen Street, Auckland, New Zealand</formatted_address>\n        <lat type=\"decimal\">-36.848616</lat>\n        <lng type=\"decimal\">174.765643</lng>\n        <deleted_at type=\"datetime\"></deleted_at>\n        <created_at type=\"datetime\" readonly=\"readonly\">2021-03-10T06:02:09+00:00</created_at>\n        <updated_at type=\"datetime\" readonly=\"readonly\">2021-03-10T06:02:09+00:00</updated_at>\n    </location>\n</asset>\n</assets>\n","key":"response","summary":"response","id":"paths/~1v5~1assets.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1assets~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <id readonly=\"readonly\">345232</id>\n    <name>Milkshake</name>\n    <model>Yard</model>\n    <serial>123456</serial>\n    <notes>A sample note</notes>\n    <group_ids>2908</group_ids>\n    <customer_id>123456</customer_id>\n    <attachment_id></attachment_id>\n    <third_party_id>Kelis</third_party_id>\n    <cost>42.50</cost>\n    <enabled>true</enabled>\n    <location>\n        <id type=\"integer\">84710961</id>\n        <address1></address1>\n        <address2></address2>\n        <suburb></suburb>\n        <city></city>\n        <post_code></post_code>\n        <country></country>\n        <province></province>\n        <region></region>\n        <state></state>\n        <formatted_address>200 Queen Street, Auckland, New Zealand</formatted_address>\n        <lat type=\"decimal\">-36.848616</lat>\n        <lng type=\"decimal\">174.765643</lng>\n        <deleted_at type=\"datetime\"></deleted_at>\n        <created_at type=\"datetime\" readonly=\"readonly\">2021-03-10T06:02:09+00:00</created_at>\n        <updated_at type=\"datetime\" readonly=\"readonly\">2021-03-10T06:02:09+00:00</updated_at>\n    </location>\n</asset>\n","key":"response","summary":"response","id":"paths/~1v5~1assets~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1assets~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <enabled>false</enabled>\n</asset>","key":"request","summary":"request","id":"paths/~1v5~1assets~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1assets~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<asset>\n    <id readonly=\"readonly\">345232</id>\n    <name>Milkshake</name>\n    <model>Yard</model>\n    <serial>123456</serial>\n    <notes>A sample note</notes>\n    <group_ids>2908</group_ids>\n    <customer_id>123456</customer_id>\n    <attachment_id></attachment_id>\n    <third_party_id>Kelis</third_party_id>\n    <cost>42.50</cost>\n    <enabled>false</enabled>\n    <location>\n        <id type=\"integer\">84710961</id>\n        <address1></address1>\n        <address2></address2>\n        <suburb></suburb>\n        <city></city>\n        <post_code></post_code>\n        <country></country>\n        <province></province>\n        <region></region>\n        <state></state>\n        <formatted_address>200 Queen Street, Auckland, New Zealand</formatted_address>\n        <lat type=\"decimal\">-36.848616</lat>\n        <lng type=\"decimal\">174.765643</lng>\n        <deleted_at type=\"datetime\"></deleted_at>\n        <created_at type=\"datetime\" readonly=\"readonly\">2021-03-10T06:02:09+00:00</created_at>\n        <updated_at type=\"datetime\" readonly=\"readonly\">2021-03-10T06:02:09+00:00</updated_at>\n    </location>\n</asset>\n","key":"response","summary":"response","id":"paths/~1v5~1assets~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1messaging.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<thread>\n    <job_id/>\n    <user_ids>123</user_ids>\n    <subject>Sample Thread</subject>\n    <messages type=\"array\">\n        <message>\n            <from_user_id/>\n            <from_user_name>Joe Bloggs</from_user_name>\n            <body>Sample Message</body>\n        </message>\n    </messages>\n</thread>","key":"request","summary":"request","id":"paths/~1v5~1messaging.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1messaging.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<thread>\n    <id>ded86e04-31d0-11e6-927a-37a1480f7e3a</id>\n    <job_id/>\n    <user_ids>123</user_ids>\n    <all_workers>false</all_workers>\n    <created_by_user_id/>\n    <subject>Sample Thread</subject>\n    <summary>Sample Message</summary>\n    <last_reply_user_id/>\n    <last_reply_at>2016-06-14T01:39:44Z</last_reply_at>\n    <created_at>2016-06-14T01:39:44Z</created_at>\n    <updated_at>2016-06-14T01:39:45Z</updated_at>\n    <messages type=\"array\">\n        <message>\n            <id>23275dfc-086d-11e4-a5ac-174e8ef2ef84</id>\n            <thread_id>23268152-086d-11e4-a5ac-174e8ef2ef84</thread_id>\n            <from_user_id/>\n            <from_user_name>Joe Bloggs</from_user_name>\n            <read_by_user_ids/>\n            <received_by_user_ids/>\n            <body>Sample Message</body>\n            <created_at>2014-07-10 20:02:36 UTC</created_at>\n            <updated_at>2014-07-11 08:02:36 +1200</updated_at>\n        </message>\n    </messages>\n</thread>\n","key":"response","summary":"response","id":"paths/~1v5~1messaging.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1messaging.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<threads type=\"array\">\n    <thread>\n        <id>ded86e04-31d0-11e6-927a-37a1480f7e3a</id>\n        <job_id/>\n        <user_ids>123</user_ids>\n        <all_workers>false</all_workers>\n        <created_by_user_id/>\n        <subject>Sample Thread</subject>\n        <summary>Sample Message</summary>\n        <last_reply_user_id/>\n        <last_reply_at>2016-06-14T01:39:44Z</last_reply_at>\n        <created_at>2016-06-14T01:39:44Z</created_at>\n        <updated_at>2016-06-14T01:39:45Z</updated_at>\n        <messages type=\"array\">\n            <message>\n                <id>23275dfc-086d-11e4-a5ac-174e8ef2ef84</id>\n                <thread_id>23268152-086d-11e4-a5ac-174e8ef2ef84</thread_id>\n                <from_user_id/>\n                <from_user_name>Joe Bloggs</from_user_name>\n                <read_by_user_ids/>\n                <received_by_user_ids/>\n                <body>Sample Message</body>\n                <created_at>2014-07-10 20:02:36 UTC</created_at>\n                <updated_at>2014-07-11 08:02:36 +1200</updated_at>\n            </message>\n        </messages>\n    </thread>\n</threads>\n","key":"response","summary":"response","id":"paths/~1v5~1messaging.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1messaging~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<thread>\n    <id>ded86e04-31d0-11e6-927a-37a1480f7e3a</id>\n    <job_id/>\n    <user_ids>123</user_ids>\n    <all_workers>false</all_workers>\n    <created_by_user_id/>\n    <subject>Sample Thread</subject>\n    <summary>Sample Message</summary>\n    <last_reply_user_id/>\n    <last_reply_at>2016-06-14T01:39:44Z</last_reply_at>\n    <created_at>2016-06-14T01:39:44Z</created_at>\n    <updated_at>2016-06-14T01:39:45Z</updated_at>\n    <messages type=\"array\">\n        <message>\n            <id>23275dfc-086d-11e4-a5ac-174e8ef2ef84</id>\n            <thread_id>23268152-086d-11e4-a5ac-174e8ef2ef84</thread_id>\n            <from_user_id/>\n            <from_user_name>Joe Bloggs</from_user_name>\n            <read_by_user_ids/>\n            <received_by_user_ids/>\n            <body>Sample Message</body>\n            <created_at>2014-07-10 20:02:36 UTC</created_at>\n            <updated_at>2014-07-11 08:02:36 +1200</updated_at>\n        </message>\n    </messages>\n</thread>\n","key":"response","summary":"response","id":"paths/~1v5~1messaging~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<message>\n    <body>This is a new message</body>\n    <from_user_id>3</from_user_id>\n</message>","key":"request","summary":"request","id":"paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<message>\n    <id>23275dfc-086d-11e4-a5ac-174e8ef2ef84</id>\n    <thread_id>23268152-086d-11e4-a5ac-174e8ef2ef84</thread_id>\n    <from_user_id>3</from_user_id>\n    <from_user_name>Joe Bloggs</from_user_name>\n    <read_by_user_ids>3</read_by_user_ids>\n    <received_by_user_ids/>\n    <body>This is a new message</body>\n    <created_at>2014-07-10 20:02:36 UTC</created_at>\n    <updated_at>2014-07-11 08:02:36 +1200</updated_at>\n</message>\n","key":"response","summary":"response","id":"paths/~1v5~1messaging~1{thread_id}~1messages.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1messaging~1{thread_id}~1messages.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<messages type=\"array\">\n    <message>\n        <id>23275dfc-086d-11e4-a5ac-174e8ef2ef84</id>\n        <thread_id>23268152-086d-11e4-a5ac-174e8ef2ef84</thread_id>\n        <from_user_id>3</from_user_id>\n        <from_user_name>Joe Bloggs</from_user_name>\n        <read_by_user_ids>3</read_by_user_ids>\n        <received_by_user_ids/>\n        <body>This is a new message</body>\n        <created_at>2014-07-10 20:02:36 UTC</created_at>\n        <updated_at>2014-07-11 08:02:36 +1200</updated_at>\n    </message>\n</messages>\n","key":"response","summary":"response","id":"paths/~1v5~1messaging~1{thread_id}~1messages.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<message>\n    <id>23275dfc-086d-11e4-a5ac-174e8ef2ef84</id>\n    <thread_id>23268152-086d-11e4-a5ac-174e8ef2ef84</thread_id>\n    <from_user_id>3</from_user_id>\n    <from_user_name>Joe Bloggs</from_user_name>\n    <read_by_user_ids>3</read_by_user_ids>\n    <received_by_user_ids/>\n    <body>This is a new message</body>\n    <created_at>2014-07-10 20:02:36 UTC</created_at>\n    <updated_at>2014-07-11 08:02:36 +1200</updated_at>\n</message>\n","key":"response","summary":"response","id":"paths/~1v5~1messaging~1{thread_id}~1messages~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1tags.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<tag>\n    <name>CDL</name>\n    <description>Commercial Driver's License</description>\n    <expires>true</expires>\n</tag>","key":"request","summary":"request","id":"paths/~1v5~1tags.xml/post/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1tags.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<tag>\n    <id type=\"integer\">27</id>\n    <name>CDL</name>\n    <description>Commercial Driver's License</description>\n    <expires type=\"boolean\">true</expires>\n    <created_by_user_id nil=\"true\"/>\n    <created_at type=\"datetime\">2016-06-14T02:41:25Z</created_at>\n    <updated_at type=\"datetime\">2016-06-14T02:41:25Z</updated_at>\n</tag>\n","key":"response","summary":"response","id":"paths/~1v5~1tags.xml/post/responses/201/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1tags.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<tags type=\"array\">\n    <tag>\n        <id type=\"integer\">27</id>\n        <name>CDL</name>\n        <description>Commercial Driver's License</description>\n        <expires type=\"boolean\">true</expires>\n        <created_by_user_id nil=\"true\"/>\n        <created_at type=\"datetime\">2016-06-14T02:41:25Z</created_at>\n        <updated_at type=\"datetime\">2016-06-14T02:41:25Z</updated_at>\n    </tag>\n</tags>","key":"response","summary":"response","id":"paths/~1v5~1tags.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1tags~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<tag>\n    <id type=\"integer\">27</id>\n    <name>CDL</name>\n    <description>Commercial Driver's License</description>\n    <expires type=\"boolean\">true</expires>\n    <created_by_user_id nil=\"true\"/>\n    <created_at type=\"datetime\">2016-06-14T02:41:25Z</created_at>\n    <updated_at type=\"datetime\">2016-06-14T02:41:25Z</updated_at>\n</tag>\n","key":"response","summary":"response","id":"paths/~1v5~1tags~1{id}.xml/get/responses/200/content/application~1xml; charset=utf-8/examples/response"},"paths/~1v5~1tags~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request":{"value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<tag>\n    <name>License</name>\n</tag>","key":"request","summary":"request","id":"paths/~1v5~1tags~1{id}.xml/put/requestBody/content/application~1xml; charset=utf-8/examples/request"},"paths/~1v5~1tags~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response":{"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<tag>\n    <id type=\"integer\">27</id>\n    <name>License</name>\n    <description>Commercial Driver's License</description>\n    <expires type=\"boolean\">true</expires>\n    <created_by_user_id nil=\"true\"/>\n    <created_at type=\"datetime\">2016-06-14T02:41:25Z</created_at>\n    <updated_at type=\"datetime\">2016-06-14T02:50:27Z</updated_at>\n</tag>\n","key":"response","summary":"response","id":"paths/~1v5~1tags~1{id}.xml/put/responses/200/content/application~1xml; charset=utf-8/examples/response"}},"securitySchemeStore":{"apiKey":{"id":"apiKey","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your key at https://go.vworkapp.com/html_client/admin/api"},"children":[]}]}]}],"in":"query","paramName":"api_key"}},"servers":[{"url":"https://api.vworkapp.com"}],"logo":{"imageUrl":"./assets/vWork-Logo.png","altText":"vWork"}},"options":{"hideReplay":true,"codeSamples":{"languages":[]},"sortRequiredPropsFirst":true,"jsonSamplesExpandLevel":2,"hideDownloadButtons":false,"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/v5.json?download"},{"url":"/_bundle/v5.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"vWork API V5 (Stable Release)","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 <a href=\"/v5-templated-jobs.json\">Templated Jobs API documentation</a>.  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 <a href=\"/v5-jobs.json\">Jobs API documentation</a>.***\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 <a href=\"https://go.vworkapp.com/html_client/admin/api\">here on the integrations page</a>.\n\nIf you do not yet have a vWork account, please <a href=\"https://www.vworkapp.com/contact-us\">get in touch</a> 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 <a href=\"https://help.vworkapp.com/forums/20898176\">helpdesk</a> page as well as <a href=\"https://help.vworkapp.com/hc/en-us/articles/204087140\">a brief intro to the vWork API</a>. If you get stuck, please don't hesitate to send us an email at: <a href=\"mailto:support@vworkapp.com\">support@vworkapp.com</a>\n\n## Mailing List\n\nDo you want to be emailed when we make a change to the API? You can <a href=\"https://www.vworkapp.com/api_notes\">signup for notifications about the vWork API here</a>. 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<?xml version='1.0' encoding='utf-8' ?>\n<errors>\n    <error>\n        <attribute>custom_fields.custom_field</attribute>\n        <message>&#39;tomorrow night&#39; must be a valid ISO8601 value.</message>\n    </error>\n</errors>\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: `<jobs type=\"array\" current_page=\"1\" per_page=\"50\" total_pages=\"3\" total_entries=\"112\">` 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<?xml version=\"1.0\"?>\n<event>\n  <transaction_id>617d4a74-7a19-11e6-bf7a-55542dc9080d</transaction_id>\n  <event_type>job_created</event_type>\n  <event_time>2016-09-14T01:20:10Z</event_time>\n  <resource>Job</resource>\n  <resource_id>9876234</resource_id>\n  <account_id>7829</account_id>\n  <request_user_type>User</request_user_type>\n  <request_user_id>123</request_user_id>\n</event>\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<?xml version=\"1.0\"?>\n<event>\n  <transaction_id>63d75660-7a1a-11e6-8d5a-474090628a07</transaction_id>\n  <event_type>step_completed</event_type>\n  <event_time>2016-09-14T01:27:24Z</event_time>\n  <resource>Step</resource>\n  <resource_id>25062292</resource_id>\n  <account_id>8723</account_id>\n  <request_user_type>User</request_user_type>\n  <request_user_id>123</request_user_id>\n  <event_location>\n    <lat>-36.86524165519692</lat>\n    <lng>174.7806050757642</lng>\n  </event_location>\n  <data>\n    <step_name>Start Job</step_name>\n    <completed_at>2016-09-15T02:00:12Z</completed_at>\n    <job_id>8626773</job_id>\n  </data>\n</event>\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```\n<job><name>test</name></job>\n```\n\nusing code like this:\n\n```\nOpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), '123', '<job><name>test</name></job>')\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/"}},"baseSlug":"/v5","routesMapping":{}}