Databox

Databox

Base URL: api/dime/rest/{mainSaId}/databox

Method	Path	Description
GET	@all	Return a collection of all databox done by all users.
GET	@me/@all	Returns a collection of all databox the user has.
POST	@me	Creates a new databox.
GET	@me/{dbId}	Returns a specific databox.
POST	@me/{dbId}	Updates a specific databox.
DELETE	@me/{dbId}	Deletes a specific databox.
GET	@me/@all/shared?sharedWithAgent={agentId}	Returns all the databoxes shared with a specific agent
GET	@me/@all/shared?sharedWithService={serviceId}	Returns all the databoxes shared with a specific service

Parameters:

• dbId: Id of an specific databox.
• agentId: Id of a specific agent.
• serviceId: Id of a specific service.

Examples:

• Call: api/dime/rest/5b223cde-07e5-4987-b531-231876fa7601/databox/@me/@all
• Response:

{
"response":{
      "meta":{
         "v":"0.9",
         "status":"OK",
         "code":200,
         "timeRef":"2011-08-30T15:01:59+02:00",
         "msg": ""
   },
   "data":{
      "startIndex":0,
      "itemsPerPage":2,
      "totalResults":2,
      "entry":[{
         "guid": "<databoxId>",
         "created":1338824999,
         "lastModified":1338824999,
         "userId": "<userId>|@me",
         "name": "Summer 2011",
         "imageUrl": "<imageUrl>",
         "type": "databox",
         "items": [
            "resourceId1",
            "resourceId2",
            "resourceId3"],
         "nao:privacyLevel":0.5,
         "nao:includes": [
                     {
                       "saidSender":"jdaspojsd39023",
                       "groups": [groupId, ...],
                       "persons": [
                          {"personId":"392a", "saidReceiver":”fweo634ifwo”},
                          {...}
                          ] ,
                       "services": ["serviceId",...]
                          },
                          {
                          ...
                          }               
                        ],
          "nao:excludes": [ ]
        }
       ]
     }
}