Creates or updates a job planning.
Request Information
URI Parameters :
None.
Body Parameters :
job_planning| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| jobs_id |
FK to jobs.id |
globally unique identifier | |
| job_name |
jobs.name |
string | |
| date_from |
Date from. Defaults to when absent from the request body. |
date | |
| date_to |
Date to. Defaults to when absent from the request body. |
date | |
| job_status_id |
FK to job_status.id |
globally unique identifier | |
| sys_logical_delete |
Soft-delete flag: when true, this planning slot is considered deleted, optimizing synchronization (can be physically deleted offline). |
boolean | |
| field_accept_date_max_timeout |
Date max time out for field accept. Defaults to when absent from the request body. |
date | |
| dateutc_in_progress |
Date utc when job is put in progress. Defaults to when absent from the request body. |
date | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating. Defaults to , which the repositories read as "never modified" (they compare against year 1980). |
date | |
| user_id |
Foreign key of the user (technician) this planning slot is assigned to. |
globally unique identifier | |
| travel_to |
Estimated travel time to reach the job's location, in minutes. |
integer | |
| travel_back |
Estimated travel time to return from the job's location, in minutes. |
integer | |
| is_locked |
Whether a planner has locked this planning slot on the portal (FSA-6084). A locked slot cannot be rescheduled or re-assigned by the technician. The app has no feature to set or change this — it only reads the portal's value on sync. |
boolean |
Request Formats :
application/json, text/json
{
"id": "c7bc4157-7173-40d5-ade0-7ec7f84b1bce",
"jobs_id": "f1abf72b-fa85-4f6b-9e5f-ae04c36d8fc4",
"job_name": "sample string 3",
"date_from": "2026-11-12T14:28:18.1504139+00:00",
"date_to": "2026-11-12T14:28:18.1504139+00:00",
"job_status_id": "f4385e0c-4007-403e-90fb-2b0aa462abd8",
"sys_logical_delete": true,
"field_accept_date_max_timeout": "2026-11-12T14:28:18.1504139+00:00",
"dateutc_in_progress": "2026-11-12T14:28:18.1504139+00:00",
"modified_dateutc": "2026-11-12T14:28:18.1504139+00:00",
"user_id": "0d497214-39bc-49c8-9863-31b5617b2163",
"travel_to": 12,
"travel_back": 13,
"is_locked": true
}
application/xml, text/xml
<job_planning xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <date_from>2026-11-12T14:28:18.150Z</date_from> <date_to>2026-11-12T14:28:18.150Z</date_to> <dateutc_in_progress>2026-11-12T14:28:18.150Z</dateutc_in_progress> <field_accept_date_max_timeout>2026-11-12T14:28:18.150Z</field_accept_date_max_timeout> <id>c7bc4157-7173-40d5-ade0-7ec7f84b1bce</id> <is_locked>true</is_locked> <job_name>sample string 3</job_name> <job_status_id>f4385e0c-4007-403e-90fb-2b0aa462abd8</job_status_id> <jobs_id>f1abf72b-fa85-4f6b-9e5f-ae04c36d8fc4</jobs_id> <modified_dateutc>2026-11-12T14:28:18.150Z</modified_dateutc> <sys_logical_delete>true</sys_logical_delete> <travel_back>13</travel_back> <travel_to>12</travel_to> <user_id>0d497214-39bc-49c8-9863-31b5617b2163</user_id> </job_planning>
Response Information
Resource Description :
IHttpActionResult containing the saved job planning.
job_planning| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| jobs_id |
FK to jobs.id |
globally unique identifier | |
| job_name |
jobs.name |
string | |
| date_from |
Date from. Defaults to when absent from the request body. |
date | |
| date_to |
Date to. Defaults to when absent from the request body. |
date | |
| job_status_id |
FK to job_status.id |
globally unique identifier | |
| sys_logical_delete |
Soft-delete flag: when true, this planning slot is considered deleted, optimizing synchronization (can be physically deleted offline). |
boolean | |
| field_accept_date_max_timeout |
Date max time out for field accept. Defaults to when absent from the request body. |
date | |
| dateutc_in_progress |
Date utc when job is put in progress. Defaults to when absent from the request body. |
date | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating. Defaults to , which the repositories read as "never modified" (they compare against year 1980). |
date | |
| user_id |
Foreign key of the user (technician) this planning slot is assigned to. |
globally unique identifier | |
| travel_to |
Estimated travel time to reach the job's location, in minutes. |
integer | |
| travel_back |
Estimated travel time to return from the job's location, in minutes. |
integer | |
| is_locked |
Whether a planner has locked this planning slot on the portal (FSA-6084). A locked slot cannot be rescheduled or re-assigned by the technician. The app has no feature to set or change this — it only reads the portal's value on sync. |
boolean |
Response Formats
application/json, text/json
{
"id": "9a4fe3c1-865c-4a3b-9b70-88a5ee519e7a",
"jobs_id": "19cdd916-7c48-4fbe-acdf-53acf9f940b7",
"job_name": "sample string 3",
"date_from": "2026-11-12T14:28:18.1504139+00:00",
"date_to": "2026-11-12T14:28:18.1504139+00:00",
"job_status_id": "2372bca3-eab2-495a-828b-d06da88b05a3",
"sys_logical_delete": true,
"field_accept_date_max_timeout": "2026-11-12T14:28:18.1504139+00:00",
"dateutc_in_progress": "2026-11-12T14:28:18.1504139+00:00",
"modified_dateutc": "2026-11-12T14:28:18.1504139+00:00",
"user_id": "7a89ca01-a382-4d0b-a168-664004f08171",
"travel_to": 12,
"travel_back": 13,
"is_locked": true
}
application/xml, text/xml
<job_planning xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <date_from>2026-11-12T14:28:18.150Z</date_from> <date_to>2026-11-12T14:28:18.150Z</date_to> <dateutc_in_progress>2026-11-12T14:28:18.150Z</dateutc_in_progress> <field_accept_date_max_timeout>2026-11-12T14:28:18.150Z</field_accept_date_max_timeout> <id>9a4fe3c1-865c-4a3b-9b70-88a5ee519e7a</id> <is_locked>true</is_locked> <job_name>sample string 3</job_name> <job_status_id>2372bca3-eab2-495a-828b-d06da88b05a3</job_status_id> <jobs_id>19cdd916-7c48-4fbe-acdf-53acf9f940b7</jobs_id> <modified_dateutc>2026-11-12T14:28:18.150Z</modified_dateutc> <sys_logical_delete>true</sys_logical_delete> <travel_back>13</travel_back> <travel_to>12</travel_to> <user_id>7a89ca01-a382-4d0b-a168-664004f08171</user_id> </job_planning>