StaffCircle API
  1. Help Center
  2. StaffCircle API

5.8 Reviews

Review Template

{

    "id": <int>,

    "managerPersonId": <int>,

       "internalReviewerPersonIds": [<int>],

    "personId": <int>,

    "title": "<string>",

    "description": <string>

    "reviewType":<string>,

    "dueOn": <string ISO 8601 Date>,

    "completedAt": <string ISO 8601 Date>,

    "attachedDocumentIds": [<int>],

    "comments": [<comment>],

    "linkedObjectives": [

      {

        "id": <int>,

        "title :<string>,

        "category": <string>

      },

    ],

    "appraisalSummary": { <id’s of appraisal question templates>

      "personAppraisalTemplateId": <int>

         "managerAppraisalTemplateId": <int>

         "internalAppraisalTemplateId": <int>

         "externalAppraisalTemplateId": <int>

    },

    "scores": {

      "score": <int>,

         "overriddenScore": <int>,

      "currentScore": <int>,

         "calculatedScore": <int>,

    },

    "createdAt": <string ISO 8601 Date>,

       "createdByPersonId": <int>,

    "modifiedAt": <string ISO 8601 Date>,

       "modifiedByPersonId": <int>,

    "contentSettings": <contentSettings>

       "notificationSettings": <notificationSettings>

  }

}

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"
        },
        "previousReviewId": {
          "type": "integer"
        },
        "manager": {
          "type": "object",
          "properties": {
            "PersonId": {
              "type": "integer"
            },
            "FirstName": {
              "type": "string"
            },
            "FamilyName": {
              "type": "string"
            },
            "Email": {
              "type": "string"
            }
          }
        },
        "internalReviewerPersonIds": {
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "person": {
          "type": "object",
          "properties": {
            "PersonId": {
              "type": "integer"
            },
            "FirstName": {
              "type": "string"
            },
            "FamilyName": {
              "type": "string"
            },
            "Email": {
              "type": "string"
            }
          }
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "reviewType": {
          "type": "string"
        },
        "personNotes": {
          "type": "string"
        },
        "managerNotes": {
          "type": "string"
        },
        "dueOn": {
          "type": "string"
        },
        "completedAt": {
          "type": "string"
        },
        "personConfirmedCompletionAt": {
          "type": "string"
        },
        "interval": {
          "type": "string"
        },
        "attachedDocumentIds": {
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "relatedItemId": {
                "type": "integer"
              },
              "itemType": {
                "type": "string"
              },
              "comment": {
                "type": "string"
              },
              "parentCommentId": {
                "type": "integer"
              },
              "attachedDocumentIds": {
                "type": "array",
                "items": {
                  "type": "integer"
                }
              },
              "likesPersonIds": {
                "type": "array",
                "items": {
                  "type": "integer"
                }
              },
              "createdAt": {
                "type": "string"
              },
              "createdByPerson": {
                "type": "object",
                "properties": {
                  "PersonId": {
                    "type": "integer"
                  },
                  "FirstName": {
                    "type": "string"
                  },
                  "FamilyName": {
                    "type": "string"
                  },
                  "Email": {
                    "type": "string"
                  }
                }
              },
              "modifiedAt": {
                "type": "string"
              },
              "modifiedByPerson": {
                "type": "object",
                "properties": {
                  "PersonId": {
                    "type": "integer"
                  },
                  "FirstName": {
                    "type": "string"
                  },
                  "FamilyName": {
                    "type": "string"
                  },
                  "Email": {
                    "type": "string"
                  }
                }
              }
            },
            "required": [
              "id",
              "relatedItemId",
              "itemType",
              "comment",
              "parentCommentId",
              "attachedDocumentIds",
              "likesPersonIds",
              "createdAt",
              "createdByPerson",
              "modifiedAt",
              "modifiedByPerson"
            ]
          }
        },
        "linkedObjectives": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "title": {
                "type": "string"
              },
              "summary": {
                "type": "string"
              },
              "category": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "title",
              "summary",
              "category"
            ]
          }
        },
        "appraisalSummary": {
          "type": "object",
          "properties": {
            "managerAppraisalTemplateId": {
              "type": "integer"
            },
            "personAppraisalTemplateId": {
              "type": "integer"
            },
            "internalAppraisalTemplateId": {
              "type": "integer"
            },
            "externalAppraisalTemplateId": {
              "type": "integer"
            }
          }
        },
        "scores": {
          "type": "object",
          "properties": {
            "score": {
              "type": "integer"
            },
            "overriddenScore": {
              "type": "integer"
            },
            "currentScore": {
              "type": "integer"
            }
          }
        },
        "createdAt": {
          "type": "string"
        },
        "createdByPerson": {
          "type": "object",
          "properties": {
            "PersonId": {
              "type": "integer"
            },
            "FirstName": {
              "type": "string"
            },
            "FamilyName": {
              "type": "string"
            },
            "Email": {
              "type": "string"
            }
          }
        },
        "modifiedAt": {
          "type": "string"
        },
        "modifiedByPerson": {
          "type": "object",
          "properties": {
            "PersonId": {
              "type": "integer"
            },
            "FirstName": {
              "type": "string"
            },
            "FamilyName": {
              "type": "string"
            },
            "Email": {
              "type": "string"
            }
          }
        },
        "contentSettings": {
          "type": "object",
          "properties": {
            "allowLikes": {
              "type": "boolean"
            },
            "allowComments": {
              "type": "boolean"
            },
            "allowImagesInComments": {
              "type": "boolean"
            },
            "allowDocuments": {
              "type": "boolean"
            }
          }
        },
        "notificationSettings": {
          "type": "object",
          "properties": {
            "push": {
              "type": "boolean"
            },
            "sms": {
              "type": "boolean"
            },
            "email": {
              "type": "boolean"
            },
            "microsoftTeams": {
              "type": "boolean"
            },
            "inApp": {
              "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"
        ]
      }
    }
  }
}