Defaults

Used to get the default values of a form data model.

URL : /api/v1/form/defaults/

URL Parameters :

name=[string] : a valid form data model name

Method : POST

Auth required : YES

Permissions required

Roles: _administrator_, developer, operator
Permissions: form-<data model name>:edit

Data example

{
    "hole_id": 205
}

Success Response

Code : 200 OK

{
  "rqd_abundance": 0,
  "rqd_intensity": 0,
  "hole_id": 205,
  "core": 278,
  "site_id": 41,
  "expedition_id": 1,
  "program_id": 1,
  "archive_files": {
    "filter": {
      "expedition": 1,
      "site": 41,
      "hole": 205,
      "core": null
    },
    "files": []
  }
}

Error Response

Condition : If a required parent ID was not set

Code : 400 Bad Request

Content :

{
    "name": "Bad Request",
    "message": "Required parameter hole_id is not sent.",
    "code": 0,
    "status": 400,
    "type": "yii\\web\\BadRequestHttpException"
}