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": "848cbba7-5e76-43c3-8bd0-8534de26fb42",
"_parent_id": "f89f424d-0505-4b4a-bb0e-adb2f3e2c48d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6e6d0a0f-d47f-48bf-85e1-903f6f8debe1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "513fb135-e47a-49d6-9fcd-59f6a4509c47",
"_parent_id": "f869bbd8-1f53-4f2f-a47e-efb22cc2d04b",
"root_parent_id": "8cd24e58-9d9d-4e44-a58c-96ce17d2e285",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "195cf33a-f043-413a-9043-54ec7563e770",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "769de9d0-9593-4a93-94ea-487411055dac",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dccf7c8c-102e-4103-99f6-46ec8118f03d",
"_parent_code": "sample string 6",
"sales_organization_id": "d4ba2e86-4068-4b5d-b035-5d6a075e3bf5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b74bde5d-e179-4b25-b96c-bd403f1fe6a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9e15c283-c962-4591-9477-3604aea694a5",
"db_currency_id": "640fc4ca-12e6-465c-8b11-44769788f5db",
"db_language_id": "970d1c7f-6987-479e-9bef-8d526fa72073",
"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-08-19T19:10:31.2485604+00:00"
},
"modified_dateutc": "2026-08-19T19:10:31.2485604+00:00"
},
"equipment_model_id": "1c3bfe04-ebd3-4a20-83b5-959d8acbacfd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ff3bf275-1602-469e-a472-e514497fb654",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ff6156fd-7822-471d-83f7-fcd3a90fb07a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "504024f6-e205-4102-9cda-441af437b259",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1306f606-742a-4841-a235-0927008dacf7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b74bde5d-e179-4b25-b96c-bd403f1fe6a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9e15c283-c962-4591-9477-3604aea694a5",
"db_currency_id": "640fc4ca-12e6-465c-8b11-44769788f5db",
"db_language_id": "970d1c7f-6987-479e-9bef-8d526fa72073",
"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-08-19T19:10:31.2485604+00:00"
},
"modified_dateutc": "2026-08-19T19:10:31.2485604+00:00"
},
"equipment_family_id": "6a99a3e5-d28c-4aae-9d3a-3df9e6b3756e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "769de9d0-9593-4a93-94ea-487411055dac",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dccf7c8c-102e-4103-99f6-46ec8118f03d",
"_parent_code": "sample string 6",
"sales_organization_id": "d4ba2e86-4068-4b5d-b035-5d6a075e3bf5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b74bde5d-e179-4b25-b96c-bd403f1fe6a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9e15c283-c962-4591-9477-3604aea694a5",
"db_currency_id": "640fc4ca-12e6-465c-8b11-44769788f5db",
"db_language_id": "970d1c7f-6987-479e-9bef-8d526fa72073",
"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-08-19T19:10:31.2485604+00:00"
},
"modified_dateutc": "2026-08-19T19:10:31.2485604+00:00"
},
"date_in_production_since": "2026-08-19T19:10:31.2485604+00:00",
"date_out_of_production_since": "2026-08-19T19:10:31.2485604+00:00",
"date_end_support": "2026-08-19T19:10:31.2485604+00:00",
"sales_organization_id": "9a86a285-37d1-4c61-a990-9b1a074be76f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b74bde5d-e179-4b25-b96c-bd403f1fe6a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9e15c283-c962-4591-9477-3604aea694a5",
"db_currency_id": "640fc4ca-12e6-465c-8b11-44769788f5db",
"db_language_id": "970d1c7f-6987-479e-9bef-8d526fa72073",
"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-08-19T19:10:31.2485604+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-08-19T19:10:31.2485604+00:00"
},
"project_status_id": "60525d83-5ed5-4f3f-9efe-dd3b565859af",
"project_status_code": "sample string 10",
"project_status": {
"id": "0fde0490-a90e-4fe4-abb7-738583c8f639",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9165184b-aa1a-4403-a7b2-865bbd4b646f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b74bde5d-e179-4b25-b96c-bd403f1fe6a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9e15c283-c962-4591-9477-3604aea694a5",
"db_currency_id": "640fc4ca-12e6-465c-8b11-44769788f5db",
"db_language_id": "970d1c7f-6987-479e-9bef-8d526fa72073",
"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-08-19T19:10:31.2485604+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-19T19:10:31.2485604+00:00"
},
"company_id": "88f51d17-4324-413d-810f-dfa20d49d629",
"company_code": "sample string 12",
"db_address_id": "f40e23b0-ea5f-4191-8d75-808d02abd201",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b7697f0c-f7ce-4709-aaf3-d7b290431dca",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c8aee5a7-7edc-4dc0-b102-91c1c3778b9d",
"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-08-19T19:10:31.2485604+00:00",
"date_create": "2026-08-19T19:10:31.2485604+00:00",
"date_update": "2026-08-19T19:10:31.2485604+00:00",
"updated_by_user_id": "7adcf881-44c2-4d91-bc41-99ed74803254",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-19T19:10:31.2485604+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-08-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-19T19:10:31.2485604+00:00",
"date_last_job": "2026-08-19T19:10:31.2485604+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-19T19:10:31.2485604+00:00",
"modified_dateutc": "2026-08-19T19:10:31.2485604+00:00",
"is_mobile_installation": true
},
"job_type_id": "e1573d18-960f-4afe-9028-cbb9f1eedad4",
"job_type_code": "sample string 7",
"job_type": {
"id": "fad22d7e-41f8-43c2-89cc-3a4f8786b7a7",
"name": "sample string 2",
"sales_organization_id": "54f588da-7394-4cc9-ba9b-49441c0d7f67",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-19T19:10:31.2485604+00:00",
"code": "sample string 7"
},
"job_priority_id": "8fb2d593-98c1-4eab-b549-767f3077b62c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9e83e43e-ce31-4e36-8e21-4f1870d9682e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d09c4c41-e41c-4ab7-aace-38ca4e615a16",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b74bde5d-e179-4b25-b96c-bd403f1fe6a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9e15c283-c962-4591-9477-3604aea694a5",
"db_currency_id": "640fc4ca-12e6-465c-8b11-44769788f5db",
"db_language_id": "970d1c7f-6987-479e-9bef-8d526fa72073",
"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-08-19T19:10:31.2485604+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-19T19:10:31.2485604+00:00"
},
"job_status_id": "8a627924-fc58-4455-a75d-724771c7ec98",
"job_status_code": "sample string 11",
"db_address_id": "cd319df7-eb56-4439-b9c7-3a971b0915b9",
"contact_id": "3b58e570-9497-495a-adc0-628b1193a778",
"requested_by_company_id": "a1b0edb3-67b9-4ca2-bceb-7cdee5871f1e",
"requested_by_contact_id": "bf432491-f72e-4171-9346-676451b626cc",
"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-08-19T19:10:31.2485604+00:00",
"due_date": "2026-08-19T19:10:31.2485604+00:00",
"date_create": "2026-08-19T19:10:31.2485604+00:00",
"date_update": "2026-08-19T19:10:31.2485604+00:00",
"date_closed": "2026-08-19T19:10:31.2485604+00:00",
"suggested_user_id": "0185becd-5a78-4e82-9994-b35fc2849b17",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "99b233b7-7c29-42c1-8574-97ae657506d6",
"db_language_id": "635fac93-f014-4694-9f90-63866421c116",
"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-08-19T19:10:31.2485604+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1abaecb7-3a2f-465f-9ab0-70d36c07fcf2",
"sales_organization": {
"id": "b74bde5d-e179-4b25-b96c-bd403f1fe6a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9e15c283-c962-4591-9477-3604aea694a5",
"db_currency_id": "640fc4ca-12e6-465c-8b11-44769788f5db",
"db_language_id": "970d1c7f-6987-479e-9bef-8d526fa72073",
"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-08-19T19:10:31.2485604+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a50fdfd3-7159-46a2-b6cd-9cac84d2c952",
"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": "672d7c04-7e52-473b-affe-7f26595fcea3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-19T19:10:31.2485604+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "13c67de1-1c7c-4fe3-8c95-624af39bf547"
},
"suggested_date_start": "2026-08-19T19:10:31.2485604+00:00",
"skill_id": "20ee4eb5-f905-426c-a008-229c3b7df2a3",
"skill_code": "sample string 32",
"skill": {
"id": "4bd9c1b6-4bfa-49f5-b467-05c9fb873ee2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0bf8468a-3fb3-4cb3-b870-94e39c657428",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b74bde5d-e179-4b25-b96c-bd403f1fe6a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9e15c283-c962-4591-9477-3604aea694a5",
"db_currency_id": "640fc4ca-12e6-465c-8b11-44769788f5db",
"db_language_id": "970d1c7f-6987-479e-9bef-8d526fa72073",
"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-08-19T19:10:31.2485604+00:00"
},
"modified_dateutc": "2026-08-19T19:10:31.2485604+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "50b51902-9f96-4590-b4f2-67b08cc9109d",
"date_reported_by_company": "2026-08-19T19:10:31.2485604+00:00",
"id2": 36,
"company_id": "066a850e-87b4-412d-b339-541782f5afd6",
"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": "55e9aeaf-134d-4f41-bad4-694a2a25a572",
"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-08-19T19:10:31.2485604+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.