Default value creation
In some cases when you create certain resources, children of those resources are also created by default. This isn’t always a desirable behavior. When creating a new submission, there are query parameters that prevent the automatic creation of certain resources on the job.
The createCoveredLocationForPrimaryLocation query parameter
By default, when a submission is initially created many property LOBs will
automatically create a line-specific covered location for the primary location on a
policy. However, this behavior can be undesirable in the context of a Composite API or
graph POST submissions request. Because the ID of an automatically-created covered
location can't be known ahead of time, there's no way to update that location in the
same request. For example, there is no way to automatically create the location and then
attach buildings or coverages to it within the composite request or the Graph API
/submissions request.
Set the createCoveredLocationForPrimaryLocation query
parameter to false to disable the creation of a default covered
location. This allows the caller to explicitly create the covered location as a separate
request so that its ID can be known (in a composite request) or so that it can have
children specified (in a graph POST request).
This query parameter is true by default. It’s available on the
following endpoints:
POST /job/v1/submissionsPOST /graph/v1/submissions
The createDefaultCoverages query parameter
By default, when you create a coverable, PolicyCenter automatically creates all coverages (and conditions and exclusions) that meet the following criteria:
- They are available when the call is made
- They have an existence type of "Required" or "Suggested"
Sometimes, a job may not want these default coverages. But it can be cumbersome for a caller to determine what coverages were added automatically and then remove the undesired ones. In these situations, it may be easier to have a coverable with no default coverages.
You can create a coverable without default coverages using the
createDefaultCoverages query parameter. This is a Boolean query
parameter whose default is true. It is available on the following sets
of endpoints:
- Line endpoints
- For example, POST
/jobs/{jobId}/lines - Note that POST
/linesendpoints are present only for multi-line products
- For example, POST
- Non-line coverable endpoints
- For example, POST
/jobs/{jobId}/lines/PersonalAutoLine/vehicles
- For example, POST
- The POST
/job/v1/submissionsendpoint- This suppresses the creation of coverages, conditions, and exclusions on the default policy lines.
- This also suppresses the creation of coverages, conditions, and exclusions on any coverable that is created automatically, such as a Commercial Property's default primary location coverable.
- The POST
/graphs/v1/submissionsendpoint -
- All the preceding behaviors on the Job API endpoints are performed on the Graph API endpoint.
When the query parameter is set to false, the following behaviors are
implemented:
- POST of a coverable
- Disable creation of default coverages, exclusions, and conditions
For example, suppose you have Personal Auto submission pc:6066. A vehicle is POSTed to the submission. The following call will create the vehicle with all default coverages.
POST /job/v1/jobs/pc:6066/lines/PersonalAutoLine/vehicles
In contrast, the following call will also create the vehicle, but with no default coverages.
POST /job/v1/jobs/pc:6066/lines/PersonalAutoLine/vehicles?createDefaultCoverages=false
This query parameter does not have special permissions. Any caller that can access coverable endpoints can also use this query parameter.
The createDefaultPolicyLines query parameter
The createDefaultPolicyLines query parameter specifies whether all
policy lines are created during a new submission request.
By default, when you create a new submission request, PolicyCenter creates all the lines available for the product. However, this behavior can be undesirable for graph POST submission requests that only include one of the available policy lines.
createDefaultPolicyLines is true by default. Set
createDefaultPolicyLines to false to prevent the
creation of all policy lines.
createDefaultPolicyLines to
fals when you create a submission request on a monoline product,
you must also explicitly create at least one PolicyLine as part of that
submission request.createDefaultPolicyLines query parameter is available on the
following endpoints:POST /job/v1/submissionsPOST /graph/v1/submissions
The createPrimaryLocationFromAccount query parameter
The createPrimaryLocationFromAccount query parameter specifies
whether a PolicyLocation is automatically created based on the account's
primary location and assigned as the primary location on the new submission
request.
By default, when you create a new submission request, PolicyCenter creates a
PolicyLocation that matches the account's
PrimaryLocation and this location is also assigned as the
PrimaryLocation on the submission. However, this behavior can be
undesirable for a graph POST submissions request that wants to explicitly create the
PolicyLocation to assign as the primary location.
createPrimaryLocationFromAccount is true by default.
Set createPrimaryLocationFromAccount to false to
disable the creation of a default PolicyLocation.
primaryLocation is required on submission
requests. If you set createPrimaryLocationFromAccount to
false, you must explicitly set the primaryLocation
as part of the submission request. createPrimaryLocationFromAccount query parameter is available on the
following endpoints:POST /job/v1/submissionsPOST /graph/v1/submissions
The suppressAllDefaults query parameter
The suppressAllDefaults query parameter specifies whether to
suppress creation of default values during a new submission request.
By default, when you create a new submission, PolicyCenter creates default values for coverages, conditions, exclusions, the primary covered location, and APD-defined defaults for fields and coverage terms. However, these behaviors can be undesirable for graph POST submission requests that intend to create data exactly as supplied in the request and do not want additional default values set on the server.
suppressAllDefaults is false by default. Set
suppressAllDefaults to true to disable creation of
default values. Typically, API callers use this query parameter when converting high
volume quotes to submissions. In most cases, suppressing the creation of default values
at a more granular level is preferred. suppressAllDefaults to true overrides any
settings for createDefaultCoverages,
createDefaultPolicyLines,
createPrimaryLocationFromAccount, or
createCoveredLocationForPrimaryLocation. It also disables the
creation of default values for APD-defined fields and coverage terms. suppressAllDefaults query parameter is available on the following
endpoints:POST /job/v1/submissionsPOST /graph/v1/submissions
You can reference the suppressAllDefaults query parameter in line of
business code to disable the creation of default values when converting high volume
quotes to submissions.