{"_id":"57624356653c2d2200fec7bf","category":{"_id":"57624356653c2d2200fec7a9","version":"57624356653c2d2200fec79c","__v":0,"project":"55c8cff571d7580d0063a5e5","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-16T21:10:36.483Z","from_sync":false,"order":25,"slug":"account-schedules","title":"Account Schedules"},"version":{"_id":"57624356653c2d2200fec79c","__v":21,"project":"55c8cff571d7580d0063a5e5","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170","5b0c16f2be9fcb0003e28222"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"__v":2,"parentDoc":null,"user":"55c8cf9471d7580d0063a5e4","project":"55c8cff571d7580d0063a5e5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-16T21:14:09.445Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"Schedules are used at various places in your Phone.com account. A schedule can specify a recurring weekly pattern such as \"Monday through Friday\" or a single time period such as \"Thanksgiving Weekend 2015\".\n\n## Supported Services\n* [List Schedules](doc:list-account-schedules) \n* [Get Schedule](doc:get-account-schedule) \n\n## Summary Object\nThe Schedule Summary Object is used to briefly represent a schedule. It can be seen in several places throughout this API. Here are the properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"Integer Schedule ID. Read-only.\",\n    \"0-2\": \"\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"Name\",\n    \"1-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nHere's an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": 26521,\\n    \\\"name\\\": \\\"Working Hours\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Full Object\nThe Full Schedule Object is identical to the [Schedule Summary Object](#section-summary-object).  See above for details.\n\n## Lookup Object\nThe Schedule Lookup Object is used to link to a schedule from another object. This is used, for example, when defining filters for [routes](doc:account-routes).  Only *one* of the following properties need to be included. If multiple are specified, then *all* properties must match one of your schedules.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"ID\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"Name\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nHere are some examples:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"schedule: {\\n    \\\"id\\\": 332421\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"schedule: {\\n    \\\"name\\\": \\\"Vacation schedule\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nInstead of inputting an object, you can also use a scalar value.  A schedule will be found if the input matches any one of the above fields.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"schedule: \\\"Vacation schedule\\\"\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"account-schedules","type":"basic","title":"Schedules"}
Schedules are used at various places in your Phone.com account. A schedule can specify a recurring weekly pattern such as "Monday through Friday" or a single time period such as "Thanksgiving Weekend 2015". ## Supported Services * [List Schedules](doc:list-account-schedules) * [Get Schedule](doc:get-account-schedule) ## Summary Object The Schedule Summary Object is used to briefly represent a schedule. It can be seen in several places throughout this API. Here are the properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "h-2": "", "0-0": "`id`", "0-1": "Integer Schedule ID. Read-only.", "0-2": "", "1-0": "`name`", "1-1": "Name", "1-2": "" }, "cols": 2, "rows": 2 } [/block] Here's an example: [block:code] { "codes": [ { "code": "{\n \"id\": 26521,\n \"name\": \"Working Hours\"\n}", "language": "json" } ] } [/block] ## Full Object The Full Schedule Object is identical to the [Schedule Summary Object](#section-summary-object). See above for details. ## Lookup Object The Schedule Lookup Object is used to link to a schedule from another object. This is used, for example, when defining filters for [routes](doc:account-routes). Only *one* of the following properties need to be included. If multiple are specified, then *all* properties must match one of your schedules. [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`id`", "0-1": "ID", "1-0": "`name`", "1-1": "Name" }, "cols": 2, "rows": 2 } [/block] Here are some examples: [block:code] { "codes": [ { "code": "schedule: {\n \"id\": 332421\n}", "language": "json" } ] } [/block] [block:code] { "codes": [ { "code": "schedule: {\n \"name\": \"Vacation schedule\"\n}", "language": "json" } ] } [/block] Instead of inputting an object, you can also use a scalar value. A schedule will be found if the input matches any one of the above fields. [block:code] { "codes": [ { "code": "schedule: \"Vacation schedule\"", "language": "json" } ] } [/block]