{
"openapi": "3.0.1",
"info": {
"title": "ShiftWorks Api"
},
"servers": [
{
"url": "/portal1240/api"
}
],
"paths": {
"/Account/Login": {
"post": {
"tags": [
"Account"
],
"summary": "Cookies based authentication.",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/Account/AuthType": {
"get": {
"tags": [
"Account"
],
"summary": "Returns user authentication type",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "loginName",
"in": "query",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/Account/LoginAuth0": {
"get": {
"tags": [
"Account"
],
"summary": "Endpoint for login users that use auth0 for authentication",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "loginName",
"in": "query",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "redirectUrl",
"in": "query",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/Account/LogoutAuth0": {
"get": {
"tags": [
"Account"
],
"summary": "Endpoint for logout users that use auth0 for authentication",
"description": "Deprecated: Use OAuth/Logout endpoint
\r\nPermissions: All users. ",
"parameters": [
{
"name": "redirectUrl",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"deprecated": true
}
},
"/Account/Auth0Callback": {
"get": {
"tags": [
"Account"
],
"summary": "Callback endpoint for auth0 service",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "code",
"in": "query",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v2/Account": {
"get": {
"tags": [
"Account"
],
"summary": "Returns information about logged in user.",
"description": "Use this method if you want to get information about logged in user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.AccountInfoModel"
},
"example": {"LoginName":"1234_belque@test","UserName":"Test Belque login","AllowUnitAccess":false,"Email":null,"PhoneNumber":null,"UseAuth0":true,"ManagerLogEnabled":false,"PendoAccountID":"1234_test","PendoEnabled":true,"HelpUrl":"https://kbunit.rmdatacentral.com/aaabbbsometokenaaaabbbb/#home","DatableTrainingEnabled":true,"MoodleHelpUrl":null,"RoleID":"U","StoreID":1,"StoreDescription":"AnatoliiRest 1","StoreNumber":null,"StoreEditStartDate":null,"StoreEditEndDate":null,"StoreShiftCounts":false,"StoreTempScale":null,"BillingGroupID":null,"BillingGroupDescription":"AlexandrKokoievSubGroup","PermissionsGranted":["AdjustTipWeights"],"StoreMaxInventoryAmount":null,"StoreNegativeUsage":false,"StoreVarianceUsageThreshold":null,"StoreEnableInventoryEstimating":null,"StoreCity":null,"StorePayrollStateCode":null,"StoreStateCode":null,"StoreZip":null,"StoreFiscalCalendarID":null,"ParentRoleID":null,"EmployeeCompanies":null,"EmployeeStores":null,"IsBrinkUser":false,"MUSharedContextEnabled":false}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.AccountInfoModel"
},
"example": {"LoginName":"1234_belque@test","UserName":"Test Belque login","AllowUnitAccess":false,"Email":null,"PhoneNumber":null,"UseAuth0":true,"ManagerLogEnabled":false,"PendoAccountID":"1234_test","PendoEnabled":true,"HelpUrl":"https://kbunit.rmdatacentral.com/aaabbbsometokenaaaabbbb/#home","DatableTrainingEnabled":true,"MoodleHelpUrl":null,"RoleID":"U","StoreID":1,"StoreDescription":"AnatoliiRest 1","StoreNumber":null,"StoreEditStartDate":null,"StoreEditEndDate":null,"StoreShiftCounts":false,"StoreTempScale":null,"BillingGroupID":null,"BillingGroupDescription":"AlexandrKokoievSubGroup","PermissionsGranted":["AdjustTipWeights"],"StoreMaxInventoryAmount":null,"StoreNegativeUsage":false,"StoreVarianceUsageThreshold":null,"StoreEnableInventoryEstimating":null,"StoreCity":null,"StorePayrollStateCode":null,"StoreStateCode":null,"StoreZip":null,"StoreFiscalCalendarID":null,"ParentRoleID":null,"EmployeeCompanies":null,"EmployeeStores":null,"IsBrinkUser":false,"MUSharedContextEnabled":false}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.AccountInfoModel"
},
"example": {"LoginName":"1234_belque@test","UserName":"Test Belque login","AllowUnitAccess":false,"Email":null,"PhoneNumber":null,"UseAuth0":true,"ManagerLogEnabled":false,"PendoAccountID":"1234_test","PendoEnabled":true,"HelpUrl":"https://kbunit.rmdatacentral.com/aaabbbsometokenaaaabbbb/#home","DatableTrainingEnabled":true,"MoodleHelpUrl":null,"RoleID":"U","StoreID":1,"StoreDescription":"AnatoliiRest 1","StoreNumber":null,"StoreEditStartDate":null,"StoreEditEndDate":null,"StoreShiftCounts":false,"StoreTempScale":null,"BillingGroupID":null,"BillingGroupDescription":"AlexandrKokoievSubGroup","PermissionsGranted":["AdjustTipWeights"],"StoreMaxInventoryAmount":null,"StoreNegativeUsage":false,"StoreVarianceUsageThreshold":null,"StoreEnableInventoryEstimating":null,"StoreCity":null,"StorePayrollStateCode":null,"StoreStateCode":null,"StoreZip":null,"StoreFiscalCalendarID":null,"ParentRoleID":null,"EmployeeCompanies":null,"EmployeeStores":null,"IsBrinkUser":false,"MUSharedContextEnabled":false}
}
}
}
}
}
},
"/v2/Account/Token": {
"get": {
"tags": [
"Account"
],
"summary": "Get JWT token for current user session",
"description": "Generates JWT access token based on current user session\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.AccessToken"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.AccessToken"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.AccessToken"
}
}
}
}
}
},
"post": {
"tags": [
"Account"
],
"summary": "Login user. Generates JWT token.",
"description": "Generates JWT token.\r\nJwt token may be with single DB or with multiple db.\r\nIf Jwt token with multiple db use change-database api\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "User credentials",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
}
}
}
}
}
},
"/v2/Account/CreateCookieSession": {
"post": {
"tags": [
"Account"
],
"summary": "Create cookie session from token",
"description": "Use this method if you want to create cookie from token.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.CreateCookieSessionTokenModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.CreateCookieSessionTokenModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.CreateCookieSessionTokenModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.CreateCookieSessionTokenModel"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v2/Account/refresh-token": {
"post": {
"tags": [
"Account"
],
"summary": "Generates a new token.",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
}
}
}
}
}
},
"/v2/Account/revoke-token": {
"post": {
"tags": [
"Account"
],
"summary": "Revoke refresh token.",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.RefreshTokenModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.RefreshTokenModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.RefreshTokenModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.RefreshTokenModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v2/Account/SwitchCompany": {
"post": {
"tags": [
"Account"
],
"summary": "Switches a company.",
"description": "Changes company for user if he/ she works for several companies.\r\nGenerates new JWT token for particular company.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Company"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Company"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Company"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Company"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
}
}
}
}
}
},
"/v2/Account/Logout": {
"post": {
"tags": [
"Account"
],
"summary": "Logout for cookie based authentication.",
"description": "Use this method if you want to logout if you login using cookie based authentication.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v2/Account/BusinessDate": {
"get": {
"tags": [
"Account"
],
"summary": "Returns current user business date.",
"description": "Use this method if you want to get current user business date.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.BusinessDateModel"
},
"example": {"BusinessDate":"2026-09-16T00:00:00"}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.BusinessDateModel"
},
"example": {"BusinessDate":"2026-09-16T00:00:00"}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.BusinessDateModel"
},
"example": {"BusinessDate":"2026-09-16T00:00:00"}
}
}
}
}
}
},
"/v2/Account/shiftworks/change-password": {
"post": {
"tags": [
"Account"
],
"summary": "Change password for swiftworks employee user.",
"description": "Deprecated: Use ChangePassword instead.
Use this method to change password for current swiftworks employee user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Change password model.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Authentication.Models.ChangePasswordModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Authentication.Models.ChangePasswordModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Authentication.Models.ChangePasswordModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Authentication.Models.ChangePasswordModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
}
}
}
},
"deprecated": true
}
},
"/v2/Account/ChangePassword": {
"post": {
"tags": [
"Account"
],
"summary": "Changes password",
"description": "Use this method to change password for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Change password model.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.ChangePassword"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.ChangePassword"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.ChangePassword"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.ChangePassword"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
}
}
}
}
}
},
"/v2/Account/BrinkLogin": {
"post": {
"tags": [
"Account"
],
"summary": "Brink user authorization",
"description": "Use this method if you want to create a DC token for Brink user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "BrinkLoginModel.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.BrinkLoginModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.BrinkLoginModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.BrinkLoginModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.BrinkLoginModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.BrinkSessionInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.BrinkSessionInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.BrinkSessionInfo"
}
}
}
}
}
}
},
"/v2/Account/CreateBrinkSession": {
"post": {
"tags": [
"Account"
],
"summary": "Create Session from token",
"description": "Use this method if you want to create session from token.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.BrinkSessionInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.BrinkSessionInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.BrinkSessionInfo"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.BrinkSessionInfo"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v2/Account/MapDCUser": {
"post": {
"tags": [
"Account"
],
"summary": "Map brink user to dc user.",
"description": "Use this method if you want to map brink user to dc user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v2/Account/StoresLookup": {
"get": {
"tags": [
"Account"
],
"summary": "Returns available stores user can switch to",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.StoreLookup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.StoreLookup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.StoreLookup"
}
}
}
}
}
}
}
},
"/v2/Account/SwitchToStore": {
"post": {
"tags": [
"Account"
],
"summary": "Switch user to store.",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.Common.SwitchToStoreModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.Common.SwitchToStoreModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.Common.SwitchToStoreModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.Common.SwitchToStoreModel"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v2/Account/SwitchToParent": {
"post": {
"tags": [
"Account"
],
"summary": "Switch user session back to parent",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.RefreshTokenModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.RefreshTokenModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.RefreshTokenModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.RefreshTokenModel"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v2/Account/SwitchStore": {
"post": {
"tags": [
"Account"
],
"summary": "Switch user store. Works for Bearer token authentication only.",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.JwtBearerSwitchStoreModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.JwtBearerSwitchStoreModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.JwtBearerSwitchStoreModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.JwtBearerSwitchStoreModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
}
}
}
}
}
},
"/v2/Account/Notifications/IsMuted": {
"get": {
"tags": [
"Account"
],
"summary": "Gets Notification Alerts Mute Status",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/v2/Account/Notifications": {
"get": {
"tags": [
"Account"
],
"summary": "Gets Notification Settings",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.NotificationSettings"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.NotificationSettings"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.NotificationSettings"
}
}
}
}
}
}
},
"/v2/Account/Notifications/Mute": {
"post": {
"tags": [
"Account"
],
"summary": "Mutes All Notification Alerts",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v2/Account/Notifications/Unmute": {
"post": {
"tags": [
"Account"
],
"summary": "Unmutes All Notification Alerts",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v2/Account/Preferences": {
"get": {
"tags": [
"Account"
],
"summary": "Returns user preferences",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.AccountPreferences"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.AccountPreferences"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.AccountPreferences"
}
}
}
}
}
},
"patch": {
"tags": [
"Account"
],
"summary": "Updates user preferences",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.AccountPreferencesPatch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.AccountPreferencesPatch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.AccountPreferencesPatch"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.AccountPreferencesPatch"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/v2/Account/AuthSettings": {
"get": {
"tags": [
"Account"
],
"summary": "Returns user authentication settings",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "loginName",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.AuthSettings"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.AuthSettings"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.AuthSettings"
}
}
}
}
}
}
},
"/v2/Account/Languages": {
"get": {
"tags": [
"Account"
],
"summary": "Returns available languages for user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.LanguageDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.LanguageDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.LanguageDto"
}
}
}
}
}
}
}
},
"/v2/Account/{userName}/reset-password": {
"post": {
"tags": [
"Account"
],
"summary": "Forgot password. Will be send a temporary password to user email.",
"description": "Deprecated: Use ForgotPassword instead
Use this method when you reset password. New password will send to email.\r\nPermissions: All users. ",
"parameters": [
{
"name": "userName",
"in": "path",
"description": "Login name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"deprecated": true
}
},
"/v2/Account/reset-password": {
"post": {
"tags": [
"Account"
],
"summary": "Add a comment on lines L304 to L305Add diff commentMarkdown input: edit mode selected.WritePreviewHeadingBoldItalicQuoteCodeLinkUnordered listNumbered listTask listMentionReferenceMore itemsSaved repliesAdd FilesPaste, drop, or click to add filesCancelAdd review comment\r\n Forgot password. Will be send a temporary password to user email.",
"description": "Deprecated: Use ForgotPassword instead
Use this method when you reset password. New password will send to email.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Reset password parameters.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.Models.Authentication.ResetPasswordDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.Models.Authentication.ResetPasswordDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.Models.Authentication.ResetPasswordDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.Models.Authentication.ResetPasswordDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
},
"deprecated": true
}
},
"/v2/Account/ForgotPassword": {
"post": {
"tags": [
"Account"
],
"summary": "Forgot password.",
"description": "Use this method when you forgot password\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Object containing Login for which change password procedure was triggered.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Services.Auth.SendForgotPasswordEmailDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Services.Auth.SendForgotPasswordEmailDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Services.Auth.SendForgotPasswordEmailDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Services.Auth.SendForgotPasswordEmailDto"
}
}
}
},
"responses": {
"204": {
"description": "Request was successful."
}
}
}
},
"/v2/Account/ResetPassword": {
"post": {
"tags": [
"Account"
],
"summary": "Reset password. Requires password and reset token to be specified in the Body",
"description": "Use this method to reset password when you have generated forgot password token\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Services.Auth.ResetForgottenPasswordDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Services.Auth.ResetForgottenPasswordDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Services.Auth.ResetForgottenPasswordDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Services.Auth.ResetForgottenPasswordDto"
}
}
}
},
"responses": {
"204": {
"description": "Request was successful."
}
}
}
},
"/v2/Account/ValidationTokenInfo": {
"post": {
"tags": [
"Account"
],
"summary": "Validates if token can be used to reset password",
"description": "Use this method to reset password when you have generated forgot password token\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Services.Auth.ResetPasswordTokenValidationDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Services.Auth.ResetPasswordTokenValidationDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Services.Auth.ResetPasswordTokenValidationDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Services.Auth.ResetPasswordTokenValidationDto"
}
}
}
},
"responses": {
"204": {
"description": "Request was successful."
},
"400": {
"description": "Token is not valid or already used."
}
}
}
},
"/v3/Account": {
"get": {
"tags": [
"Account"
],
"summary": "Returns information about current user.",
"description": "Use this method if you want to get information about current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.Account"
},
"example": {"LoginName":"1234_belque@test","Company":{"Name":"1234_test"},"CanSwitchStore":false,"RegularContext":{"UserName":"Test Belque login","Email":null,"RoleID":"U","BillingGroup":{"ID":"b48c40fe-6a34-4acb-87c6-c8bc28004219","Description":"AlexandrKokoievSubGroup","DelagetClientID":null},"PermissionsGranted":["AdjustTipWeights"],"PhoneNumber":null,"UseAuth0":true,"ManagerLogEnabled":false,"PendoEnabled":true,"UseUserAnalytics":true,"HelpUrl":"https://kbunit.rmdatacentral.com/aaabbbsometokenaaaabbbb/#home","DatableTrainingEnabled":true,"MoodleHelpUrl":null,"ParentRoleID":null,"IsBrinkUser":false,"MUSharedContextEnabled":false,"AutoLaunchReportRecordID":null,"AutoLaunchReportRefreshIntervalMinutes":0,"AllowUnitAccess":false,"AIChatbotEnabled":true,"AIScheduleChatBotEnabled":false,"ApprovalWorkflowEnabled":true},"EmployeeContext":null,"StoreContext":{"ID":1,"Description":"AnatoliiRest 1","StoreNumber":null,"FiscalCalendarID":"00000000-0000-0000-0000-000000000000","PeriodStartDate":"0001-01-01","EditStartDate":"0001-01-01","EditEndDate":"0001-01-01","ShiftCounts":false,"TempScale":"\u0000","MaxInventoryAmount":0.0,"NegativeUsage":false,"VarianceUsageThreshold":null,"EnableInventoryEstimating":false,"CountryID":null,"City":null,"PayrollStateID":null,"PayrollStateCode":null,"StateCode":null,"Zip":null,"BusinessDate":"0001-01-01T00:00:00","StartTime":"00:00","IsSsnUsed":null},"TranslationEnabled":false,"UseUIEventLogs":false,"Language":null}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.Account"
},
"example": {"LoginName":"1234_belque@test","Company":{"Name":"1234_test"},"CanSwitchStore":false,"RegularContext":{"UserName":"Test Belque login","Email":null,"RoleID":"U","BillingGroup":{"ID":"b48c40fe-6a34-4acb-87c6-c8bc28004219","Description":"AlexandrKokoievSubGroup","DelagetClientID":null},"PermissionsGranted":["AdjustTipWeights"],"PhoneNumber":null,"UseAuth0":true,"ManagerLogEnabled":false,"PendoEnabled":true,"UseUserAnalytics":true,"HelpUrl":"https://kbunit.rmdatacentral.com/aaabbbsometokenaaaabbbb/#home","DatableTrainingEnabled":true,"MoodleHelpUrl":null,"ParentRoleID":null,"IsBrinkUser":false,"MUSharedContextEnabled":false,"AutoLaunchReportRecordID":null,"AutoLaunchReportRefreshIntervalMinutes":0,"AllowUnitAccess":false,"AIChatbotEnabled":true,"AIScheduleChatBotEnabled":false,"ApprovalWorkflowEnabled":true},"EmployeeContext":null,"StoreContext":{"ID":1,"Description":"AnatoliiRest 1","StoreNumber":null,"FiscalCalendarID":"00000000-0000-0000-0000-000000000000","PeriodStartDate":"0001-01-01","EditStartDate":"0001-01-01","EditEndDate":"0001-01-01","ShiftCounts":false,"TempScale":"\u0000","MaxInventoryAmount":0.0,"NegativeUsage":false,"VarianceUsageThreshold":null,"EnableInventoryEstimating":false,"CountryID":null,"City":null,"PayrollStateID":null,"PayrollStateCode":null,"StateCode":null,"Zip":null,"BusinessDate":"0001-01-01T00:00:00","StartTime":"00:00","IsSsnUsed":null},"TranslationEnabled":false,"UseUIEventLogs":false,"Language":null}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.Account"
},
"example": {"LoginName":"1234_belque@test","Company":{"Name":"1234_test"},"CanSwitchStore":false,"RegularContext":{"UserName":"Test Belque login","Email":null,"RoleID":"U","BillingGroup":{"ID":"b48c40fe-6a34-4acb-87c6-c8bc28004219","Description":"AlexandrKokoievSubGroup","DelagetClientID":null},"PermissionsGranted":["AdjustTipWeights"],"PhoneNumber":null,"UseAuth0":true,"ManagerLogEnabled":false,"PendoEnabled":true,"UseUserAnalytics":true,"HelpUrl":"https://kbunit.rmdatacentral.com/aaabbbsometokenaaaabbbb/#home","DatableTrainingEnabled":true,"MoodleHelpUrl":null,"ParentRoleID":null,"IsBrinkUser":false,"MUSharedContextEnabled":false,"AutoLaunchReportRecordID":null,"AutoLaunchReportRefreshIntervalMinutes":0,"AllowUnitAccess":false,"AIChatbotEnabled":true,"AIScheduleChatBotEnabled":false,"ApprovalWorkflowEnabled":true},"EmployeeContext":null,"StoreContext":{"ID":1,"Description":"AnatoliiRest 1","StoreNumber":null,"FiscalCalendarID":"00000000-0000-0000-0000-000000000000","PeriodStartDate":"0001-01-01","EditStartDate":"0001-01-01","EditEndDate":"0001-01-01","ShiftCounts":false,"TempScale":"\u0000","MaxInventoryAmount":0.0,"NegativeUsage":false,"VarianceUsageThreshold":null,"EnableInventoryEstimating":false,"CountryID":null,"City":null,"PayrollStateID":null,"PayrollStateCode":null,"StateCode":null,"Zip":null,"BusinessDate":"0001-01-01T00:00:00","StartTime":"00:00","IsSsnUsed":null},"TranslationEnabled":false,"UseUIEventLogs":false,"Language":null}
}
}
}
}
}
},
"/v3/Account/Token": {
"post": {
"tags": [
"Account"
],
"summary": "Login user. Generates JWT token.",
"description": "Generates JWT token.\r\nJwt token may be with single DB or with multiple db.\r\nIf Jwt token with multiple db use change-database api\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "User credentials",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RMDCApi.Models.LogOnModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.TokenModel"
}
}
}
}
}
}
},
"/shiftworks/Acknowledgments": {
"get": {
"tags": [
"Acknowledgments"
],
"summary": "Returns all acknowledgments for current user",
"description": "Returns all acknowledgments for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "SigningActions",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "DateFrom",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "DateThru",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentDto"
}
}
}
}
}
}
}
},
"/shiftworks/v1/Acknowledgments": {
"get": {
"tags": [
"Acknowledgments"
],
"summary": "Returns all acknowledgments for current user",
"description": "Returns all acknowledgments for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "SigningActions",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "DateFrom",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "DateThru",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentDto"
}
}
}
}
}
}
}
},
"/shiftworks/Acknowledgments/Schedule/{id}": {
"get": {
"tags": [
"Acknowledgments"
],
"summary": "Returns schedule acknowledgment details",
"description": "Returns schedule acknowledgment details.\r\nPermissions: All users. ",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentScheduleDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentScheduleDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentScheduleDto"
}
}
}
}
}
}
},
"/shiftworks/v1/Acknowledgments/Schedule/{id}": {
"get": {
"tags": [
"Acknowledgments"
],
"summary": "Returns schedule acknowledgment details",
"description": "Returns schedule acknowledgment details.\r\nPermissions: All users. ",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentScheduleDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentScheduleDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentScheduleDto"
}
}
}
}
}
}
},
"/shiftworks/Acknowledgments/Timecard/{id}": {
"get": {
"tags": [
"Acknowledgments"
],
"summary": "Returns timecard acknowledgment details",
"description": "Returns timecard acknowledgment details.\r\nPermissions: All users. ",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentTimecardDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentTimecardDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentTimecardDto"
}
}
}
}
}
}
},
"/shiftworks/v1/Acknowledgments/Timecard/{id}": {
"get": {
"tags": [
"Acknowledgments"
],
"summary": "Returns timecard acknowledgment details",
"description": "Returns timecard acknowledgment details.\r\nPermissions: All users. ",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentTimecardDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentTimecardDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentTimecardDto"
}
}
}
}
}
}
},
"/shiftworks/Acknowledgments/Timecard/{id}/Acknowledged": {
"put": {
"tags": [
"Acknowledgments"
],
"summary": "Set timecard acknowledgment as Acknowledged",
"description": "Set timecard acknowledgment as Acknowledged.\r\nPermissions: All users. ",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v1/Acknowledgments/Timecard/{id}/Acknowledged": {
"put": {
"tags": [
"Acknowledgments"
],
"summary": "Set timecard acknowledgment as Acknowledged",
"description": "Set timecard acknowledgment as Acknowledged.\r\nPermissions: All users. ",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Acknowledgments/Timecard/{id}/Disputed": {
"put": {
"tags": [
"Acknowledgments"
],
"summary": "Set timecard acknowledgment as Disputed",
"description": "Set timecard acknowledgment as Disputed.\r\nPermissions: All users. ",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.TimecardDisputedRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.TimecardDisputedRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.TimecardDisputedRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.TimecardDisputedRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v1/Acknowledgments/Timecard/{id}/Disputed": {
"put": {
"tags": [
"Acknowledgments"
],
"summary": "Set timecard acknowledgment as Disputed",
"description": "Set timecard acknowledgment as Disputed.\r\nPermissions: All users. ",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.TimecardDisputedRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.TimecardDisputedRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.TimecardDisputedRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.TimecardDisputedRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Acknowledgments/Settings": {
"get": {
"tags": [
"Acknowledgments"
],
"summary": "Returns acknowledgment settings",
"description": "Returns acknowledgment settings.\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgementSettingsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgementSettingsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgementSettingsDto"
}
}
}
}
}
}
},
"/shiftworks/v1/Acknowledgments/Settings": {
"get": {
"tags": [
"Acknowledgments"
],
"summary": "Returns acknowledgment settings",
"description": "Returns acknowledgment settings.\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgementSettingsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgementSettingsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgementSettingsDto"
}
}
}
}
}
}
},
"/shiftworks/Acknowledgments/Schedule/{id}/Acknowledged": {
"put": {
"tags": [
"Acknowledgments"
],
"summary": "Set schedule acknowledgment as Acknowledged",
"description": "Set schedule acknowledgment as Acknowledged.\r\nPermissions: All users. ",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v1/Acknowledgments/Schedule/{id}/Acknowledged": {
"put": {
"tags": [
"Acknowledgments"
],
"summary": "Set schedule acknowledgment as Acknowledged",
"description": "Set schedule acknowledgment as Acknowledged.\r\nPermissions: All users. ",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Availabilities": {
"get": {
"tags": [
"Availabilities"
],
"summary": "Returns current and future availability for current user",
"description": "Returns current and future availability for current user.\r\nIf the user does not have any of the availability, then it is not returned.\r\nPermissions: All users. ",
"parameters": [
{
"name": "IdList",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "ActiveOnly",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "api-version",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilityDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilityDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilityDto"
}
}
}
}
}
}
},
"post": {
"tags": [
"Availabilities"
],
"summary": "Submit new availability for current user",
"description": "Replace or add future availability for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilitySubmitDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilitySubmitDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilitySubmitDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilitySubmitDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
},
"delete": {
"tags": [
"Availabilities"
],
"summary": "Delete future availability for current user",
"description": "Delete future availability for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v2/Availabilities": {
"get": {
"tags": [
"Availabilities"
],
"summary": "Returns current and future availability for current user",
"description": "Returns current and future availability for current user.\r\nIf the user does not have any of the availability, then it is not returned.\r\nPermissions: All users. ",
"parameters": [
{
"name": "IdList",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "ActiveOnly",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilityDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilityDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilityDto"
}
}
}
}
}
}
},
"post": {
"tags": [
"Availabilities"
],
"summary": "Submit new availability for current user",
"description": "Replace or add future availability for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilitySubmitDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilitySubmitDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilitySubmitDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilitySubmitDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
},
"delete": {
"tags": [
"Availabilities"
],
"summary": "Delete future availability for current user",
"description": "Delete future availability for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Availabilities/timeoffs": {
"get": {
"tags": [
"Availabilities"
],
"summary": "Returns current and future timeoffs for current user",
"description": "Returns current and future timeoffs for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "IdList",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
{
"name": "ActiveOnly",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "api-version",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOffDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOffDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOffDto"
}
}
}
}
}
}
},
"post": {
"tags": [
"Availabilities"
],
"summary": "Returns current and future timeoffs for current user",
"description": "Returns current and future timeoffs for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff"
}
}
}
}
}
},
"patch": {
"tags": [
"Availabilities"
],
"summary": "Update timeoffs for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.EmployeeAvailabilities.EmployeeTimeOffPatchDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.EmployeeAvailabilities.EmployeeTimeOffPatchDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.EmployeeAvailabilities.EmployeeTimeOffPatchDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.EmployeeAvailabilities.EmployeeTimeOffPatchDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v2/Availabilities/timeoffs": {
"get": {
"tags": [
"Availabilities"
],
"summary": "Returns current and future timeoffs for current user",
"description": "Returns current and future timeoffs for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "IdList",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
{
"name": "ActiveOnly",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOffDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOffDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOffDto"
}
}
}
}
}
}
},
"post": {
"tags": [
"Availabilities"
],
"summary": "Returns current and future timeoffs for current user",
"description": "Returns current and future timeoffs for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff"
}
}
}
}
}
},
"patch": {
"tags": [
"Availabilities"
],
"summary": "Update timeoffs for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.EmployeeAvailabilities.EmployeeTimeOffPatchDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.EmployeeAvailabilities.EmployeeTimeOffPatchDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.EmployeeAvailabilities.EmployeeTimeOffPatchDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.EmployeeAvailabilities.EmployeeTimeOffPatchDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Availabilities/timeoffs/{timeoffid}": {
"delete": {
"tags": [
"Availabilities"
],
"summary": "Delete timeoffs for current user.",
"description": "Delete timeoffs for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "timeoffid",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "api-version",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v2/Availabilities/timeoffs/{timeoffid}": {
"delete": {
"tags": [
"Availabilities"
],
"summary": "Delete timeoffs for current user.",
"description": "Delete timeoffs for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "timeoffid",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Availabilities/blackouts": {
"get": {
"tags": [
"Availabilities"
],
"summary": "Returns blackout list for Unit.",
"description": "Use this method if you want to GET blackout list for current employee.\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.DateRange"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.DateRange"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.DateRange"
}
}
}
}
}
}
}
},
"/shiftworks/v2/Availabilities/blackouts": {
"get": {
"tags": [
"Availabilities"
],
"summary": "Returns blackout list for Unit.",
"description": "Use this method if you want to GET blackout list for current employee.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.DateRange"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.DateRange"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.DateRange"
}
}
}
}
}
}
}
},
"/shiftworks/AvailabilitiesMulti": {
"get": {
"tags": [
"AvailabilitiesMulti"
],
"summary": "Returns current and future availability for current user",
"description": "Returns current and future availability for current user.\r\nIf the user does not have any of the availability, then it is not returned.\r\nPermissions: All users. ",
"parameters": [
{
"name": "IdList",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "ActiveOnly",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "api-version",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityWithTimeRangesDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityWithTimeRangesDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityWithTimeRangesDto"
}
}
}
}
}
}
},
"post": {
"tags": [
"AvailabilitiesMulti"
],
"summary": "Submit new availability for current user",
"description": "Replace or add future availability for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityCreateDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityCreateDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityCreateDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityCreateDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
},
"delete": {
"tags": [
"AvailabilitiesMulti"
],
"summary": "Delete future availability for current user",
"description": "Delete future availability for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v3/AvailabilitiesMulti": {
"get": {
"tags": [
"AvailabilitiesMulti"
],
"summary": "Returns current and future availability for current user",
"description": "Returns current and future availability for current user.\r\nIf the user does not have any of the availability, then it is not returned.\r\nPermissions: All users. ",
"parameters": [
{
"name": "IdList",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "ActiveOnly",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityWithTimeRangesDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityWithTimeRangesDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityWithTimeRangesDto"
}
}
}
}
}
}
},
"post": {
"tags": [
"AvailabilitiesMulti"
],
"summary": "Submit new availability for current user",
"description": "Replace or add future availability for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityCreateDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityCreateDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityCreateDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityCreateDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
},
"delete": {
"tags": [
"AvailabilitiesMulti"
],
"summary": "Delete future availability for current user",
"description": "Delete future availability for current user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Certification": {
"get": {
"tags": [
"Certification"
],
"summary": "Returns list of cerifications for user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "onlyForNotification",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationPreviewModel"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationPreviewModel"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationPreviewModel"
}
}
}
}
}
}
},
"post": {
"tags": [
"Certification"
],
"summary": "Post data for specific certificate",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"CertificationID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"IssuedOn": {
"type": "string",
"format": "date-time"
},
"ExpiresOn": {
"type": "string",
"format": "date-time"
},
"CertificateNumber": {
"type": "string"
},
"Approved": {
"type": "boolean"
},
"ApprovedBy": {
"type": "string"
}
}
},
"example": "Recipe Description,Recipe UOM,Recipe Yield,Recipe Visible,Recipe Quantity,Recipe Standard Cost,Recipe Extended Cost,Recipe Contents,Type,Ingredient UOM,Ingredient Quantity,Ingredient Standard Cost,Ingredient Extended Cost,Ingredient Yield,Ingredient Visible\r\n[Potatoes Twirled],ten,100.00,TRUE,2.0000,5.38,10.75,!!egg3000s,Standard,Dozen,1.0000,2.35,2.35,100.00,TRUE\r\n[Potatoes Twirled],,,,,,,Potato Soak,Standard,Each,3.0000,0.88,2.64,100.00,TRUE\r\n[Potatoes Twirled],,,,,,,Potatoes Bakers,Standard,Each,24.0000,0.24,5.76,100.00,TRUE",
"encoding": {
"image": {
"style": "form"
},
"CertificationID": {
"style": "form"
},
"IssuedOn": {
"style": "form"
},
"ExpiresOn": {
"style": "form"
},
"CertificateNumber": {
"style": "form"
},
"Approved": {
"style": "form"
},
"ApprovedBy": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
}
}
}
}
},
"patch": {
"tags": [
"Certification"
],
"summary": "Patch data for specific certificate",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"CertificationID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"IssuedOn": {
"type": "string",
"format": "date-time"
},
"ExpiresOn": {
"type": "string",
"format": "date-time"
},
"CertificateNumber": {
"type": "string"
},
"Approved": {
"type": "boolean"
},
"ApprovedBy": {
"type": "string"
}
}
},
"example": "Recipe Description,Recipe UOM,Recipe Yield,Recipe Visible,Recipe Quantity,Recipe Standard Cost,Recipe Extended Cost,Recipe Contents,Type,Ingredient UOM,Ingredient Quantity,Ingredient Standard Cost,Ingredient Extended Cost,Ingredient Yield,Ingredient Visible\r\n[Potatoes Twirled],ten,100.00,TRUE,2.0000,5.38,10.75,!!egg3000s,Standard,Dozen,1.0000,2.35,2.35,100.00,TRUE\r\n[Potatoes Twirled],,,,,,,Potato Soak,Standard,Each,3.0000,0.88,2.64,100.00,TRUE\r\n[Potatoes Twirled],,,,,,,Potatoes Bakers,Standard,Each,24.0000,0.24,5.76,100.00,TRUE",
"encoding": {
"image": {
"style": "form"
},
"CertificationID": {
"style": "form"
},
"IssuedOn": {
"style": "form"
},
"ExpiresOn": {
"style": "form"
},
"CertificateNumber": {
"style": "form"
},
"Approved": {
"style": "form"
},
"ApprovedBy": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
}
}
}
}
}
},
"/shiftworks/v1/Certification": {
"get": {
"tags": [
"Certification"
],
"summary": "Returns list of cerifications for user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "onlyForNotification",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationPreviewModel"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationPreviewModel"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationPreviewModel"
}
}
}
}
}
}
},
"post": {
"tags": [
"Certification"
],
"summary": "Post data for specific certificate",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"CertificationID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"IssuedOn": {
"type": "string",
"format": "date-time"
},
"ExpiresOn": {
"type": "string",
"format": "date-time"
},
"CertificateNumber": {
"type": "string"
},
"Approved": {
"type": "boolean"
},
"ApprovedBy": {
"type": "string"
}
}
},
"example": "Recipe Description,Recipe UOM,Recipe Yield,Recipe Visible,Recipe Quantity,Recipe Standard Cost,Recipe Extended Cost,Recipe Contents,Type,Ingredient UOM,Ingredient Quantity,Ingredient Standard Cost,Ingredient Extended Cost,Ingredient Yield,Ingredient Visible\r\n[Potatoes Twirled],ten,100.00,TRUE,2.0000,5.38,10.75,!!egg3000s,Standard,Dozen,1.0000,2.35,2.35,100.00,TRUE\r\n[Potatoes Twirled],,,,,,,Potato Soak,Standard,Each,3.0000,0.88,2.64,100.00,TRUE\r\n[Potatoes Twirled],,,,,,,Potatoes Bakers,Standard,Each,24.0000,0.24,5.76,100.00,TRUE",
"encoding": {
"image": {
"style": "form"
},
"CertificationID": {
"style": "form"
},
"IssuedOn": {
"style": "form"
},
"ExpiresOn": {
"style": "form"
},
"CertificateNumber": {
"style": "form"
},
"Approved": {
"style": "form"
},
"ApprovedBy": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
}
}
}
}
},
"patch": {
"tags": [
"Certification"
],
"summary": "Patch data for specific certificate",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary"
},
"CertificationID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"IssuedOn": {
"type": "string",
"format": "date-time"
},
"ExpiresOn": {
"type": "string",
"format": "date-time"
},
"CertificateNumber": {
"type": "string"
},
"Approved": {
"type": "boolean"
},
"ApprovedBy": {
"type": "string"
}
}
},
"example": "Recipe Description,Recipe UOM,Recipe Yield,Recipe Visible,Recipe Quantity,Recipe Standard Cost,Recipe Extended Cost,Recipe Contents,Type,Ingredient UOM,Ingredient Quantity,Ingredient Standard Cost,Ingredient Extended Cost,Ingredient Yield,Ingredient Visible\r\n[Potatoes Twirled],ten,100.00,TRUE,2.0000,5.38,10.75,!!egg3000s,Standard,Dozen,1.0000,2.35,2.35,100.00,TRUE\r\n[Potatoes Twirled],,,,,,,Potato Soak,Standard,Each,3.0000,0.88,2.64,100.00,TRUE\r\n[Potatoes Twirled],,,,,,,Potatoes Bakers,Standard,Each,24.0000,0.24,5.76,100.00,TRUE",
"encoding": {
"image": {
"style": "form"
},
"CertificationID": {
"style": "form"
},
"IssuedOn": {
"style": "form"
},
"ExpiresOn": {
"style": "form"
},
"CertificateNumber": {
"style": "form"
},
"Approved": {
"style": "form"
},
"ApprovedBy": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
}
}
}
}
}
},
"/shiftworks/Certification/{certificationID}": {
"get": {
"tags": [
"Certification"
],
"summary": "Return data for specific certificate",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "certificationID",
"in": "path",
"description": "The certification id.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
}
}
}
}
}
},
"/shiftworks/v1/Certification/{certificationID}": {
"get": {
"tags": [
"Certification"
],
"summary": "Return data for specific certificate",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "certificationID",
"in": "path",
"description": "The certification id.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel"
}
}
}
}
}
}
},
"/shiftworks/Certification/lookups": {
"get": {
"tags": [
"Certification"
],
"summary": "Return certifications lookups",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.PayrollCertificationModel"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.PayrollCertificationModel"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.PayrollCertificationModel"
}
}
}
}
}
}
}
},
"/shiftworks/v1/Certification/lookups": {
"get": {
"tags": [
"Certification"
],
"summary": "Return certifications lookups",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.PayrollCertificationModel"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.PayrollCertificationModel"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.ShiftWorks.Models.Certifications.PayrollCertificationModel"
}
}
}
}
}
}
}
},
"/shiftworks/Chats": {
"get": {
"tags": [
"Chats"
],
"summary": "Returns all conversations for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.PreviewChatInfo"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.PreviewChatInfo"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.PreviewChatInfo"
}
}
}
}
}
}
},
"post": {
"tags": [
"Chats"
],
"summary": "Creates or get chat group.",
"description": "Creates or get chat group. Returns information of Group.\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Conversation group",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatCreate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatCreate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatCreate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatCreate"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatInfoDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatInfoDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatInfoDto"
}
}
}
}
}
}
},
"/shiftworks/v1/Chats": {
"get": {
"tags": [
"Chats"
],
"summary": "Returns all conversations for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.PreviewChatInfo"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.PreviewChatInfo"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.PreviewChatInfo"
}
}
}
}
}
}
},
"post": {
"tags": [
"Chats"
],
"summary": "Creates or get chat group.",
"description": "Creates or get chat group. Returns information of Group.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Conversation group",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatCreate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatCreate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatCreate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatCreate"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatInfoDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatInfoDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatInfoDto"
}
}
}
}
}
}
},
"/shiftworks/Chats/{chatId}": {
"get": {
"tags": [
"Chats"
],
"summary": "Returns information of Group",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "chatId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatInfoDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatInfoDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatInfoDto"
}
}
}
}
}
}
},
"/shiftworks/v1/Chats/{chatId}": {
"get": {
"tags": [
"Chats"
],
"summary": "Returns information of Group",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "chatId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatInfoDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatInfoDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatInfoDto"
}
}
}
}
}
}
},
"/shiftworks/Chats/{chatId}/messages": {
"post": {
"tags": [
"Chats"
],
"summary": "Creates new message and returns all unread messages from chat group (backward compatible)",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "chatId",
"in": "path",
"description": "Conversation group id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "maxDeliveredMessageId",
"in": "query",
"description": "Latest message id that was delivered to user.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Message",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Chats.ChatMessageCreate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Chats.ChatMessageCreate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Chats.ChatMessageCreate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Chats.ChatMessageCreate"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
}
}
}
}
}
},
"/shiftworks/v1/Chats/{chatId}/messages": {
"post": {
"tags": [
"Chats"
],
"summary": "Creates new message and returns all unread messages from chat group (backward compatible)",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "chatId",
"in": "path",
"description": "Conversation group id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "maxDeliveredMessageId",
"in": "query",
"description": "Latest message id that was delivered to user.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Message",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Chats.ChatMessageCreate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Chats.ChatMessageCreate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Chats.ChatMessageCreate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Chats.ChatMessageCreate"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
}
}
}
}
}
},
"/shiftworks/Chats/{chatId}/media-messages": {
"post": {
"tags": [
"Chats"
],
"summary": "Creates new message and returns all unread messages from chat group",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "chatId",
"in": "path",
"description": "Conversation group id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "maxDeliveredMessageId",
"in": "query",
"description": "Latest message id that was delivered to user.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Message"
},
"images": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Up to 5 image files (JPEG, PNG, GIF, WEBP; max 5 MB each)"
}
}
},
"example": "Recipe Description,Recipe UOM,Recipe Yield,Recipe Visible,Recipe Quantity,Recipe Standard Cost,Recipe Extended Cost,Recipe Contents,Type,Ingredient UOM,Ingredient Quantity,Ingredient Standard Cost,Ingredient Extended Cost,Ingredient Yield,Ingredient Visible\r\n[Potatoes Twirled],ten,100.00,TRUE,2.0000,5.38,10.75,!!egg3000s,Standard,Dozen,1.0000,2.35,2.35,100.00,TRUE\r\n[Potatoes Twirled],,,,,,,Potato Soak,Standard,Each,3.0000,0.88,2.64,100.00,TRUE\r\n[Potatoes Twirled],,,,,,,Potatoes Bakers,Standard,Each,24.0000,0.24,5.76,100.00,TRUE",
"encoding": {
"message": {
"style": "form"
},
"images": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
}
}
}
}
}
},
"/shiftworks/v1/Chats/{chatId}/media-messages": {
"post": {
"tags": [
"Chats"
],
"summary": "Creates new message and returns all unread messages from chat group",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "chatId",
"in": "path",
"description": "Conversation group id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "maxDeliveredMessageId",
"in": "query",
"description": "Latest message id that was delivered to user.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Message"
},
"images": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Up to 5 image files (JPEG, PNG, GIF, WEBP; max 5 MB each)"
}
}
},
"example": "Recipe Description,Recipe UOM,Recipe Yield,Recipe Visible,Recipe Quantity,Recipe Standard Cost,Recipe Extended Cost,Recipe Contents,Type,Ingredient UOM,Ingredient Quantity,Ingredient Standard Cost,Ingredient Extended Cost,Ingredient Yield,Ingredient Visible\r\n[Potatoes Twirled],ten,100.00,TRUE,2.0000,5.38,10.75,!!egg3000s,Standard,Dozen,1.0000,2.35,2.35,100.00,TRUE\r\n[Potatoes Twirled],,,,,,,Potato Soak,Standard,Each,3.0000,0.88,2.64,100.00,TRUE\r\n[Potatoes Twirled],,,,,,,Potatoes Bakers,Standard,Each,24.0000,0.24,5.76,100.00,TRUE",
"encoding": {
"message": {
"style": "form"
},
"images": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
}
}
}
}
}
},
"/shiftworks/Chats/sync": {
"get": {
"tags": [
"Chats"
],
"summary": "returns all unread messages from chat group",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "chatId",
"in": "query",
"description": "Conversation group id",
"schema": {
"type": "string"
}
},
{
"name": "maxDeliveredMessageId",
"in": "query",
"description": "Latest message id that was delivered to user.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "detailedNotifications",
"in": "query",
"description": "Show information in the context of each chat or shows only the total number in TotalNotificationCount field.",
"schema": {
"type": "boolean"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
}
}
}
}
}
},
"/shiftworks/v1/Chats/sync": {
"get": {
"tags": [
"Chats"
],
"summary": "returns all unread messages from chat group",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "chatId",
"in": "query",
"description": "Conversation group id",
"schema": {
"type": "string"
}
},
{
"name": "maxDeliveredMessageId",
"in": "query",
"description": "Latest message id that was delivered to user.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "detailedNotifications",
"in": "query",
"description": "Show information in the context of each chat or shows only the total number in TotalNotificationCount field.",
"schema": {
"type": "boolean"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult"
}
}
}
}
}
}
},
"/shiftworks/ContactInfo": {
"get": {
"tags": [
"ContactInfo"
],
"summary": "Returns contact info for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoModel"
}
}
}
}
}
},
"patch": {
"tags": [
"ContactInfo"
],
"summary": "Sets contact info for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoUpdate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoUpdate"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v1/ContactInfo": {
"get": {
"tags": [
"ContactInfo"
],
"summary": "Returns contact info for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoModel"
}
}
}
}
}
},
"patch": {
"tags": [
"ContactInfo"
],
"summary": "Sets contact info for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoUpdate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoUpdate"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/ContactInfo/email": {
"put": {
"tags": [
"ContactInfo"
],
"summary": "Request for update email for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ChangeEmailModels.RequestUpdateEmail"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ChangeEmailModels.RequestUpdateEmail"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ChangeEmailModels.RequestUpdateEmail"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ChangeEmailModels.RequestUpdateEmail"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v1/ContactInfo/email": {
"put": {
"tags": [
"ContactInfo"
],
"summary": "Request for update email for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ChangeEmailModels.RequestUpdateEmail"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ChangeEmailModels.RequestUpdateEmail"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ChangeEmailModels.RequestUpdateEmail"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.ChangeEmailModels.RequestUpdateEmail"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/EmailChange": {
"get": {
"tags": [
"EmailChange"
],
"summary": "change email.",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "token",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Authentication.Models.TokenDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Authentication.Models.TokenDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Authentication.Models.TokenDto"
}
}
}
}
}
}
},
"/shiftworks/MenuSetting": {
"get": {
"tags": [
"MenuSetting"
],
"summary": "Returns true if Shift Works Messenger is allowed and false if not",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Common.MenuSetting"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Common.MenuSetting"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Common.MenuSetting"
}
}
}
}
}
}
},
"/shiftworks/v1/MenuSetting": {
"get": {
"tags": [
"MenuSetting"
],
"summary": "Returns true if Shift Works Messenger is allowed and false if not",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Common.MenuSetting"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Common.MenuSetting"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Common.MenuSetting"
}
}
}
}
}
}
},
"/shiftworks/Requests/Pickup/ChangeDate": {
"get": {
"tags": [
"Requests"
],
"summary": "Gets pickup request change times for list of pickup ids for current user.",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "RecordIds",
"in": "query",
"description": "",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.PickupRequestChangeDateDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.PickupRequestChangeDateDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.PickupRequestChangeDateDto"
}
}
}
}
}
}
}
},
"/shiftworks/v1/Requests/Pickup/ChangeDate": {
"get": {
"tags": [
"Requests"
],
"summary": "Gets pickup request change times for list of pickup ids for current user.",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "RecordIds",
"in": "query",
"description": "",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.PickupRequestChangeDateDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.PickupRequestChangeDateDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.PickupRequestChangeDateDto"
}
}
}
}
}
}
}
},
"/shiftworks/Requests/Drop": {
"post": {
"tags": [
"Requests"
],
"summary": "Post drop request for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The drop request.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v1/Requests/Drop": {
"post": {
"tags": [
"Requests"
],
"summary": "Post drop request for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The drop request.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Requests/Pickup": {
"post": {
"tags": [
"Requests"
],
"summary": "Post pickup request for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The pickup request.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.TShiftWorksRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.TShiftWorksRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.TShiftWorksRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.TShiftWorksRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v1/Requests/Pickup": {
"post": {
"tags": [
"Requests"
],
"summary": "Post pickup request for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The pickup request.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.TShiftWorksRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.TShiftWorksRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.TShiftWorksRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.TShiftWorksRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Requests/CancelDrop": {
"patch": {
"tags": [
"Requests"
],
"summary": "Patch cancel drop request for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The drop request.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v1/Requests/CancelDrop": {
"patch": {
"tags": [
"Requests"
],
"summary": "Patch cancel drop request for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The drop request.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.DropRequestDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Requests/CancelPickup": {
"patch": {
"tags": [
"Requests"
],
"summary": "Patch cancel pickup request for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The pickup request.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.PickupRequestDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.PickupRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.PickupRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.PickupRequestDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v1/Requests/CancelPickup": {
"patch": {
"tags": [
"Requests"
],
"summary": "Patch cancel pickup request for current user",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The pickup request.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.PickupRequestDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.PickupRequestDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.PickupRequestDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.PickupRequestDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Settings": {
"get": {
"tags": [
"Settings"
],
"summary": "Get settings for current employee.",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksUserSettingDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksUserSettingDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksUserSettingDto"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"summary": "Set settings for current employee.",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The settings.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksSettingForPatchDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksSettingForPatchDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksSettingForPatchDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksSettingForPatchDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v1/Settings": {
"get": {
"tags": [
"Settings"
],
"summary": "Get settings for current employee.",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksUserSettingDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksUserSettingDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksUserSettingDto"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"summary": "Set settings for current employee.",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The settings.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksSettingForPatchDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksSettingForPatchDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksSettingForPatchDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksSettingForPatchDto"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Shifts/upcoming": {
"get": {
"tags": [
"Shifts"
],
"summary": "Returns upcoming shift for current user",
"description": "Deprecated: Instead use: v2/Shifts. Can be removed after 26.20 release
\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Shifts.UpcomingShiftModel"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Shifts.UpcomingShiftModel"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Shifts.UpcomingShiftModel"
}
}
}
}
}
},
"deprecated": true
}
},
"/shiftworks/v1/Shifts/upcoming": {
"get": {
"tags": [
"Shifts"
],
"summary": "Returns upcoming shift for current user",
"description": "Deprecated: Instead use: v2/Shifts. Can be removed after 26.20 release
\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Shifts.UpcomingShiftModel"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Shifts.UpcomingShiftModel"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Shifts.UpcomingShiftModel"
}
}
}
}
}
},
"deprecated": true
}
},
"/shiftworks/Shifts/headers/{unitID}": {
"get": {
"tags": [
"Shifts"
],
"summary": "Return all shifts for current employee/unit",
"description": "Deprecated: Instead use: v2/Shifts/headers/{unitID}. Can be removed after 26.20 release
\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitID",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.AllShiftsDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.AllShiftsDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.AllShiftsDto"
}
}
}
}
}
},
"deprecated": true
}
},
"/shiftworks/v1/Shifts/headers/{unitID}": {
"get": {
"tags": [
"Shifts"
],
"summary": "Return all shifts for current employee/unit",
"description": "Deprecated: Instead use: v2/Shifts/headers/{unitID}. Can be removed after 26.20 release
\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitID",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.AllShiftsDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.AllShiftsDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.AllShiftsDto"
}
}
}
}
}
},
"deprecated": true
}
},
"/shiftworks/Shifts/details/{Localemployeeid}/{businessdate}/{chainid}": {
"get": {
"tags": [
"Shifts"
],
"summary": "Return all shifts by unit for current user",
"description": "Deprecated: Instead use: v2/Shifts/details/{chainID}. Can be removed after 26.20 release
Returns all shifts by unit. Result includes all shift for other users without shifts for this user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "Localemployeeid",
"in": "path",
"description": "employee.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
}
},
{
"name": "businessdate",
"in": "path",
"description": "date.",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "chainid",
"in": "path",
"description": "chain.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.ShiftDetailModel"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.ShiftDetailModel"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.ShiftDetailModel"
}
}
}
}
}
},
"deprecated": true
}
},
"/shiftworks/v1/Shifts/details/{Localemployeeid}/{businessdate}/{chainid}": {
"get": {
"tags": [
"Shifts"
],
"summary": "Return all shifts by unit for current user",
"description": "Deprecated: Instead use: v2/Shifts/details/{chainID}. Can be removed after 26.20 release
Returns all shifts by unit. Result includes all shift for other users without shifts for this user.\r\nPermissions: All users. ",
"parameters": [
{
"name": "Localemployeeid",
"in": "path",
"description": "employee.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
}
},
{
"name": "businessdate",
"in": "path",
"description": "date.",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "chainid",
"in": "path",
"description": "chain.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.ShiftDetailModel"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.ShiftDetailModel"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.ShiftDetailModel"
}
}
}
}
}
},
"deprecated": true
}
},
"/shiftworks/Shifts/employeeJobs/{unitID}": {
"get": {
"tags": [
"Shifts"
],
"summary": "Returns jobs list for current user by UnitID",
"description": "Deprecated: Instead use: v2/Shifts/employeeJobs/{unitID}. Can be removed after 26.20 release
\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitID",
"in": "path",
"description": "The unit id.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.CurrentEmployeeJobDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.CurrentEmployeeJobDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.CurrentEmployeeJobDto"
}
}
}
}
}
},
"deprecated": true
}
},
"/shiftworks/v1/Shifts/employeeJobs/{unitID}": {
"get": {
"tags": [
"Shifts"
],
"summary": "Returns jobs list for current user by UnitID",
"description": "Deprecated: Instead use: v2/Shifts/employeeJobs/{unitID}. Can be removed after 26.20 release
\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitID",
"in": "path",
"description": "The unit id.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.CurrentEmployeeJobDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.CurrentEmployeeJobDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.CurrentEmployeeJobDto"
}
}
}
}
}
},
"deprecated": true
}
},
"/shiftworks/Shifts/employeesWithJobs/{unitID}": {
"get": {
"tags": [
"Shifts"
],
"summary": "Returns jobs list for current user by UnitID for Messenger",
"description": "Deprecated: Instead use: v2/Shifts/otherEmployeeJobs/{unitID}. Can be removed after 26.20 release
\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitID",
"in": "path",
"description": "The unit id.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.EmployeeJobDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.EmployeeJobDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.EmployeeJobDto"
}
}
}
}
}
},
"deprecated": true
}
},
"/shiftworks/v1/Shifts/employeesWithJobs/{unitID}": {
"get": {
"tags": [
"Shifts"
],
"summary": "Returns jobs list for current user by UnitID for Messenger",
"description": "Deprecated: Instead use: v2/Shifts/otherEmployeeJobs/{unitID}. Can be removed after 26.20 release
\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitID",
"in": "path",
"description": "The unit id.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.EmployeeJobDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.EmployeeJobDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Dto.EmployeeJobDto"
}
}
}
}
}
},
"deprecated": true
}
},
"/shiftworks/Swaps/enabled/{unitid}": {
"post": {
"tags": [
"Swaps"
],
"summary": "Checks if swaps are enabled for given unit",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitid",
"in": "path",
"description": "unit.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/shiftworks/v1/Swaps/enabled/{unitid}": {
"post": {
"tags": [
"Swaps"
],
"summary": "Checks if swaps are enabled for given unit",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitid",
"in": "path",
"description": "unit.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/shiftworks/Swaps/availableshifts/{unitid}/{businessdate}/{chainid}": {
"get": {
"tags": [
"Swaps"
],
"summary": "Return all available shifts by unit for current user for definite chainid",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitid",
"in": "path",
"description": "unit.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "businessdate",
"in": "path",
"description": "date.",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "chainid",
"in": "path",
"description": "chain.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapAvailableShiftModel"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapAvailableShiftModel"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapAvailableShiftModel"
}
}
}
}
}
}
}
},
"/shiftworks/v1/Swaps/availableshifts/{unitid}/{businessdate}/{chainid}": {
"get": {
"tags": [
"Swaps"
],
"summary": "Return all available shifts by unit for current user for definite chainid",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitid",
"in": "path",
"description": "unit.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "businessdate",
"in": "path",
"description": "date.",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "chainid",
"in": "path",
"description": "chain.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapAvailableShiftModel"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapAvailableShiftModel"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapAvailableShiftModel"
}
}
}
}
}
}
}
},
"/shiftworks/Swaps/proposed": {
"get": {
"tags": [
"Swaps"
],
"summary": "Returns requested swaps for me",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestModel"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestModel"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestModel"
}
}
}
}
}
}
}
},
"/shiftworks/v1/Swaps/proposed": {
"get": {
"tags": [
"Swaps"
],
"summary": "Returns requested swaps for me",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestModel"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestModel"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestModel"
}
}
}
}
}
}
}
},
"/shiftworks/Swaps/notifications": {
"post": {
"tags": [
"Swaps"
],
"summary": "Returns requested swaps for me",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestCardModelDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestCardModelDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestCardModelDto"
}
}
}
}
}
}
}
},
"/shiftworks/v1/Swaps/notifications": {
"post": {
"tags": [
"Swaps"
],
"summary": "Returns requested swaps for me",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestCardModelDto"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestCardModelDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestCardModelDto"
}
}
}
}
}
}
}
},
"/shiftworks/Swaps": {
"post": {
"tags": [
"Swaps"
],
"summary": "Creates new proposition for swap",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The swap proposition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestCreateModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestCreateModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestCreateModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestCreateModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int64"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int64"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
},
"/shiftworks/v1/Swaps": {
"post": {
"tags": [
"Swaps"
],
"summary": "Creates new proposition for swap",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The swap proposition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestCreateModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestCreateModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestCreateModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestCreateModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int64"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int64"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
},
"/shiftworks/Swaps/{swapId}/approve": {
"put": {
"tags": [
"Swaps"
],
"summary": "Approve swap",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "swapId",
"in": "path",
"description": "The swap id",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v1/Swaps/{swapId}/approve": {
"put": {
"tags": [
"Swaps"
],
"summary": "Approve swap",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "swapId",
"in": "path",
"description": "The swap id",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Swaps/reject": {
"put": {
"tags": [
"Swaps"
],
"summary": "Reject list of swap requests sent to an employee",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "List of swap ids",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestRejectListModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestRejectListModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestRejectListModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestRejectListModel"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v1/Swaps/reject": {
"put": {
"tags": [
"Swaps"
],
"summary": "Reject list of swap requests sent to an employee",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "List of swap ids",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestRejectListModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestRejectListModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestRejectListModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Swaps.SwapRequestRejectListModel"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Swaps/{swapId}/reject": {
"put": {
"tags": [
"Swaps"
],
"summary": "Reject swap",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "swapId",
"in": "path",
"description": "The swap id",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v1/Swaps/{swapId}/reject": {
"put": {
"tags": [
"Swaps"
],
"summary": "Reject swap",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "swapId",
"in": "path",
"description": "The swap id",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Swaps/{swapId}/cancel": {
"put": {
"tags": [
"Swaps"
],
"summary": "Cancel swap",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "swapId",
"in": "path",
"description": "The swap id",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/v1/Swaps/{swapId}/cancel": {
"put": {
"tags": [
"Swaps"
],
"summary": "Cancel swap",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "swapId",
"in": "path",
"description": "The swap id",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/shiftworks/Timeclock/history/{unitID}": {
"get": {
"tags": [
"Timeclock"
],
"summary": "Returns timeclock history",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitID",
"in": "path",
"description": "The unit ID.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Timeclocks.TClock"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Timeclocks.TClock"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Timeclocks.TClock"
}
}
}
}
}
}
}
},
"/shiftworks/v1/Timeclock/history/{unitID}": {
"get": {
"tags": [
"Timeclock"
],
"summary": "Returns timeclock history",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitID",
"in": "path",
"description": "The unit ID.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Timeclocks.TClock"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Timeclocks.TClock"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Timeclocks.TClock"
}
}
}
}
}
}
}
},
"/shiftworks/Timeclock/firstweekday/{unitID}": {
"get": {
"tags": [
"Timeclock"
],
"summary": "Returns unit first week day",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitID",
"in": "path",
"description": "The unit ID.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
},
"/shiftworks/v1/Timeclock/firstweekday/{unitID}": {
"get": {
"tags": [
"Timeclock"
],
"summary": "Returns unit first week day",
"description": "\r\nPermissions: All users. ",
"parameters": [
{
"name": "unitID",
"in": "path",
"description": "The unit ID.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
},
"/shiftworks/Version": {
"get": {
"tags": [
"Version"
],
"summary": "Get version.",
"description": "Get version.\r\nPermissions: All users. ",
"parameters": [
{
"name": "api-version",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Common.AppVersion"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Common.AppVersion"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Common.AppVersion"
}
}
}
}
}
}
},
"/shiftworks/v1/Version": {
"get": {
"tags": [
"Version"
],
"summary": "Get version.",
"description": "Get version.\r\nPermissions: All users. ",
"parameters": [
{
"name": "DCKey",
"in": "header",
"description": "The Integration Key generated for API Authentication by the PAR OPS support team as part of the integration/partnership process.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Common.AppVersion"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Common.AppVersion"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Common.AppVersion"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"DataCentral.Shared.ActivityFeed.ActivityFeedDataSourceType": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38
],
"type": "integer",
"format": "int32"
},
"DataCentral.Shared.Api.Models.Authentication.ResetPasswordDto": {
"required": [
"UserName"
],
"type": "object",
"properties": {
"UserName": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DataCentral.Shared.Api.Models.StoreDto": {
"type": "object",
"properties": {
"StoreID": {
"type": "integer",
"description": "Store identifier",
"format": "int32"
},
"StoreName": {
"type": "string",
"description": "Store Name",
"nullable": true
},
"StoreNumber": {
"type": "string",
"description": "Store Number",
"nullable": true
},
"EmployeeMessagingEnabled": {
"type": "boolean",
"description": "Indicates whether employee messaging is enabled for the store."
},
"AllowImagesInMessaging": {
"type": "boolean",
"description": "Indicates whether images are allowed in messaging for the store."
}
},
"additionalProperties": false,
"description": "Store model"
},
"DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationModel": {
"type": "object",
"properties": {
"ShiftWorksUserID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"CertificationID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"IssuedOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"ExpiresOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"CertificateNumber": {
"type": "string",
"nullable": true
},
"ApprovedBy": {
"type": "string",
"nullable": true
},
"ApprovedOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"Approved": {
"type": "boolean"
},
"FileImageLink": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DataCentral.Shared.Api.ShiftWorks.Models.Certifications.CertificationPreviewModel": {
"type": "object",
"properties": {
"CertificationID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Description": {
"type": "string",
"nullable": true
},
"Approved": {
"type": "boolean"
},
"ExpireDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"DataCentral.Shared.Api.ShiftWorks.Models.Certifications.PayrollCertificationModel": {
"type": "object",
"properties": {
"CertificationID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Description": {
"type": "string",
"nullable": true
},
"ExpireDays": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Authentication.Models.ChangePasswordModel": {
"required": [
"NewPassword",
"OldPassword"
],
"type": "object",
"properties": {
"OldPassword": {
"minLength": 1,
"type": "string"
},
"NewPassword": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Authentication.Models.TokenDto": {
"type": "object",
"properties": {
"Token": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Availabilities.AvailabilityPeriodType": {
"enum": [
67,
70
],
"type": "integer",
"format": "int32"
},
"DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOff": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int64",
"nullable": true
},
"ShiftWorksUserID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"GlobalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"readOnly": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD",
"deprecated": true
},
"StartDate": {
"type": "string",
"format": "date-time"
},
"EndDate": {
"type": "string",
"format": "date-time"
},
"AllDay": {
"type": "boolean"
},
"Status": {
"type": "string",
"description": "Has next values: 'A' (Approved), 'P' (Pending), 'R' (Rejected)\r\nby default is P"
},
"StartTime": {
"type": "TimeSpan",
"nullable": true,
"example": "21:30:00"
},
"EndTime": {
"type": "TimeSpan",
"nullable": true,
"example": "21:30:00"
},
"Comment": {
"type": "string",
"nullable": true
},
"Origin": {
"type": "string",
"description": "Has next values: 'M' (Manager), 'E' (Employee)"
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Availabilities.EmployeeTimeOffDto": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int64",
"nullable": true
},
"ShiftWorksUserID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"StartDate": {
"type": "string",
"format": "date-time"
},
"EndDate": {
"type": "string",
"format": "date-time"
},
"AllDay": {
"type": "boolean"
},
"Status": {
"$ref": "#/components/schemas/OPS.Shared.Models.EmployeeAvailabilities.TimeOffsStatus"
},
"StartTime": {
"type": "TimeSpan",
"nullable": true,
"example": "21:30:00"
},
"EndTime": {
"type": "TimeSpan",
"nullable": true,
"example": "21:30:00"
},
"Comment": {
"type": "string",
"nullable": true
},
"Origin": {
"$ref": "#/components/schemas/OPS.Shared.Models.EmployeeAvailabilities.TimeOffsOrigin"
},
"ReviewedBy": {
"type": "string",
"nullable": true
},
"ReviewedOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"RejectReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilityDayDto": {
"type": "object",
"properties": {
"WeekDay": {
"type": "integer",
"format": "int32"
},
"AvailabilityTimeFrom": {
"type": "TimeSpan",
"nullable": true,
"example": "21:30:00"
},
"AvailabilityTimeThru": {
"type": "TimeSpan",
"nullable": true,
"example": "21:30:00"
},
"Available": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilityDto": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int64"
},
"ShiftWorksUserID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"GlobalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"readOnly": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD",
"deprecated": true
},
"StartDate": {
"type": "string",
"format": "date-time"
},
"Type": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.AvailabilityPeriodType"
},
"Status": {
"$ref": "#/components/schemas/OPS.Shared.Models.Enums.AvailabilityStatusEnum"
},
"Comment": {
"type": "string",
"nullable": true
},
"Days": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilityDayDto"
},
"nullable": true
},
"ReviewedBy": {
"type": "string",
"nullable": true
},
"ReviewedOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"RejectReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilitySubmitDto": {
"required": [
"Days"
],
"type": "object",
"properties": {
"StartDate": {
"type": "string",
"format": "date-time"
},
"Comment": {
"type": "string",
"nullable": true
},
"Days": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v2.AvailabilityDayDto"
}
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityCreateDto": {
"type": "object",
"properties": {
"StartDate": {
"type": "string",
"format": "date-time"
},
"Comment": {
"type": "string",
"nullable": true
},
"Days": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityDayWithTimeRangesDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityDayWithTimeRangesDto": {
"type": "object",
"properties": {
"WeekDay": {
"type": "integer",
"format": "int32"
},
"Available": {
"type": "boolean"
},
"TimeRanges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityTimeRangeDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityTimeRangeDto": {
"type": "object",
"properties": {
"From": {
"type": "TimeSpan",
"nullable": true,
"example": "21:30:00"
},
"Thru": {
"type": "TimeSpan",
"nullable": true,
"example": "21:30:00"
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityWithTimeRangesDto": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int64"
},
"ShiftWorksUserID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"GlobalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"readOnly": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD",
"deprecated": true
},
"StartDate": {
"type": "string",
"format": "date-time"
},
"Type": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.AvailabilityPeriodType"
},
"Status": {
"$ref": "#/components/schemas/OPS.Shared.Models.Enums.AvailabilityStatusEnum"
},
"Comment": {
"type": "string",
"nullable": true
},
"Days": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Availabilities.v3.AvailabilityDayWithTimeRangesDto"
},
"nullable": true
},
"ReviewedBy": {
"type": "string",
"nullable": true
},
"ReviewedOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"RejectReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.ChangeEmailModels.RequestUpdateEmail": {
"type": "object",
"properties": {
"NewEmail": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Chats.ChatMessageCreate": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Common.AppVersion": {
"type": "object",
"properties": {
"Version": {
"type": "string",
"nullable": true
},
"ForceUpgradeApp": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Common.MenuSetting": {
"type": "object",
"properties": {
"AllowMessenger": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoModel": {
"type": "object",
"properties": {
"Email": {
"type": "string",
"nullable": true
},
"Phone": {
"type": "string",
"nullable": true
},
"AddressLine1": {
"type": "string",
"nullable": true
},
"AddressLine2": {
"type": "string",
"nullable": true
},
"City": {
"type": "string",
"nullable": true
},
"StateID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"StateDescription": {
"type": "string",
"nullable": true
},
"ZipCode": {
"type": "string",
"nullable": true
},
"ApprovedStoreID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ApprovedStoreName": {
"type": "string",
"nullable": true
},
"LanguageID": {
"type": "string",
"nullable": true
},
"LanguageName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.ContactInfo.ContactInfoUpdate": {
"type": "object",
"properties": {
"Phone": {
"type": "string"
},
"LanguageID": {
"type": "string"
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Shifts.UpcomingShiftModel": {
"type": "object",
"properties": {
"ChainID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Dropped": {
"type": "boolean"
},
"JobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"JobDescription": {
"type": "string",
"nullable": true
},
"UnitID": {
"type": "integer",
"format": "int32"
},
"UnitName": {
"type": "string",
"nullable": true
},
"StartTime": {
"type": "string",
"format": "date-time"
},
"EndTime": {
"type": "string",
"format": "date-time"
},
"BusinessDate": {
"type": "string",
"format": "date-time"
},
"LocalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"SwapStatus": {
"type": "string",
"nullable": true
},
"MyRequest": {
"type": "boolean"
},
"SwapID": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Timeclocks.TClock": {
"type": "object",
"properties": {
"ClockID": {
"type": "integer",
"format": "int32"
},
"BusinessDate": {
"type": "string",
"format": "date-time"
},
"PayrollJobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"JobDescription": {
"type": "string",
"nullable": true
},
"ClockIn": {
"type": "string",
"format": "date-time"
},
"ClockOut": {
"type": "string",
"format": "date-time",
"nullable": true
},
"TimeclockMinutes": {
"type": "integer",
"format": "int32"
},
"PaidBreaks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Timeclocks.TClockBreak"
},
"nullable": true
},
"UnpaidBreaks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.ShiftWorks.Api.Models.Timeclocks.TClockBreak"
},
"nullable": true
}
},
"additionalProperties": false
},
"DataCentral.ShiftWorks.Api.Models.Timeclocks.TClockBreak": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int64"
},
"BreakStart": {
"type": "string",
"format": "date-time"
},
"BreakEnd": {
"type": "string",
"format": "date-time"
},
"BreakMinutes": {
"type": "integer",
"format": "int32"
},
"Paid": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.AccessToken": {
"type": "object",
"properties": {
"Token": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Acknowledgments.AcknowledgementFrequency": {
"enum": [
"D",
"R"
],
"type": "string"
},
"OPS.Shared.Models.Acknowledgments.AcknowledgmentSigningAction": {
"enum": [
"A",
"D",
"P"
],
"type": "string"
},
"OPS.Shared.Models.Acknowledgments.AcknowledgmentType": {
"enum": [
"S",
"T"
],
"type": "string"
},
"OPS.Shared.Models.Acknowledgments.Dto.AcknowledgementSettingsDto": {
"type": "object",
"properties": {
"ScheduleAcknowledgementsEnabled": {
"type": "boolean"
},
"TimecardAcknowledgementsEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentDto": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int64"
},
"UnitID": {
"type": "integer",
"format": "int32"
},
"UnitName": {
"type": "string",
"nullable": true
},
"AcknowledgmentDate": {
"type": "string",
"format": "date-time"
},
"AcknowledgmentDateEnd": {
"type": "string",
"format": "date-time"
},
"Type": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.AcknowledgmentType"
},
"SigningAction": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.AcknowledgmentSigningAction"
},
"SigningTimeUtc": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentScheduleDetailDto": {
"type": "object",
"properties": {
"NewShift": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentScheduleDetailItemDto"
},
"OldShift": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentScheduleDetailItemDto"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentScheduleDetailItemDto": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int64"
},
"TAcknowledgmentID": {
"type": "integer",
"format": "int64"
},
"BusinessDate": {
"type": "string",
"format": "date-time"
},
"ChainID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"JobID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"JobName": {
"type": "string",
"nullable": true
},
"StartTime": {
"type": "string",
"format": "date-time"
},
"EndTime": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentScheduleDto": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int64"
},
"UnitID": {
"type": "integer",
"format": "int32"
},
"UnitName": {
"type": "string",
"nullable": true
},
"AcknowledgmentDate": {
"type": "string",
"format": "date-time"
},
"AcknowledgmentDateEnd": {
"type": "string",
"format": "date-time"
},
"Type": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.AcknowledgmentType"
},
"SigningAction": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.AcknowledgmentSigningAction"
},
"SigningTimeUtc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"Details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentScheduleDetailDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentTimecardDetailDto": {
"type": "object",
"properties": {
"Timecard": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentTimecardDetailItemDto"
},
"PreviousTimecard": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentTimecardDetailItemDto"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentTimecardDetailItemDto": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int64"
},
"TAcknowledgmentID": {
"type": "integer",
"format": "int64"
},
"BusinessDate": {
"type": "string",
"format": "date-time"
},
"JobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"JobName": {
"type": "string",
"nullable": true
},
"ClockIn": {
"type": "string",
"format": "date-time"
},
"ClockOut": {
"type": "string",
"format": "date-time"
},
"PaidBreakTime": {
"type": "TimeSpan",
"example": "21:30:00"
},
"UnPaidBreakTime": {
"type": "TimeSpan",
"example": "21:30:00"
},
"TotalTime": {
"type": "TimeSpan",
"example": "21:30:00"
},
"OvertimeTime": {
"type": "TimeSpan",
"example": "21:30:00"
},
"DeclaredTips": {
"type": "number",
"format": "double"
},
"RegTime": {
"type": "TimeSpan",
"example": "21:30:00"
},
"ClockID": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentTimecardDto": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int64"
},
"UnitID": {
"type": "integer",
"format": "int32"
},
"UnitName": {
"type": "string",
"nullable": true
},
"AcknowledgmentDate": {
"type": "string",
"format": "date-time"
},
"Type": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.AcknowledgmentType"
},
"SigningAction": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.AcknowledgmentSigningAction"
},
"SigningTimeUtc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"Details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.Dto.AcknowledgmentTimecardDetailDto"
},
"nullable": true
},
"AcknowledgmentDateEnd": {
"type": "string",
"format": "date-time"
},
"TotalTime": {
"type": "TimeSpan",
"example": "21:30:00"
},
"TotalRegTime": {
"type": "TimeSpan",
"example": "21:30:00"
},
"TotalOvertimeTime": {
"type": "TimeSpan",
"example": "21:30:00"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Acknowledgments.Dto.TimecardDisputedRequest": {
"type": "object",
"properties": {
"Comment": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.BillingGroups.BillingGroup": {
"required": [
"Description",
"LegalEntity"
],
"type": "object",
"properties": {
"ID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"BGTypeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"BGType": {
"$ref": "#/components/schemas/OPS.Shared.Models.BillingGroups.BillingGroupType"
},
"LegalEntity": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"DelagetClientID": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"CalendarID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"DelagetFranCode": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"EnableAutoCompliance": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.BillingGroups.BillingGroupType": {
"required": [
"Description",
"Suffix"
],
"type": "object",
"properties": {
"BGTypeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"FLevel": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"Hide": {
"type": "boolean"
},
"Suffix": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"IsArchive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.AccountMetaData": {
"type": "object",
"properties": {
"MetaDataId": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Description": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"Lock": {
"type": "boolean"
},
"Hide": {
"type": "boolean"
},
"Revenu": {
"type": "boolean"
},
"Expense": {
"type": "boolean"
},
"Payment": {
"type": "boolean"
},
"AllowAdjustment": {
"type": "boolean"
},
"AllowBudget": {
"type": "boolean"
},
"Discounts": {
"type": "boolean"
},
"Inventory": {
"type": "boolean"
},
"Asset": {
"type": "boolean"
},
"Discard": {
"type": "boolean"
},
"Tax": {
"type": "boolean"
},
"BalanceSheet": {
"type": "boolean"
},
"GuestTracking": {
"type": "boolean"
},
"Calculated": {
"type": "boolean"
},
"Export": {
"type": "boolean"
},
"LaborAmount": {
"type": "boolean"
},
"LaborHour": {
"type": "boolean"
},
"SalesTracking": {
"type": "boolean"
},
"Liability": {
"type": "boolean"
},
"POSAdjustment": {
"type": "boolean"
},
"VoidTracking": {
"type": "boolean"
},
"CheckTracking": {
"type": "boolean"
},
"SOSTracking": {
"type": "boolean"
},
"POSOther": {
"type": "boolean"
},
"ARSales": {
"type": "boolean"
},
"ARPayments": {
"type": "boolean"
},
"PaidIO": {
"type": "boolean"
},
"UnitTrade": {
"type": "boolean"
},
"Deposit": {
"type": "boolean"
},
"EntreeTracking": {
"type": "boolean"
},
"DiscountTracking": {
"type": "boolean"
},
"TaxTracking": {
"type": "boolean"
},
"PmixTracking": {
"type": "boolean"
},
"PaymentTracking": {
"type": "boolean"
},
"GuestSurvey": {
"type": "boolean"
},
"Accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.ChartOfAccounts"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.ChartOfAccountModeDbEnum": {
"enum": [
"C",
"D",
"R"
],
"type": "string"
},
"OPS.Shared.Models.Common.ChartOfAccounts": {
"type": "object",
"properties": {
"AccountID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"AccountCode": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"Description": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"HideAccountYN": {
"type": "boolean"
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Item.Item"
},
"nullable": true
},
"CustomReportingID": {
"type": "string",
"nullable": true
},
"MetaDataId": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Metadata": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.AccountMetaData"
},
"AccountSub": {
"maxLength": 4,
"type": "string",
"nullable": true
},
"Mode": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.ChartOfAccountModeDbEnum"
},
"VendorAccountLimits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.VendorCategoryLimit"
},
"nullable": true
},
"VoucherTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.TAPVoucherTemplate"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.City": {
"type": "object",
"properties": {
"CountryID": {
"type": "integer",
"format": "int32"
},
"StateID": {
"type": "integer",
"format": "int32"
},
"CountyID": {
"type": "integer",
"format": "int32"
},
"ID": {
"type": "integer",
"format": "int32"
},
"CityName": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"CityCode": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"CountryState": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.CountryState"
},
"County": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.County"
},
"Country": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Country"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.Country": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int32"
},
"Description": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"Code": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"alpha2Code": {
"maxLength": 2,
"type": "string",
"nullable": true
},
"Hide": {
"type": "boolean"
},
"CountryStates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.CountryState"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.CountryState": {
"type": "object",
"properties": {
"CountryID": {
"type": "integer",
"format": "int32"
},
"ID": {
"type": "integer",
"format": "int32"
},
"StateName": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"StateCode": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"Country": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Country"
},
"Counties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.County"
},
"nullable": true
},
"PayrollDisctrictState": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.State"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.County": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int32"
},
"CountryID": {
"type": "integer",
"format": "int32"
},
"StateID": {
"type": "integer",
"format": "int32"
},
"CountyName": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"CountyCode": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"Country": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Country"
},
"CountryState": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.CountryState"
},
"Cities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.City"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.DCGroup": {
"required": [
"Description",
"GroupType",
"RootCode"
],
"type": "object",
"properties": {
"Id": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ParentId": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Parent": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.DCGroup"
},
"Description": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"GroupType": {
"maxLength": 20,
"maxItems": 20,
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.DCGroupType"
}
},
"GroupTypeString": {
"type": "string",
"nullable": true,
"readOnly": true,
"deprecated": true
},
"HideYN": {
"type": "boolean"
},
"RootCode": {
"maxLength": 10,
"minLength": 1,
"type": "string"
},
"VendorGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.VendorGroup"
},
"nullable": true
},
"UnitGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.UnitGroup"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.DCGroupType": {
"enum": [
"A",
"C",
"F",
"I",
"J",
"L",
"P",
"R",
"S",
"U",
"V",
"X"
],
"type": "string"
},
"OPS.Shared.Models.Common.DateRange": {
"type": "object",
"properties": {
"StartDate": {
"type": "string",
"format": "date-time"
},
"EndDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.GrantOptions": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"OPS.Shared.Models.Common.PayCardDbEnum": {
"enum": [
"I",
"M"
],
"type": "string"
},
"OPS.Shared.Models.Common.PayrollClockSource": {
"enum": [
"D",
"E",
"P"
],
"type": "string"
},
"OPS.Shared.Models.Common.ScheduleStation": {
"required": [
"Description"
],
"type": "object",
"properties": {
"ID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"UnitID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"Unit": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"Description": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"Color": {
"type": "integer",
"format": "int32",
"nullable": true
},
"Type": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.ScheduleStationType"
},
"SkillLevel": {
"type": "integer",
"format": "int32"
},
"MaxHoursPerWeek": {
"type": "number",
"format": "double",
"nullable": true
},
"FixedDailyHours": {
"type": "number",
"format": "double"
},
"IsPrivate": {
"type": "boolean",
"readOnly": true
},
"IsAdminManaged": {
"type": "boolean"
},
"Scale": {
"type": "boolean"
},
"Hide": {
"type": "boolean"
},
"Groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleStationGroup"
},
"nullable": true
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.ScheduleStationType": {
"enum": [
"N",
"S"
],
"type": "string"
},
"OPS.Shared.Models.Common.State": {
"type": "object",
"properties": {
"StateID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Country": {
"type": "integer",
"format": "int32"
},
"Description": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"Code": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"Hide": {
"type": "boolean"
},
"StateTax": {
"type": "boolean"
},
"MealBreakWaiver": {
"type": "boolean"
},
"MaxNumberHrsBeforeBreak": {
"type": "integer",
"format": "int32"
},
"MinNumberHrsBeforeBreak": {
"type": "integer",
"format": "int32"
},
"MaxDailyHrsAddViolation": {
"type": "integer",
"format": "int32"
},
"HomeStateID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"DefaultTimeZoneID": {
"type": "integer",
"format": "int32"
},
"CountryStateID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"CountryState": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.CountryState"
},
"AcknowledgementTypes": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.AcknowledgmentType"
},
"nullable": true
},
"AcknowledgementFrequency": {
"$ref": "#/components/schemas/OPS.Shared.Models.Acknowledgments.AcknowledgementFrequency"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.TimeZone": {
"required": [
"Code",
"Name"
],
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int32"
},
"Code": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"Name": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.UMSystemSetup": {
"type": "object",
"properties": {
"UnitID": {
"type": "integer",
"format": "int32"
},
"PnLPeriodStart": {
"type": "string",
"format": "date-time"
},
"PnLPeriodEnd": {
"type": "string",
"format": "date-time"
},
"AddDays": {
"type": "integer",
"format": "int32"
},
"Unit": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.Unit": {
"required": [
"UnitName",
"UnitNumber"
],
"type": "object",
"properties": {
"UnitID": {
"type": "integer",
"format": "int32"
},
"UnitName": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"UnitNumber": {
"maxLength": 10,
"minLength": 1,
"type": "string"
},
"CalendarId": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"BillingGroupId": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"BillingGroup": {
"$ref": "#/components/schemas/OPS.Shared.Models.BillingGroups.BillingGroup"
},
"StateID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"State": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.State"
},
"CountryCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ForecastID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ScheduleTemplateID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"FirstWeekDay": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.UnitWeekDay"
},
"UseNickName": {
"type": "boolean"
},
"StartTime": {
"type": "TimeSpan",
"example": "21:30:00"
},
"CloseTime": {
"type": "TimeSpan",
"example": "21:30:00"
},
"PayrollClockSource": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.PayrollClockSource"
},
"AutoApproveRequests": {
"type": "boolean"
},
"NWeeks": {
"type": "integer",
"format": "int32"
},
"UnitGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.UnitGroup"
},
"nullable": true
},
"DefaultForecastFormat": {
"$ref": "#/components/schemas/OPS.Shared.Models.Forecast.ForecastFormat"
},
"ScheduleTemplate": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleTemplate"
},
"IgnoreSSNValidation": {
"type": "boolean"
},
"MaxInventoryAmount": {
"maximum": 9999999.99,
"minimum": 0.01,
"type": "number",
"format": "double"
},
"ImportCalendarId": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"UnitIDForPayroll": {
"maxLength": 255,
"type": "string",
"nullable": true
},
"PayrollStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"OcrUnitId": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"StoreVendors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.StoreVendors.StoreVendor"
},
"nullable": true
},
"TimeZoneID": {
"type": "integer",
"format": "int32"
},
"TimeZone": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.TimeZone"
},
"PayrollGroupID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollGroup": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.PayrollGroup"
},
"ShowJobs": {
"type": "boolean"
},
"ShowNotes": {
"type": "boolean"
},
"ShowStatus": {
"type": "boolean"
},
"ShowActivityPermissions": {
"type": "boolean"
},
"ShowLaborOptions": {
"type": "boolean"
},
"StoreVendorDeliverySchedules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.StoreVendors.StoreVendorDeliverySchedule"
},
"nullable": true
},
"PkVendors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.Vendor"
},
"nullable": true
},
"Employees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployee"
},
"nullable": true
},
"ShowW4F": {
"type": "boolean"
},
"ShowW4S": {
"type": "boolean"
},
"HideYN": {
"type": "boolean"
},
"PosGroupID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"MinimumHoursBeforeDrop": {
"maximum": 48,
"minimum": 0,
"type": "number",
"format": "double"
},
"MinimumHoursBeforeSwap": {
"maximum": 48,
"minimum": 0,
"type": "number",
"format": "double"
},
"MinimumHoursBeforePickup": {
"maximum": 48,
"minimum": 0,
"type": "number",
"format": "double"
},
"CountryStateID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"CountyID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"CityID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"EnableShiftSwaps": {
"type": "boolean"
},
"EnableShiftDrops": {
"type": "boolean"
},
"Group5": {
"type": "string",
"nullable": true
},
"ShiftCounts": {
"type": "boolean"
},
"EstimateDailyCounts": {
"type": "boolean"
},
"UMSystemSetup": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.UMSystemSetup"
},
"EmployeeMappingID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ShiftHeaderID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"EmployeeMessagingEnabled": {
"type": "boolean"
},
"AllowImagesInMessaging": {
"type": "boolean"
},
"AllowEditTipPercent": {
"type": "string",
"nullable": true
},
"PayCard": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.PayCardDbEnum"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.UnitGroup": {
"type": "object",
"properties": {
"UnitID": {
"type": "integer",
"format": "int32"
},
"Unit": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"GroupID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Group": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.DCGroup"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Common.UnitWeekDay": {
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"format": "int32"
},
"OPS.Shared.Models.EmployeeAvailabilities.AvailabilityWeekDay": {
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"format": "int32"
},
"OPS.Shared.Models.EmployeeAvailabilities.EmployeeTimeOffPatchDto": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int64"
},
"ShiftWorksUserID": {
"$ref": "#/components/schemas/OPS.Shared.Models.NullablePatchField`1[[System.Guid, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"GlobalEmployeeID": {
"$ref": "#/components/schemas/OPS.Shared.Models.NullablePatchField`1[[System.Guid, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"StartDate": {
"$ref": "#/components/schemas/OPS.Shared.Models.NullablePatchField`1[[System.DateTime, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"EndDate": {
"$ref": "#/components/schemas/OPS.Shared.Models.NullablePatchField`1[[System.DateTime, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"AllDay": {
"$ref": "#/components/schemas/OPS.Shared.Models.NullablePatchField`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"Status": {
"$ref": "#/components/schemas/OPS.Shared.Models.NullablePatchField`1[[System.Char, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"StartTime": {
"$ref": "#/components/schemas/OPS.Shared.Models.NullablePatchField`1[[System.Nullable`1[[System.TimeSpan, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"EndTime": {
"$ref": "#/components/schemas/OPS.Shared.Models.NullablePatchField`1[[System.Nullable`1[[System.TimeSpan, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"Comment": {
"type": "string"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.EmployeeAvailabilities.TimeOffsOrigin": {
"enum": [
"E",
"M"
],
"type": "string"
},
"OPS.Shared.Models.EmployeeAvailabilities.TimeOffsStatus": {
"enum": [
"A",
"D",
"P",
"R"
],
"type": "string"
},
"OPS.Shared.Models.Employees.Employee": {
"type": "object",
"properties": {
"EmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollGroupID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollGroup": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.PayrollGroup"
},
"GlobalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"GlobalEmployee": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.GlobalEmployee"
},
"HomeUnitID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"HomeUnit": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"PayrollNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"Status": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployeeStatus"
},
"Hide": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.EmployeeExport": {
"type": "object",
"properties": {
"ID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ProcessorID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"SSN": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"GlobalNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"GlobalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"GlobalEmployee": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.GlobalEmployee"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.GlobalEmployee": {
"required": [
"Ssn"
],
"type": "object",
"properties": {
"GlobalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ShiftWorksUserID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"FirstName": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"LastName": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"Ssn": {
"maxLength": 20,
"minLength": 1,
"type": "string"
},
"PhoneNumber": {
"maxLength": 255,
"type": "string",
"nullable": true
},
"Address": {
"maxLength": 200,
"type": "string",
"nullable": true
},
"Address2": {
"maxLength": 200,
"type": "string",
"nullable": true
},
"StateID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"City": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"Zip": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"Birthday": {
"type": "string",
"format": "date-time",
"nullable": true
},
"NickName": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"MiddleName": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"Suffix": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"OriginalHireDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"Flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.GlobalEmployeeFlag"
},
"nullable": true
},
"ShiftWorksUser": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksUser"
},
"State": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.State"
},
"LocalEmployees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployee"
},
"nullable": true
},
"PayrollGroupEmployees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.Employee"
},
"nullable": true
},
"GlobalEmployeeGF_W4F": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.GlobalEmployeeGF_W4F"
},
"GlobalEmployeeGF_W4S": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.GlobalEmployeeGF_W4S"
},
"EmployeeExport": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.EmployeeExport"
},
"nullable": true
},
"AnnualSalary": {
"type": "number",
"format": "double",
"nullable": true
},
"PrimaryJobID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ExemptMinor": {
"type": "boolean"
},
"PayrollLastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.GlobalEmployeeFlag": {
"type": "object",
"properties": {
"RecordID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"GlobalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"GlobalEmployee": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.GlobalEmployee"
},
"FlagID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Flag": {
"$ref": "#/components/schemas/OPS.Shared.Models.Payroll.PayrollFlags"
},
"Hide": {
"type": "boolean"
},
"ValueType": {
"$ref": "#/components/schemas/OPS.Shared.Models.Payroll.PayrollFlagValueType"
},
"Value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.GlobalEmployeeGF_W4F": {
"type": "object",
"properties": {
"GlobalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"GlobalEmployee": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.GlobalEmployee"
},
"FederalFilingStatus": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"FederalExemptions": {
"type": "integer",
"format": "int32"
},
"FederalAddAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"ExemptFromFedWithholding": {
"maxLength": 1,
"type": "string",
"nullable": true
},
"MultipleJobs": {
"maxLength": 1,
"type": "string",
"nullable": true
},
"DependentsTotal": {
"type": "number",
"format": "double",
"nullable": true
},
"OtherIncome": {
"type": "number",
"format": "double",
"nullable": true
},
"Deductions": {
"type": "number",
"format": "double",
"nullable": true
},
"FilingStatusID": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.GlobalEmployeeGF_W4S": {
"type": "object",
"properties": {
"GlobalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"GlobalEmployee": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.GlobalEmployee"
},
"StateFillingStatus": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"StateExemptions": {
"type": "integer",
"format": "int32"
},
"StateAddAmount": {
"type": "number",
"format": "double"
},
"ExemptFromStateWithholding": {
"maxLength": 1,
"type": "string",
"nullable": true
},
"WithholdPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"FilingStatusID": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.PayrollJob": {
"type": "object",
"properties": {
"PayrollJobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Description": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"ScheduleDepartment": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"Mode": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.PayrollJobMode"
},
"Hide": {
"type": "boolean"
},
"Schedule": {
"type": "boolean"
},
"DefaultMasterStationID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"readOnly": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Tippable": {
"type": "boolean"
},
"SCTipMethod": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.TipShareMethod"
},
"SCPoolMethod": {
"type": "boolean"
},
"SecureRates": {
"type": "boolean"
},
"AccountPrimaryBlendedJobPrc": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollJobGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.PayrollJobGroup"
},
"nullable": true
},
"BlendedRateJobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.BlendedRateJobs"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.PayrollJobGroup": {
"type": "object",
"properties": {
"PayrollJobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollJob": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.PayrollJob"
},
"GroupID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Group": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.DCGroup"
},
"GrantOptions": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.GrantOptions"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.PayrollJobMode": {
"enum": [
"H",
"S"
],
"type": "string"
},
"OPS.Shared.Models.Employees.ShiftWorksSettingForPatchDto": {
"type": "object",
"properties": {
"ShiftAvailableForPickup": {
"$ref": "#/components/schemas/OPS.Shared.Models.NullablePatchField`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"ScheduleChange": {
"$ref": "#/components/schemas/OPS.Shared.Models.NullablePatchField`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"Certifications": {
"$ref": "#/components/schemas/OPS.Shared.Models.NullablePatchField`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"Availability": {
"$ref": "#/components/schemas/OPS.Shared.Models.NullablePatchField`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"ShiftSwaps": {
"$ref": "#/components/schemas/OPS.Shared.Models.NullablePatchField`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"Reminder": {
"type": "integer"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.ShiftWorksUser": {
"type": "object",
"properties": {
"ShiftWorksUserID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"FirstName": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"LastName": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"NickName": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"Email": {
"maxLength": 255,
"type": "string",
"nullable": true
},
"PrimaryUnitID": {
"type": "integer",
"format": "int32"
},
"PrimaryUnit": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"PhoneNumber": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"Zip": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"Address": {
"maxLength": 200,
"type": "string",
"nullable": true
},
"Address2": {
"maxLength": 200,
"type": "string",
"nullable": true
},
"City": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"StateID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Birthday": {
"type": "string",
"format": "date-time",
"nullable": true
},
"Registered": {
"type": "boolean"
},
"Setting": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksUserSetting"
},
"GlobalEmployees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.GlobalEmployee"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.ShiftWorksUserSetting": {
"type": "object",
"properties": {
"ShiftWorksUserID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ShiftWorksUser": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.ShiftWorksUser"
},
"ShiftAvailableForPickup": {
"type": "boolean"
},
"ScheduleChange": {
"type": "boolean"
},
"Certifications": {
"type": "boolean"
},
"Availability": {
"type": "boolean"
},
"ShiftSwaps": {
"type": "boolean"
},
"Reminder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.ShiftWorksUserSettingDto": {
"type": "object",
"properties": {
"ShiftAvailableForPickup": {
"type": "boolean"
},
"ScheduleChange": {
"type": "boolean"
},
"Certifications": {
"type": "boolean"
},
"Availability": {
"type": "boolean"
},
"ShiftSwaps": {
"type": "boolean"
},
"Reminder": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.TipShareMethod": {
"enum": [
"1",
"2"
],
"type": "string"
},
"OPS.Shared.Models.Employees.UEmployee": {
"type": "object",
"properties": {
"LocalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"UnitID": {
"type": "integer",
"format": "int32"
},
"Unit": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"FirstName": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"LastName": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"Status": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployeeStatus"
},
"Mode": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployeeMode"
},
"Hide": {
"type": "boolean"
},
"Borrowed": {
"type": "boolean",
"deprecated": true
},
"ClockInMethod": {
"maxLength": 1,
"type": "string",
"nullable": true
},
"GlobalEmployee": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.GlobalEmployee"
},
"GlobalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ExemptMinor": {
"type": "boolean"
},
"PrimaryJobID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PrimaryJob": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.PayrollJob"
},
"Jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployeeJobs"
},
"nullable": true
},
"DailyScheduleCost": {
"type": "number",
"format": "double",
"nullable": true
},
"DynamicDailyScheduleCost": {
"type": "boolean"
},
"Type": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployeeType"
},
"Display": {
"type": "boolean"
},
"IgnoreForPayroll": {
"type": "boolean"
},
"POSPayrollID": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"OriginalHireDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"EmployeeID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ClockExemptSchedule": {
"type": "boolean"
},
"ClockExemptAutoBreaks": {
"type": "boolean"
},
"ClockExemptPayDeducts": {
"type": "boolean"
},
"ElectronicID": {
"type": "string",
"nullable": true
},
"TimeClockID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"FullPartTime": {
"maxLength": 1,
"type": "string",
"nullable": true
},
"Group1": {
"type": "string",
"nullable": true
},
"Group2": {
"type": "string",
"nullable": true
},
"Group3": {
"type": "string",
"nullable": true
},
"Group4": {
"type": "string",
"nullable": true
},
"Group5": {
"type": "string",
"nullable": true
},
"Group6": {
"type": "string",
"nullable": true
},
"Group7": {
"type": "string",
"nullable": true
},
"Group8": {
"type": "string",
"nullable": true
},
"Group9": {
"type": "string",
"nullable": true
},
"Group10": {
"type": "string",
"nullable": true
},
"Group11": {
"type": "string",
"nullable": true
},
"Group12": {
"type": "string",
"nullable": true
},
"Group13": {
"type": "string",
"nullable": true
},
"Group14": {
"type": "string",
"nullable": true
},
"Group15": {
"type": "string",
"nullable": true
},
"Group16": {
"type": "string",
"nullable": true
},
"Group17": {
"type": "string",
"nullable": true
},
"Group18": {
"type": "string",
"nullable": true
},
"Group19": {
"type": "string",
"nullable": true
},
"Group20": {
"type": "string",
"nullable": true
},
"PayrollLastMDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"StatusHistories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployeeStatusHistory"
},
"nullable": true
},
"SchoolCalendarID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"SchoolCalendar": {
"$ref": "#/components/schemas/OPS.Shared.Models.Schedule.SchoolCalendar"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.UEmployeeDCJobRate": {
"type": "object",
"properties": {
"RecordID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollJobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollJob": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.PayrollJob"
},
"LocalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"LocalEmployee": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployee"
},
"Rate": {
"type": "number",
"format": "double",
"nullable": true
},
"EffectiveDate": {
"type": "string",
"format": "date-time"
},
"EndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"Approved": {
"type": "boolean"
},
"ApproveUser": {
"type": "string",
"nullable": true
},
"Hide": {
"type": "boolean"
},
"UEmployeeJob": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployeeJobs"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.UEmployeeJobs": {
"type": "object",
"properties": {
"RecordID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollJobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollJob": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.PayrollJob"
},
"LocalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"LocalEmployee": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployee"
},
"POSRate": {
"type": "number",
"format": "double"
},
"BaseRate": {
"type": "number",
"format": "double",
"nullable": true
},
"Hide": {
"type": "boolean"
},
"SkillLevel": {
"type": "integer",
"format": "int32"
},
"UEmployeeDCJobRates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployeeDCJobRate"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.UEmployeeMode": {
"enum": [
"H",
"N",
"S"
],
"type": "string"
},
"OPS.Shared.Models.Employees.UEmployeeStatus": {
"enum": [
"A",
"L",
"T"
],
"type": "string"
},
"OPS.Shared.Models.Employees.UEmployeeStatusHistory": {
"type": "object",
"properties": {
"RecordID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"LocalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"LocalEmployee": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployee"
},
"Status": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployeeStatus"
},
"ReasonID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Comment": {
"maxLength": 200,
"type": "string",
"nullable": true
},
"Hide": {
"type": "boolean"
},
"BusinessDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Employees.UEmployeeType": {
"enum": [
"P",
"R"
],
"type": "string"
},
"OPS.Shared.Models.Enums.AvailabilityStatusEnum": {
"enum": [
"A",
"P",
"R"
],
"type": "string",
"properties": {
"Value": {
"type": "string",
"readOnly": true
}
},
"additionalProperties": false,
"description": "AvailabilityStatusEnum { Approved: 'A'; Pending: 'P'; Rejected: 'R' }",
"example": "A"
},
"OPS.Shared.Models.Enums.UserRoleCharEnum": {
"enum": [
"U",
"H",
"A",
"P",
"S"
],
"type": "string",
"properties": {
"Value": {
"type": "string",
"readOnly": true
}
},
"additionalProperties": false,
"description": "UserRoleCharEnum { Unit: 'U'; MultiUnit: 'H'; Administrator: 'A'; SupportAdministrator: 'P'; SystemAdministrator: 'S' }",
"example": "U"
},
"OPS.Shared.Models.Forecast.ForecastFormat": {
"type": "object",
"properties": {
"ForecastID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Description": {
"type": "string",
"nullable": true
},
"IntervalType": {
"$ref": "#/components/schemas/OPS.Shared.Models.Forecast.ForecastIntervalType"
},
"Default": {
"type": "boolean"
},
"Hide": {
"type": "boolean"
},
"Weeks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Forecast.ForecastWeeks"
},
"nullable": true
},
"Units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"nullable": true
},
"AccountID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"GuestAccountID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"TableAccountID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"CheckAccountID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"EntreeAccountID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"SalesType": {
"$ref": "#/components/schemas/OPS.Shared.Models.Forecast.ForecastSalesType"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Forecast.ForecastIntervalType": {
"enum": [
1,
2,
4,
96
],
"type": "integer",
"format": "int32"
},
"OPS.Shared.Models.Forecast.ForecastSalesType": {
"enum": [
"G",
"N"
],
"type": "string"
},
"OPS.Shared.Models.Forecast.ForecastWeeks": {
"type": "object",
"properties": {
"ForecastID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ForecastFormat": {
"$ref": "#/components/schemas/OPS.Shared.Models.Forecast.ForecastFormat"
},
"WeekToken": {
"type": "integer",
"format": "int32"
},
"WeekNumber": {
"type": "integer",
"format": "int32"
},
"Weight": {
"type": "number",
"format": "double"
},
"TrendWeeks": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Item.EstimationMethod": {
"enum": [
"N",
"R",
"T",
"Z"
],
"type": "string"
},
"OPS.Shared.Models.Item.Item": {
"type": "object",
"properties": {
"ItemID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Description": {
"type": "string",
"nullable": true
},
"ItemMode": {
"$ref": "#/components/schemas/OPS.Shared.Models.Item.ItemMode"
},
"AccountID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Account": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.ChartOfAccounts"
},
"CostingUM": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"CountItemYN": {
"type": "boolean"
},
"HideMasterItemYN": {
"type": "boolean"
},
"RequireCount": {
"type": "boolean"
},
"DefaultPurchaseUM": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"DefaultCountingUM": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ItemUMs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Item.ItemUM"
},
"nullable": true
},
"DefaultVendorID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"DefaultVendor": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.Vendor"
},
"CountDailyYN": {
"type": "string",
"nullable": true
},
"EstimationMethod": {
"$ref": "#/components/schemas/OPS.Shared.Models.Item.EstimationMethod"
},
"ItemCode": {
"maxLength": 10,
"minLength": 10,
"type": "string",
"nullable": true
},
"UMasterItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Item.UMasterItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Item.ItemMode": {
"enum": [
"G",
"I",
"M",
"P",
"R"
],
"type": "string"
},
"OPS.Shared.Models.Item.ItemUM": {
"required": [
"ItemID"
],
"type": "object",
"properties": {
"ItemID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"UMID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Item": {
"$ref": "#/components/schemas/OPS.Shared.Models.Item.Item"
},
"CostingUnits": {
"type": "number",
"format": "double"
},
"YieldPercent": {
"type": "number",
"format": "double"
},
"ConversionFactor": {
"type": "number",
"format": "double"
},
"CanBeSold": {
"type": "boolean"
},
"Purchase": {
"type": "boolean"
},
"Recipe": {
"type": "boolean"
},
"CountYN": {
"type": "boolean"
},
"Trade": {
"type": "boolean"
},
"Hide": {
"type": "boolean"
},
"Waste": {
"type": "boolean"
},
"SpecialEvent": {
"type": "boolean"
},
"Nutrition": {
"type": "boolean"
},
"PrepMode": {
"type": "boolean"
},
"EntreeValue": {
"type": "number",
"format": "double"
},
"Thaw": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ShelfLife": {
"type": "integer",
"format": "int32",
"nullable": true
},
"UMCode": {
"type": "string",
"nullable": true
},
"Description": {
"type": "string",
"nullable": true
},
"Tare": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Item.UMasterItem": {
"type": "object",
"properties": {
"UnitID": {
"type": "integer",
"format": "int32"
},
"Unit": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"ItemID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"MasterItem": {
"$ref": "#/components/schemas/OPS.Shared.Models.Item.Item"
},
"UHide": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.LineCheck.Frequency": {
"enum": [
"D",
"E",
"H",
"L",
"M",
"P",
"Q",
"S",
"W",
"Y"
],
"type": "string"
},
"OPS.Shared.Models.NetworkCredentials.NetworkCredential": {
"type": "object",
"properties": {
"NCID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Type": {
"$ref": "#/components/schemas/OPS.Shared.Models.NetworkCredentials.NetworkTypeEnum"
},
"Description": {
"type": "string",
"nullable": true
},
"Destination": {
"type": "string",
"nullable": true
},
"Login": {
"type": "string",
"nullable": true
},
"Password": {
"type": "string",
"nullable": true
},
"Internal": {
"type": "boolean"
},
"FTPPassiveMode": {
"type": "boolean"
},
"DeleteFileBeforeUpload": {
"type": "boolean"
},
"Lock": {
"type": "boolean"
},
"BadEmail": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.NetworkCredentials.NetworkTypeEnum": {
"enum": [
"E",
"F",
"G",
"L",
"N",
"O"
],
"type": "string"
},
"OPS.Shared.Models.NullablePatchField`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "boolean",
"properties": {
"Value": {
"type": "boolean",
"readOnly": true
},
"IsSet": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.NullablePatchField`1[[System.Char, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "string",
"properties": {
"Value": {
"type": "string",
"readOnly": true
},
"IsSet": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.NullablePatchField`1[[System.DateTime, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "string",
"properties": {
"Value": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"IsSet": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.NullablePatchField`1[[System.Guid, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "guid",
"properties": {
"Value": {
"type": "guid",
"format": "uniqueidentifier",
"readOnly": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"IsSet": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.NullablePatchField`1[[System.Nullable`1[[System.TimeSpan, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "TimeSpan",
"properties": {
"Value": {
"type": "TimeSpan",
"nullable": true,
"readOnly": true,
"example": "21:30:00"
},
"IsSet": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Payroll.FilterEmployees": {
"enum": [
"H",
"N",
"S"
],
"type": "string"
},
"OPS.Shared.Models.Payroll.PayrollFlagValueType": {
"enum": [
"Date",
"Integer",
"LookUp",
"Money",
"Text",
"WOTC_Code",
"Yes/No"
],
"type": "string"
},
"OPS.Shared.Models.Payroll.PayrollFlags": {
"type": "object",
"properties": {
"FlagID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Description": {
"type": "string",
"nullable": true
},
"InternalID": {
"type": "string",
"nullable": true
},
"ValueType": {
"$ref": "#/components/schemas/OPS.Shared.Models.Payroll.PayrollFlagValueType"
},
"Hide": {
"type": "boolean"
},
"DefaultValue": {
"type": "string",
"nullable": true
},
"Required": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Payroll.PayrollGroupFile": {
"type": "object",
"properties": {
"ID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"FileID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollProcessorFile": {
"$ref": "#/components/schemas/OPS.Shared.Models.Payroll.PayrollProcessorFile"
},
"PayrollGroupID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollGroup": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.PayrollGroup"
},
"FileName": {
"type": "string",
"nullable": true
},
"ExportLabels": {
"type": "boolean"
},
"Hide": {
"type": "boolean"
},
"Comment": {
"type": "string",
"nullable": true
},
"ShardID": {
"type": "integer",
"format": "int32"
},
"FilterEmployees": {
"$ref": "#/components/schemas/OPS.Shared.Models.Payroll.FilterEmployees"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Payroll.PayrollProcessor": {
"type": "object",
"properties": {
"ProcessorID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Description": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"InternalID": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"Hide": {
"type": "boolean"
},
"Path": {
"maxLength": 500,
"type": "string",
"nullable": true
},
"ProcessorStartNumber": {
"type": "integer",
"format": "int32"
},
"UnitStartNumber": {
"type": "integer",
"format": "int32"
},
"AllowMultipleRates": {
"type": "boolean"
},
"ConsolidateOT": {
"type": "boolean"
},
"DefaultPayrollGroupID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"AllowDailyExport": {
"type": "boolean"
},
"DefaultOTAlias": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"IgnoreZeroHours": {
"type": "boolean"
},
"ProcessorIgnoreNumber": {
"type": "integer",
"format": "int32"
},
"AutoExportNetworkCredentials": {
"$ref": "#/components/schemas/OPS.Shared.Models.NetworkCredentials.NetworkCredential"
},
"AutoExportNetworkCredentialsID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Payroll.PayrollProcessorFile": {
"type": "object",
"properties": {
"FileID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ProcessorID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollProcessor": {
"$ref": "#/components/schemas/OPS.Shared.Models.Payroll.PayrollProcessor"
},
"FileType": {
"type": "string"
},
"DefaultFileName": {
"type": "string",
"nullable": true
},
"ExportLabels": {
"type": "boolean"
},
"Hide": {
"type": "boolean"
},
"Comment": {
"type": "string",
"nullable": true
},
"ExportFileType": {
"type": "string"
},
"Mode": {
"type": "string",
"nullable": true
},
"CustomSPName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Payroll.TPayrollBatchFile": {
"type": "object",
"properties": {
"ID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"BatchHeaderID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"TPayrollBatchGroup": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.TPayrollBatchGroup"
},
"FileID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollProcessorFile": {
"$ref": "#/components/schemas/OPS.Shared.Models.Payroll.PayrollProcessorFile"
},
"FullName": {
"type": "string",
"nullable": true
},
"ExportLabels": {
"type": "boolean"
},
"Hide": {
"type": "boolean"
},
"Comment": {
"type": "string",
"nullable": true
},
"ExportDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"SubBatchNumber": {
"type": "integer",
"format": "int32"
},
"FilterEmployees": {
"type": "boolean"
},
"AutoExportDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.PayrollGroup.OvertimeMethod": {
"enum": [
"E",
"G",
"P",
"U"
],
"type": "string"
},
"OPS.Shared.Models.PayrollGroup.PayrollGroup": {
"required": [
"Description"
],
"type": "object",
"properties": {
"PayrollGroupID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"BatchHeaderID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Name": {
"type": "string",
"nullable": true
},
"Description": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"Frequency": {
"$ref": "#/components/schemas/OPS.Shared.Models.LineCheck.Frequency"
},
"OvertimeMethod": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.OvertimeMethod"
},
"FirstWeekDay": {
"$ref": "#/components/schemas/OPS.Shared.Models.EmployeeAvailabilities.AvailabilityWeekDay"
},
"PayrollPeriodStart": {
"type": "string",
"format": "date-time"
},
"PayrollPeriodEnd": {
"type": "string",
"format": "date-time"
},
"CalendarID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"CountryCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ProcessorID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Processor": {
"$ref": "#/components/schemas/OPS.Shared.Models.Payroll.PayrollProcessor"
},
"AllowEditTodayTimeCards": {
"type": "boolean"
},
"BatchGroupHeader": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.TPayrollBatchGroup"
},
"BatchGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.TPayrollBatchGroup"
},
"nullable": true
},
"Files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Payroll.PayrollGroupFile"
},
"nullable": true
},
"SyncJobRate": {
"type": "boolean"
},
"EmployeeAdd": {
"type": "string",
"nullable": true
},
"AutoExportPayrollEnabled": {
"type": "boolean"
},
"AutoExportPayrollAfterHours": {
"type": "integer",
"format": "int32",
"nullable": true
},
"OTMethod": {
"type": "integer",
"format": "int32"
},
"Hide": {
"type": "boolean"
},
"AllowDailyExport": {
"type": "boolean"
},
"DailyExportHours": {
"type": "string",
"format": "date-time",
"nullable": true
},
"GroupIDforPayroll": {
"type": "string",
"nullable": true
},
"Employer": {
"type": "string",
"nullable": true
},
"EIN": {
"type": "string",
"nullable": true
},
"Address": {
"type": "string",
"nullable": true
},
"CalculateOTForSalaryEmployees": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.PayrollGroup.RegularType": {
"enum": [
"O",
"R"
],
"type": "string"
},
"OPS.Shared.Models.PayrollGroup.TPayrollBatchGroup": {
"type": "object",
"properties": {
"BatchHeaderID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollGroupID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollGroup": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.PayrollGroup"
},
"PayrollBatchName": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"PayrollPeriodStart": {
"type": "string",
"format": "date-time"
},
"PayrollPeriodEnd": {
"type": "string",
"format": "date-time"
},
"ApprovedYN": {
"type": "boolean"
},
"ExportedYN": {
"type": "boolean"
},
"CurrentYN": {
"type": "boolean"
},
"ApproveUser": {
"type": "string",
"nullable": true
},
"ApproveDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"ProcessorID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollProcessor": {
"$ref": "#/components/schemas/OPS.Shared.Models.Payroll.PayrollProcessor"
},
"BatchUnitHeaders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.TPayrollBatchUnit"
},
"nullable": true
},
"SubBatchGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.TPayrollSubBatchGroup"
},
"nullable": true
},
"AutoExportProgress": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.TPayrollBatchGroupAutoExport"
},
"Files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Payroll.TPayrollBatchFile"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.PayrollGroup.TPayrollBatchGroupAutoExport": {
"type": "object",
"properties": {
"BatchHeaderID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"AutoExportStatus": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.TPayrollBatchGroupAutoExportStatus"
},
"PayrollBatchGroup": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.TPayrollBatchGroup"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.PayrollGroup.TPayrollBatchGroupAutoExportStatus": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
],
"type": "integer",
"format": "int32"
},
"OPS.Shared.Models.PayrollGroup.TPayrollBatchTimeCardHeader": {
"type": "object",
"properties": {
"IntID": {
"type": "integer",
"format": "int64"
},
"UnitPayrollIntID": {
"type": "integer",
"format": "int64"
},
"BatchUnit": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.TPayrollBatchUnit"
},
"BusinessDate": {
"type": "string",
"format": "date-time"
},
"StartDate": {
"type": "string",
"format": "date-time"
},
"EndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"RegularRate": {
"type": "number",
"format": "double",
"nullable": true
},
"TotalHours": {
"type": "number",
"format": "double",
"nullable": true
},
"HolidayRate": {
"type": "number",
"format": "double",
"nullable": true
},
"HolidayHours": {
"type": "number",
"format": "double",
"nullable": true
},
"UnPaidBreakMinuts": {
"type": "number",
"format": "double"
},
"LocalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollJobID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ClockID": {
"type": "integer",
"format": "int64",
"nullable": true
},
"HideYN": {
"type": "boolean"
},
"TimeCardLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.TPayrollBatchTimeCardLine"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.PayrollGroup.TPayrollBatchTimeCardLine": {
"type": "object",
"properties": {
"IntID": {
"type": "integer",
"format": "int64"
},
"HeaderIntID": {
"type": "integer",
"format": "int64"
},
"TimeCardHeader": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.TPayrollBatchTimeCardHeader"
},
"Rate": {
"type": "number",
"format": "double",
"nullable": true
},
"Hours": {
"type": "number",
"format": "double",
"nullable": true
},
"Rule": {
"type": "integer",
"format": "int32",
"nullable": true
},
"HolidayRate": {
"type": "number",
"format": "double",
"nullable": true
},
"HolidayHours": {
"type": "number",
"format": "double",
"nullable": true
},
"Regular": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.RegularType"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.PayrollGroup.TPayrollBatchUnit": {
"type": "object",
"properties": {
"UnitPayrollIntID": {
"type": "integer",
"format": "int64"
},
"UnitHeaderId": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"BatchHeaderID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"BatchGroupHeader": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.TPayrollBatchGroup"
},
"UnitId": {
"type": "integer",
"format": "int32"
},
"Unit": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"ApprovedYN": {
"type": "boolean"
},
"Locked": {
"type": "boolean"
},
"TimeCardHeaders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.TPayrollBatchTimeCardHeader"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.PayrollGroup.TPayrollSubBatchGroup": {
"type": "object",
"properties": {
"SubBatchHeaderID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"BatchHeaderID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"BatchGroupHeader": {
"$ref": "#/components/schemas/OPS.Shared.Models.PayrollGroup.TPayrollBatchGroup"
},
"SubBatchNumber": {
"type": "integer",
"format": "int32"
},
"ApprovedYN": {
"type": "boolean"
},
"CurrentYN": {
"type": "boolean"
},
"ApproveUser": {
"type": "string",
"nullable": true
},
"Comment": {
"type": "string",
"nullable": true
},
"ApproveDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"ExportedYN": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.RefreshTokenModel": {
"required": [
"RefreshToken"
],
"type": "object",
"properties": {
"RefreshToken": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Schedule.SchoolCalendar": {
"required": [
"SchoolName"
],
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int32"
},
"SchoolName": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"StateID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Enabled": {
"type": "boolean"
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
},
"State": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.State"
},
"Events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Schedule.SchoolCalendarEvent"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Schedule.SchoolCalendarEvent": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int32"
},
"SchoolCalendarID": {
"type": "integer",
"format": "int32"
},
"StartDate": {
"type": "string",
"format": "date-time"
},
"EndDate": {
"type": "string",
"format": "date-time"
},
"Description": {
"maxLength": 200,
"type": "string",
"nullable": true
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
},
"SchoolCalendar": {
"$ref": "#/components/schemas/OPS.Shared.Models.Schedule.SchoolCalendar"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.ShiftWorks.Chats.ChatCreate": {
"type": "object",
"properties": {
"ShiftWorksUserIDs": {
"type": "array",
"items": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"nullable": true
},
"UnitID": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.ShiftWorks.Chats.ChatEmployee": {
"type": "object",
"properties": {
"ShiftWorksUserID": {
"type": "string",
"nullable": true
},
"GlobalEmployeeID": {
"type": "string",
"nullable": true,
"readOnly": true,
"deprecated": true
},
"FirstName": {
"type": "string",
"nullable": true
},
"LastName": {
"type": "string",
"nullable": true
},
"IsDeleted": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.ShiftWorks.Chats.ChatInfoDto": {
"type": "object",
"properties": {
"ChatID": {
"type": "string",
"nullable": true
},
"ChatEmployees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatEmployee"
},
"nullable": true
},
"IsReadOnly": {
"type": "boolean"
},
"UnitID": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"ImagesEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.ShiftWorks.Chats.ChatMessage": {
"type": "object",
"properties": {
"MessageID": {
"type": "integer",
"format": "int32"
},
"ChatID": {
"type": "string",
"nullable": true
},
"MessageTime": {
"type": "string",
"format": "date-time"
},
"Message": {
"type": "string",
"nullable": true
},
"ShiftWorksUserID": {
"type": "string",
"nullable": true
},
"GlobalEmployeeID": {
"type": "string",
"nullable": true,
"readOnly": true,
"deprecated": true
},
"GlobalEmployeeFirstName": {
"type": "string",
"nullable": true
},
"GlobalEmployeeLastName": {
"type": "string",
"nullable": true
},
"ImageUrls": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.ShiftWorks.Chats.ChatsSyncResult": {
"type": "object",
"properties": {
"ChatID": {
"type": "string",
"nullable": true
},
"ChatNotifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.SyncChatInfo"
},
"nullable": true
},
"Messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatMessage"
},
"nullable": true
},
"TotalNotificationCount": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.ShiftWorks.Chats.PreviewChatInfo": {
"type": "object",
"properties": {
"ChatID": {
"type": "string",
"nullable": true
},
"ChatEmployees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.ShiftWorks.Chats.ChatEmployee"
},
"nullable": true
},
"IsReadOnly": {
"type": "boolean"
},
"UnitID": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"ImagesEnabled": {
"type": "boolean"
},
"NotificationCount": {
"type": "integer",
"format": "int32"
},
"LastMessageTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"LastMessage": {
"type": "string",
"nullable": true
},
"LastMessageRead": {
"type": "boolean",
"readOnly": true
},
"LastMessageEmployeeLastName": {
"type": "string",
"nullable": true
},
"LastMessageEmployeeFirstName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.ShiftWorks.Chats.SyncChatInfo": {
"type": "object",
"properties": {
"ChatID": {
"type": "string",
"nullable": true
},
"NotificationCount": {
"type": "integer",
"format": "int32"
},
"LastMessageTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"LastMessage": {
"type": "string",
"nullable": true
},
"LastMessageRead": {
"type": "boolean",
"readOnly": true
},
"LastMessageEmployeeLastName": {
"type": "string",
"nullable": true
},
"LastMessageEmployeeFirstName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.BlendedRateJobs": {
"type": "object",
"properties": {
"PayrollJobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollJob": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.PayrollJob"
},
"BlendedJobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"BlendedJob": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.PayrollJob"
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Dto.AllShiftsDto": {
"type": "object",
"properties": {
"ChainID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"StartTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"EndTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"BusinessDate": {
"type": "string",
"format": "date-time"
},
"CanPickupRequest": {
"type": "boolean"
},
"MyPickupRequest": {
"type": "boolean"
},
"JobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"JobDescription": {
"type": "string",
"nullable": true
},
"ShiftWorksUserID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"LocalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"EmployeeFirstName": {
"type": "string",
"nullable": true
},
"EmployeeLastName": {
"type": "string",
"nullable": true
},
"IsScheduled": {
"type": "boolean"
},
"IsMyShift": {
"type": "boolean"
},
"SwapStatus": {
"type": "string",
"nullable": true
},
"IsMySwap": {
"type": "boolean"
},
"SwapID": {
"type": "integer",
"format": "int64",
"nullable": true
},
"GlobalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"readOnly": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD",
"deprecated": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Dto.CurrentEmployeeJobDto": {
"type": "object",
"properties": {
"PayrollJobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Dto.DropRequestDto": {
"type": "object",
"properties": {
"UnitID": {
"type": "integer",
"format": "int32"
},
"ChainID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Dto.EmployeeJobDto": {
"type": "object",
"properties": {
"ShiftWorksUserID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"FirstName": {
"type": "string",
"nullable": true
},
"LastName": {
"type": "string",
"nullable": true
},
"PayrollJobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Dto.PickupRequestChangeDateDto": {
"type": "object",
"properties": {
"RecordID": {
"type": "integer",
"format": "int64",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Dto.PickupRequestDto": {
"type": "object",
"properties": {
"UnitID": {
"type": "integer",
"format": "int32"
},
"BusinessDate": {
"type": "string",
"format": "date-time"
},
"ChainID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Dto.ShiftDetailModel": {
"type": "object",
"properties": {
"ChainID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"StationID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"StationDescription": {
"type": "string",
"nullable": true
},
"ScheduleBreakID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ScheduleBreakDescription": {
"type": "string",
"nullable": true
},
"StartTime": {
"type": "string",
"format": "date-time"
},
"EndTime": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Generations.ForecastType": {
"enum": [
"R",
"G",
"C",
"T",
"E",
"GI",
"CI",
"TI",
"GO",
"TO",
"CO"
],
"type": "string"
},
"OPS.Shared.Models.Shifts.Generations.ScheduleAccount": {
"type": "object",
"properties": {
"AccountID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Account": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.ChartOfAccounts"
},
"BaseID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Base": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ScheduleBase"
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Generations.ScheduleBase": {
"required": [
"Description"
],
"type": "object",
"properties": {
"ID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ScheduleTemplateID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ScheduleTemplate": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleTemplate"
},
"Description": {
"maxLength": 80,
"minLength": 1,
"type": "string"
},
"Hide": {
"type": "boolean"
},
"ForecastType": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ForecastType"
},
"Jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ScheduleJob"
},
"nullable": true
},
"JobTargetMatrices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ScheduleJobTargetMatrix"
},
"nullable": true
},
"Accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ScheduleAccount"
},
"nullable": true
},
"DailyRequirements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ScheduleDailyRequirement"
},
"nullable": true
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Generations.ScheduleDailyRequirement": {
"type": "object",
"properties": {
"RequirementID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"StationID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Station": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.ScheduleStation"
},
"BaseID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Base": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ScheduleBase"
},
"WeekDays": {
"type": "string",
"nullable": true
},
"Target": {
"type": "number",
"format": "double"
},
"MinHours": {
"type": "number",
"format": "double",
"nullable": true
},
"MaxHours": {
"type": "number",
"format": "double",
"nullable": true
},
"ForecastType": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ForecastType"
},
"Matrixes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ScheduleDailyTargetMatrix"
},
"nullable": true
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Generations.ScheduleDailyTargetMatrix": {
"type": "object",
"properties": {
"ID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"RequirementID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Requirement": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ScheduleDailyRequirement"
},
"IntervalCap": {
"type": "number",
"format": "double"
},
"Allowed": {
"type": "number",
"format": "double",
"nullable": true
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Generations.ScheduleJob": {
"type": "object",
"properties": {
"ScheduleJobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"JobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Job": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.PayrollJob"
},
"BaseID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Base": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ScheduleBase"
},
"ScheduleStationID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ScheduleStation": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.ScheduleStation"
},
"Less1Round": {
"type": "number",
"format": "double"
},
"More1Round": {
"type": "number",
"format": "double"
},
"IntervalTarget": {
"type": "number",
"format": "double"
},
"IntervalType": {
"$ref": "#/components/schemas/OPS.Shared.Models.Forecast.ForecastIntervalType"
},
"WeekDays": {
"type": "string",
"nullable": true
},
"Shifts": {
"type": "string",
"nullable": true
},
"MinAlloc": {
"type": "integer",
"format": "int32"
},
"MaxAlloc": {
"type": "integer",
"format": "int32"
},
"MaxIntAlloc": {
"type": "integer",
"format": "int32"
},
"MaxAllocCombined": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"MDI": {
"type": "integer",
"format": "int32"
},
"MCI": {
"type": "integer",
"format": "int32"
},
"JobTargetMatrices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ScheduleJobTargetMatrix"
},
"nullable": true
},
"ShiftsArray": {
"type": "array",
"items": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"nullable": true
},
"WeekDaysArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/System.DayOfWeek"
},
"nullable": true
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Generations.ScheduleJobTargetMatrix": {
"type": "object",
"properties": {
"ID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"JobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Job": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.PayrollJob"
},
"BaseID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Base": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ScheduleBase"
},
"IntervalCap": {
"type": "number",
"format": "double"
},
"Target": {
"type": "number",
"format": "double",
"nullable": true
},
"Allowed": {
"type": "number",
"format": "double",
"nullable": true
},
"ScheduleJobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ScheduleJob": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ScheduleJob"
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.ScheduleBreak": {
"required": [
"Description"
],
"type": "object",
"properties": {
"ID": {
"type": "integer",
"format": "int32"
},
"UnitID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"Unit": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"Description": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"IsPaid": {
"type": "boolean"
},
"AutoCreate": {
"type": "boolean"
},
"Color": {
"type": "integer",
"format": "int32",
"nullable": true
},
"MinShiftLength": {
"type": "integer",
"format": "int32",
"nullable": true
},
"FixedMinutes": {
"type": "integer",
"format": "int32",
"nullable": true
},
"Hide": {
"type": "boolean"
},
"IsPrivate": {
"type": "boolean",
"readOnly": true
},
"IsAdminManaged": {
"type": "boolean"
},
"Jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleBreakJob"
},
"nullable": true
},
"Groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleBreakGroup"
},
"nullable": true
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.ScheduleBreakGroup": {
"type": "object",
"properties": {
"BreakID": {
"type": "integer",
"format": "int32"
},
"Break": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleBreak"
},
"GroupID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Group": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.DCGroup"
},
"GrantOptions": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.GrantOptions"
},
"Comment": {
"type": "string",
"nullable": true
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.ScheduleBreakJob": {
"type": "object",
"properties": {
"ScheduleBreakID": {
"type": "integer",
"format": "int32"
},
"ScheduleBreak": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleBreak"
},
"JobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Job": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.PayrollJob"
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.ScheduleGroup": {
"type": "object",
"properties": {
"GroupID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Group": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.DCGroup"
},
"ScheduleTemplateID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ScheduleTemplate": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleTemplate"
},
"GrantOptions": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.GrantOptions"
},
"Comment": {
"type": "string",
"nullable": true
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.ScheduleStationGroup": {
"type": "object",
"properties": {
"GroupID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Group": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.DCGroup"
},
"StationID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Station": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.ScheduleStation"
},
"GrantOptions": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.GrantOptions"
},
"Comment": {
"type": "string",
"nullable": true
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.ScheduleSwapCardModel": {
"type": "object",
"properties": {
"RecordID": {
"type": "integer",
"format": "int64"
},
"StoreEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"FirstName": {
"type": "string",
"nullable": true
},
"LastName": {
"type": "string",
"nullable": true
},
"BusinessDate": {
"type": "string",
"format": "date-time"
},
"JobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"JobDescription": {
"type": "string",
"nullable": true
},
"ShiftStartTime": {
"type": "string",
"format": "date-time"
},
"ShiftEndTime": {
"type": "string",
"format": "date-time"
},
"Hours": {
"type": "number",
"format": "double"
},
"TotalWeekHours": {
"type": "number",
"format": "double"
},
"Type": {
"type": "string"
},
"CreateDate": {
"type": "string",
"format": "date-time"
},
"Status": {
"type": "string"
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.ScheduleTemplate": {
"required": [
"Description"
],
"type": "object",
"properties": {
"ID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"UnitID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"Unit": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"Description": {
"maxLength": 80,
"minLength": 1,
"type": "string"
},
"Hide": {
"type": "boolean"
},
"IntervalType": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleTemplateIntervalType"
},
"ForecastType": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ForecastType"
},
"MonthlySchedule": {
"type": "boolean"
},
"IsPrivate": {
"type": "boolean",
"readOnly": true
},
"IsAdminManaged": {
"type": "boolean"
},
"Groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleGroup"
},
"nullable": true
},
"ScheduleBases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.Generations.ScheduleBase"
},
"nullable": true
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
},
"Publishes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.TSchedulePublished"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.ScheduleTemplateIntervalType": {
"enum": [
"1",
"2",
"4"
],
"type": "string"
},
"OPS.Shared.Models.Shifts.ShiftSource": {
"enum": [
"F",
"M",
"S"
],
"type": "string"
},
"OPS.Shared.Models.Shifts.Swaps.SwapAvailableShiftModel": {
"type": "object",
"properties": {
"StoreEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"FirstName": {
"type": "string",
"nullable": true
},
"LastName": {
"type": "string",
"nullable": true
},
"JobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"BusinessDate": {
"type": "string",
"format": "date-time"
},
"ChainID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Job": {
"type": "string",
"nullable": true
},
"ShiftStart": {
"type": "string",
"format": "date-time"
},
"ShiftEnd": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Swaps.SwapRequestCardModelDto": {
"type": "object",
"properties": {
"RecordId": {
"type": "integer",
"format": "int64"
},
"CreateDate": {
"type": "string",
"format": "date-time"
},
"LastMDate": {
"type": "string",
"format": "date-time"
},
"Status": {
"type": "string"
},
"Proposed": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleSwapCardModel"
},
"Requested": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleSwapCardModel"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Swaps.SwapRequestCreateModel": {
"type": "object",
"properties": {
"UnitID": {
"type": "integer",
"format": "int32"
},
"ChainIDProposed": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ChainIDRequested": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"LocalEmployeeIDRequested": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Swaps.SwapRequestModel": {
"type": "object",
"properties": {
"RecordID": {
"type": "integer",
"format": "int64"
},
"UnitID": {
"type": "integer",
"format": "int32"
},
"UnitName": {
"type": "string",
"nullable": true
},
"ChainIDProposed": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"EmployeeFirstNameProposed": {
"type": "string",
"nullable": true
},
"EmployeeLastNameProposed": {
"type": "string",
"nullable": true
},
"StartTimeProposed": {
"type": "string",
"format": "date-time"
},
"EndTimeProposed": {
"type": "string",
"format": "date-time"
},
"BusinessDateProposed": {
"type": "string",
"format": "date-time"
},
"JobIDProposed": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"JobProposed": {
"type": "string",
"nullable": true
},
"ChainIDRequested": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"EmployeeFirstNameRequested": {
"type": "string",
"nullable": true
},
"EmployeeLastNameRequested": {
"type": "string",
"nullable": true
},
"StartTimeRequested": {
"type": "string",
"format": "date-time"
},
"EndTimeRequested": {
"type": "string",
"format": "date-time"
},
"BusinessDateRequested": {
"type": "string",
"format": "date-time"
},
"JobIDRequested": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"JobRequested": {
"type": "string",
"nullable": true
},
"Status": {
"type": "string"
},
"CreateDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.Swaps.SwapRequestRejectListModel": {
"type": "object",
"properties": {
"IdList": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.TScheduleHeader": {
"type": "object",
"properties": {
"ID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"BusinessDate": {
"type": "string",
"format": "date-time"
},
"StartTime": {
"type": "string",
"format": "date-time"
},
"EndTime": {
"type": "string",
"format": "date-time"
},
"UnitID": {
"type": "integer",
"format": "int32"
},
"Unit": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"JobID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Job": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.PayrollJob"
},
"LocalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"LocalEmployee": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployee"
},
"ScheduleTemplateID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ScheduleTemplate": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleTemplate"
},
"HasDropRequest": {
"type": "boolean"
},
"ShiftSource": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ShiftSource"
},
"EmployeeGroupID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"LastMDate": {
"type": "string",
"format": "date-time"
},
"LastMUser": {
"type": "string",
"nullable": true
},
"Shifts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.TScheduleShift"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.TSchedulePublished": {
"type": "object",
"properties": {
"UnitID": {
"type": "integer",
"format": "int32"
},
"Unit": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"StartDate": {
"type": "string",
"format": "date-time"
},
"EndDate": {
"type": "string",
"format": "date-time"
},
"ScheduleTemplateID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ScheduleTemplate": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleTemplate"
},
"Published": {
"type": "boolean"
},
"SchoolInSession": {
"type": "boolean"
},
"OriginalPublish": {
"type": "string",
"format": "date-time",
"nullable": true
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.TScheduleShift": {
"type": "object",
"properties": {
"ID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ScheduleHeaderID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ScheduleHeader": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.TScheduleHeader"
},
"StartTime": {
"type": "string",
"format": "date-time"
},
"EndTime": {
"type": "string",
"format": "date-time"
},
"StationID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Station": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.ScheduleStation"
},
"ScheduleBreakID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ScheduleBreak": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.ScheduleBreak"
},
"ShiftType": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.TScheduleShiftType"
},
"Duration": {
"type": "TimeSpan",
"readOnly": true,
"example": "21:30:00"
},
"IsBreak": {
"type": "boolean",
"readOnly": true
},
"LastMUser": {
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.TScheduleShiftType": {
"enum": [
"B",
"N",
"P",
"S"
],
"type": "string"
},
"OPS.Shared.Models.Shifts.TShiftWorksRequest": {
"type": "object",
"properties": {
"RecordID": {
"type": "integer",
"format": "int64"
},
"UnitID": {
"type": "integer",
"format": "int32"
},
"BusinessDate": {
"type": "string",
"format": "date-time"
},
"LocalEmployeeID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"LocalEmployee": {
"$ref": "#/components/schemas/OPS.Shared.Models.Employees.UEmployee"
},
"ChainID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Chain": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.TScheduleHeader"
},
"Status": {
"$ref": "#/components/schemas/OPS.Shared.Models.Shifts.TShiftWorksRequestStatus"
},
"JobID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"StartTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"EndTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"RejectReason": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"LastMDate": {
"type": "string",
"format": "date-time"
},
"LastMUser": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Shifts.TShiftWorksRequestStatus": {
"enum": [
"A",
"C",
"J",
"M",
"O",
"R"
],
"type": "string"
},
"OPS.Shared.Models.StoreVendors.StoreVendor": {
"required": [
"StoreId",
"VendorId"
],
"type": "object",
"properties": {
"ID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"VendorId": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Vendor": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.Vendor"
},
"StoreId": {
"type": "integer",
"format": "int32"
},
"Store": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"LocalPayToCode": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"LocalDescription": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"HideStoreVendor": {
"type": "boolean"
},
"Type": {
"$ref": "#/components/schemas/OPS.Shared.Models.StoreVendors.StoreVendorTypeDbEnum"
},
"EDIDataPumpEnabled": {
"type": "boolean"
},
"VendorUnitId": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"VendorBranchId": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"Method": {
"$ref": "#/components/schemas/OPS.Shared.Models.StoreVendors.StoreVendorMethodDbEnum"
},
"RegularInvoice": {
"type": "boolean"
},
"ManualCheck": {
"type": "boolean"
},
"PaidIn": {
"type": "boolean"
},
"PaidOut": {
"type": "boolean"
},
"CreditMemo": {
"type": "boolean"
},
"PurchaseOrder": {
"type": "boolean"
},
"FileMask": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"POExportEnabled": {
"type": "boolean"
},
"ISA_GSSenderID": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"IsImageRequired": {
"type": "boolean"
},
"OrderingBuffer": {
"type": "number",
"format": "double"
},
"IsEarlyDelivery": {
"type": "boolean"
},
"AllowOrderDueAlert": {
"type": "boolean"
},
"AllowModifiedAccount": {
"type": "boolean"
},
"B2BPartnerID": {
"type": "string",
"nullable": true
},
"B2BUserName": {
"type": "string",
"nullable": true
},
"B2BPassword": {
"type": "string",
"nullable": true
},
"B2BDivision": {
"type": "string",
"nullable": true
},
"B2BCustNumber": {
"type": "string",
"nullable": true
},
"B2BDepartmentNumber": {
"type": "string",
"nullable": true
},
"AutoApproveInvoice": {
"type": "boolean"
},
"MinQtyWarning": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int32",
"nullable": true
},
"AutoSendOrder": {
"type": "boolean"
},
"StoreVendorDeliverySchedules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.StoreVendors.StoreVendorDeliverySchedule"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.StoreVendors.StoreVendorDeliverySchedule": {
"type": "object",
"properties": {
"ID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"StoreId": {
"type": "integer",
"format": "int32"
},
"Store": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"StoreVendorId": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"StoreVendor": {
"$ref": "#/components/schemas/OPS.Shared.Models.StoreVendors.StoreVendor"
},
"Frequency": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.VendorDeliveryScheduleFrequencyDbEnum"
},
"FrequencyOption": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"LeadDays": {
"type": "integer",
"format": "int32"
},
"CutoffTime": {
"type": "string",
"format": "time",
"nullable": true
},
"MaximumLeadDays": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.StoreVendors.StoreVendorMethodDbEnum": {
"enum": [
"C",
"I",
"M",
"N",
"P",
"S",
"V"
],
"type": "string"
},
"OPS.Shared.Models.StoreVendors.StoreVendorTypeDbEnum": {
"enum": [
"C",
"I",
"M",
"O",
"R"
],
"type": "string"
},
"OPS.Shared.Models.TokenModel": {
"required": [
"AccessToken",
"RefreshToken"
],
"type": "object",
"properties": {
"AccessToken": {
"minLength": 1,
"type": "string"
},
"RefreshToken": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.VendorItem.PreferenceDbEnum": {
"enum": [
"I",
"P",
"S"
],
"type": "string"
},
"OPS.Shared.Models.VendorItem.VendorItem": {
"type": "object",
"properties": {
"VendorItemID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"VendorID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Vendor": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.Vendor"
},
"VendorItemCode": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"VendorItemDescription": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"VendorUM": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"ItemID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"MasterItem": {
"$ref": "#/components/schemas/OPS.Shared.Models.Item.Item"
},
"UMID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Measure": {
"$ref": "#/components/schemas/OPS.Shared.Models.Item.ItemUM"
},
"PackSizeDescription": {
"maxLength": 80,
"type": "string",
"nullable": true
},
"SourceCategory": {
"maxLength": 80,
"type": "string",
"nullable": true
},
"ManufacturerID": {
"maxLength": 48,
"type": "string",
"nullable": true
},
"ManufacturerName": {
"maxLength": 80,
"type": "string",
"nullable": true
},
"CanBeSplit": {
"type": "boolean",
"nullable": true
},
"Preference": {
"$ref": "#/components/schemas/OPS.Shared.Models.VendorItem.PreferenceDbEnum"
},
"CatalogComment": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"LastCost": {
"maximum": 999999999.9999,
"minimum": 0,
"type": "number",
"format": "double",
"nullable": true
},
"MinOrderQuantity": {
"maximum": 9999999999.99,
"minimum": 0,
"type": "number",
"format": "double",
"nullable": true
},
"Template": {
"type": "boolean"
},
"TemplateQty": {
"maximum": 99999999.9999,
"minimum": 0,
"type": "number",
"format": "double",
"nullable": true
},
"CatchWeightUMID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"MaxOrderQuantity": {
"maximum": 9999999999.99,
"minimum": 0,
"type": "number",
"format": "double",
"nullable": true
},
"Location": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"Shelf": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"SortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"PriceCatalogExcluded": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Vendors.B2BIntegrationDbEnum": {
"enum": [
"C",
"I",
"M",
"N",
"P",
"S",
"V"
],
"type": "string"
},
"OPS.Shared.Models.Vendors.DefaultDocumentDateDbEnum": {
"enum": [
"B",
"T"
],
"type": "string"
},
"OPS.Shared.Models.Vendors.DefaultOrderPreferenceEnum": {
"enum": [
"I",
"P",
"S"
],
"type": "string"
},
"OPS.Shared.Models.Vendors.DefaultSourceSODbEnum": {
"enum": [
"P",
"T",
"V",
"W"
],
"type": "string"
},
"OPS.Shared.Models.Vendors.InvoiceDateFromDbEnum": {
"enum": [
"D",
"I"
],
"type": "string"
},
"OPS.Shared.Models.Vendors.TAPVoucherTemplate": {
"type": "object",
"properties": {
"VendorID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Vendor": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.Vendor"
},
"AccountID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Account": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.ChartOfAccounts"
},
"Hide": {
"type": "boolean"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Vendors.Vendor": {
"required": [
"Description"
],
"type": "object",
"properties": {
"VendorID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"DefaultPayToCode": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"Description": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"HideMasterVendorYN": {
"type": "boolean"
},
"AutoAddToLocalVendorsYN": {
"type": "boolean"
},
"Group1": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"Group2": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"Group3": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"Address1": {
"maxLength": 40,
"type": "string",
"nullable": true
},
"Address2": {
"maxLength": 40,
"type": "string",
"nullable": true
},
"City": {
"maxLength": 15,
"type": "string",
"nullable": true
},
"State": {
"maxLength": 15,
"type": "string",
"nullable": true
},
"Zip": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"Country": {
"maxLength": 40,
"type": "string",
"nullable": true
},
"ContactName": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"Phone": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"CellPhone": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"Fax": {
"maxLength": 25,
"type": "string",
"nullable": true
},
"Email": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"WebSite": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"DefaultType": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.VendorTypeDbEnum"
},
"EDIDataPumpEnabledYN": {
"type": "boolean"
},
"EnablePriceControl": {
"type": "boolean"
},
"LiabilityAccountID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"APVoucher": {
"type": "boolean"
},
"DefaultMethod": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.B2BIntegrationDbEnum"
},
"DefaultReconcile": {
"type": "boolean"
},
"ReasonCodeRequired": {
"type": "boolean"
},
"RegularInvoice": {
"type": "boolean"
},
"ManualCheck": {
"type": "boolean"
},
"PaidIn": {
"type": "boolean"
},
"PaidOut": {
"type": "boolean"
},
"CreditMemo": {
"type": "boolean"
},
"PurchaseOrder": {
"type": "boolean"
},
"EDIVendorGlobalCode": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"NCID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"FileMask": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"EDIAutoImport": {
"type": "boolean"
},
"AutoInvoiceNumber": {
"type": "boolean"
},
"PKUnitID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"PKUnit": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.Unit"
},
"ISA_GSSenderID": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"DefaultDocumentDate": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.DefaultDocumentDateDbEnum"
},
"ShortDocumentNumber": {
"type": "boolean"
},
"SenderInterchangeQualifier": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"ReceiverInterchangeQualifier": {
"maxLength": 10,
"type": "string",
"nullable": true
},
"UseContractPrice": {
"type": "boolean"
},
"AutoCreditMemoNumber": {
"type": "boolean"
},
"MultipleInvoices": {
"type": "boolean"
},
"UsePOCostForCommissary": {
"type": "boolean"
},
"InvoiceDateFrom": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.InvoiceDateFromDbEnum"
},
"DefaultSourceSO": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.DefaultSourceSODbEnum"
},
"EDIWHCombinedCode": {
"maxLength": 40,
"type": "string",
"nullable": true
},
"SumUpScanAssistLines": {
"type": "boolean"
},
"DefaultVendorSuppliedVendorCode": {
"maxLength": 30,
"type": "string",
"nullable": true
},
"AllowEDIinClosedPeriod": {
"type": "boolean"
},
"ImageRequirement": {
"type": "boolean"
},
"OrderingBuffer": {
"type": "number",
"format": "double"
},
"IsEarlyDelivery": {
"type": "boolean"
},
"AutoApproveInvoice": {
"type": "boolean"
},
"CreditAuthorizationRequired": {
"type": "boolean"
},
"AllowOrderDueAlert": {
"type": "boolean"
},
"AutoLinkVendorItems": {
"type": "boolean"
},
"DefaultMinQtyWarning": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int32",
"nullable": true
},
"DefaultOrderPreference": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.DefaultOrderPreferenceEnum"
},
"AutoSendOrder": {
"type": "boolean"
},
"AllowOrderModifications": {
"type": "boolean"
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Item.Item"
},
"nullable": true
},
"AccountLimits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.VendorCategoryLimit"
},
"nullable": true
},
"VoucherTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.TAPVoucherTemplate"
},
"nullable": true
},
"VendorOrderings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.VendorDeliverySchedule"
},
"nullable": true
},
"VendorGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.VendorGroup"
},
"nullable": true
},
"StoreVendors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.StoreVendors.StoreVendor"
},
"nullable": true
},
"VendorItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OPS.Shared.Models.VendorItem.VendorItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Vendors.VendorCategoryLimit": {
"type": "object",
"properties": {
"VendorID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Vendor": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.Vendor"
},
"AccountID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Account": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.ChartOfAccounts"
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Vendors.VendorDeliverySchedule": {
"type": "object",
"properties": {
"Id": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"VendorID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Vendor": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.Vendor"
},
"Frequency": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.VendorDeliveryScheduleFrequencyDbEnum"
},
"FrequencyOption": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"LeadDays": {
"type": "integer",
"format": "int32"
},
"CutoffTime": {
"type": "string",
"format": "time",
"nullable": true
},
"MaximumLeadDays": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Vendors.VendorDeliveryScheduleFrequencyDbEnum": {
"enum": [
"D",
"M",
"W"
],
"type": "string"
},
"OPS.Shared.Models.Vendors.VendorGroup": {
"required": [
"GrantOptions",
"GroupID",
"VendorID"
],
"type": "object",
"properties": {
"VendorID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Vendor": {
"$ref": "#/components/schemas/OPS.Shared.Models.Vendors.Vendor"
},
"GroupID": {
"type": "guid",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Group": {
"$ref": "#/components/schemas/OPS.Shared.Models.Common.DCGroup"
},
"GrantOptions": {
"type": "integer",
"format": "int32"
},
"Comment": {
"maxLength": 100,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Models.Vendors.VendorTypeDbEnum": {
"enum": [
"G",
"R"
],
"type": "string"
},
"OPS.Shared.Services.Auth.ResetForgottenPasswordDto": {
"type": "object",
"properties": {
"Login": {
"type": "string",
"nullable": true
},
"Token": {
"type": "string",
"nullable": true
},
"NewPassword": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Services.Auth.ResetPasswordTokenValidationDto": {
"type": "object",
"properties": {
"Login": {
"type": "string",
"nullable": true
},
"Token": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OPS.Shared.Services.Auth.SendForgotPasswordEmailDto": {
"type": "object",
"properties": {
"Login": {
"type": "string",
"nullable": true
},
"IsMobile": {
"type": "boolean"
}
},
"additionalProperties": false
},
"RMDCApi.Models.Common.SwitchToStoreModel": {
"title": "Common.SwitchToStoreModel",
"required": [
"StoreID"
],
"type": "object",
"properties": {
"StoreID": {
"type": "integer",
"description": "Store identifier that will be used for switching to unit role. Mandatory field.",
"format": "int32"
}
},
"additionalProperties": false
},
"RMDCApi.Models.LogOnModel": {
"title": "LogOnModel",
"required": [
"Password",
"UserName"
],
"type": "object",
"properties": {
"UserName": {
"minLength": 1,
"type": "string",
"readOnly": true
},
"Password": {
"minLength": 1,
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"RMDCApi.v2.Models.Account.Account": {
"type": "object",
"properties": {
"LoginName": {
"type": "string",
"description": "Login Name. Short string that represents user in the application. Will be used for login to the application",
"nullable": true
},
"Company": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Company"
},
"CanSwitchStore": {
"type": "boolean",
"description": "Flag that shows if user can switch between stores"
},
"RegularContext": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.RegularContext"
},
"EmployeeContext": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.EmployeeContext"
},
"StoreContext": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.StoreContext"
},
"TranslationEnabled": {
"type": "boolean",
"description": "Flag that shows if subscription group user belongs to supports language translation"
},
"UseUIEventLogs": {
"type": "boolean",
"description": "Returns True if UI event logs are enabled"
},
"Language": {
"type": "string",
"description": "Default Language",
"nullable": true
}
},
"additionalProperties": false,
"description": "Current session account info"
},
"RMDCApi.v2.Models.Account.AccountPreferences": {
"type": "object",
"properties": {
"Email": {
"type": "string",
"description": "Email address",
"nullable": true
},
"PhoneNumber": {
"type": "string",
"description": "Phone number",
"nullable": true
},
"StoreID": {
"type": "integer",
"description": "Default store in case unit user allowed to switch to another unit",
"format": "int32",
"nullable": true
},
"StoreName": {
"type": "string",
"description": "Default store name",
"nullable": true
},
"ShiftWorksUserID": {
"type": "guid",
"description": "Linked ShiftWorks user",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ShiftWorksUserDescription": {
"type": "string",
"description": "Linked ShiftWorks user description",
"nullable": true
},
"LanguageID": {
"type": "string",
"description": "Default Language code",
"nullable": true
},
"LanguageName": {
"type": "string",
"description": "Default language name",
"nullable": true
}
},
"additionalProperties": false,
"description": "User preferences"
},
"RMDCApi.v2.Models.Account.AccountPreferencesPatch": {
"type": "object",
"properties": {
"Email": {
"type": "string",
"description": "Email address"
},
"PhoneNumber": {
"type": "string",
"description": "Phone number"
},
"StoreID": {
"type": "integer",
"description": "Default store in case user has multi-unit role use feature 'Unit switch only'"
},
"ShiftWorksUserID": {
"type": "guid",
"description": "ShiftWorks user linked to regular user"
},
"LanguageID": {
"type": "string",
"description": "Default language"
},
"IsAnyEmployeeFieldSet": {
"type": "boolean",
"description": "Flag to check if any employee field from combined context changed",
"readOnly": true
}
},
"additionalProperties": false,
"description": "User preferences update model"
},
"RMDCApi.v2.Models.Account.AuthSettings": {
"type": "object",
"properties": {
"UseOAuth": {
"type": "boolean",
"description": "Flag that says if user use OAuth authorization"
},
"OAuthDomain": {
"type": "string",
"description": "OAuth Domain",
"nullable": true
}
},
"additionalProperties": false,
"description": "User authorization settings"
},
"RMDCApi.v2.Models.Account.BillingGroup": {
"type": "object",
"properties": {
"ID": {
"type": "guid",
"description": "Subscription group ID, where the user is assigned to. Not used for 'Unit' role user",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Description": {
"type": "string",
"description": "Subscription group Description, where the user is assigned to. Not used for 'Unit' role user",
"nullable": true
},
"DelagetClientID": {
"type": "string",
"description": "Delaget Client ID",
"nullable": true
}
},
"additionalProperties": false,
"description": "Subscription group"
},
"RMDCApi.v2.Models.Account.ChangePassword": {
"required": [
"NewPassword",
"Password"
],
"type": "object",
"properties": {
"Password": {
"minLength": 1,
"type": "string",
"description": "New password"
},
"NewPassword": {
"minLength": 1,
"type": "string",
"description": "New password"
}
},
"additionalProperties": false,
"description": "Change password model"
},
"RMDCApi.v2.Models.Account.CreateCookieSessionTokenModel": {
"required": [
"AccessToken"
],
"type": "object",
"properties": {
"AccessToken": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RMDCApi.v2.Models.Account.EmployeeContext": {
"type": "object",
"properties": {
"AllowMessenger": {
"type": "boolean",
"description": "Check if user can use Messenger"
},
"Companies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Company"
},
"description": "List of companies user works for.",
"nullable": true
}
},
"additionalProperties": false,
"description": "User's employee context info"
},
"RMDCApi.v2.Models.Account.JwtBearerSwitchStoreModel": {
"type": "object",
"properties": {
"StoreID": {
"type": "integer",
"description": "Store identifier",
"format": "int32"
},
"RefreshToken": {
"type": "string",
"description": "Refresh token",
"nullable": true
}
},
"additionalProperties": false,
"description": "Switch store model"
},
"RMDCApi.v2.Models.Account.LanguageDto": {
"type": "object",
"properties": {
"Code": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RMDCApi.v2.Models.Account.NotificationSettings": {
"type": "object",
"properties": {
"IsMuted": {
"type": "boolean",
"description": "Flag that shows if all notifications muted."
},
"ActivityFeedNotificationSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.ActivityFeedNotificationAlertConfigDto"
},
"description": "Activity feed notification alert options",
"nullable": true
}
},
"additionalProperties": false,
"description": "User notifications settings"
},
"RMDCApi.v2.Models.Account.RegularContext": {
"type": "object",
"properties": {
"UserName": {
"type": "string",
"description": "Full user name",
"nullable": true
},
"Email": {
"type": "string",
"description": "Email",
"nullable": true
},
"RoleID": {
"$ref": "#/components/schemas/OPS.Shared.Models.Enums.UserRoleCharEnum"
},
"BillingGroup": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Account.BillingGroup"
},
"PermissionsGranted": {
"type": "array",
"items": {
"type": "string"
},
"description": "Permissions granted to the user",
"nullable": true
},
"PhoneNumber": {
"type": "string",
"description": "Phone number the system uses to send a notification to the user",
"nullable": true
},
"UseAuth0": {
"type": "boolean",
"description": "Describes if a user uses auth0 to login"
},
"ManagerLogEnabled": {
"type": "boolean",
"description": "Returns True if Manager Log is enabled"
},
"PendoEnabled": {
"type": "boolean",
"description": "Returns True if Pendo is enabled"
},
"UseUserAnalytics": {
"type": "boolean",
"description": "Returns True if Clarity is enabled"
},
"HelpUrl": {
"type": "string",
"description": "Help Link",
"nullable": true
},
"DatableTrainingEnabled": {
"type": "boolean",
"description": "Returns True if Datable Training is enabled"
},
"MoodleHelpUrl": {
"type": "string",
"description": "Moodle Help Link",
"nullable": true
},
"ParentRoleID": {
"$ref": "#/components/schemas/OPS.Shared.Models.Enums.UserRoleCharEnum"
},
"IsBrinkUser": {
"type": "boolean",
"description": "Brink user flag"
},
"MUSharedContextEnabled": {
"type": "boolean",
"description": "Use mu shared context feature in switch to unit"
},
"AutoLaunchReportRecordID": {
"type": "guid",
"description": "Report record that uses for auto launch",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"AutoLaunchReportRefreshIntervalMinutes": {
"type": "integer",
"description": "Refresh interval in minutes for auto launch",
"format": "int32"
},
"AllowUnitAccess": {
"type": "boolean",
"description": "Allow Unit Access"
},
"AIChatbotEnabled": {
"type": "boolean",
"description": "Returns True if AI chatbot is enabled"
},
"AIScheduleChatBotEnabled": {
"type": "boolean",
"description": "Returns True if AI Schedule Chat Bot is enabled"
},
"ApprovalWorkflowEnabled": {
"type": "boolean",
"description": "Returns True if Approval Workflow is enabled"
}
},
"additionalProperties": false,
"description": "User's regular context info"
},
"RMDCApi.v2.Models.Account.StoreContext": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"description": "Store ID, where the user is working at. Mandatory for 'Unit' role user only. Should be omitted for other type of users",
"format": "int32"
},
"Description": {
"type": "string",
"description": "Store Description, where the user is working at. Mandatory for 'Unit' role user only. Should be omitted for other type of users",
"nullable": true
},
"StoreNumber": {
"type": "string",
"description": "Store Number, where the user is working at. Mandatory for 'Unit' role user only. Should be omitted for other type of users",
"nullable": true
},
"FiscalCalendarID": {
"type": "guid",
"description": "Store fiscal calendar id",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PeriodStartDate": {
"type": "date",
"description": "Store edit start date",
"format": "date",
"example": "2019-01-03"
},
"EditStartDate": {
"type": "date",
"description": "Store edit start date",
"format": "date",
"example": "2019-01-03"
},
"EditEndDate": {
"type": "date",
"description": "Store edit end date. Includes addDays",
"format": "date",
"example": "2019-01-03"
},
"ShiftCounts": {
"type": "boolean",
"description": "Identifies if Shift Counts is enabled for this account in portal"
},
"TempScale": {
"type": "string",
"description": "Temperature scale. [F]ahrenheit, [C]elsius"
},
"MaxInventoryAmount": {
"type": "number",
"description": "Maximum inventory amount.",
"format": "double"
},
"NegativeUsage": {
"type": "boolean",
"description": "If negative COGS are validated."
},
"VarianceUsageThreshold": {
"type": "number",
"description": "Percentage threshold to check variance from expected usage.",
"format": "double",
"nullable": true
},
"EnableInventoryEstimating": {
"type": "boolean",
"description": "Enable Inventory Estimating",
"format": "boolean",
"example": false
},
"CountryID": {
"type": "integer",
"description": "Country identifier",
"format": "int32",
"nullable": true
},
"City": {
"type": "string",
"description": "Store city",
"nullable": true
},
"PayrollStateID": {
"type": "guid",
"description": "Store Payroll State ID",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"PayrollStateCode": {
"type": "string",
"description": "Store Payroll State code",
"nullable": true
},
"StateCode": {
"type": "string",
"description": "Store State code",
"nullable": true
},
"Zip": {
"type": "string",
"description": "Store zip code",
"nullable": true
},
"BusinessDate": {
"type": "datetime",
"description": "Store business date",
"format": "datetime",
"example": "2019-01-03T04:39:40"
},
"StartTime": {
"type": "string",
"description": "Store Start Time",
"format": "time"
},
"IsSsnUsed": {
"type": "boolean",
"description": "Indicates whether a Social Security Number (SSN) is used for employees.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Store info user working with"
},
"RMDCApi.v2.Models.Account.StoreLookup": {
"type": "object",
"properties": {
"ID": {
"type": "integer",
"description": "Store identifier",
"format": "int32"
},
"Description": {
"type": "string",
"description": "Store description",
"nullable": true
},
"StoreNumber": {
"type": "string",
"description": "Store number",
"nullable": true
},
"Context": {
"type": "string",
"description": "Available in context: 'R' - Regular, 'E' - Employee, 'B' - Both"
},
"EmployeeMessagingEnabled": {
"type": "boolean",
"description": "Indicates whether employee messaging is enabled for this store."
},
"AllowImagesInMessaging": {
"type": "boolean",
"description": "Indicates whether images are allowed in employee messaging for this store."
}
},
"additionalProperties": false,
"description": "Switch to store model"
},
"RMDCApi.v2.Models.AccountInfoModel": {
"type": "object",
"properties": {
"LoginName": {
"type": "string",
"description": "Login Name. Short string that represents user in the application. Will be used for login to the application",
"nullable": true
},
"UserName": {
"type": "string",
"description": "Full description of a user",
"nullable": true
},
"AllowUnitAccess": {
"type": "boolean",
"description": "Specifies if a user is allowed to re-login under Unit role. Not applicable to 'Unit' role user",
"nullable": true
},
"Email": {
"type": "string",
"description": "E-mail address the system uses to send a notification to the user",
"nullable": true
},
"PhoneNumber": {
"type": "string",
"description": "Phone number the system uses to send a notification to the user",
"nullable": true
},
"UseAuth0": {
"type": "boolean",
"description": "Describes if a user uses auth0 to login",
"nullable": true
},
"ManagerLogEnabled": {
"type": "boolean",
"description": "Returns True if Manager Log is enabled"
},
"PendoAccountID": {
"type": "string",
"description": "PendoAccountID",
"nullable": true
},
"PendoEnabled": {
"type": "boolean",
"description": "Returns True if Pendo is enabled"
},
"HelpUrl": {
"type": "string",
"description": "Help Link",
"nullable": true
},
"DatableTrainingEnabled": {
"type": "boolean",
"description": "Returns True if Datable Training is enabled"
},
"MoodleHelpUrl": {
"type": "string",
"description": "Moodle Help Link",
"nullable": true
},
"RoleID": {
"$ref": "#/components/schemas/OPS.Shared.Models.Enums.UserRoleCharEnum"
},
"StoreID": {
"type": "integer",
"description": "Store ID, where the user is working at. Mandatory for 'Unit' role user only. Should be omitted for other type of users",
"format": "int32",
"nullable": true
},
"StoreDescription": {
"type": "string",
"description": "Store Description, where the user is working at. Mandatory for 'Unit' role user only. Should be omitted for other type of users",
"nullable": true
},
"StoreNumber": {
"type": "string",
"description": "Store Number, where the user is working at. Mandatory for 'Unit' role user only. Should be omitted for other type of users",
"nullable": true
},
"StoreEditStartDate": {
"type": "date",
"description": "Store edit start date",
"format": "date",
"nullable": true,
"example": "2019-01-03"
},
"StoreEditEndDate": {
"type": "date",
"description": "Store edit end date. Includes addDays",
"format": "date",
"nullable": true,
"example": "2019-01-03"
},
"StoreShiftCounts": {
"type": "boolean",
"description": "Identifies if Shift Counts is enabled for this account in portal"
},
"StoreTempScale": {
"type": "string",
"description": "Temperature scale. [F]ahrenheit, [C]elsius",
"nullable": true
},
"BillingGroupID": {
"type": "guid",
"description": "Subscription group ID, where the user is assigned to. Not used for 'Unit' role user",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"BillingGroupDescription": {
"type": "string",
"description": "Subscription group Description, where the user is assigned to. Not used for 'Unit' role user",
"nullable": true
},
"PermissionsGranted": {
"type": "array",
"items": {
"type": "string"
},
"description": "Permissions granted to the user",
"nullable": true
},
"StoreMaxInventoryAmount": {
"type": "number",
"description": "Maximum inventory amount.",
"format": "double",
"nullable": true
},
"StoreNegativeUsage": {
"type": "boolean",
"description": "If negative COGS are validated."
},
"StoreVarianceUsageThreshold": {
"type": "number",
"description": "Percentage threshold to check variance from expected usage.",
"format": "double",
"nullable": true
},
"StoreEnableInventoryEstimating": {
"type": "boolean",
"format": "boolean",
"nullable": true,
"example": false
},
"StoreCity": {
"type": "string",
"nullable": true
},
"StorePayrollStateCode": {
"type": "string",
"nullable": true
},
"StoreStateCode": {
"type": "string",
"nullable": true
},
"StoreZip": {
"type": "string",
"nullable": true
},
"StoreFiscalCalendarID": {
"type": "guid",
"format": "uniqueidentifier",
"nullable": true,
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"ParentRoleID": {
"$ref": "#/components/schemas/OPS.Shared.Models.Enums.UserRoleCharEnum"
},
"EmployeeCompanies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RMDCApi.v2.Models.Company"
},
"description": "List of companies user works for.",
"nullable": true
},
"EmployeeStores": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataCentral.Shared.Api.Models.StoreDto"
},
"description": "List of stores available for employee.",
"nullable": true
},
"IsBrinkUser": {
"type": "boolean",
"description": "Brink user flag"
},
"MUSharedContextEnabled": {
"type": "boolean",
"description": "Use MU shared cointext feature when switch to unit"
}
},
"additionalProperties": false,
"description": "Summary info about logged user"
},
"RMDCApi.v2.Models.ActivityFeedNotificationAlertConfigDto": {
"required": [
"DataSourceID"
],
"type": "object",
"properties": {
"DataSourceID": {
"$ref": "#/components/schemas/DataCentral.Shared.ActivityFeed.ActivityFeedDataSourceType"
},
"SendEmail": {
"type": "boolean",
"description": "Identifier for sending feed notification alert with e-mail",
"nullable": true
},
"SendPush": {
"type": "boolean",
"description": "Identifier for sending feed notification alert with push",
"nullable": true
}
},
"additionalProperties": false,
"description": "Notification alert configuration (PUT method)"
},
"RMDCApi.v2.Models.BrinkLoginModel": {
"required": [
"Environment",
"GroupID",
"Token"
],
"type": "object",
"properties": {
"Token": {
"minLength": 1,
"type": "string",
"description": "Brink Jwt Token"
},
"GroupID": {
"type": "guid",
"description": "Brink Group ID",
"format": "uniqueidentifier",
"example": "C895A81E-0C20-42C0-B2DC-EAF43F9447BD"
},
"Environment": {
"maxLength": 1,
"minLength": 1,
"pattern": "D|Q|S|P",
"type": "string",
"description": "Brink Environment"
}
},
"additionalProperties": false,
"description": "Brink Login Model"
},
"RMDCApi.v2.Models.BrinkSessionInfo": {
"type": "object",
"properties": {
"Token": {
"type": "string",
"description": "Session identifier.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Brink Session info"
},
"RMDCApi.v2.Models.BusinessDateModel": {
"type": "object",
"properties": {
"BusinessDate": {
"type": "datetime",
"format": "datetime",
"example": "2019-01-03T04:39:40"
}
},
"additionalProperties": false
},
"RMDCApi.v2.Models.Company": {
"required": [
"Name"
],
"type": "object",
"properties": {
"Name": {
"minLength": 1,
"type": "string",
"description": "Name of company. Currently it is equal to database name."
}
},
"additionalProperties": false,
"description": "Company model."
},
"System.DayOfWeek": {
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer",
"format": "int32"
}
},
"securitySchemes": {
"Bearer": {
"type": "http",
"description": "Enter JWT Bearer token only",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}