Saltar al contenido
XOS para desarrolladores

Create a form submission

Módulo Workforce

POST/form-submissionsformSubmissions.create

A submitted form: answers against one template version, score, GPS stamp, signature and approval. Creates a form submission. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad knowledge.sop.acknowledge.
  • Alcances de OAuth: knowledge.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: FormSubmissionCreate

formSubmissions.create: FormSubmissionCreate
CampoTipoObligatorioDescripción
form_template_idstring (uuid)SíIdentifier of the form answered.
project_idstring (uuid) | nullNoIdentifier of the project the submission belongs to.
answersobjectSíAnswers keyed by field key.
latitudenumber | nullNoWGS 84 latitude.Restricciones: range -90 to 90
longitudenumber | nullNoWGS 84 longitude.Restricciones: range -180 to 180
accuracy_mnumber | nullNoGPS accuracy in metres.Restricciones: range 0 to any
signer_namestring | nullNoName of the signer.Restricciones: length 1 to 200
signature_pathstring | nullNoSignature image path in the field-media bucket.Restricciones: length 1 to 500
{
  "form_template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "answers": {
    "hoist_ok": true
  },
  "latitude": 25.7617,
  "longitude": -80.1918,
  "accuracy_m": 8,
  "signer_name": "Frank Adeyemi",
  "signature_path": "org/forms/sig.png"
}

Respuesta 201: FormSubmission

formSubmissions.create: FormSubmission
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the form submission.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíPerson who last updated the row; null for seed, platform or system writes.
form_template_idstring (uuid)SíIdentifier of the form answered.
form_template_version_idstring (uuid)SíIdentifier of the version answered.
project_idstring (uuid) | nullSíIdentifier of the project the submission belongs to.
record_idstring (uuid) | nullSíIdentifier of the record the project submission became.
submitted_by_membership_idstring (uuid)SíIdentifier of the member who submitted.
answersobjectSíAnswers keyed by field key.
scorenumber | nullSíPoints earned.
max_scorenumber | nullSíPoints available on the shown fields.
passedboolean | nullSíWhether the pass score was met.
latitudenumber | nullSíWGS 84 latitude.Restricciones: range -90 to 90
longitudenumber | nullSíWGS 84 longitude.Restricciones: range -180 to 180
accuracy_mnumber | nullNoGPS accuracy in metres.Restricciones: range 0 to any
signer_namestring | nullSíName of the signer.Restricciones: length 1 to 200
signature_pathstring | nullSíSignature image path in the field-media bucket.Restricciones: length 1 to 500
signed_atstring (date-time) | nullSíWhen it was signed.
submission_state"Submitted" | "Approved" | "Rejected" | "Recorded"SíSubmission state.
decided_by_membership_idstring (uuid) | nullSíIdentifier of the approver who decided.
decision_notestring | nullSíApprover's note.Restricciones: length 1 to 1000
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "form_template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "form_template_version_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "submitted_by_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "answers": {
    "hoist_ok": true
  },
  "score": 3,
  "max_score": 3,
  "passed": true,
  "latitude": 25.7617,
  "longitude": -80.1918,
  "accuracy_m": 8,
  "signer_name": "Frank Adeyemi",
  "signature_path": "org/forms/sig.png",
  "signed_at": "2026-10-08T14:30:00Z",
  "submission_state": "Submitted",
  "decided_by_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "decision_note": "Good to lift."
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/form-submissions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"form_template_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","answers":{"hoist_ok":true},"latitude":25.7617,"longitude":-80.1918,"accuracy_m":8,"signer_name":"Frank Adeyemi","signature_path":"org/forms/sig.png"}'
const { data } = await xos.formSubmissions.create({
    "form_template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "answers": {
      "hoist_ok": true
    },
    "latitude": 25.7617,
    "longitude": -80.1918,
    "accuracy_m": 8,
    "signer_name": "Frank Adeyemi",
    "signature_path": "org/forms/sig.png"
  });
response = xos.form_submissions.create({"form_template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "answers": {"hoist_ok": True}, "latitude": 25.7617, "longitude": -80.1918, "accuracy_m": 8, "signer_name": "Frank Adeyemi", "signature_path": "org/forms/sig.png"})
xos form-submissions create --data '{"form_template_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","answers":{"hoist_ok":true},"latitude":25.7617,"longitude":-80.1918,"accuracy_m":8,"signer_name":"Frank Adeyemi","signature_path":"org/forms/sig.png"}'