Retrieves the job planning with the specified key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

The job planning id.

 globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult containing the job planning, or 404 Not Found if it doesn't exist.

job_planning
NameDescriptionTypeAdditional 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

Sample: 
{
  "id": "ef7c03af-ce7d-45ad-b043-7f84097b1b30",
  "jobs_id": "433175a3-60ee-4acd-bc3a-6e3da08a5883",
  "job_name": "sample string 3",
  "date_from": "2026-11-12T14:28:47.6039937+00:00",
  "date_to": "2026-11-12T14:28:47.6039937+00:00",
  "job_status_id": "6d9f12b4-c61f-46de-a522-2eb56026c02a",
  "sys_logical_delete": true,
  "field_accept_date_max_timeout": "2026-11-12T14:28:47.6039937+00:00",
  "dateutc_in_progress": "2026-11-12T14:28:47.6039937+00:00",
  "modified_dateutc": "2026-11-12T14:28:47.6039937+00:00",
  "user_id": "948b2f98-0d22-4182-acf5-bdcd0b836d8d",
  "travel_to": 12,
  "travel_back": 13,
  "is_locked": true
}

application/xml, text/xml

Sample: 
<job_planning xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <date_from>2026-11-12T14:28:47.603Z</date_from>
  <date_to>2026-11-12T14:28:47.603Z</date_to>
  <dateutc_in_progress>2026-11-12T14:28:47.603Z</dateutc_in_progress>
  <field_accept_date_max_timeout>2026-11-12T14:28:47.603Z</field_accept_date_max_timeout>
  <id>ef7c03af-ce7d-45ad-b043-7f84097b1b30</id>
  <is_locked>true</is_locked>
  <job_name>sample string 3</job_name>
  <job_status_id>6d9f12b4-c61f-46de-a522-2eb56026c02a</job_status_id>
  <jobs_id>433175a3-60ee-4acd-bc3a-6e3da08a5883</jobs_id>
  <modified_dateutc>2026-11-12T14:28:47.603Z</modified_dateutc>
  <sys_logical_delete>true</sys_logical_delete>
  <travel_back>13</travel_back>
  <travel_to>12</travel_to>
  <user_id>948b2f98-0d22-4182-acf5-bdcd0b836d8d</user_id>
</job_planning>