POST api/private/Rules/Add
Request Information
URI Parameters
None.
Body Parameters
Rule| Name | Description | Type | Additional information |
|---|---|---|---|
| Hour | integer |
None. |
|
| StickingCheckValue | decimal number |
None. |
|
| StickingCheckHours | integer |
None. |
|
| MaxSuspect | decimal number |
None. |
|
| MaxSevere | decimal number |
None. |
|
| MinDrift | decimal number |
None. |
|
| RatesOfChange | decimal number |
None. |
|
| Site | Site |
None. |
|
| Parameter | Parameter |
None. |
|
| Id | integer |
None. |
|
| ModifiedDate | date |
None. |
|
| CreatedDate | date |
None. |
|
| Disabled | boolean |
None. |
|
| DisabledDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"Hour": 1,
"StickingCheckValue": 2.1,
"StickingCheckHours": 3,
"MaxSuspect": 4.1,
"MaxSevere": 5.1,
"MinDrift": 6.1,
"RatesOfChange": 7.1,
"Site": {
"EstablishedDate": "2026-04-02T19:29:43.1714034Z",
"Name": "sample string 1",
"LocalIdentifier": "sample string 2",
"AQS": "sample string 3",
"URL": "sample string 4",
"Street": "sample string 5",
"City": "sample string 6",
"CityCode": "sample string 7",
"State": "sample string 8",
"Zip": "sample string 9",
"AQCR": "sample string 10",
"Lon": 11.1,
"Lat": 12.1,
"Landuse": "sample string 13",
"StateCode": "sample string 14",
"CountyCode": "sample string 15",
"AQSSiteId": "sample string 16",
"DisplayAQI": "sample string 17",
"DisplayAQIParameterCode": "sample string 18",
"DisplayAQIParameterName": "sample string 19",
"DisplayAQIColor": "sample string 20",
"IncludeInForecast": true,
"Monitors": [
{
"OccurrenceCode": "sample string 1",
"AQS": true,
"ParentId": 1,
"Parameter": {
"Name": "sample string 1",
"Description": "sample string 2",
"Code": "sample string 3",
"Abbreviation": "sample string 4",
"PublicName": "sample string 5",
"Min": 6,
"Max": 7,
"IncludeInForecast": true,
"IncludeInTrends": true,
"MeasurementUnit": {
"Name": "sample string 1",
"Description": "sample string 2",
"Id": 3,
"ModifiedDate": "2026-04-02T19:29:43.1714034Z",
"CreatedDate": "2026-04-02T19:29:43.1714034Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.1714034Z"
},
"Id": 10,
"ModifiedDate": "2026-04-02T19:29:43.1714034Z",
"CreatedDate": "2026-04-02T19:29:43.1714034Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.1714034Z"
},
"Id": 3,
"ModifiedDate": "2026-04-02T19:29:43.1714034Z",
"CreatedDate": "2026-04-02T19:29:43.1714034Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.1714034Z"
},
{
"OccurrenceCode": "sample string 1",
"AQS": true,
"ParentId": 1,
"Parameter": {
"Name": "sample string 1",
"Description": "sample string 2",
"Code": "sample string 3",
"Abbreviation": "sample string 4",
"PublicName": "sample string 5",
"Min": 6,
"Max": 7,
"IncludeInForecast": true,
"IncludeInTrends": true,
"MeasurementUnit": {
"Name": "sample string 1",
"Description": "sample string 2",
"Id": 3,
"ModifiedDate": "2026-04-02T19:29:43.1714034Z",
"CreatedDate": "2026-04-02T19:29:43.1714034Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.1714034Z"
},
"Id": 10,
"ModifiedDate": "2026-04-02T19:29:43.1714034Z",
"CreatedDate": "2026-04-02T19:29:43.1714034Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.1714034Z"
},
"Id": 3,
"ModifiedDate": "2026-04-02T19:29:43.1714034Z",
"CreatedDate": "2026-04-02T19:29:43.1714034Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.1714034Z"
}
],
"Records": [
{
"DateOnlyString": "sample string 1",
"Date": "2026-04-02T19:29:43.1714034Z",
"Hour": 3,
"Value": 1.1,
"ReadingAverageDataID": "sample string 4",
"SiteName": "sample string 5",
"AqsParameterCode": "sample string 6",
"ParameterName": "sample string 7",
"AqsUnitAbbreviation": "sample string 8",
"AqsParameterOccuranceCode": "sample string 9",
"AQSSiteId": "sample string 10",
"AQI": 1,
"Surrogate": 1.1,
"Bad": true,
"AVValid": true,
"NullCodeDescription": "sample string 13",
"MeasurementUnit": {
"Name": "sample string 1",
"Description": "sample string 2",
"Id": 3,
"ModifiedDate": "2026-04-02T19:29:43.1714034Z",
"CreatedDate": "2026-04-02T19:29:43.1714034Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.1714034Z"
},
"Id": 14,
"ModifiedDate": "2026-04-02T19:29:43.1714034Z",
"CreatedDate": "2026-04-02T19:29:43.1714034Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.1714034Z"
},
{
"DateOnlyString": "sample string 1",
"Date": "2026-04-02T19:29:43.1714034Z",
"Hour": 3,
"Value": 1.1,
"ReadingAverageDataID": "sample string 4",
"SiteName": "sample string 5",
"AqsParameterCode": "sample string 6",
"ParameterName": "sample string 7",
"AqsUnitAbbreviation": "sample string 8",
"AqsParameterOccuranceCode": "sample string 9",
"AQSSiteId": "sample string 10",
"AQI": 1,
"Surrogate": 1.1,
"Bad": true,
"AVValid": true,
"NullCodeDescription": "sample string 13",
"MeasurementUnit": {
"Name": "sample string 1",
"Description": "sample string 2",
"Id": 3,
"ModifiedDate": "2026-04-02T19:29:43.1714034Z",
"CreatedDate": "2026-04-02T19:29:43.1714034Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.1714034Z"
},
"Id": 14,
"ModifiedDate": "2026-04-02T19:29:43.1714034Z",
"CreatedDate": "2026-04-02T19:29:43.1714034Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.1714034Z"
}
],
"Buddies": [],
"Id": 22,
"ModifiedDate": "2026-04-02T19:29:43.1714034Z",
"CreatedDate": "2026-04-02T19:29:43.1714034Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.1714034Z"
},
"Parameter": {
"Name": "sample string 1",
"Description": "sample string 2",
"Code": "sample string 3",
"Abbreviation": "sample string 4",
"PublicName": "sample string 5",
"Min": 6,
"Max": 7,
"IncludeInForecast": true,
"IncludeInTrends": true,
"MeasurementUnit": {
"Name": "sample string 1",
"Description": "sample string 2",
"Id": 3,
"ModifiedDate": "2026-04-02T19:29:43.1714034Z",
"CreatedDate": "2026-04-02T19:29:43.1714034Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.1714034Z"
},
"Id": 10,
"ModifiedDate": "2026-04-02T19:29:43.1714034Z",
"CreatedDate": "2026-04-02T19:29:43.1714034Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.1714034Z"
},
"Id": 8,
"ModifiedDate": "2026-04-02T19:29:43.1714034Z",
"CreatedDate": "2026-04-02T19:29:43.1714034Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.1714034Z"
}
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Rule| Name | Description | Type | Additional information |
|---|---|---|---|
| Hour | integer |
None. |
|
| StickingCheckValue | decimal number |
None. |
|
| StickingCheckHours | integer |
None. |
|
| MaxSuspect | decimal number |
None. |
|
| MaxSevere | decimal number |
None. |
|
| MinDrift | decimal number |
None. |
|
| RatesOfChange | decimal number |
None. |
|
| Site | Site |
None. |
|
| Parameter | Parameter |
None. |
|
| Id | integer |
None. |
|
| ModifiedDate | date |
None. |
|
| CreatedDate | date |
None. |
|
| Disabled | boolean |
None. |
|
| DisabledDate | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"Hour": 1,
"StickingCheckValue": 2.1,
"StickingCheckHours": 3,
"MaxSuspect": 4.1,
"MaxSevere": 5.1,
"MinDrift": 6.1,
"RatesOfChange": 7.1,
"Site": {
"EstablishedDate": "2026-04-02T19:29:43.2299035Z",
"Name": "sample string 1",
"LocalIdentifier": "sample string 2",
"AQS": "sample string 3",
"URL": "sample string 4",
"Street": "sample string 5",
"City": "sample string 6",
"CityCode": "sample string 7",
"State": "sample string 8",
"Zip": "sample string 9",
"AQCR": "sample string 10",
"Lon": 11.1,
"Lat": 12.1,
"Landuse": "sample string 13",
"StateCode": "sample string 14",
"CountyCode": "sample string 15",
"AQSSiteId": "sample string 16",
"DisplayAQI": "sample string 17",
"DisplayAQIParameterCode": "sample string 18",
"DisplayAQIParameterName": "sample string 19",
"DisplayAQIColor": "sample string 20",
"IncludeInForecast": true,
"Monitors": [
{
"OccurrenceCode": "sample string 1",
"AQS": true,
"ParentId": 1,
"Parameter": {
"Name": "sample string 1",
"Description": "sample string 2",
"Code": "sample string 3",
"Abbreviation": "sample string 4",
"PublicName": "sample string 5",
"Min": 6,
"Max": 7,
"IncludeInForecast": true,
"IncludeInTrends": true,
"MeasurementUnit": {
"Name": "sample string 1",
"Description": "sample string 2",
"Id": 3,
"ModifiedDate": "2026-04-02T19:29:43.2299035Z",
"CreatedDate": "2026-04-02T19:29:43.2299035Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.2299035Z"
},
"Id": 10,
"ModifiedDate": "2026-04-02T19:29:43.2299035Z",
"CreatedDate": "2026-04-02T19:29:43.2299035Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.2299035Z"
},
"Id": 3,
"ModifiedDate": "2026-04-02T19:29:43.2299035Z",
"CreatedDate": "2026-04-02T19:29:43.2299035Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.2299035Z"
},
{
"OccurrenceCode": "sample string 1",
"AQS": true,
"ParentId": 1,
"Parameter": {
"Name": "sample string 1",
"Description": "sample string 2",
"Code": "sample string 3",
"Abbreviation": "sample string 4",
"PublicName": "sample string 5",
"Min": 6,
"Max": 7,
"IncludeInForecast": true,
"IncludeInTrends": true,
"MeasurementUnit": {
"Name": "sample string 1",
"Description": "sample string 2",
"Id": 3,
"ModifiedDate": "2026-04-02T19:29:43.2299035Z",
"CreatedDate": "2026-04-02T19:29:43.2299035Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.2299035Z"
},
"Id": 10,
"ModifiedDate": "2026-04-02T19:29:43.2299035Z",
"CreatedDate": "2026-04-02T19:29:43.2299035Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.2299035Z"
},
"Id": 3,
"ModifiedDate": "2026-04-02T19:29:43.2299035Z",
"CreatedDate": "2026-04-02T19:29:43.2299035Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.2299035Z"
}
],
"Records": [
{
"DateOnlyString": "sample string 1",
"Date": "2026-04-02T19:29:43.2299035Z",
"Hour": 3,
"Value": 1.1,
"ReadingAverageDataID": "sample string 4",
"SiteName": "sample string 5",
"AqsParameterCode": "sample string 6",
"ParameterName": "sample string 7",
"AqsUnitAbbreviation": "sample string 8",
"AqsParameterOccuranceCode": "sample string 9",
"AQSSiteId": "sample string 10",
"AQI": 1,
"Surrogate": 1.1,
"Bad": true,
"AVValid": true,
"NullCodeDescription": "sample string 13",
"MeasurementUnit": {
"Name": "sample string 1",
"Description": "sample string 2",
"Id": 3,
"ModifiedDate": "2026-04-02T19:29:43.2299035Z",
"CreatedDate": "2026-04-02T19:29:43.2299035Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.2299035Z"
},
"Id": 14,
"ModifiedDate": "2026-04-02T19:29:43.2299035Z",
"CreatedDate": "2026-04-02T19:29:43.2299035Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.2299035Z"
},
{
"DateOnlyString": "sample string 1",
"Date": "2026-04-02T19:29:43.2299035Z",
"Hour": 3,
"Value": 1.1,
"ReadingAverageDataID": "sample string 4",
"SiteName": "sample string 5",
"AqsParameterCode": "sample string 6",
"ParameterName": "sample string 7",
"AqsUnitAbbreviation": "sample string 8",
"AqsParameterOccuranceCode": "sample string 9",
"AQSSiteId": "sample string 10",
"AQI": 1,
"Surrogate": 1.1,
"Bad": true,
"AVValid": true,
"NullCodeDescription": "sample string 13",
"MeasurementUnit": {
"Name": "sample string 1",
"Description": "sample string 2",
"Id": 3,
"ModifiedDate": "2026-04-02T19:29:43.2299035Z",
"CreatedDate": "2026-04-02T19:29:43.2299035Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.2299035Z"
},
"Id": 14,
"ModifiedDate": "2026-04-02T19:29:43.2299035Z",
"CreatedDate": "2026-04-02T19:29:43.2299035Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.2299035Z"
}
],
"Buddies": [],
"Id": 22,
"ModifiedDate": "2026-04-02T19:29:43.2299035Z",
"CreatedDate": "2026-04-02T19:29:43.2299035Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.2299035Z"
},
"Parameter": {
"Name": "sample string 1",
"Description": "sample string 2",
"Code": "sample string 3",
"Abbreviation": "sample string 4",
"PublicName": "sample string 5",
"Min": 6,
"Max": 7,
"IncludeInForecast": true,
"IncludeInTrends": true,
"MeasurementUnit": {
"Name": "sample string 1",
"Description": "sample string 2",
"Id": 3,
"ModifiedDate": "2026-04-02T19:29:43.2299035Z",
"CreatedDate": "2026-04-02T19:29:43.2299035Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.2299035Z"
},
"Id": 10,
"ModifiedDate": "2026-04-02T19:29:43.2299035Z",
"CreatedDate": "2026-04-02T19:29:43.2299035Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.2299035Z"
},
"Id": 8,
"ModifiedDate": "2026-04-02T19:29:43.2299035Z",
"CreatedDate": "2026-04-02T19:29:43.2299035Z",
"Disabled": true,
"DisabledDate": "2026-04-02T19:29:43.2299035Z"
}
text/xml
Sample:
Sample not available.