|
Http Verb |
GET |
|---|---|
|
Url |
/workforce/crew-shells/r1/crew-shell-workshift-processing-status/{crewShellWorkShiftProcessingStatusId} |
|
Permissions required |
No |
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
r1 |
|
Released since |
FSM 25.0 (source @since) |
|
Deprecated since |
Not declared. |
|
Removed since |
Not declared. |
|
Tech Tags |
No |
Business Logic
CrewShellWorkShiftProcessingStatusService provides read-only access to the crew shell work shift processing status catalogue stored in LCREWSHELLWORKSHIFTPROCSTATUS. Both endpoints produce application/json. This service declares no POST, PUT, PATCH, or DELETE operations.
Single record
GET /workforce/crew-shells/r1/crew-shell-workshift-processing-status/{crewShellWorkShiftProcessingStatusId} returns the status identified by the path parameter, using CrewShellWorkShiftProcessingStatusLoadEvent.
Path parameters
|
Field |
Validations |
Note |
|---|---|---|
|
crewShellWorkShiftProcessingStatusId |
Required for single-record retrieval; route pattern [0-9]+; binds to Long. |
Status catalogue ID. No additional positive-value constraint is declared. |
Query String Parameters
N/A
Header Parameters
Default private-service headers and authentication. No additional endpoint-specific header parameters are declared. Response Content-Type: application/json.
Response documentation
Single record: DTOCrewShellWorkShiftProcessingStatus. The following fields describe each status object, not the pagination wrapper.
Response payload fields
|
Field |
Note |
|---|---|
|
id |
Long. Status ID, mapped to LCWPID. |
|
code |
String. Status code, mapped to LCWPCODE. |
|
description |
String. Status description, mapped to LCWPDESCRIPTION. |
Seeded status values
|
id |
code |
description |
|---|---|---|
|
1 |
QUEUED |
Queued |
|
2 |
IN_PROCESS |
In Process |
|
3 |
COMPLETED |
Completed |
|
4 |
ERROR |
Error |
These values are inserted by the installation script. The lookup service does not define or enforce processing state transitions.
Response error
|
HTTP status |
Applies to |
Note |
|---|---|---|
|
200 OK |
Both |
Successful collection or single-status response. |
|
403 Forbidden |
Both |
Declared by the controller. No additional function permission is enforced by the status search/load tasks; shared private-service access rules still apply. |
|
404 Not Found |
Single record |
Declared for a status that cannot be found. |
Binding, validation, and data-access exceptions are delegated to the shared REST infrastructure. No endpoint-specific error payload is declared in this controller.
Implementation references
Routes: crewshell.rs1/src/main/java/overit/geocallapp/wfm/core/crewshell/rs1/APIPath.java. Business tasks and DAO ordering: crewshell/src/main/java/overit/geocallapp/wfm/crewshell/bl/workshift/processing/status/, task and data packages.
Seed values: crewshell/src/main/java/overit/geocallapp/wfm/crewshell/install/scripts/25.0.0.26101600.sql.