log inhelp

View
 

Tables::States::Schema

States

The states feature allows read access to grid states saved in the factual.com interface with filters, column orders, sorts and other settings already applied.  They serve as a convenient option to save fixed customizations to a table and apply them to all results.  Many of these options can then be overridden with additional parameters but establish custom defaults.

 

Schema

 

Requires a table key in the TABLE_STATE_KEY position of request url.

 

Parameters

none.

 

Result Payload 

Payload Field Description Examples
schema_object An object describing the schema of the table. 
{"fields":
  [
    {"name":"Restaurant","is_primary":true,"id":3231768,"datatype":"String"},
    {"name":"Street Address","is_primary":true,"id":3231769,"datatype":"String"},
    {"name":"City","is_primary":false,"id":3231771,"datatype":"String"},
    {"name":"State","is_primary":false,"id":3231772,"datatype":"String"},
  ],
  "key":"CIGf9f",
  "created_at":"2009/10/11 22:47:03 +0000",
  "total_row_count":53914,
  "description":null,
  "updated_at":"2009/10/11 22:50:09 +0000",
  "name":"California Restaurants",
  "source":null,
  "creator":"factualstaff",
  "rating":1.0,
  "is_private":false,
  "created_by_user_id":186
}

 

 

 

PDF version