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": "a50afb2d-4578-4610-9766-4665d6472f08",
"_parent_id": "1b8716ad-56d9-4f1c-9c91-435e8a61f4e7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "20fc2fd5-5707-4882-bf93-e6b4aa146941",
"project_reference_back_office": "sample string 5",
"project": {
"id": "856704dd-a2e8-4cb3-b1a4-6b6968df94cd",
"_parent_id": "c0211abb-8617-4c39-a051-085bdda60163",
"root_parent_id": "c2e8219c-6804-4c0d-83c5-99f0b8e50ecf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c4d531c4-47dd-4faa-9d8b-ee5fd9cd0470",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e82c0f62-3583-42f8-a9e5-f152810d8d12",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e3d99c46-8894-4477-9640-984574afffc0",
"_parent_code": "sample string 6",
"sales_organization_id": "fea6482d-3d46-4fee-beb5-bd57b8350653",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "08e004b6-4423-428e-b4ad-652dc9168dd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d5f14c-3f8a-4250-91df-02ba61d306f5",
"db_currency_id": "45c9499f-a245-4427-ab1c-751c3d28dba5",
"db_language_id": "c8c0ec41-9fcf-4ebc-9052-965342e43630",
"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-11-10T10:25:45.46298+00:00"
},
"modified_dateutc": "2026-11-10T10:25:45.46298+00:00"
},
"equipment_model_id": "cad4d5f9-4a03-4556-9290-5ac180f59692",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e4be1aad-3d0f-46ec-8362-70555e7db07c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c353be71-6946-449e-9063-d62efb88e6d4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3d08b0a3-203c-4b47-8963-0b6d5eb12c7e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "abe9d4e4-ef3c-45f3-8092-a881a5ec9103",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "08e004b6-4423-428e-b4ad-652dc9168dd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d5f14c-3f8a-4250-91df-02ba61d306f5",
"db_currency_id": "45c9499f-a245-4427-ab1c-751c3d28dba5",
"db_language_id": "c8c0ec41-9fcf-4ebc-9052-965342e43630",
"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-11-10T10:25:45.46298+00:00"
},
"modified_dateutc": "2026-11-10T10:25:45.46298+00:00"
},
"equipment_family_id": "a7937fcb-d70e-40d5-898a-198aa55771cc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e82c0f62-3583-42f8-a9e5-f152810d8d12",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e3d99c46-8894-4477-9640-984574afffc0",
"_parent_code": "sample string 6",
"sales_organization_id": "fea6482d-3d46-4fee-beb5-bd57b8350653",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "08e004b6-4423-428e-b4ad-652dc9168dd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d5f14c-3f8a-4250-91df-02ba61d306f5",
"db_currency_id": "45c9499f-a245-4427-ab1c-751c3d28dba5",
"db_language_id": "c8c0ec41-9fcf-4ebc-9052-965342e43630",
"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-11-10T10:25:45.46298+00:00"
},
"modified_dateutc": "2026-11-10T10:25:45.46298+00:00"
},
"date_in_production_since": "2026-11-10T10:25:45.46298+00:00",
"date_out_of_production_since": "2026-11-10T10:25:45.46298+00:00",
"date_end_support": "2026-11-10T10:25:45.46298+00:00",
"sales_organization_id": "95c509e5-dd89-4292-811f-febdb38af4a2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "08e004b6-4423-428e-b4ad-652dc9168dd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d5f14c-3f8a-4250-91df-02ba61d306f5",
"db_currency_id": "45c9499f-a245-4427-ab1c-751c3d28dba5",
"db_language_id": "c8c0ec41-9fcf-4ebc-9052-965342e43630",
"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-11-10T10:25:45.46298+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-11-10T10:25:45.46298+00:00"
},
"project_status_id": "a1a7060d-e746-400f-826a-53e0daca99d8",
"project_status_code": "sample string 10",
"project_status": {
"id": "65d7c4e0-66d8-4e5b-ab74-8272e8cfe6ed",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ebfb6a0e-7b62-4ce8-adbb-4be778a0e756",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "08e004b6-4423-428e-b4ad-652dc9168dd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d5f14c-3f8a-4250-91df-02ba61d306f5",
"db_currency_id": "45c9499f-a245-4427-ab1c-751c3d28dba5",
"db_language_id": "c8c0ec41-9fcf-4ebc-9052-965342e43630",
"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-11-10T10:25:45.46298+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-10T10:25:45.46298+00:00"
},
"company_id": "1aa689e6-c2b2-4b3a-9e40-e35cda4a0927",
"company_code": "sample string 12",
"db_address_id": "76c657b9-d929-4cb2-81a4-70a0ffe8e523",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5069ecbd-d619-46d3-a430-6348bbd1c75a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f41d078f-80d7-48e2-8c60-e3091977ef91",
"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-11-10T10:25:45.46298+00:00",
"date_create": "2026-11-10T10:25:45.46298+00:00",
"date_update": "2026-11-10T10:25:45.46298+00:00",
"updated_by_user_id": "38d03655-6f8b-4a70-8d57-619a35c91ac3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-10T10:25:45.46298+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-11-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-10T10:25:45.46298+00:00",
"date_last_job": "2026-11-10T10:25:45.46298+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-10T10:25:45.46298+00:00",
"modified_dateutc": "2026-11-10T10:25:45.46298+00:00",
"is_mobile_installation": true
},
"job_type_id": "c2d45fec-1e98-4dfe-8104-ed8628cc8fed",
"job_type_code": "sample string 7",
"job_type": {
"id": "52390f3b-828c-4f2b-ae15-d3ce7ecbf533",
"name": "sample string 2",
"sales_organization_id": "67d2716f-a378-41eb-b419-bde660f5310b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-10T10:25:45.46298+00:00",
"code": "sample string 7"
},
"job_priority_id": "7e7cffe8-b8f8-4c70-89a2-d635406e311f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c8a401c1-4bab-4ef5-889a-83603a0d4fec",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "12a15609-433c-4fc7-a34e-1e51450f5e79",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "08e004b6-4423-428e-b4ad-652dc9168dd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d5f14c-3f8a-4250-91df-02ba61d306f5",
"db_currency_id": "45c9499f-a245-4427-ab1c-751c3d28dba5",
"db_language_id": "c8c0ec41-9fcf-4ebc-9052-965342e43630",
"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-11-10T10:25:45.46298+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-10T10:25:45.46298+00:00"
},
"job_status_id": "0834adb8-8d7a-42df-bf86-a2d258f76713",
"job_status_code": "sample string 11",
"db_address_id": "bfc39220-36d3-4389-84c5-df85c6768d99",
"contact_id": "c97019eb-eb70-438a-a771-05f3efc8840f",
"requested_by_company_id": "135b82a2-52f5-4008-b2b4-473789f17bf9",
"requested_by_contact_id": "a84787ef-081c-454f-a885-30899a9eb56f",
"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-11-10T10:25:45.46298+00:00",
"due_date": "2026-11-10T10:25:45.46298+00:00",
"date_create": "2026-11-10T10:25:45.46298+00:00",
"date_update": "2026-11-10T10:25:45.46298+00:00",
"date_closed": "2026-11-10T10:25:45.46298+00:00",
"suggested_user_id": "967acb1f-5b30-43a2-a25b-933273de6d31",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "edfb9974-a189-4266-b178-d340db705fab",
"db_language_id": "3747d765-b75d-47da-9596-e91e12a33b3d",
"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-11-10T10:25:45.475841+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "66d0d890-09bb-487c-9d5e-03e979560b01",
"sales_organization": {
"id": "08e004b6-4423-428e-b4ad-652dc9168dd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d5f14c-3f8a-4250-91df-02ba61d306f5",
"db_currency_id": "45c9499f-a245-4427-ab1c-751c3d28dba5",
"db_language_id": "c8c0ec41-9fcf-4ebc-9052-965342e43630",
"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-11-10T10:25:45.46298+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "277ee512-c188-4793-afec-bfd8634522a0",
"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": "60b5b0bb-fcc1-4282-af03-07ce8627c528",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-10T10:25:45.475841+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c81444ee-bdc2-4f7a-81d3-858ef5353903"
},
"suggested_date_start": "2026-11-10T10:25:45.475841+00:00",
"skill_id": "0a40bf92-5694-4708-b3cf-886f9e813233",
"skill_code": "sample string 32",
"skill": {
"id": "5af0b911-5464-4ddc-a81a-a2292a7173d5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b071e1ad-5f5a-45a3-bc3c-084c7f49e2ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "08e004b6-4423-428e-b4ad-652dc9168dd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78d5f14c-3f8a-4250-91df-02ba61d306f5",
"db_currency_id": "45c9499f-a245-4427-ab1c-751c3d28dba5",
"db_language_id": "c8c0ec41-9fcf-4ebc-9052-965342e43630",
"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-11-10T10:25:45.46298+00:00"
},
"modified_dateutc": "2026-11-10T10:25:45.475841+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fd551ac9-30ef-4099-a54e-30d0f3def1e9",
"date_reported_by_company": "2026-11-10T10:25:45.475841+00:00",
"id2": 36,
"company_id": "64f281de-9501-4276-bf07-f2eb3ad90d2b",
"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": "3d407f80-70f3-43c2-a3e1-faa640bbecc3",
"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-11-10T10:25:45.475841+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.