-
Notifications
You must be signed in to change notification settings - Fork 0
Picture Object
Salvatore D'Agositno edited this page Oct 26, 2013
·
4 revisions
##NB: IDs for Pictures are using UUID-OOSP
This function will create a picture object
POST /photos
##Sample Request Arguments(POST):
username : jsnow // Auth
password : test // Auth
evenId : fbaf8db9-ceb4-453b-9f95-ca31e45eb24c
userId : 1
picture : myPicture.png (file)
##Sample Response:
{
"error": false,
"message": "Picture Uploaded",
"data": null
}
This function will return all picture objects for a given event
GET /events/:eventId/photos
##Sample Request Arguments(GET):
username : jsnow // Auth
password : test // Auth
start : 1 // Optional
limit : 1 // Optional
##Sample Response:
{
"error" : false,
"message" : "",
"data" : [
{
"id" : "a962bfc5-610d-4d6d-86e7-c64db370ddd9",
"name" : "1.jpg",
"owner" : 1,
"date_created" : "2013-10-23T00:09:05.529Z",
"date_updated" : null,
"url" : "https://s3.amazonaws.com/projectPS/fbaf8db9-ceb4-453b-9f95-ca31e45eb24c/c97e3b3928ef6e9ab2982f8a576247c4081585a8.jpg",
"hash" : "c97e3b3928ef6e9ab2982f8a576247c4081585a8",
"mime" : "image/jpeg",
"extension" : "jpg",
"event_id" : "fbaf8db9-ceb4-453b-9f95-ca31e45eb24c"
},
{
"id" : "07406ef2-fdbd-4ab4-8eef-8e6055ce9ebd",
"name" : "DSC01316.jpg",
"owner" : 1,
"date_created" : "2013-10-26T02:30:25.392Z",
"date_updated" : null,
"url" : "https://s3.amazonaws.com/projectPS/fbaf8db9-ceb4-453b-9f95-ca31e45eb24c/2ed72417c64e16f58828c1c946fdb1b61a12571f.jpg",
"hash" : "2ed72417c64e16f58828c1c946fdb1b61a12571f",
"mime" : "image/jpeg",
"extension" : "jpeg",
"event_id" : "fbaf8db9-ceb4-453b-9f95-ca31e45eb24c"
}
]
}
This function sends back a single picture
GET /photos/:eventId/:pictureId
##Sample Request Arguments(GET):
username : jsnow // Auth
password : test // Auth
##Sample Response:
{
"error" :false,
"message" :"",
"data" :{} // File Object Will Be Here
}
This function will update a picture record
PUT /photos/:id
##Sample Request Arguments(PUT):
username : jsnow // Auth
password : test // Auth
photo :
{
"name": "thisNameHasBeenUpdated",
"owner": 1
}
##Sample Response:
{
"error" : false,
"message" : "Picture updated",
"data" : null
}
This function will update a picture record
DELETE /photos/:eventId/:pictureId
##Sample Request Arguments(DELETE):
username : jsnow // Auth
password : test // Auth
##Sample Response:
{
"error" : false,
"message" : "Picture deleted",
"data" : null
}