Skip to content

Validation errors

Jefferson Medeiros edited this page Jan 28, 2020 · 5 revisions

Invalid ID

Pattern Error

{
  "code": 400,
  "message": "Parameter {resourcename_id} is not in valid format!",
  "description": "A 24-byte hex ID similar to this: 507f191e810c19729de860ea is expected."
}

The ID parameter patterns currently used are:

  • bodyfat_id
  • child_id
  • environment_id
  • institution_id
  • physicalactivity_id
  • sleep_id
  • weight_id

Invalid JSON format

Pattern error

{
  "code": 400,
  "message": "Unable to process request body.",
  "description": "Please verify that the JSON provided in the request body has a valid format and try again."
}

Missing fields

Pattern error

{
  "code": 400,
  "message": "Required fields were not provided...",
  "description": "{comma separated fields} are required!"
}

Empty string

Pattern error

{
  "code": 400,
  "message": "One or more request fields are invalid...",
  "description": "{field name} must have at least one character!"
}

Invalid string

Pattern error

{
  "code": 400,
  "message": "One or more request fields are invalid...",
  "description": "{field name} must be a string!"
}

Invalid datetime

Pattern error

{
  "code": 400,
  "message": "Datetime: {datetime}, is not in valid ISO 8601 format.",
  "description": "Datetime must be in the format: yyyy-MM-ddTHH:mm:ssZ"
}    

Invalid date

Pattern error

{
  "code": 400,
  "message": "Date: {date}, is not in valid ISO 8601 format.",
  "description": "Date must be in the format: yyyy-MM-dd"
}

Invalid date day

Pattern error

{
  "code": 400,
  "message": "Date: {date}, is not in valid ISO 8601 format."
}            

Invalid date year

Pattern error

{
  "code": 400,
  "message": "Date {date} has year not allowed. The year must be greater than 1678 and less than 2261."
}

Invalid date range

Pattern error (date_end older than date_start)

{
  "code": 400,
  "message": "The interval between dates {date_start} and {date_end} is invalid!",
  "description": "The date_end parameter can not contain an older date than that the date_start parameter!"
}

Pattern error (interval greater than one year)

{
  "code": 400,
  "message": "The interval between dates {date_start} and {date_end} is invalid!",
  "description": "The period between the received dates can not exceed one year!"
}

Invalid number

Pattern error (float)

{
  "code": 400,
  "message": "One or more request fields are invalid...",
  "description": "{field name} must be a number equal to or greater than zero."
}

Pattern error (integer)

{
  "code": 400,
  "message": "One or more request fields are invalid...",
  "description": "{field name} must be an integer equal to or greater than zero."
}

Pattern error (integer greater than zero)

{
  "code": 400,
  "message": "One or more request fields are invalid...",
  "description": "{field name} must be an integer greater than zero."
}
Clone this wiki locally