POST Request Parameters
Parameter | Description | Usage |
---|---|---|
locations object contains the following elements: | ||
objectId | Uniquely identifies location coordinates. If provided, the associated objectId with location coordinates is returned in the response for reference. It should be a valid positive integer. If not provided, then the objectId is generated starting '1' and auto incremented. | Optional |
locations.geometry object contains the following elements: | ||
type | Point | Optional |
coordinates | Specifies the x, y input coordinates, where x=longitude and y=latitude. For example: [ -105.25175, 40.024494 ] | Required |
preferences object contains the following elements: | ||
richterValue | Specifies the acceptable richter values. Multiple values can be
passed in a comma-separated format. For example: 'richterValue=R0,
R2, R5_GE' Valid Values: R0, R1, R2, R3, R4, R5, R6, R7, R0_GE, R1_GE, R2_GE, R3_GE, R4_GE, R5_GE, R6_GE, R7_G. R1 refers to the count of Richter scale 1 events. R2 refers to the count of Richter scale 2 events, and so on. R6_GE is the count of all events greater than Richter scale 6. R7_GE is the count of all events greater than Richter scale 7, and so on. Default: 'all'. If 'all' is specified as an input, then all richter values are returned. If any other valid value is specified along with 'all', then all is considered and other value is ignored. |
Optional |
includeGeometry | Specifies whether or not to include the geometry. If 'Y' is
specified, earthquake zone boundary will be shown in response. If
'N' is specified, the earthquake zone boundary will not be shown in
response. Possible values: Y or N Default: 'N' |
Optional |