answers

Create or update a response (single answer bundle) to a workflow

post/v2/answers

Request

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

Request body

workflow-idstring uuid required
source-identifierstring

The source-identifier of the answer-bundle

model-idstring uuid required
external-identifierstring required

The external identifier of the answer-bundle

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)

inputsobject
input-mapstring required

string that is not empty or whitespace only

Example request

{
  "source-identifier": "SOURCE_IDENTIFIER",
  "external-identifier": "ANSWER_BUNDLE_ID",
  "files": [
    {
      "external-identifier": "FILE_ID"
    }
  ],
  "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-identifier": "EVENT_ID"
    }
  ],
  "company-ident": "COMPANY_IDENT",
  "state": "submitted",
  "messages": [
    {
      "external-identifier": "MESSAGE_ID"
    }
  ],
  "claims": [
    {
      "claim-reports": [
        {
          "reported-date": "2011-03-24",
          "entries": [
            {
              "payments": 123.42,
              "oslr": 123.42,
              "reserves": 123.42,
              "recovery": 123.42
            }
          ],
          "external-identifier": "CLAIM_REPORT_ID",
          "target-close-date": "2011-03-24"
        }
      ],
      "status-date": "2011-03-24",
      "external-identifier": "CLAIM_ID",
      "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",
      "transactions": [
        {
          "tax-id": "tax identifier",
          "indicator-4850": "false",
          "invoice-amount": 123.42,
          "payee": "payee name",
          "exempt-1099": "true",
          "external-identifier": "TRANSACTION_ID",
          "sub-category": "sub-category",
          "payer": "payer name",
          "note": "a note",
          "check-identifier": "check identifier",
          "invoice-date": "2011-03-24",
          "self-pay?": "false",
          "service-end": "2011-03-24",
          "recovery": 123.42,
          "service-begin": "2011-03-24",
          "adjuster-name": "adjuster name",
          "payments": 123.42,
          "check-issue-date": "2011-03-24",
          "reserves": 123.42,
          "check-void-date": "2011-03-24",
          "documents": [
            {
              "external-identifier": "TRANSACTION_DOCUMENT_ID"
            }
          ],
          "date": "2011-03-24",
          "invoice-identifier": "invoice identifier",
          "category": "general",
          "check-clear-date": "2011-03-24"
        }
      ],
      "policy-external-ident": "POLICY_ID"
    }
  ]
}

Response

Default response

Changes

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