API Reference

Retrieve aggregate exposures

post
https://{host}/platform/import/v1/folders//files//retrieve-aggregate-exposures

Parses the aggregate exposure flat file staged at the specified fileId and returns the data as a grid of aggregate exposure values that may be reviewed and edited before it is saved by the Update aggregate exposures operation.

The request specifies the insurance type of the data, parser hints (delimiter, dataRowStart), the geography of the data (countryCode, resolution), and a columnMapping that maps destination fields to the columns of the file.

Supported for files in ALM import folders.

Path Params
string
required

ID of import file

string
required

ID of import folder

Body Params
string
enum
required

Type of aggregate exposure data in the file. Case-insensitive.

Allowed:
string
enum
required

Text delimiter used to separate columns of data in the uploaded flat file.

Allowed:
int32
required
≥ 1

Number of the first row of the file that contains data. Rows before this row (for example, a header row) are ignored.

string
required

Two-letter ISO 3166 code of the country of the aggregate exposure data. Workers' compensation data supports US only.

string
required

Geographic resolution of the rows of the file, for example State, County, or Postal Code.

string | null

Resolution that the specified resolution depends on. For example, County depends on State.

string

Resolution of the source data. To aggregate the data into a coarser resolution, specify the file's resolution in resolutionConversionFrom and the target resolution in resolutionConversionTo.

string

Resolution of the returned grid.

columnMapping
object
required

Map of destination fields to source column numbers in the file.

For property data, map the geography fields plus one field per line of business. For workers' compensation data, map State, Occ Scheme, Occ Type, and Payroll, plus County or Postal Code when required by the resolution.

Responses

Updated about 3 hours ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 3 hours ago

Did this page help you?