Orders
Get Client Order
Returns a single client portal order by ID.
GET
/
clients
/
{id}
/
orders
/
{order_id}
Get Client Order
curl --request GET \
--url https://api.roostedhr.com/api/1_12/clients/{id}/orders/{order_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.roostedhr.com/api/1_12/clients/{id}/orders/{order_id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.roostedhr.com/api/1_12/clients/{id}/orders/{order_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.roostedhr.com/api/1_12/clients/{id}/orders/{order_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.roostedhr.com/api/1_12/clients/{id}/orders/{order_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.roostedhr.com/api/1_12/clients/{id}/orders/{order_id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roostedhr.com/api/1_12/clients/{id}/orders/{order_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"comments": "<string>",
"order_comments": "<string>",
"time_start": "<string>",
"time_end": "<string>",
"location": "<string>",
"address": "<string>",
"city": "<string>",
"postal_code": "<string>",
"order_status": 0,
"order_created": "<string>",
"shifts": [
{
"id": "<string>",
"custom_name": "<string>",
"role_id": "<string>",
"quantity": 123,
"start": "<string>",
"end": "<string>",
"overnight": true,
"comments": "<string>"
}
]
}Authorizations
Response
OK
Unique order identifier.
Order name.
Internal comments.
Comments from the client.
Order start datetime.
Order end datetime.
Location name.
Street address.
City.
Postal or ZIP code.
Order status code.
Available options:
0, 2, 86, 96 Datetime when the order was created.
Shifts within this order.
Show child attributes
Show child attributes
⌘I
Get Client Order
curl --request GET \
--url https://api.roostedhr.com/api/1_12/clients/{id}/orders/{order_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.roostedhr.com/api/1_12/clients/{id}/orders/{order_id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.roostedhr.com/api/1_12/clients/{id}/orders/{order_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.roostedhr.com/api/1_12/clients/{id}/orders/{order_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.roostedhr.com/api/1_12/clients/{id}/orders/{order_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.roostedhr.com/api/1_12/clients/{id}/orders/{order_id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roostedhr.com/api/1_12/clients/{id}/orders/{order_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"comments": "<string>",
"order_comments": "<string>",
"time_start": "<string>",
"time_end": "<string>",
"location": "<string>",
"address": "<string>",
"city": "<string>",
"postal_code": "<string>",
"order_status": 0,
"order_created": "<string>",
"shifts": [
{
"id": "<string>",
"custom_name": "<string>",
"role_id": "<string>",
"quantity": 123,
"start": "<string>",
"end": "<string>",
"overnight": true,
"comments": "<string>"
}
]
}