NIC MAP Client API

Schemas

CreateAnalysisResponse

success

boolean · required

analysisId

integer · int32

errorMessage

string

CreateAnalysisRequest

bufferType

string · enum · required

Enum values:

Distance

DriveTime

bufferValue

integer · int32 · required

address

string

latitude

number · double

longitude

number · double

analysisName

string

BufferTypeDto

string · enum

Enum values:

Distance

DriveTime

AnalysisStatusResponse

analysisId

integer · int32 · required

dateRequested

string · date-time · required

status

string

percentComplete

number · double

dateCompleted

string · date-time

name

string

QuotaResponse

dailyLimit

integer · int32 · required

usedToday

integer · int32 · required

remaining

integer · int32 · required

MetricsResponse

analysisId

integer · int32 · required

siteId

integer · int32 · required

bufferTypeId

integer · int32

bufferValue

number · double

object[]

MetricItem

measureTypeId

integer · int32 · required

name

string

displayName

string

value

number · decimal

displayType

string

formattedValue

string

SupplyResponse

analysisId

integer · int32 · required

siteId

integer · int32 · required

bufferTypeId

integer · int32

bufferValue

number · double

object[]

SupplyItem

latitude

number · decimal · required

longitude

number · decimal · required

distanceFromTarget

number · double · required

yearOpened

integer · int32 · required

supplyType

integer · int32 · required

id

string

name

string

address

string

city

string

state

string

zip

string

totalUnits

integer · int32

propertyType

string

propertyStatus

string

DodgePipelineResponse

analysisId

integer · int32 · required

siteId

integer · int32 · required

object[]

DodgePipelineItem

latitude

number · double · required

longitude

number · double · required

distanceFromTarget

number · double · required

isTypeNewConstruction

boolean · required

isTypeAddition

boolean · required

isTypeAlteration

boolean · required

isTypeConversion

boolean · required

name

string

stage

string

targetConstCompletion

string · date-time

BuildCentralPipelineResponse

analysisId

integer · int32 · required

siteId

integer · int32 · required

object[]

BuildCentralPipelineItem

latitude

number · double · required

longitude

number · double · required

distanceFromTarget

number · double · required

isTypeNewConstruction

boolean · required

isTypeAddition

boolean · required

isTypeAlteration

boolean · required

isTypeConversion

boolean · required

name

string

stage

string

targetConstCompletion

string · date-time

RIFacilitiesResponse

object[]

RIFacilityItem

facilityId

integer · int32 · required

communityName

string

RIRunsResponse

facilityId

integer · int32 · required

object[]

RIRunItem

runId

integer · int32 · required

runDate

string · date-time · required

RIBenchmarkFacilitiesResponse

facilityId

integer · int32 · required

runId

integer · int32 · required

object[]

RIInsightResponse

facilityId

integer · int32 · required

runId

integer · int32 · required

benchmarkFacilityId

integer · int32

object[]

object

RIWealthGroup

type

integer · int32 · required

object[]

RIPsychographicSelection

label

string

object[]

RIMosaicDataPoint

value

number · decimal · required

benchmark

number · decimal · required

bottom

number · decimal · required

label

string

RIStatsData

totalRecords

integer · int32 · required

matchedRecords

integer · int32 · required

matchRate

number · decimal · required

RIMosaicDefinitionsResponse

object[]

RIMosaicDefinitionItem

label

string

title

string

description

string

SupplyItem

latitude

number · decimal · required

longitude

number · decimal · required

distanceFromTarget

number · double · required

yearOpened

integer · int32 · required

supplyType

integer · int32 · required

id

string

name

string

address

string

city

string

state

string

zip

string

totalUnits

integer · int32

propertyType

string

propertyStatus

string

DodgePipelineItem

latitude

number · double · required

longitude

number · double · required

distanceFromTarget

number · double · required

isTypeNewConstruction

boolean · required

isTypeAddition

boolean · required

isTypeAlteration

boolean · required

isTypeConversion

boolean · required

name

string

stage

string

targetConstCompletion

string · date-time

BuildCentralPipelineItem

latitude

number · double · required

longitude

number · double · required

distanceFromTarget

number · double · required

isTypeNewConstruction

boolean · required

isTypeAddition

boolean · required

isTypeAlteration

boolean · required

isTypeConversion

boolean · required

name

string

stage

string

targetConstCompletion

string · date-time