Updates permissions for the business document with the specified ID.

Request

PUT http://keypay.yourpayroll.local/api/v2/business/{businessId}/document/{id}

Path parameters

Parameter name Value Description Additional
id int32 Required
businessId string Required

Request body

The request body takes a complete UpdateDocumentPermissionsModel resource, containing the following writable properties:

{
    "employeeGroups": [
        "int32"
    ],
    "id": "int32",
    "locations": [
        "int32"
    ],
    "requiresEmployeeAcknowledgement": "boolean",
    "sendInitialNotificationOn": "date-time",
    "sendNotificationImmediately": "boolean",
    "sendNotificationToEmployee": "boolean",
    "sendReminderEveryXDays": "int32",
    "visibleToAll": "boolean"
}

Properties

Name Type Description
employeeGroups[] array of int32
id int32 Int32
locations[] array of int32
requiresEmployeeAcknowledgement boolean Boolean
sendInitialNotificationOn date-time Nullable
sendNotificationImmediately boolean Boolean
sendNotificationToEmployee boolean Boolean
sendReminderEveryXDays int32 Nullable
visibleToAll boolean Boolean

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

DocumentModel