Blankets on jobs

Retrieve blanket candidates

You can retrieve the coverables and clauses that can be associated with a blanket by calling the candidate-blanket-associations endpoint. The response from this endpoint provides the list of coverables that can be specified when you create a blanket association. (See Add an association to a blanket below.)

After a coverable or clause has been associated with a blanket, it will no longer be a candidate and will therefore not be returned in the response.

Command

GET /job/v1/jobs/pc:200/lines/TSTLine/high-risk-blankets/4/candidate-blanket-associations

Response

{
  "data": [
    {
      "attributes": {
        "coverable": [
          {
            "displayName": "1: Kerosene Can: Leaky Gasoline Truck field",
            "id": "1",
            "type": "TSTKeroseneCan",
            …
          },
          "id": "TSTKeroseneCan:1"
        },
        …
    },
    {
      "attributes": {
        "coverable": [
          {
            "displayName": "2: Kerosene Can: Leaky Gasoline Truck field",
            "id": "2",
            "type": "TSTKeroseneCan",
            …
          },
          "id": "TSTKeroseneCan:2"
        },
        …
    },
    {
      "attributes": {
        "clause": {
          "displayName": "Kerosene Liquid leak",
          "id": "TSTKeroseneLiquidLeak",
          "type": "TSTKeroseneCanCoverage",
          …
        },
        "coverable": {
          "displayName": 2: Kerosene Can: Leaky Gasoline Truck field",
          "id": "2",
          "type": "TSTKeroseneCan",
          …
        },
        …

This partial response shows two coverables available for association, and one clause on one of those coverables.

Add an association to a blanket

You can add coverable and clause associations to a blanket. However, for a specific blanket you can add only those coverables and clauses that are returned from the candidate-blanket-associations endpoint. You cannot add a single coverable or clause twice to the same blanket.

This example associates a coverable with the blanket.

Command

POST /job/v1/jobs/pc:200/lines/TSTLine/high-risk-blankets/4/blanket-associations

Request

{
  "data": {
    "attributes": {
      "coverable": {
        "id": "2",
        "type": "TSTKeroseneCan"
      }
    }
  }
}

Associating a clause is similar. Instead of adding only the coverable, you add the clause and the corresponding coverable.

Request

{
  "data": {
    "attributes": {
      "clause": {
        "id": "TSTKeroseneLiquidLeak"
      },
     "coverable": {
        "id": "2",
        "type": "TSTKeroseneCan"
      }
    }
  }
}

Retrieve associated blankets

The coverables and clauses returned in the preceding example are available to be associated with the blanket, but have not been associated yet. To retrieve the coverables and clauses that have been associated with the blanket, use the blanket-associations endpoint.

Command

GET /job/v1/jobs/pc:200/lines/TSTLine/high-risk-blankets/4/blanket-associations

Response

{
  "data": [
    {
      "attributes": {
        "coverable": [
          {
            "displayName": "1: Kerosene Can: Leaky Gasoline Truck field",
            "id": "2",
            "type": "TSTKeroseneCan",
            …
          },
          "id": "TSTKeroseneCan:1"
        },
    },

The response shows that the high-risk-blankets blanket with ID 4 has one coverable associated with it.

Delete an association

Deleting an association removes the coverable or clause from the blanket, and returns it to the list of configured blanket associations.

Command

DELETE /job/v1/jobs/pc:200/lines/TSTLine/high-risk-blankets/4/blanket-associations/TSTKeroseneCan:2

No request body is required

Blankets associations in graph submissions

You can include blanket associations in submissions created through the graph API. Here's an example showing the segment of the request with the blanket associations:

…
"lines": {
 "TSTLine": {
   "condos": [
     {
       "condoDecField": "9999.99",
       "occupancies": [
         {
           "coverages": {
             "TSTOccCondHQBlanket": {
               "pattern": {
                 "id": "TSTOccCondHQBlanket"
               }
             }
           },
           "integerField": 1,
           "personalProperties": [
             {
               "booleanField": true,
               "keroseneCans": [
                 {
                   "refid": "testKeroseneCan",
                   "stringField": "Leaky Gasoline Truck field"
                 }
               ],
               "stringField": "Personal property"
             }
           ],
           "refid": "testOccupancyOccCondHQBlanket",
           "stringField": "occupancy1"
         }
       ],
       "pin": "PIN_9999"
     }
   ],
   "highRiskBlankets": [
     {
       "blanketAssociations": [
         {
           "clause": {
             "id": "TSTOccCondHQBlanket"
           },
           "coverable": {
             "refid": "testOccupancyOccCondHQBlanket",
             "type": "TSTOccupancy"
           }
         },
         {
           "coverable": {
             "refid": "testKeroseneCan",
             "type": "TSTKeroseneCan"
           }
         }
       ]
     }
   ]
 }
}
…

Notice the use of refids to associate coverables with the blanket.

For more information on graph submissions, see Streamlined account and submission creation.