Form patterns lookups

PolicyCenter automatically generates the list of forms for a policy by using forms inference logic and configuration settings. For example, if a user submits a new auto policy, the forms to print when issuing the policy can be inferred by the coverages, vehicles, and other fields. Included in this logic is a lookup of the jurisdiction and availability.

Forms can be designated as being explicitly available or unavailable in certain jurisdictions. With Cloud API, you can retrieve, add, and update jurisdiction availability information through the form patterns lookups endpoints.

Note: The information accessed by these endpoints corresponds to the information in the Availability table under the Jurisdictions tab in the user interface.

Retrieving jurisdiction availability

The list of jurisdiction availability for each form pattern is accessed through the form pattern lookups endpoints:

  • GET /admin/v1/form-patterns/{policyFormPatternId}/lookups
  • GET /admin/v1/form-patterns/{policyFormPatternId}/lookups/{lookupId}

Here is an example of retrieving the jurisdiction availability for form pattern pc:102:

Command

GET /admin/v1/form-patterns/pc:102/lookups

Response

{
    "data": [
        {
            "attributes": {
                "availability": {
                    "code": "Unavailable",
                    "name": "Unavailable"
                },
                "id": "pc:909",
                "jurisdiction": {
                    "code": "OK",
                    "name": "Oklahoma"
                },
                "startEffectiveDate": "1989-12-01T08:00:00.000Z"
            },
        …
        },
        {
            "attributes": {
                "availability": {
                    "code": "Available",
                    "name": "Available"
                },
                "id": "pc:910",
                "jurisdiction": {
                    "code": "MT",
                    "name": "Montana"
                },
                "startEffectiveDate": "1989-12-01T08:00:00.000Z"
            },
            …
        }

Adding jurisdiction availability

You can add jurisdiction availability information to a form pattern with the following endpoint:

  • POST /admin/v1/policy-form-patterns/{policyFormPatternId}/lookups

The following example makes form pc:910 unavailable in the Florida jurisdiction as of July 26, 2024:

Command

POST /admin/v1/form-patterns/pc:910/lookups

Request

{
    "data": {
        "attributes": {
            "availability": {
                "code": "Unavailable"
            },
            "startEffectiveDate": "20240726",
            "jurisdiction": {
                "code": "FL"
            }
        }
    }
}

Updating jurisdiction availability

You can update and delete a form pattern jurisdiction availability with the following endpoints:

  • PATCH /admin/v1/form-patterns/{policyFormPatternId}/lookups/{lookupId}
  • DELETE /admin/v1/form-patterns/{policyFormPatternId}/lookups/{lookupId}

The following example changes the availability of the jurisdiction with ID pc:90001 on form pattern pc:910 to Available:

Command

PATCH /admin/v1/form-patterns/pc:910/lookups/pc:90001

Request

{
    "data": {
        "attributes": {
            "availability": {
                "code": "Available"
            }
        }
    }
}

The following command deletes jurisdiction availability pc:90001 from form pattern pc:910:

DELETE /admin/v1/form-patterns/pc:910/lookups/pc:90001