Create quality control entry
curl --request POST \
--url http://localhost:3000/v2/qualityControl/ \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"rating": 4.5,
"objectId": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"comment": "<string>",
"objectManagerId": "<string>",
"verified": false,
"roomChecks": [
{
"roomId": "<string>",
"levelId": "<string>",
"comment": "<string>",
"serviceChecks": [
{
"serviceTypeId": "<string>",
"evaluation": 123,
"evaluationType": "<string>",
"rated": true
}
],
"controlImages": [
{
"imageURL": "<string>",
"comment": "<string>",
"label": "<string>"
}
]
}
],
"images": [
"<string>"
]
}
'import requests
url = "http://localhost:3000/v2/qualityControl/"
payload = {
"rating": 4.5,
"objectId": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"comment": "<string>",
"objectManagerId": "<string>",
"verified": False,
"roomChecks": [
{
"roomId": "<string>",
"levelId": "<string>",
"comment": "<string>",
"serviceChecks": [
{
"serviceTypeId": "<string>",
"evaluation": 123,
"evaluationType": "<string>",
"rated": True
}
],
"controlImages": [
{
"imageURL": "<string>",
"comment": "<string>",
"label": "<string>"
}
]
}
],
"images": ["<string>"]
}
headers = {
"x-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rating: 4.5,
objectId: '<string>',
_id: '<string>',
number: 123,
companyId: '<string>',
status: {
status: 123,
createdAt: '2023-11-07T05:31:56Z',
createdBy: '<string>',
lastModifiedAt: '2023-11-07T05:31:56Z',
lastModifiedBy: '<string>'
},
comment: '<string>',
objectManagerId: '<string>',
verified: false,
roomChecks: [
{
roomId: '<string>',
levelId: '<string>',
comment: '<string>',
serviceChecks: [
{
serviceTypeId: '<string>',
evaluation: 123,
evaluationType: '<string>',
rated: true
}
],
controlImages: [{imageURL: '<string>', comment: '<string>', label: '<string>'}]
}
],
images: ['<string>']
})
};
fetch('http://localhost:3000/v2/qualityControl/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/qualityControl/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rating' => 4.5,
'objectId' => '<string>',
'_id' => '<string>',
'number' => 123,
'companyId' => '<string>',
'status' => [
'status' => 123,
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'lastModifiedAt' => '2023-11-07T05:31:56Z',
'lastModifiedBy' => '<string>'
],
'comment' => '<string>',
'objectManagerId' => '<string>',
'verified' => false,
'roomChecks' => [
[
'roomId' => '<string>',
'levelId' => '<string>',
'comment' => '<string>',
'serviceChecks' => [
[
'serviceTypeId' => '<string>',
'evaluation' => 123,
'evaluationType' => '<string>',
'rated' => true
]
],
'controlImages' => [
[
'imageURL' => '<string>',
'comment' => '<string>',
'label' => '<string>'
]
]
]
],
'images' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v2/qualityControl/"
payload := strings.NewReader("{\n \"rating\": 4.5,\n \"objectId\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"comment\": \"<string>\",\n \"objectManagerId\": \"<string>\",\n \"verified\": false,\n \"roomChecks\": [\n {\n \"roomId\": \"<string>\",\n \"levelId\": \"<string>\",\n \"comment\": \"<string>\",\n \"serviceChecks\": [\n {\n \"serviceTypeId\": \"<string>\",\n \"evaluation\": 123,\n \"evaluationType\": \"<string>\",\n \"rated\": true\n }\n ],\n \"controlImages\": [\n {\n \"imageURL\": \"<string>\",\n \"comment\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"images\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/v2/qualityControl/")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rating\": 4.5,\n \"objectId\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"comment\": \"<string>\",\n \"objectManagerId\": \"<string>\",\n \"verified\": false,\n \"roomChecks\": [\n {\n \"roomId\": \"<string>\",\n \"levelId\": \"<string>\",\n \"comment\": \"<string>\",\n \"serviceChecks\": [\n {\n \"serviceTypeId\": \"<string>\",\n \"evaluation\": 123,\n \"evaluationType\": \"<string>\",\n \"rated\": true\n }\n ],\n \"controlImages\": [\n {\n \"imageURL\": \"<string>\",\n \"comment\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"images\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/qualityControl/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rating\": 4.5,\n \"objectId\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"comment\": \"<string>\",\n \"objectManagerId\": \"<string>\",\n \"verified\": false,\n \"roomChecks\": [\n {\n \"roomId\": \"<string>\",\n \"levelId\": \"<string>\",\n \"comment\": \"<string>\",\n \"serviceChecks\": [\n {\n \"serviceTypeId\": \"<string>\",\n \"evaluation\": 123,\n \"evaluationType\": \"<string>\",\n \"rated\": true\n }\n ],\n \"controlImages\": [\n {\n \"imageURL\": \"<string>\",\n \"comment\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"images\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"rating": 4.5,
"objectId": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"comment": "<string>",
"objectManagerId": "<string>",
"verified": false,
"roomChecks": [
{
"roomId": "<string>",
"levelId": "<string>",
"comment": "<string>",
"serviceChecks": [
{
"serviceTypeId": "<string>",
"evaluation": 123,
"evaluationType": "<string>",
"rated": true
}
],
"controlImages": [
{
"imageURL": "<string>",
"comment": "<string>",
"label": "<string>"
}
]
}
],
"images": [
"<string>"
]
}Quality Control
Create Quality Control
Create a new quality control entry. This automatically updates object and room ratings based on the assessment and sends notifications to relevant users.
POST
/
qualityControl
/
Create quality control entry
curl --request POST \
--url http://localhost:3000/v2/qualityControl/ \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"rating": 4.5,
"objectId": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"comment": "<string>",
"objectManagerId": "<string>",
"verified": false,
"roomChecks": [
{
"roomId": "<string>",
"levelId": "<string>",
"comment": "<string>",
"serviceChecks": [
{
"serviceTypeId": "<string>",
"evaluation": 123,
"evaluationType": "<string>",
"rated": true
}
],
"controlImages": [
{
"imageURL": "<string>",
"comment": "<string>",
"label": "<string>"
}
]
}
],
"images": [
"<string>"
]
}
'import requests
url = "http://localhost:3000/v2/qualityControl/"
payload = {
"rating": 4.5,
"objectId": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"comment": "<string>",
"objectManagerId": "<string>",
"verified": False,
"roomChecks": [
{
"roomId": "<string>",
"levelId": "<string>",
"comment": "<string>",
"serviceChecks": [
{
"serviceTypeId": "<string>",
"evaluation": 123,
"evaluationType": "<string>",
"rated": True
}
],
"controlImages": [
{
"imageURL": "<string>",
"comment": "<string>",
"label": "<string>"
}
]
}
],
"images": ["<string>"]
}
headers = {
"x-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rating: 4.5,
objectId: '<string>',
_id: '<string>',
number: 123,
companyId: '<string>',
status: {
status: 123,
createdAt: '2023-11-07T05:31:56Z',
createdBy: '<string>',
lastModifiedAt: '2023-11-07T05:31:56Z',
lastModifiedBy: '<string>'
},
comment: '<string>',
objectManagerId: '<string>',
verified: false,
roomChecks: [
{
roomId: '<string>',
levelId: '<string>',
comment: '<string>',
serviceChecks: [
{
serviceTypeId: '<string>',
evaluation: 123,
evaluationType: '<string>',
rated: true
}
],
controlImages: [{imageURL: '<string>', comment: '<string>', label: '<string>'}]
}
],
images: ['<string>']
})
};
fetch('http://localhost:3000/v2/qualityControl/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/qualityControl/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rating' => 4.5,
'objectId' => '<string>',
'_id' => '<string>',
'number' => 123,
'companyId' => '<string>',
'status' => [
'status' => 123,
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'lastModifiedAt' => '2023-11-07T05:31:56Z',
'lastModifiedBy' => '<string>'
],
'comment' => '<string>',
'objectManagerId' => '<string>',
'verified' => false,
'roomChecks' => [
[
'roomId' => '<string>',
'levelId' => '<string>',
'comment' => '<string>',
'serviceChecks' => [
[
'serviceTypeId' => '<string>',
'evaluation' => 123,
'evaluationType' => '<string>',
'rated' => true
]
],
'controlImages' => [
[
'imageURL' => '<string>',
'comment' => '<string>',
'label' => '<string>'
]
]
]
],
'images' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v2/qualityControl/"
payload := strings.NewReader("{\n \"rating\": 4.5,\n \"objectId\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"comment\": \"<string>\",\n \"objectManagerId\": \"<string>\",\n \"verified\": false,\n \"roomChecks\": [\n {\n \"roomId\": \"<string>\",\n \"levelId\": \"<string>\",\n \"comment\": \"<string>\",\n \"serviceChecks\": [\n {\n \"serviceTypeId\": \"<string>\",\n \"evaluation\": 123,\n \"evaluationType\": \"<string>\",\n \"rated\": true\n }\n ],\n \"controlImages\": [\n {\n \"imageURL\": \"<string>\",\n \"comment\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"images\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/v2/qualityControl/")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rating\": 4.5,\n \"objectId\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"comment\": \"<string>\",\n \"objectManagerId\": \"<string>\",\n \"verified\": false,\n \"roomChecks\": [\n {\n \"roomId\": \"<string>\",\n \"levelId\": \"<string>\",\n \"comment\": \"<string>\",\n \"serviceChecks\": [\n {\n \"serviceTypeId\": \"<string>\",\n \"evaluation\": 123,\n \"evaluationType\": \"<string>\",\n \"rated\": true\n }\n ],\n \"controlImages\": [\n {\n \"imageURL\": \"<string>\",\n \"comment\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"images\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/qualityControl/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rating\": 4.5,\n \"objectId\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"comment\": \"<string>\",\n \"objectManagerId\": \"<string>\",\n \"verified\": false,\n \"roomChecks\": [\n {\n \"roomId\": \"<string>\",\n \"levelId\": \"<string>\",\n \"comment\": \"<string>\",\n \"serviceChecks\": [\n {\n \"serviceTypeId\": \"<string>\",\n \"evaluation\": 123,\n \"evaluationType\": \"<string>\",\n \"rated\": true\n }\n ],\n \"controlImages\": [\n {\n \"imageURL\": \"<string>\",\n \"comment\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"images\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"rating": 4.5,
"objectId": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"comment": "<string>",
"objectManagerId": "<string>",
"verified": false,
"roomChecks": [
{
"roomId": "<string>",
"levelId": "<string>",
"comment": "<string>",
"serviceChecks": [
{
"serviceTypeId": "<string>",
"evaluation": 123,
"evaluationType": "<string>",
"rated": true
}
],
"controlImages": [
{
"imageURL": "<string>",
"comment": "<string>",
"label": "<string>"
}
]
}
],
"images": [
"<string>"
]
}Authorizations
API-KeyBearer-Auth
Body
application/json
Quality control assessment data
Quality control assessment for objects and rooms including ratings, comments, and detailed room checks
Overall quality rating (0.0 to 5.0)
Required range:
0 <= x <= 5Example:
4.5
ID of the object being assessed
Unique identifier for the quality control entry
Unique number of the entity, used for identification
The ID of the company this entity belongs to
Entity Status information
Show child attributes
Show child attributes
General comments about the quality control assessment
ID of the object manager who performed the assessment
Whether the quality control has been verified
Detailed room-by-room quality checks
Show child attributes
Show child attributes
General images for this quality control
Response
Quality control entry created successfully
Quality control assessment for objects and rooms including ratings, comments, and detailed room checks
Overall quality rating (0.0 to 5.0)
Required range:
0 <= x <= 5Example:
4.5
ID of the object being assessed
Unique identifier for the quality control entry
Unique number of the entity, used for identification
The ID of the company this entity belongs to
Entity Status information
Show child attributes
Show child attributes
General comments about the quality control assessment
ID of the object manager who performed the assessment
Whether the quality control has been verified
Detailed room-by-room quality checks
Show child attributes
Show child attributes
General images for this quality control
Was this page helpful?
⌘I