answers

Create a response (answer bundle) to a workflow

post/v1/answers

Request

  • Base URL: https://api.aclaimant.com/api
  • URL: https://api.aclaimant.com/api/v1/answers
  • Auth: API key in header x-aclaimant-api-key

Request body

workflow-idstring uuid required
allow-dangerous-operations?boolean

When true, bypasses the safety guards that reject requests which would delete a majority of an answer-bundle's existing answers, or save mostly malformed (wrong type/shape) answer values. Use with caution.

input-map-idstring uuid required
workflowstring required

string that is not empty or whitespace only

answersobject
search-resultsobject

search result ident to look up values by

pipeline-run-identifierstring
company-identstring required
statestring

one of the valid states for an answer bundle (e.g. "draft", "submitted", etc)

external-identstring required

The external-ident of the answer bundle

input-mapstring required

string that is not empty or whitespace only

Example request

{
  "search-results": {
    "search-name": "ident-of-a-search-result"
  },
  "events": [
    {
      "date": "2011-03-24",
      "type": "Return to Work",
      "category": "category name",
      "subject": [
        "Title",
        "subtitle"
      ],
      "location": "location of event",
      "sub-category": "subcategory name",
      "external-ident": "EVENT_IDENT"
    }
  ],
  "company-ident": "COMPANY_IDENT",
  "state": "submitted",
  "external-ident": "YOUR_IDENT",
  "claims": [
    {
      "status-date": "2011-03-24",
      "policy-period-effective-date": "2011-03-24",
      "status": "open",
      "subject": [
        "Title",
        "subtitle"
      ],
      "claim-number": "CLAIM_NUMBER",
      "submitted-date": "2011-03-24",
      "coverage-type": "workers-comp",
      "policy-external-ident": "POLICY_ID"
    }
  ]
}

Response

Default response

Changes

No recorded changes to this operation across all 1 revision of this API.