swagger
Explore
Swagger Sample App
This is a sample server Petstore server. You can find out more about Swagger at
http://swagger.wordnik.com
or on irc.freenode.net, #swagger. For this sample, you can use the api key "special-key" to test the authorization filters
Terms of service
Contact the developer
Apache 2.0
ldsdoc
: Document resource creation
Show/Hide
List Operations
Expand Operations
Raw
post
/ldshake/ldsdoc/
Create a document resource
Response type
Body containing a url
Response Content Type
text/plain
Parameters
Parameter
Value
Description
Parameter Type
Data Type
document
Document file.
multipart/form-data
file
sectoken
Security token.
multipart/form-data
string
ldshake_frame_origin
URL with the LdShake server’s domain.
multipart/form-data
string
lang
Language code.
multipart/form-data
string
name
Design’s title.
multipart/form-data
string
Status Codes
HTTP Status Code
Reason
201
Created
400
Bad request
500
Internal server error
507
Insufficient Storage
Hide Response
Request URL
Response Body
Response Code
Response Headers
get
/ldshake/ldsdoc/{document_id}
Retrieve the document in the current state in the editor iframe
Response type
Binary file
Response Content Type
application/octetstream
Parameters
Parameter
Value
Description
Parameter Type
Data Type
document_id
Id of the document to retrieve.
path
integer
Status Codes
HTTP Status Code
Reason
200
OK
400
Bad request
401
Unauthorized
404
Not found
500
Internal server error
Hide Response
Request URL
Response Body
Response Code
Response Headers
get
/ldshake/ldsdoc/{document_id}/summary
Retrieve a zipped html preview of the current document
Response type
Binary file
Response Content Type
application/octetstream
Parameters
Parameter
Value
Description
Parameter Type
Data Type
document_id
Id of the document to retrieve.
path
integer
Status Codes
HTTP Status Code
Reason
200
OK
400
Bad request
401
Unauthorized
404
Not found
500
Internal server error
Hide Response
Request URL
Response Body
Response Code
Response Headers
get
/ldshake/ldsdoc/{document_id}.imsld
Retrieve a IMS-LD version of the current document
Response type
Binary file
Response Content Type
application/octetstream
Parameters
Parameter
Value
Description
Parameter Type
Data Type
document_id
Id of the document to retrieve.
path
integer
Status Codes
HTTP Status Code
Reason
200
OK
400
Bad request
401
Unauthorized
404
Not found
500
Internal server error
Hide Response
Request URL
Response Body
Response Code
Response Headers