Validate template field assignments - SpitShake

POST

/

api

/

templates

/

{id}

/

validate_assignments

Error

A valid request URL is required to generate request examples

{
  "valid": true,
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "field_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_name": "<string>"
    }
  ],
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "field_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_name": "<string>"
    }
  ],
  "summary": {
    "total_fields": 123,
    "total_submitters": 123,
    "assignment_count": 123,
    "submitters": [
      {
        "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "submitter_name": "<string>",
        "field_count": 123,
        "signature_field_count": 123
      }
    ]
  }
}

{
  "valid": true,
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "field_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_name": "<string>"
    }
  ],
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "field_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_name": "<string>"
    }
  ],
  "summary": {
    "total_fields": 123,
    "total_submitters": 123,
    "assignment_count": 123,
    "submitters": [
      {
        "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "submitter_name": "<string>",
        "field_count": 123,
        "signature_field_count": 123
      }
    ]
  }
}

Authorizations

X-Auth-Token

string

header

required

API token generated at Settings > API

Path Parameters

id

integer

required

Body

application/json

field_assignments

object[]

Optional proposed assignment overrides for validation

Show child attributes

required_signature_submitter_uuids

string<uuid>[]

Optional submitter UUIDs that must have at least one signature or initials field

Response

Assignment validation passed

valid

boolean

errors

object[]

Show child attributes

warnings

object[]

Show child attributes

summary

object

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "valid": true,
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "field_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_name": "<string>"
    }
  ],
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "field_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_name": "<string>"
    }
  ],
  "summary": {
    "total_fields": 123,
    "total_submitters": 123,
    "assignment_count": 123,
    "submitters": [
      {
        "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "submitter_name": "<string>",
        "field_count": 123,
        "signature_field_count": 123
      }
    ]
  }
}

{
  "valid": true,
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "field_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_name": "<string>"
    }
  ],
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "field_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_name": "<string>"
    }
  ],
  "summary": {
    "total_fields": 123,
    "total_submitters": 123,
    "assignment_count": 123,
    "submitters": [
      {
        "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "submitter_name": "<string>",
        "field_count": 123,
        "signature_field_count": 123
      }
    ]
  }
}