Share via

VerifyStringResult (JSON)

  • Article

Result codes corresponding to each string submitted to /system/strings/validate.

VerifyStringResult

The VerifyStringResult object has the following specification.

Member Type Description
resultCode 32-bit unsigned integer Required. HResult code corresponding to submitted string.
offendingString string Required. String value that caused a string to be rejected.

Sample JSON syntax

{
    "verifyStringResult":
    [
        {"resultCode": "1", "offendingString": "badword"},
        {"resultCode": "0", "offendingString": ""},
        {"resultCode": "0", "offendingString": ""},
        {"resultCode": "0", "offendingString": ""},
    ]
}

Common HResult Values

Value Error Name
0 Success
1 Offensive string
2 String too long
3 Unknown error

See also

Parent

JavaScript Object Notation (JSON) Object Reference

Reference

POST (/system/strings/validate)