API Version Migration v2 to v3
Trio VMS encourages users and integrators to move from the v2 to expanded v3 APIs for simplied data access, enhanced functionality, additional properties and consistent performance.
The primary change between v2 and v3 APIs are the move away from OData. Trio VMS API v2 are OData endpoints, which adds an additional layer of metadata and complexity in making calls and handling responses. We believe the v3 APIs are more straight-forward and easier to work with in a REST-ful manner.
v3 API Changes
The Trio VMS v3 APIs adds a number of endpoints that can be leveraged for integrations, introduces additional properties to frequently used models, and filter options for simplified and performant resource querying.
Job
The /v3/Job endpoint replaces the /v2/Jobs endpoint used to list jobs available to an account. The primary changes include additional data for each job and a way to optimize job retrieval by supporting getting open jobs by the last time they were modified.
Jobs Response
The response when retrieving jobs with the v3 endpoint directly returns an array of jobs rather than an array in a value property.
Additional Job Properties
- NumberOfCurrentOpenPositions - The number of remaining positions currently open for the job.
- UnitDescription - Description detail for the unit the job is located at.
- RelationshipManagerPhone - Phone number for the Relationship Manager (if available)
- RelationshipManagerEmail - Email for the Relationship Manager (if available)
- PlacementCoordinator - Name of the Placement Coordinator
- PlacementCoordinatorPhone - Phone number for the Placement Coordinator
- PlacementCoordinatorEmail - Email for the Placement Coordinator
Job Filtering
- v3 Job endpoints support retrieval of closed jobs as well as open through two different endpoints
- /v3/Job - Retrieves all Open and OnHold jobs. A modifiedDate can optionally be provided to only get open jobs that have been modified after the supplied date.
- /v3/GetClosedJobs - Retrieves closed jobs that were posted between the provided start and end dates.
Candidate
The /v3/candidates endpoints provides additional filter capability and a cleaner, paged response when listing candidates as well as an expanded candidate detail model.
Model Comparison
| Model | Removed in v3 | Added in v3 | Changed in v3 | Notes |
|---|---|---|---|---|
| CandidateResponseModel | None | IsAlcoholFree, IsNicotineFree, IsConvicted, ConvictedDescription, IsSuspended, SuspendedDescription, Specialties, Certifications, StateLicenses | None | Expanded with additional candidate details and associated data |
| JobResponseModel | None | NumberOfCurrentOpenPositions, UnitDescription, RelationshipManagerPhone, RelationshipManagerEmail, PlacementCoordinator, PlacementCoordinatorPhone, PlacementCoordinatorEmail | None | Added more detailed job and contact information |
| ProviderConfirmationResponseModel | None | EsignStatus, StartDate, EndDate, SupervisorContactId | None | Added e-signature and date range information |
| TimecardExpenseResponseModel | None | ExpenseAccountNumber | None | Added account number for expense tracking |
| TimecardResponseModel | Invoice | InvoiceRefNumber, Context, ConfirmationNumber, AssignmentNumber, AssignmentStartDate, AssignmentEndDate, ClearanceNumber | None | Removed Invoice object, added more detailed reference information |
| TimecardPayTypeResponseModel | None | IsPermPlacement | None | Added flag for permanent placement pay types |