Skip to main content

Review miscellaneous validation rules for feature compatibility and configuration requirements

Date Added​

DateAddedMustBePresent​

DefinitionSeverityAPISampleMode
Validate that dateAdded is present
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__DateAddedMustBePresent",
"severity": "VIOLATION",
"message": "Field '{{field}}' must be present",
"context": {
"field": "dateAdded"
},
"details": {
"createdDate": "2026-02-10T11:36:02.00Z",
"submitted": [],
"compared": [],
"expected": []
}
}

DateAddedMustNotBeEmpty​

DefinitionSeverityAPISampleMode
Validate that dateAdded is not an empty string
VIOLATION
POST_AND_PUT
S

DateAddedMustHaveValidFormat​

DefinitionSeverityAPISampleMode
Validate that dateAdded formatting is valid
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__DateAddedMustHaveValidFormat",
"severity": "VIOLATION",
"message": "'{{dateAdded}}' must have valid format",
"context": {
"dateAdded": "31-08-2022"
},
"details": {
"createdDate": "2026-08-31T22:02:36.010Z",
"submitted": [
{
"field": "$.reviewDetails.dateAdded",
"value": "31-08-2022"
}
],
"compared": [],
"expected": []
}
}

MustNotBeFutureDate​

DefinitionSeverityAPISampleMode
Validate that dateAdded is not a future date
VIOLATION
POST_AND_PUT
S

Partners Review ID​

PartnersReviewIdMustBePresent​

DefinitionSeverityAPISampleMode
Validate that partnersReviewId is present
VIOLATION
POST_AND_PUT
S

PartnersReviewIdMustNotBeEmpty​

DefinitionSeverityAPISampleMode
Validate that partnersReviewId is not an empty string
VIOLATION
POST_AND_PUT
S

Review​

UndeleteTimePeriodHasElapsed​

DefinitionSeverityAPISampleMode
Validate that the quantity of days that a resource's state was DELETED is ninety (90) days or less
VIOLATION
UNDELETE
S
Example Validation Report
{
"code": "VALIDATION__UndeleteTimePeriodHasElapsed",
"message": "Undelete operation no longer available after 90 days",
"severity": "VIOLATION",
"details": {
"createdDate": "2026-02-10T11:36:02.00Z",
"submitted": [],
"compared": [],
"expected": []
}
}

Review Details​

UpdatedReviewShouldNotMatchExistingReview​

DefinitionSeverityAPISampleMode
Validate that the review does not exactly match the previous existing record
VIOLATION
PUT
A

Configuration

Match Constraints
Exclude internal fields
Exclude reviewDetails/partnerReviewId
Limit matching to all other properties of reviewDetails

Review Body​

ReviewBodyMustBeSuitableForAboutSection​

Preconditions
Submitting org is allow-listed to have reviews used in the About section
DefinitionSeverityAPISampleMode
Validate that reviewBody is suitable for display in the place card's About section
VIOLATION
POST_AND_PUT
A
Example Validation Report
{
"code": "VALIDATION__ReviewBodyMustBeSuitableForAboutSection",
"severity": "VIOLATION",
"message": "'reviewBody' must be suitable for display in the place card's About section (sentiment: '{{sentimentCategory}}')",
"context": {
"sentimentCategory": "Negative"
},
"details": {
"createdDate": "2026-09-03T13:00:00.00Z",
"submitted": [
{
"field": "$.reviewDetails.review.reviewBody",
"value": "The service was slow and the food was bland — we won't be returning."
}
],
"compared": [],
"expected": []
}
}

Sentiment Category Values​

Value
Abusive/Unsafe
Highly Negative
Negative
Neutral/Mixed
Positive
Highly Positive