StaffCircle API
  1. Help Center
  2. StaffCircle API

5.14 Benefits

Json Schema (for use with MS Power Automate)

 

{
  "type": "object",
  "properties": {
    "subjectType": {
      "type": "string"
    },
    "changeType": {
      "type": "string"
    },
    "subjectFrontEndUrl": {
      "type": "string"
    },
    "timeStamp": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "person": {
          "type": "object",
          "properties": {
            "PersonId": {
              "type": "integer"
            },
            "FirstName": {
              "type": "string"
            },
            "FamilyName": {
              "type": "string"
            },
            "Email": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "benefitTypeId": {
          "type": "integer"
        },
        "pictureURL": {
          "type": "string"
        },
        "tag": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "modifiedAt": {
          "type": "string"
        },
        "createdByPersonId": {
          "type": "integer"
        },
        "modifiedByPersonId": {
          "type": "integer"
        },
        "startDate": {
          "type": "string"
        },
        "expiryDate": {
          "type": "string"
        },
        "sensitive": {
          "type": "boolean"
        }
      }
    },
    "differences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string"
          },
          "oldValue": {
            "type": "string"
          },
          "newValue": {
            "type": "string"
          }
        },
        "required": [
          "path",
          "oldValue",
          "newValue"
        ]
      }
    }
  }
}