v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

generalSettings

find one generalSetting

Find one generalSetting by its unique identifier.

get/api/serviceattendance/generalSettings/{identifier}

Path parameters

identifierstring uuid required

generalSetting unique identifier

Response

One generalSetting document found. Wrapped in a JsonAPI root response with document as data.

Example response

{
  "data": {
    "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
    "createdAt": "2021-05-05T01:02:03.924Z",
    "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
    "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
    "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
    "lastUpdatedByAudience": "employer",
    "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
    "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
    "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
    "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
    "companyUuid": "cf8fc0c8-b8e7-4337-992e-8f71d67bdf5b",
    "payrollIntegration": {
      "fileFormat": "xlsx",
      "templateFile": {
        "redirectUrl": "https://example.com/timesheets.xlsx",
        "uuid": "cf8fc0c8-b8e7-4337-992e-8f71d67bdf5b",
        "type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
        "key": "public/companies/cf8fc0c8-b8e7-4337-992e-8f71d67bdf5b/timesheets/timesheets.xlsx",
        "name": "timesheets.xlsx",
        "size": 123456,
        "lastModified": 1679033600
      },
      "webhook": {
        "callbackUrl": "https://example.com/callback",
        "apiKey": "1234567890",
        "method": "POST"
      }
    },
    "payPeriod": {
      "startDayOfWeek": 6
    },
    "kiosk": {
      "workerLoginMethods": [
        "mobilePhone.number"
      ]
    }
  },
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}