NextGen APIs

GET /workforce/crew-shells/r1/crew-shell-workshift-processing-status

Http Verb

GET

Url

/workforce/crew-shells/r1/crew-shell-workshift-processing-status

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

PAGINATION ORDERING-SERVER-SIDE

Pagination and ordering apply to the collection endpoint only. Field selection is available on both endpoints.

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.

Collection

GET /workforce/crew-shells/r1/crew-shell-workshift-processing-status returns a paginated collection of statuses filtered by input criteria. The service maps DTOCrewShellWorkShiftProcessingStatusFilter to CrewShellWorkShiftProcessingStatusSearchFilter and launches the search event through the shared REST helper. There is no crewShellId parameter or crew-shell-specific scope.

Path parameters

N/A

Query String Parameters

Filter

Collection endpoint only. The bound filter object is annotated @Valid and @NotNull. Its individual fields are optional and have no explicit field-level validation constraints.

Field

Validations

Note

id

Collection of Long

Status IDs.

code

Collection of String

Status codes, such as QUEUED or COMPLETED.

description

String

Status description filter. Matching uses the shared DAO filter infrastructure.

Order

Optional _order string on the collection endpoint; passed to the shared REST search helper.

Default Order

Status code (LCWPCODE), as declared by DAOCrewShellWorkShiftProcessingStatusSearch.

Possible order values

No endpoint-specific allow-list is declared. Ordering syntax and field resolution are delegated to the shared REST infrastructure.

Page

_page is required by the collection method's @RequestParam declaration. Type: Page, annotated @Valid and @NotExploded, with FORM style and explode=false. Pagination encoding and limits use the shared Page infrastructure; no endpoint-specific default is declared.

Not applicable to single-record retrieval.

Fields

Optional _fields collection of strings on both endpoints, passed to the shared REST helper for response field selection. DTO field names are id, code, and description.

Header Parameters

Default private-service headers and authentication. No additional endpoint-specific header parameters are declared. Response Content-Type: application/json.

Response documentation

Collection: PageResponse<DTOCrewShellWorkShiftProcessingStatus>. 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

Controller and DTOs: crewshell.rs1/src/main/java/overit/geocallapp/wfm/core/crewshell/rs1/crewshell/workshift/processing/status/ (CrewShellWorkShiftProcessingStatusService.java, DTOCrewShellWorkShiftProcessingStatus.java, DTOCrewShellWorkShiftProcessingStatusFilter.java).

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.