Creates a new work order
Request Information
URI Parameters :
None.
Body Parameters :
jobs| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| _parent_id |
Reference to a parent job (in case of Multi Job) |
globally unique identifier | |
| _parent_job |
Embedded entity "job" for parent (multi job level) when adding/updating job |
jobs | |
| _parent_jobs_reference_back_office |
Embedded entity "job" for parent (multi job level) using ERP PK when adding/updating job |
string | |
| project_id |
Foreign key of project for this job |
globally unique identifier |
Optionally required : project_id, project_reference_back_office or project must be provided |
| project_reference_back_office |
Embedded entity "project" using ERP PK when adding/updating job |
string |
Optionally required : project_id, project_reference_back_office or project must be provided |
| project |
Embedded entity "project" when adding/updating job |
project |
Optionally required : project_id, project_reference_back_office or project must be provided |
| job_type_id |
Foreign key of job type for this job |
globally unique identifier |
Optionally required : job_type_id, job_type_code or job_type must be provided |
| job_type_code |
Embedded entity "job_type" using ERP PK when adding/updating job |
string |
Optionally required : job_type_id, job_type_code or job_type must be provided |
| job_type |
Embedded entity "job_type" when adding/updating job |
job_type |
Optionally required : job_type_id, job_type_code or job_type must be provided |
| job_priority_id |
Foreign key of job priority for this job |
globally unique identifier | |
| job_priority_code |
Foreign key of job status for this job. If you don't know the GUID, use job_type_code |
string | |
| job_priority |
Embedded entity "job_priority" when adding/updating job |
job_priority | |
| job_status_id |
Foreign key of job status for this job |
globally unique identifier |
Optionally required : job_status_id or job_status_code must be provided |
| job_status_code |
Foreign key of job status using code. Use "Canceled,ToBePlanned, Waiting, Pooling, Suggested, Activated or Open" If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
string |
Optionally required : job_status_id or job_status_code must be provided |
| db_address_id |
Foreign key of db_address if job is not on a mobile equipment.Must be the address_id of the location or the equipment |
globally unique identifier | |
| contact_id |
Foreign key of contact if the main contact of the job is different than the one of the project |
globally unique identifier | |
| requested_by_company_id |
Foreign key of company if a specific company makes the request for this job |
globally unique identifier | |
| requested_by_contact_id |
Foreign key of contact to specify why contact of the requested_company_id makes the request |
globally unique identifier | |
| reference_back_office |
The Id/Ref of the back office for this job. Used by Embedded entity |
string |
Max length: 50 |
| name |
Name of the Job |
string |
Required Max length: 255 |
| description |
Description of the job |
string |
Max length: 4000 |
| working_sequence |
In case of mutli job, they will be ordered by this sequence |
integer | |
| internal_memo |
Internal field for communication between BackOffice/Planners/Technicians |
string | |
| prejob_information |
Information usefull for the technician before start (Call the customer,...) |
string | |
| estimated_time |
Estimation of the time needed (in minute). Will be used for planning and statistic |
integer | |
| earliest_date_plannable |
Use this field if there is a minimum date for the planning (Not Before) |
date | |
| due_date |
Deadline of Max date for the planning (Not After) |
date | |
| date_create |
Creation date+time |
date | |
| date_update |
Update date+time |
date | |
| date_closed |
Date+time job goes to completed |
date | |
| suggested_user_id |
Foreign key of user if there is a suggested user (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
globally unique identifier | |
| suggested_user_code |
Embedded entity "suggested user" using ERP PK when adding/updating job |
string | |
| suggested_user |
Embedded entity "sugessted user" when adding/updating job |
user | |
| suggested_date_start |
Suggested date+time start (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
date | |
| skill_id |
Foreign key of skill if the job requires a specific skill (used for planning) |
globally unique identifier | |
| skill_code |
Embedded entity "skill" using ERP PK when adding/updating job |
string | |
| skill |
Embedded entity "skill" when adding/updating job |
skill | |
| customer_reference |
Reference of this job for the customer |
string |
Max length: 50 |
| approval_responsible_user_id |
In case of multi user job, foreign key of user that is the "WO Leader" |
globally unique identifier | |
| date_reported_by_company |
Date+time when company reported the problem |
date | |
| id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer | |
| company_id |
This field will be filled automatically based on the project_id |
globally unique identifier | |
| company_code |
This field will be filled automatically based on the project_id |
string | |
| db_address_name |
When mobile equipment, the address to use |
string |
Max length: 100 |
| db_address_street |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
| db_address_street2 |
It is sub street |
string |
Max length: 50 |
| db_address_street_number |
When mobile equipment, the address to use |
string |
Max length: 50 |
| db_address_city |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
| db_address_zip |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
| db_address_db_country_id |
When mobile equipment, the address to use |
globally unique identifier | |
| db_address_db_country_code |
When mobile equipment, the address to use |
string | |
| db_address_phone |
When mobile equipment, the address to use |
string |
Max length: 50 |
| db_address_email |
When mobile equipment, the address to use |
string |
Max length: 250 |
| db_address_latitude_decimal |
Latitude |
decimal number | |
| db_address_longitude_decimal |
Latitude |
decimal number | |
| estimated_quantity_remark |
Description of the parts your technician should use or pick up |
string |
Max length: 4000 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
{
"id": "7bf15a09-2323-4de5-b6d9-786aeeb916bb",
"_parent_id": "fa43affd-9089-4fab-8e24-02246135b6df",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "82b609e8-fee0-4494-861a-93141c8e1484",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fca37174-5200-455c-8e49-12c1c805cec9",
"_parent_id": "f7da1ccd-db62-4c3d-a6da-66095387a21c",
"root_parent_id": "f64df6fa-4d84-4c85-8ea4-aa1094d6880f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "43563c7d-4169-425b-90da-02de747156ff",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2dbcce25-35c7-42ca-9d8f-5ca7ad96a1c0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "67c38cda-a521-464f-9057-6c970490d232",
"_parent_code": "sample string 6",
"sales_organization_id": "f5adab9e-7fdf-4449-9ace-78861899bda9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bb8dc221-1d8d-4e42-81eb-c848f7a51a3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2efcbb90-312a-4c14-802b-72a932378115",
"db_currency_id": "9749e28f-fec4-4248-84fc-58076a654942",
"db_language_id": "a65c0521-60d2-4222-a1f6-e47788a777a2",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"equipment_model_id": "16d87858-2249-4647-8257-455dfd42fa51",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cb7e52dd-e3bd-4b0a-9941-19270b13500f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "20b09144-f1d5-41c1-b2f3-298070a3e513",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bb40d51d-45ae-4d1d-b280-5d5ef315aaef",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "14b31e04-fe77-493b-a7a6-439967232109",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bb8dc221-1d8d-4e42-81eb-c848f7a51a3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2efcbb90-312a-4c14-802b-72a932378115",
"db_currency_id": "9749e28f-fec4-4248-84fc-58076a654942",
"db_language_id": "a65c0521-60d2-4222-a1f6-e47788a777a2",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"equipment_family_id": "6892141e-4099-4a84-b9cd-56f99246ac73",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2dbcce25-35c7-42ca-9d8f-5ca7ad96a1c0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "67c38cda-a521-464f-9057-6c970490d232",
"_parent_code": "sample string 6",
"sales_organization_id": "f5adab9e-7fdf-4449-9ace-78861899bda9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bb8dc221-1d8d-4e42-81eb-c848f7a51a3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2efcbb90-312a-4c14-802b-72a932378115",
"db_currency_id": "9749e28f-fec4-4248-84fc-58076a654942",
"db_language_id": "a65c0521-60d2-4222-a1f6-e47788a777a2",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"date_in_production_since": "2026-09-20T20:04:38.2112866+00:00",
"date_out_of_production_since": "2026-09-20T20:04:38.2112866+00:00",
"date_end_support": "2026-09-20T20:04:38.2112866+00:00",
"sales_organization_id": "c0b7dce0-d430-4375-8bdb-b94a84e77e22",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bb8dc221-1d8d-4e42-81eb-c848f7a51a3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2efcbb90-312a-4c14-802b-72a932378115",
"db_currency_id": "9749e28f-fec4-4248-84fc-58076a654942",
"db_language_id": "a65c0521-60d2-4222-a1f6-e47788a777a2",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"project_status_id": "eb0e4e2c-f1de-4d3f-8e54-aca1ab3b78fe",
"project_status_code": "sample string 10",
"project_status": {
"id": "440efbc4-eb16-4c75-b965-3701803bf4f6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "140bbdff-6b55-490e-b5e3-9ba4d9d38a5c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bb8dc221-1d8d-4e42-81eb-c848f7a51a3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2efcbb90-312a-4c14-802b-72a932378115",
"db_currency_id": "9749e28f-fec4-4248-84fc-58076a654942",
"db_language_id": "a65c0521-60d2-4222-a1f6-e47788a777a2",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"company_id": "04dcfd6d-1e49-4cdb-a23e-c2a65387553a",
"company_code": "sample string 12",
"db_address_id": "33de8fd5-7e8a-481b-9e28-f94b35640b97",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "41db5000-0a98-43a9-93e9-59cd1379d326",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "af5d278d-090f-4fdb-9205-169ec7dc74ba",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2026-09-20T20:04:38.2112866+00:00",
"date_create": "2026-09-20T20:04:38.2112866+00:00",
"date_update": "2026-09-20T20:04:38.2112866+00:00",
"updated_by_user_id": "11e8c339-484a-4a79-90e0-be80f194d644",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-20T20:04:38.2112866+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2026-09-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-20T20:04:38.2112866+00:00",
"date_last_job": "2026-09-20T20:04:38.2112866+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-20T20:04:38.2112866+00:00",
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00",
"is_mobile_installation": true
},
"job_type_id": "33efd39b-7e7c-44ec-9795-cee02a6c55b6",
"job_type_code": "sample string 7",
"job_type": {
"id": "04a38f0c-16df-4ca9-9a1e-8b48bdbf0073",
"name": "sample string 2",
"sales_organization_id": "e82a7fc8-fd67-448c-bea2-19220ece3e72",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00",
"code": "sample string 7"
},
"job_priority_id": "8b7cf580-7b28-4e2d-9f58-778d3a2d48c2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4859670f-b222-4df8-b0a2-a86103ee34d9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2f3ad15b-8461-42b9-af31-c2482cd481d0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bb8dc221-1d8d-4e42-81eb-c848f7a51a3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2efcbb90-312a-4c14-802b-72a932378115",
"db_currency_id": "9749e28f-fec4-4248-84fc-58076a654942",
"db_language_id": "a65c0521-60d2-4222-a1f6-e47788a777a2",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"job_status_id": "8eb18d2a-1058-433f-a479-6f72c259c6ea",
"job_status_code": "sample string 11",
"db_address_id": "21f1892c-5cfa-4b41-b112-fe767223028e",
"contact_id": "7ef25673-1c6c-4b7d-b5cb-d8c0204bda34",
"requested_by_company_id": "62c5c250-7051-493a-9e58-5919211354f8",
"requested_by_contact_id": "f97d960e-aa37-4275-bca8-b3185c97a783",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2026-09-20T20:04:38.2112866+00:00",
"due_date": "2026-09-20T20:04:38.2112866+00:00",
"date_create": "2026-09-20T20:04:38.2112866+00:00",
"date_update": "2026-09-20T20:04:38.2112866+00:00",
"date_closed": "2026-09-20T20:04:38.2112866+00:00",
"suggested_user_id": "db1ac882-cc69-4a33-b038-210c0e35a2fe",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d01ecbe8-206e-46b5-80a9-d755695cc12a",
"db_language_id": "9c06d54d-c325-447d-ab8a-565fc2d6022a",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2026-09-20T20:04:38.2112866+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "af84f028-0204-46be-8679-6cdd58efa276",
"sales_organization": {
"id": "bb8dc221-1d8d-4e42-81eb-c848f7a51a3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2efcbb90-312a-4c14-802b-72a932378115",
"db_currency_id": "9749e28f-fec4-4248-84fc-58076a654942",
"db_language_id": "a65c0521-60d2-4222-a1f6-e47788a777a2",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2d3e6557-f2d6-47da-a16e-28aab3471d56",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "13d40495-981b-4344-8938-b4dd236c3ec9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "adcdbe72-d772-45a2-9d61-5766199b99d4"
},
"suggested_date_start": "2026-09-20T20:04:38.2112866+00:00",
"skill_id": "ab8282ca-03c8-47e4-a70b-4d648b70aa72",
"skill_code": "sample string 32",
"skill": {
"id": "a617a721-3cf3-43e4-80ac-e290e6725358",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2a91154c-ef12-4609-8668-7756da9ad5cc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bb8dc221-1d8d-4e42-81eb-c848f7a51a3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2efcbb90-312a-4c14-802b-72a932378115",
"db_currency_id": "9749e28f-fec4-4248-84fc-58076a654942",
"db_language_id": "a65c0521-60d2-4222-a1f6-e47788a777a2",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dd3ed82f-2032-4f8b-aa03-a1c4f08827f3",
"date_reported_by_company": "2026-09-20T20:04:38.2112866+00:00",
"id2": 36,
"company_id": "e6374a46-9c4d-453e-b518-3a66c99fe1ae",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "f1d7ef5a-37f9-4335-9e58-5555e4250acd",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2026-09-20T20:04:38.2112866+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.