{"_id":"592364fca91ac40f0041c04e","parentDoc":null,"project":"56e3719a591f620e00bf5095","__v":1,"category":{"_id":"56e3719b591f620e00bf5099","pages":["56e3719c591f620e00bf509b","56e74226555c030e00a52a90","56e7447c7d693632001d5cb4","56e752bd56d59a0e00d5660e","56e755b98aa2c00e00494cd9","56e7584d911296190096dd80","56e759339b25270e001d11a0","56e7593e1b41040e009d10cf","56e7594e911296190096dd88","56e7595e8aa2c00e00494ce3","56e75d7f5669091700c5b2b4","56e77e22911296190096de13","56e77f259b25270e001d1232","56e7b2c737afb90e00e0eb9d","56ec4daf611730190000f23f","56ec4fde26db830e00afa083","56ec8f7204e8940e00966567","56f184cc9791b22d0077b9d9","56f18a2c3af4942b00bb3c47"],"project":"56e3719a591f620e00bf5095","__v":19,"version":"56e3719a591f620e00bf5098","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"user":"56e371538b32a10e00f79750","version":{"_id":"56e3719a591f620e00bf5098","hasReference":true,"hasDoc":true,"__v":2,"project":"56e3719a591f620e00bf5095","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["56e3719b591f620e00bf5099","56e7b24ad365390e007baeab"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-22T22:23:56.093Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[{"name":"","code":"{\n  \"uid\": \"4f6a3a32-6d57-450d-8b46-44abb3b01994\",\n  \"status\": \"SCHEDULED\",\n  \"serviceUid\": \"4f6a3a32-6d57-450d-8b46-44abb3b12378\",\n  \"jobDate\": \"2017-02-25\",\n  \"startTime\": \"12\",\n  \"endTime\": \"15\"\n}","language":"json","status":200},{"name":"","code":"Orbirental API - Bad request.","language":"text","status":400},{"code":"Orbirental API - Service not found.","language":"text","status":409}]},"settings":"","auth":"required","params":[{"_id":"59235f547180400f00049013","ref":"","in":"body","required":true,"desc":"Unique ID of the service","default":"","type":"string","name":"serviceUid"},{"_id":"59235f547180400f00049012","ref":"","in":"body","required":true,"desc":"Unique ID of the property","default":"","type":"string","name":"propertyUid"},{"_id":"59235f547180400f00049011","ref":"","in":"body","required":true,"desc":"","default":"","type":"yyyy-mm-dd","name":"jobDate"},{"_id":"59235f547180400f00049010","ref":"","in":"body","required":false,"desc":"Can be SCHEDULED, CANCELLED, DONE","default":"SCHEDULED","type":"string","name":"status"},{"_id":"59235f547180400f0004900f","ref":"","in":"body","required":false,"desc":"","default":"0","type":"int","name":"startTime"},{"_id":"59235f547180400f0004900e","ref":"","in":"body","required":false,"desc":"","default":"0","type":"int","name":"endTime"}],"url":"/jobs"},"isReference":false,"order":15,"body":"","excerpt":"Create a new job","slug":"jobs-1","type":"endpoint","title":"/jobs"}

post/jobs

Create a new job

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

serviceUid:
required
string
Unique ID of the service
propertyUid:
required
string
Unique ID of the property
jobDate:
required
yyyy-mm-dd
status:
stringSCHEDULED
Can be SCHEDULED, CANCELLED, DONE
startTime:
integer0
endTime:
integer0

Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}