ACacculynx
jobs

Get Job Insurance

Changed on

This endpoint returns the job's insurance information.

get/jobs/{jobId}/insurance

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/jobs/{jobId}/insurance
  • Auth
    HTTP bearer

Path parameters

jobIdstring uuid required

The job's unique identifier

Response

OK

customInsuranceCompanyNamestring

A job can have an Insurance Company that is not from the list managed in Account Settings. In this case, insuranceCompany will be null.

damagelocationstring

Where the damage is located.

dateOfLossstring

The date the damage occurred in UTC.

claimFiledboolean

Has the claim been filed? Must be true if claimFiledDate is populated.

claimFiledDatestring

The date the claim was filed in UTC.

claimNumberstring

The identifier of the insurance claim given by the insurance company.

hasPaperworkboolean

Is the paperwork for this job collected?

Example response

{
  "insuranceCompany": {
    "id": "89082e73-39fa-4082-b097-9cb1351da726",
    "name": "Jim's Insurance",
    "isActive": true
  },
  "customInsuranceCompanyName": "An Insurance Company that is not managed in Account Settings.",
  "damagelocation": "Near the chimney.",
  "dateOfLoss": "2020-07-23T16:56:27Z",
  "claimFiledDate": "2020-07-23T16:56:27Z",
  "claimNumber": "123abc",
  "hasPaperwork": true
}

Changes

  • 443924b00f43Revision changes
    • breaking

      the /// response's property type changed from no type to object for status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      removed subschema #2 from the /// response property allOf list for the response status