insurance

Query insurance COPE values for a specific period, with optional filters and pagination

post/api/rpc/queryInsuranceValues

Request

  • Base URL: https://21risk.com
  • URL: https://21risk.com/api/rpc/queryInsuranceValues
  • Auth: OAuth 2 (client credentials, token URL /api/v1/oauth/token)

Request body

tenantunknown required
querystring
periodstring required
namestring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

valueStatusstring

Valid operands: -, in progress, completed. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

copeStatusstring

Valid operands: -, in progress, completed. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

biPeriodstring

Operands must represent integer IDs, such as "1,2" or "!3". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

smokeVentsstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

fireSectionsstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

closureMechanismsstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

cableAndPipingstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

highRackStoragestring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

spillDropColstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

electricalInstallationstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

lithiumBatteriesstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

unmannedMachinerystring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

seperateChargingstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

markedChargingstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

sharedOccupancystring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

electricalHeatingstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

fireDetectionstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

fireLogbookstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

fireAutSprinklersstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

fireExtingstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

externalHydrantsstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

extingServicestring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

thermographicSurveystring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

hotWorkPermitstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

inspectionRegularHousekeepingstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

inspectionSandwichPanelsstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

inspectionFireDoorsstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

smokePolicystring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

biPlanstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

solarInstalltedstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

roofstring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

internalWallsstring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

externalWallsstring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

occupancyTypestring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

storageTypesstring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

waterPumpsstring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

waterSupplystring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

countrystring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

citystring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

regionstring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

districtstring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

postcodestring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

localitystring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

neighborhoodstring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

tagsstring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

createdDatestring

ISO dates (2024-01-15), periods (2024, 2024-01), comparisons (>=2024, <2024-06), ranges (2024-01-01..2024-12-31), or relative dates (@today, @today-7d). Units: d, w, m, y. Use * for any date, !* for empty.

tivstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

tivChangestring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

totalPDstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

totalPDChangestring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

totalBIstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

totalBIChangestring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

tivIncludingOffSitestring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

stockAndSuppliesIncludingOffSitestring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

machineryAndEquipmentIncludingOffSitestring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

areastring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

buildingsstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

machineryAndEquipmentstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

leaseImprovementsstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

furnitureAndFixturesstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

stockAndSuppliesstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

businessInterruptionstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

buildingsChangestring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

machineryAndEquipmentChangestring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

leaseImprovementsChangestring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

furnitureAndFixturesChangestring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

stockAndSuppliesChangestring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

businessInterruptionChangestring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

businessInterruptionScaledstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

businessInterruptionScaledChangestring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

numberOfBuildingsstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

storiesstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

whiteCollarEmployeesstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

blueCollarEmployeesstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

normalOperatingDaysAWeekstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

buildingConstructionYearstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

fireBrigadestring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

fireDetectionAreastring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

sprinklerProtectionstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

smokeVentsPercstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

normalOperationShiftsstring

Exact match (=42), comparisons (>42, <=42), or ranges (10..20). Use * for any value, !* for empty.

includesstring[]

Only include records whose IDs are in this list.

excludesstring[]

Exclude records whose IDs are in this list.

afterstring

Cursor-based pagination: return results after this cursor. Use pageInfo.endCursor from the previous page.

beforestring

Cursor-based pagination: return results before this cursor. Use pageInfo.startCursor from the current/previous page.

lastinteger

Cursor-based pagination: number of results to return before the before cursor. Use for backward pagination.

sort'name' | 'createdDate' | 'tiv' | 'tivChange' | 'totalPD' | 'totalPDChange' | 'totalBI' | 'totalBIChange' | 'tivIncludingOffSite' | 'stockAndSuppliesIncludingOffSite' | 'machineryAndEquipmentIncludingOffSite' | 'valueStatus' | 'copeStatus' | 'area' | 'buildings' | 'machineryAndEquipment' | 'leaseImprovements' | 'furnitureAndFixtures' | 'stockAndSupplies' | 'businessInterruption' | 'buildingsChange' | 'machineryAndEquipmentChange' | 'leaseImprovementsChange' | 'furnitureAndFixturesChange' | 'stockAndSuppliesChange' | 'businessInterruptionChange' | 'businessInterruptionScaled' | 'businessInterruptionScaledChange' | 'numberOfBuildings' | 'stories' | 'whiteCollarEmployees' | 'blueCollarEmployees' | 'normalOperatingDaysAWeek' | 'buildingConstructionYear' | 'fireBrigade' | 'fireDetectionArea' | 'sprinklerProtection' | 'smokeVentsPerc' | 'normalOperationShifts' | 'biPeriod' | 'smokeVents' | 'fireSections' | 'closureMechanisms' | 'cableAndPiping' | 'highRackStorage' | 'spillDropCol' | 'electricalInstallation' | 'lithiumBatteries' | 'unmannedMachinery' | 'seperateCharging' | 'markedCharging' | 'sharedOccupancy' | 'electricalHeating' | 'fireDetection' | 'fireLogbook' | 'fireAutSprinklers' | 'fireExting' | 'externalHydrants' | 'extingService' | 'thermographicSurvey' | 'hotWorkPermit' | 'inspectionRegularHousekeeping' | 'inspectionSandwichPanels' | 'inspectionFireDoors' | 'smokePolicy' | 'biPlan' | 'solarInstallted' | 'roof' | 'internalWalls' | 'externalWalls' | 'occupancyType' | 'storageTypes' | 'waterPumps' | 'waterSupply' | 'country' | 'address' | 'city' | 'region' | 'district' | 'postcode' | 'locality' | 'neighborhood' | 'street' | 'latitude' | 'longitude'
direction'asc' | 'desc'

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.