CityScope / CS_CityIO

Serverside script for the cityscope platform
https://cityio.media.mit.edu
14 stars 8 forks source link

[Suggestion] Add endpoint for CS tables list #29

Closed RELNO closed 6 years ago

RELNO commented 6 years ago

Concept: Accessing https://cityio.media.mit.edu/api/LIST, will return table list. List include URLs for each table endpoint [i.e https://cityio.media.mit.edu/api/table/citymatrix_volpe]

yasushisakai commented 6 years ago

so a JSON like this?

[
  {
    "table_name":  "virtual_table",
    "url": "https://cityio.media.mit.edu/api/table/virtual_table",
  },
  {
    "table_name":  "citymatrix_volpe",
    "url": "https://cityio.media.mit.edu/api/table/citymatrix_volpe",
  }
]

are there other useful information when getting the list? like timestamp?

RELNO commented 6 years ago

If we're really spoiling ourselves here -- This will allow to plot a map with table location, name, [potential] activity indication, without calling/ parsing the table itself. Might be too much though.

[
  {
    "table_name":  "virtual_table",
    "url": "https://cityio.media.mit.edu/api/table/virtual_table",
    "latZero": "42.506285", // lat loc of cell 0,0
    "lonZero": "1.521801", //lon loc of cell 0,0
    "timeStamp": "1517964394" //last time server received new stuff  
  },
  {
    "table_name":  "citymatrix_volpe",
    "url": "https://cityio.media.mit.edu/api/table/citymatrix_volpe",
     ...
  }
]
yasushisakai commented 6 years ago

I get the point, and understand the importance of having the url (robust in terms of changes). Is it too much to dump all of the header?

popabczhang commented 6 years ago

not the header of the data point json, but header of table list json as I understand?

On Wed, Feb 7, 2018 at 9:04 AM, Yasushi Sakai notifications@github.com wrote:

I get the point, and understand the importance of having the url (robust in terms of changes). Is it too much to dump all of the header?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/CityScope/CS_CityIO_Backend/issues/29#issuecomment-363778490, or mute the thread https://github.com/notifications/unsubscribe-auth/ACrA-FlDLjGPPTTdMxjuSSq7ieBU0eflks5tSa2EgaJpZM4R7Vm0 .

--

YAN ZHANG "RYAN"

PH.D. STUDENT, ASSISTANT RESEARCHER MEDIA ARTS & SCIENCES, MEDIA LAB MASSACHUSETTS INSTITUTE OF TECHNOLOGY

M.S. ADVANCED ARCHITECTURE DESIGN COLUMBIA UNIVERSITY IN THE CITY OF NEW YORK

20 AMES STREET, BUILDING E15-368 CAMBRIDGE, MA 02142

1(917)767-3589 POPABCZHANG@GMAIL.COM

RELNO commented 6 years ago

I get the point, and understand the importance of having the url (robust in terms of changes). Is it too much to dump all of the header?

If this is not too much of overhead, yes, this could be beneficial. But I also saw your new endpoint query function which could be another way to solve this -- when calling https://cityio.media.mit.edu/api/ one gets the list, but with ?fields=meta,grid,objects it returns the header of each.

RELNO commented 6 years ago

@yasushisakai now that we have API v2 out, any way to get query the table list?

yasushisakai commented 6 years ago

@RELNO https://cityio.media.mit.edu/api/tables/list

I think I will work on "Go rewrite" and moving the server as one release, but for the time being, I will expose the above endpoint.

RELNO commented 6 years ago

image