Difference between revisions of "API:POST /submission"

From SoFurry
Jump to: navigation, search
(Created page with "This is the first step in uploading new content into SoFurry. First, a Submission record is created via this method. It is then populated using the PUT method. Note that this...")
 
(Request)
 
(One intermediate revision by the same user not shown)
Line 17: Line 17:
 
  {
 
  {
 
   "title": "My awesome artwork", # Required, String
 
   "title": "My awesome artwork", # Required, String
   "type": "image", # Required, One of: image, music, story, flash
+
   "type": "image", # Required, One of: image, music, story, flash, diary, photo, video
   "rating": "clean" # Required, One of: clean, adult, extreme
+
   "rating": "clean" # Required, One of: clean, mature, adult, extreme
 
   "description": "Some sample artwork", # Required, Max 8192 characters
 
   "description": "Some sample artwork", # Required, Max 8192 characters
  "visible": true
 
 
  }
 
  }
  
Line 39: Line 38:
 
  }
 
  }
  
The result will be the submission object itself.
+
The result will be the submission object itself. Once the submission is created it needs to be populated with the PUT method.
  
 
[[Category:API]]
 
[[Category:API]]

Latest revision as of 14:26, 15 May 2016

This is the first step in uploading new content into SoFurry. First, a Submission record is created via this method. It is then populated using the PUT method.

Note that this API endpoint is still under development. Among the upcoming changes:

  • Subtypes - be more specific about the type of image, for eg: image.jpg, story.pdf, music.mp3
  • Content URLs - the return object will have a URL to access the content directly
  • Resolved User - Instead of just an ID, return the full user profile object in the same call, under user

Resource URL

https://api.sofurrybeta.com/submission

Request

POST /submission
X-SoFurry-Token: 1:3e9ed5866113d0a5b95b4798f8e7db9a
{
  "title": "My awesome artwork", # Required, String
  "type": "image", # Required, One of: image, music, story, flash, diary, photo, video
  "rating": "clean" # Required, One of: clean, mature, adult, extreme
  "description": "Some sample artwork", # Required, Max 8192 characters
}

Response: Success

HTTP 200
{
  "user_id": 1,
  "title": "My awesome artwork",
  "type": "image",
  "description": "Some sample artwork",
  "visible": true,
  "rating": "clean",
  "guid": "f8a89ef6-34ac-a7a5-0c00-ad22165c46ba",
  "updated_at": "2016-04-25 13:23:41",
  "created_at": "2016-04-25 13:23:41",
  "id": 5
}

The result will be the submission object itself. Once the submission is created it needs to be populated with the PUT method.