API documentation

GET /state_call_limits/new

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/state_call_limits/new

Build State Call Frequency with defaults.

Builds a State Call Frequency rule with default attributes without saving it.

Params

Param name	Description
states Optional Blank value allowed	States Must be an array of strings. EG: `["abc123", "xzy023"]`
name Optional Blank value allowed	Name Must be a String
call_limit_interval Optional Blank value allowed	Call Limit Interval Must be a decimal number.
call_limit_limit Optional Blank value allowed	Call Limit Limit Must be a decimal number.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/state_call_limits/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "state_call_limit": {
    "id": null,
    "type": "StateCallLimit",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/state_call_limits/new",
    "routes_edit_path": "/state_call_limits/new",
    "external_record_id": null,
    "company_id": 10001,
    "states": [
      "us-al",
      "us-ak",
      "us-az"
    ],
    "name": null,
    "call_limit_interval": 86400,
    "call_limit_limit": 3,
    "is_system_template": false
  },
  "metadata": {
    "root": "state_call_limit"
  }
}