Another API description
Resource | Description |
---|---|
GET /api/v2/building_sync/download/rp/buildings/:id | Export the building with the given ID. Response for a successful request is a BuildingSync XML document. |
GET /api/v2/building_sync/download/rp/nyc/properties/:id | Export the NYC property with the given ID. Response for a successful request is a BuildingSync XML document. |
POST /api/v2/building_sync/upload | Import Buildings. Response for a successful request is an object with the assigned unique IDs for the new buildings. |
Resource | Description |
---|---|
GET /api/v2/rp/buildings | All Buildings. |
Resource | Description |
---|---|
GET /api/v2/rp/cities/:id | All submissions for city. |
Resource | Description |
---|---|
GET /api/v2/rp/submissions/:id | One submission. |
POST /api/v2/rp/submissions/:id/mark_as_compliant | Mark submission as compliant. |
POST /api/v2/rp/submissions/:id/mark_as_pending | Mark submission as pending. |
POST /api/v2/rp/submissions/:id/mark_as_received | Mark submission as received. |
POST /api/v2/rp/submissions/:id/mark_as_rejected | Mark submission as rejected. |
Resource | Description |
---|---|
GET /api/v2/table/exports | All Table Exports. |
GET /api/v2/table/exports/:id | One Table Export. |
GET /api/v2/table/exports/:id/download | Download File for Table Export. |
POST /api/v2/table/exports | New Table Export. |
Resource | Description |
---|---|
GET /api/v2/table/imports | All Table Imports. |
GET /api/v2/table/imports/:id | One Table Import. |
GET /api/v2/table/imports/:id/download | Download File for Table Import. |
POST /api/v2/table/imports | New Table Import. |
Resource | Description |
---|---|
GET /api/v2/users | Retrieve a list of users. NOTE: Users are only allowed to view their own account.This call always returns a 404. |
POST /api/v2/users/authenticate | Authenticate user to get API token. Response for a successful request will be an object including a token to be used with future API requests. |
GET /api/v2/users/:id | Retrieve the user with the given ID. NOTE: Users are only allowed to view their own account. |
POST /api/v2/users | Create a new user account. Response for a successful request is a complete User object with the assigned unique ID of the new user.Password must contain uppercase, lowercase, digit and a special character. |
PUT /api/v2/users/:id | Update user account with given ID. Nothing is returned. NOTE: Users can only update their own account. Users NOT allowed to change role or organization. |