Scheduled item endpoints

Cloud API generates separate endpoints for each type of scheduled item. Typically, each of these endpoints is the child of a /coverages endpoint. The endpoint paths for scheduled items have paths similar to the following patterns:

  • Collection endpoints: .../<coverables>/{<coverable>Id}/coverages/{coverageId}/scheduled-items

  • Element endpoints: .../<coverables>/{<coverable>Id}/coverages/{coverageId}/scheduled-items/{scheduledItemId}

For example, suppose you have a homeowners product with dwelling coverables that can have coverages attached to them. Some coverages can have scheduled items. The LOB endpoints for this product would include the following:

  • GET /jobs/{jobId}/lines/HOPLine/coverage-parts/{coveragePartId}/dwellings/{dwellingId}/coverages/{coverageId}/scheduled-items

  • POST /jobs/{jobId}/lines/HOPLine/coverage-parts/{coveragePartId}/dwellings/{dwellingId}/coverages/{coverageId}/scheduled-items

  • GET /jobs/{jobId}/lines/HOPLine/coverage-parts/{coveragePartId}/dwellings/{dwellingId}/coverages/{coverageId}/scheduled-items/{scheduledItemId}

  • PATCH /jobs/{jobId}/lines/HOPLine/coverage-parts/{coveragePartId}/dwellings/{dwellingId}/coverages/{coverageId}/scheduled-items/{scheduledItemId}

  • DELETE /jobs/{jobId}/lines/HOPLine/coverage-parts/{coveragePartId}/dwellings/{dwellingId}/coverages/{coverageId}/scheduled-items/{scheduledItemId}