---
description: Gets the html documentation for a browser
url: http://api.linport.org/
method: GET
example: curl -X GET http://api.linport.org
returns: html documentation (HTTP NOT FOUND 404)
...
---
description: Creates a new BTS instance with a new uuid on the server
url: http://api.linport.org/
method: POST
example: curl -X POST http://api.linport.org/
returns: uuid (HTTP OK 200)
...
---
description: Uploads a BTS instance to the server
url: http://api.linport.org/*uuid*/ #note that the uuid is optional in this case
method: PUT
example: curl -X PUT -F file=@myfilename http://api.linport.org/
returns: uuid (HTTP OK 200)
...
---
description: Get a top level map of the uploaded BTS or download the ZIP file (specify this in the request header)
url: http://api.linport.org/*uuid*/
method: GET
example: curl -X GET -H "Accept: application/zip" http://api.linport.org/*uuid*/
returns: Top level map of the BTS or complete BTS Zip File (HTTP OK 200)
...
---
description: Delete BTS instance on the server
url: http://api.linport.org/*uuid*/
method: DELETE
example: curl -X DELETE -F http://api.linport.org/*uuid*/
returns: none (HTTP NO CONTENT 204)
...
---
description: Return the BTS manifest as XML (other formats are currently unsupported for this function)
url: http://api.linport.org/*uuid*/portinfo/manifest/
method: GET
example: curl -X GET http://api.linport.org/*uuid*/portinfo/manifest/
returns: XML manifest data (HTTP OK 200)
...
---
description: Refreshes the manifest online
url: http://api.linport.org/*uuid*/portinfo/manifest/
method: POST
example: curl -X POST http://api.linport.org/*uuid*/portinfo/manifest/
returns: none (HTTP NO CONTENT 204)
...
---
description: Return the BTS metatdata
url: http://api.linport.org/*uuid*/portinfo/metadata/
method: GET
example: curl -X GET -H "Accept: application/xml" http://api.linport.org/*uuid*/portinfo/metadata/ #note this should return the metadata in XML
returns: metadata (HTTP OK 200)
...
---
description: Replaces the online metadata with the metadata file provided
url: http://api.linport.org/*uuid*/portinfo/metadata/
method: PUT
example: curl -X PUT -F file=@myfilename http://api.linport.org/*uuid*/portinfo/metadata/
returns: none (HTTP NO CONTENT 204)
...
---
description: Deletes the BTS metadata online
url: http://api.linport.org/*uuid*/portinfo/metadata/
method: DELETE
example: curl -X DELETE http://api.linport.org/*uuid*/portinfo/manifest/
returns: none (HTTP NO CONTENT 204)
...
---
description: Get the value of a metadata element
url: http://api.linport.org/*uuid*/portinfo/metadata/*elementName*/
method: GET
example: curl -X GET http://api.linport.org/*uuid*/portinfo/metadata/*elementName*/ #note an example of an element name would be "profile"
returns: string contents of the specified metadata element (HTTP OK 200)
...
---
description: Set the value of a metadata element
url: http://api.linport.org/*uuid*/portinfo/metadata/*elementName*/
method: PUT
example: curl -X PUT -d element_value=myvalue http://api.linport.org/*uuid*/portinfo/metadata/*elementName*/
returns: none (HTTP NO CONTENT 204)
...
---
description: Clear the value of a metadata element
url: http://api.linport.org/*uuid*/portinfo/metadata/*elementName*/
method: DELETE
example: curl -X DELETE http://api.linport.org/*uuid*/portinfo/metadata/*elementName*/
returns: none (HTTP NO CONTENT 204)
...
---
description: Get a mapping of all sets in the BTS with their respective URLs
url: http://api.linport.org/*uuid*/sets/
method: GET
example: curl -X GET -H "Accept: application/json" http://api.linport.org/*uuid*/sets/
returns: mapping of sets and URLs (HTTP OK 200) #note that the mapping will be JSON for the above example
...
---
description: Get a mapping of all documents in a particular set with their respective URLs
url: http://api.linport.org/*uuid*/sets/*setName*/
method: GET
example: curl -X GET -H "Accept: application/json" http://api.linport.org/*uuid*/sets/*setName*/
returns: mapping of sets and URLs (HTTP OK 200) #note that the mapping will be JSON for the above example
...
---
description: Create a new set with any included files and get a mapping of all documents in that set with their respective URLs
url: http://api.linport.org/*uuid*/sets/*setName*/
method: PUT
example: curl -X PUT -H "Accept: application/xml" -F file1=@myfile1 -F file2=@myfile2 http://api.linport.org/*uuid*/sets/*setName*/
returns: mapping of documents and URLs (HTTP OK 200) #note that the mapping will be XML for the above example
...
---
description: Delete the specified set and all of its documents online
url: http://api.linport.org/*uuid*/sets/*setName*/
method: DELETE
example: curl -X DELETE http://api.linport.org/*uuid*/sets/*setName*/
returns: none (HTTP NO CONTENT 204)
...
---
description: Get the contents of a document for translation
url: http://api.linport.org/*uuid*/sets/*setName*/*docName*/
method: GET
example: curl -X GET http://api.linport.org/*uuid*/sets/*setName*/*docName*/
returns: string of bytes (HTTP OK 200) #This is an unaware call. For example, if the document is a PDF, the client will need to know how to interpret it
...
---
description: Upload a document for translation
url: http://api.linport.org/*uuid*/sets/*setName*/*docName*/
method: PUT
example: curl -X PUT -F file=@myfilename http://api.linport.org/*uuid*/sets/*setName*/*docName*/
returns: none (HTTP NO CONTENT 204)
...
---
description: Delete a translation document from the server
url: http://api.linport.org/*uuid*/sets/*setName*/*docName*/
method: DELETE
example: curl -X DELETE http://api.linport.org/*uuid*/sets/*setName*/*docName*/
returns: none (HTTP NO CONTENT 204)
...
---
description: Get a mapping of all machine reference document names with their access URLs for the specified set
url: http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/machine/
method: GET
example: curl -X GET http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/machine/
returns: mapping of reference documents and URLs (HTTP OK 200)
...
---
description: Get the contents of a machine readable reference document
url: http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/machine/*docName*/
method: GET
example: curl -X GET http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/machine/*docName*/
returns: string of bytes (HTTP OK 200) #This is an unaware call. For example, if the document is a PDF, the client will need to know how to interpret it
...
---
description: Upload a machine readable reference document for translation
url: http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/machine/*docName*/
method: PUT
example: curl -X PUT -F file=@myfilename http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/machine/*docName*/
returns: none (HTTP NO CONTENT 204)
...
---
description: Delete a machine readable reference document from the server
url: http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/machine/*docName*/
method: DELETE
example: curl -X DELETE http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/machine/*docName*/
returns: none (HTTP NO CONTENT 204)
...
---
description: Get a mapping of all human reference document names with their access URLs for the specified set
url: http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/human/
method: GET
example: curl -X GET http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/human/
returns: mapping of reference documents and URLs (HTTP OK 200)
...
---
description: Get the contents of a human readable reference document
url: http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/human/*docName*/
method: GET
example: curl -X GET http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/human/*docName*/
returns: string of bytes (HTTP OK 200) #This is an unaware call. For example, if the document is a PDF, the client will need to know how to interpret it
...
---
description: Upload a human readable reference document for translation
url: http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/human/*docName*/
method: PUT
example: curl -X PUT -F file=@myfilename http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/human/*docName*/
returns: none (HTTP NO CONTENT 204)
...
---
description: Delete a human readable reference document from the server
url: http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/human/*docName*/
method: DELETE
example: curl -X DELETE http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/reference/human/*docName*/
returns: none (HTTP NO CONTENT 204)
...
---
description: Get the specifications corresponding to a particular set
url: http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/specifications/
method: GET
example: curl -X GET -H "Accept: application/xml" http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/specifications/
returns: specifications data (HTTP OK 200) #note that the mapping will be XML for the above example but may be in another format
...
---
description: Upload a specifications file to override the specifications corresponding to a particular set
url: http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/specifications/
method: PUT
example: curl -X PUT -F file=@myspecifications http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/specifications/
returns: none (HTTP NO CONTENT 204)
...
---
description: Get the value of a particular parameter
url: http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/specifications/*parameterName*/
method: GET
example: curl -X GET http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/specifications/*parameterName*/
returns: parameter contents (including status and any subparameters) (HTTP OK 200) #the default is JSON but other formats can be requested via the Accept Header
...
---
description: Set the value of a particular parameter to the uploaded XML
url: http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/specifications/*parameterName*/
method: PUT
example: curl -X PUT -d param_value="<layout status=\"proposed\">No Requirements</layout> http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/specifications/*parameterName*/
returns: none (HTTP NO CONTENT 204)
...
---
description: Clear the contents of a particular parameter
url: http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/specifications/*parameterName*/
method: DELETE
example: curl -X DELETE http://api.linport.org/*uuid*/setsinfo/*setName*/setinfo/specifications/*parameterName*/
returns: none (HTTP NO CONTENT 204)
...