Requesting output formats
Request formats at parse time or any time afterward.- At parse time, pass
output_formats(a list of one or more) to Start SOV Parsing Job. Each requested format is generated as part of the job. - After parsing, request a single format with
Get Or Create SOV Output,
or pass
output_formatsto Start SOV Update Job when generating a new revision. See Regenerating outputs.
output_format value
returned by List Available Output Formats
as the canonical spelling. Requesting a format your organization has not enabled
returns a 400 whose message lists the formats you may request.
Discovering available formats
The set of formats available to you is configured per organization, so List Available Output Formats is the authoritative source for what you can request. Scope the lookup with one ofsovid, division_uuid, or team_uuid. When none is supplied, the endpoint uses
your default team and division. Precedence is sovid > division_uuid >
team_uuid > user default.
Each item in the response describes one format:
| Field | Meaning |
|---|---|
output_format | The value to pass when requesting this format. |
label | The human-readable label that appears on the generated output. |
output_extension | The file extension the output uses. Can be null. |
is_public | true for the public formats listed below, available to every account. false for other formats configured for your account. |
is_public set to true and are available to every account.
Your account may also return formats with is_public set to false, such as
org-specific workbooks. Call the endpoint to see your full set.
Formats available to every account
Structured data
output_format | Label | File type | Use it for |
|---|---|---|---|
JSON | JSON | JSON | The normalized SOV as structured data. This is the primary machine-readable output and the one most integrations consume. The JSON Format Specification documents its structure. |
DEBUGJSON | DEBUGJSON | JSON | A verbose variant of the JSON output that adds diagnostic parsing detail. Use it when you need to inspect how the source was interpreted. |
Excel workbooks
output_format | Label | File type | Use it for |
|---|---|---|---|
AUDITOR | Ping SOV | Excel (.xlsx) | A review-oriented workbook with a summary sheet, for checking the parsed data before you use it. |
AIRSCRUBBER | Ping SOV | Excel (.xlsm) | A workbook of the scrubbed SOV with AIR construction and occupancy coding. |
RMSSCRUBBER | RMS Scrubber | Excel (.xlsm) | The same workbook with RMS construction and occupancy coding. |
CATSCRUBBER | Ping SOV | Excel (.xlsm) | A workbook combining AIR and RMS coding in one file. |
AIRModeler | AIR Modeler | Excel (.xlsm) | A workbook laid out for AIR modeling. |
RMSModeler | RMS Modeler | Excel (.xlsm) | A workbook laid out for RMS modeling. |
CSV exports
output_format | Label | File type | Use it for |
|---|---|---|---|
AIRPolicy | AIR Policy CSV | CSV | Policy-level rows formatted for AIR catastrophe-model import. |
AIRLocation | AIR Location CSV | CSV | Location-level rows formatted for AIR catastrophe-model import. |
RMSPolicy | RMS Policy CSV | CSV | Policy-level rows formatted for RMS catastrophe-model import. |
RMSLocation | RMS Location CSV | CSV | Location-level rows formatted for RMS catastrophe-model import. |
OEDPolicy | OED Policy CSV | CSV | Policy-level rows in the Open Exposure Data (OED) standard. |
OEDLocation | OED Location CSV | CSV | Location-level rows in the Open Exposure Data (OED) standard. |
RMSAccountResults | RMS Analysis Account Results | CSV | Account-level results from RMS analysis. |
RMSLocationResults | RMS Analysis Location Results | CSV | Location-level results from RMS analysis. |
CDR | CDR CSV | CSV | Lloyd’s Core Data Record (CDR) format. |
Ping SOV. The output_format value, not the
label, is what distinguishes them when you request a file.
Formats specific to your organization
Your organization may have additional formats configured for its workflow, such as custom workbook layouts or partner-specific exports. These appear in List Available Output Formats withis_public set to false, and you request them the same way as any other format.
Because they are configured per organization, the endpoint is the only reliable way to
see the complete set available to your account.
How formats appear in responses
A completed job lists its generated files underresult.outputs. Each entry carries a
filename, a url to download from, and a description with the format’s
human-readable label. Request and download flows are covered in
Process an SOV and
Get or Create an SOV Output.