5.3 Awards

  • Last updated on September 22, 2020 at 12:50 PM

Any time an award is created edited or deleted in the management section the data will conform to the below template.

Award Template

{

    "id": <int>,

    "name": <string>,

    "description": <string>,

    "awardTypeId": <int – Id of the award type for the company>,

    "pictureURL": <string – url of thumbnail image for award>,

    "tag": <string>,

    "points": <int>,

       "createdByPersonId": <int>,

    "createdAt": "<string ISO 8601 Date>,",

       "notificationSettings": <notificationSettings see 8.0>

    "awardableByAll": <bool – true if any employee can give this award>,

    "isDeleted": <bool>

}

 

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"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "awardTypeId": {
          "type": "integer"
        },
        "pictureURL": {
          "type": "string"
        },
        "tag": {
          "type": "string"
        },
        "points": {
          "type": "integer"
        },
        "createdByPerson": {
          "type": "object",
          "properties": {
            "PersonId": {
              "type": "integer"
            },
            "FirstName": {
              "type": "string"
            },
            "FamilyName": {
              "type": "string"
            },
            "Email": {
              "type": "string"
            }
          }
        },
        "createdAt": {
          "type": "string"
        },
        "modifiedByPerson": {
          "type": "object",
          "properties": {
            "PersonId": {
              "type": "integer"
            },
            "FirstName": {
              "type": "string"
            },
            "FamilyName": {
              "type": "string"
            },
            "Email": {
              "type": "string"
            }
          }
        },
        "modifiedAt": {
          "type": "string"
        },
        "notificationSettings": {
          "type": "object",
          "properties": {
            "push": {
              "type": "boolean"
            },
            "sms": {
              "type": "boolean"
            },
            "email": {
              "type": "boolean"
            },
            "microsoftTeams": {
              "type": "boolean"
            },
            "inApp": {
              "type": "boolean"
            }
          }
        },
        "awardableByAll": {
          "type": "boolean"
        },
        "isDeleted": {
          "type": "boolean"
        }
      }
    },
    "differences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string"
          },
          "oldValue": {
            "type": "string"
          },
          "newValue": {
            "type": "string"
          }
        },
        "required": [
          "path",
          "oldValue",
          "newValue"
        ]
      }
    }
  }
}

Was this article helpful?