See the version list below for details.
Install-Package VSoft.MobileWorkforce -Version 3.0.0
dotnet add package VSoft.MobileWorkforce --version 3.0.0
<PackageReference Include="VSoft.MobileWorkforce" Version="3.0.0" />
paket add VSoft.MobileWorkforce --version 3.0.0
#r "nuget: VSoft.MobileWorkforce, 3.0.0"
// Install VSoft.MobileWorkforce as a Cake Addin #addin nuget:?package=VSoft.MobileWorkforce&version=3.0.0 // Install VSoft.MobileWorkforce as a Cake Tool #tool nuget:?package=VSoft.MobileWorkforce&version=3.0.0
.NET Standard client implementation for VSoft Mobile Workforce REST API
|.NET||net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows|
|.NET Core||netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1|
|.NET Standard||netstandard2.0 netstandard2.1|
|.NET Framework||net461 net462 net463 net47 net471 net472 net48|
- No dependencies.
This package is not used by any NuGet packages.
This package is not used by any popular GitHub repositories.
New major API version was introduced. All changes listed below apply to new endpoints only. Backward compatibility for all existing methods is preserved and no immediate client side code changes are required after the software.
Added v3 endpoint addressing for all API methods. All v3 endpoints use REST resource based endpoint naming scheme and HTTP status codes for failure communication (400 for validation errors, 404 for not existing objects).
Added parameter expand in the GetMobileUserGroups method that allows to include additional data. It supports comma-separated strings of fields to include. Currently supported values: expand-users.
Added data querying methods for mobile users (GetMobileUsers) and tasks (GetTasks). These methods support generic data filtering and ordering. You can read more on the Data queries page.
Some API fields were removed:
Task data no longer contains TaskAddress, Coordinates and PhoneNumber fields. Addresses and phone numbers should be specified only in TaskData.MetaData.Addresses and TaskData.MetaData.PhoneNumbers fields respectively.
Optional user provided task geolocation data can now be specified for each individual task address using TaskData.MetaData.Addresses.Coordinates field.
TaskData.Id field was removed form data used by the AddTask and UpdateTask methods. New endpoint url is now used to pass the id instead.
Some API fields were renamed:
TaskData.MetaData.History was renamed to TaskData.MetaData.CaseHistory.
TaskData.MetaData.CaseDetails.IsInCase was renamed to TaskData.MetaData.CaseDetails.InCase.
TaskData.MetaData.Payments.No was renamed to TaskData.MetaData.Payments.Number.
ReportData.Phones was renamed to ReportData.PhoneNumbers.
Some API fields were added:
Result.Code: contains error class code in case of an error result.
TaskData.DryRun: allows executing only a validation phase of AddTask and UpdateTask methods.
Some API methods were deprecated:
GetBankingTaskOrNull: use GetTaskOrNull method instead.
GetBankingReportOrNull: use GetReportOrNull method instead.
AddBankingTask: user AddTask method instead.
UpdateBankingTask: use UpdateTask method instead.
GetObjectNames: use GetPredefinedCategories method instead.
GetUsers: use GetMobileUsers method method instead.
ValidateTask: use DryRun param of AddTask method instead.
ValidateUpdateTask: use DryRun param of UpdateTask method instead.
Behavior changes introduced in v3 methods (pre v3 endpoints are not affected):
Methods that return Result data type will now additionally use HTTP 400 code for data communicating validation errors and HTTP 404 code when related data object is not found.
GetTaskPayments, GetTaskActions, GetUserSchedule, GetJobStatus will now use HTTP 404 code when object related to the query does not exist.
GetMobileUserSchedule now returns tasks from all systems.
Downloading task data created in previous system versions:
Main task address previously specified in the TaskData will now be automatically included in the TaskData.MetaData.Address collection. Such an address will have its id set to the constant value of 'main-d23ce527f309'. The address will be included only if Addresses collection does not contain any address with same data as main address.
Main task phone number previously specified in the TaskData will now be automatically included in the TaskData.MetaData.PhoneNumbers collection. Such a number will have its id set to the constant value of 'main-d23ce527f309'. The number will be included only if PhoneNumbers collection does not already contain specified number.
These changes affect only the data returned by the GetTaskOrNull method.
Address and phone number with special id 'main-d23ce527f309' will not be sent to the mobile clients as a part of the meta data.