Skip to main content

Job API (1.6.0)

APIs for job related objects

Update the specified additional named insured

Update the specified additional named insured (Since 1.4.0)

gw-resourceType: AdditionalNamedInsured
gw-sinceVersion: 1.4.0
Authorizations:
path Parameters
jobId
required
string

The identifier for the job

additionalNamedInsuredId
required
string
gw-sinceVersion: 1.4.0

The identifier for the additional named insured (Since 1.4.0)

query Parameters
fields
Array of strings
gw-allowForCompositeApi: true

Allows the caller to specify the set of fields that should be included on the response. This can be used to limit the set of fields returned as well as to include optional fields that otherwise wouldn't normally be returned. The parameter is either of the form fields=<field list> or fields=<include>:<field list>, where <field list> consists of a comma-separated list of field or field set names. See the documentation for more information.

jobVersion
string
gw-allowForCompositeApi: true
gw-sinceVersion: 1.1.0

The version of the job to view or modify (Since 1.1.0)

Request Body schema: application/json
required
object (AdditionalNamedInsuredData)
object (PolicyPeriodInclusions)

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "included": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": {
    }
}