Document
API change historyThis API allows operations on the Document entity in Safefood 360.
URL | https://api.safefood360.com/document |
Methods supported | GET, PUT, POST |
Operations |
AddDocument: Adds a new Document GetDocument: Returns details on a specific Document GetDocumentVersion: Returns details on a specific Document Version GetDocumentList: Returns a list of Documents UpdateDocument: Updates an existing Document |
Request
Request URL
Request parameters
-
string
The unique identifier for a Document – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9
-
(optional)boolean
A boolean parameter to specify whether the base64 content payload should be returned in the response. Default is false.
-
(optional)boolean
A boolean parameter to specify whether the direct HTTP accessible URL with shared access signatures (SAS) to the file should be returned with the response. Default is false.
Request headers
Request body
Responses
200 OK
The File information returned in the Document body will always represent the last version of that document.
If the WithURL parameter is requested then a direct URL to the File will be provided with an expiry of 30 minutes.
Representations
{
"Id":"eddde398-bcf6-49d6-947c-647267d608cf",
"SiteSequenceId":106,
"Name":"Customer Complaint SOP01",
"Description":"Standard Operating Procedure for the handling of Customer Complaints",
"Version":3,
"FileType":"application/pdf",
"FileName":"SOP01-Complaints.pdf",
"FileContent":"ZXhhbXBsZSBmaWxl",
"FileURL":"https://storageservice.us1.safefood360.com/508e0478-ad13-4047-b3a5-9fbb00f84279/AC0D61DF-7CEC-4262-A308-9A50DAF7424D.pdf?sv=2015-02-12&st=2015-02-12T22%3A18%3A26Z&se=2013-04-30T02%3A23%3A26Z&sr=b&sp=rw&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D",
"EntityFolderId":"15e5cf46-c1c0-41ce-ba05-327a7d592674",
"DocumentVersion":[
{
"Id":"7dcb43c0-e63f-4016-89bc-d90401c9e646",
"FileName":"SOP01-Complaints",
"FileType":"application/pdf",
"Version":1,
"Added":"2014-04-12T18:25:43.511Z"
},
{
"Id":"b64fd844-6a98-49f7-b486-ee4641345573",
"FileName":"SOP01-Complaints",
"FileType":"application/pdf",
"Version":2,
"Added":"2014-03-12T18:25:43.511Z"
}
],
"UserToReview":[
{
"Id":"7dcb43c0-e63f-4016-89bc-d90401c9e646"
},
{
"Id":"b64fd844-6a98-49f7-b486-ee4641345573"
}
],
"UserToApprove":[
{
"Id":"7dcb43c0-e63f-4016-89bc-d90401c9e646"
},
{
"Id":"b64fd844-6a98-49f7-b486-ee4641345573"
}
],
"UserToNotify":[
{
"Id":"7dcb43c0-e63f-4016-89bc-d90401c9e646"
},
{
"Id":"b64fd844-6a98-49f7-b486-ee4641345573"
}
],
"Created":"2012-04-23T18:25:43.511Z",
"CreatedBy":"4af35477-f49e-4aa6-940d-bfe882045a9d",
"LastModified":"2014-04-12T18:25:43.511Z",
"LastModifiedBy":"585a2bcd-364c-419e-93f3-a1466be4cd5b"
}
Code samples
@ECHO OFF
curl -v -X GET "https://api.safefood360.com/document/GetDocument/{Id}?WithContent=false&WithURL=false"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["WithContent"] = "false";
queryString["WithURL"] = "false";
var uri = "https://api.safefood360.com/document/GetDocument/{Id}?" + queryString;
var response = await client.GetAsync(uri);
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.safefood360.com/document/GetDocument/{Id}");
builder.setParameter("WithContent", "false");
builder.setParameter("WithURL", "false");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"WithContent": "false",
"WithURL": "false",
};
$.ajax({
url: "https://api.safefood360.com/document/GetDocument/{Id}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.safefood360.com/document/GetDocument/{Id}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"WithContent=false",
@"WithURL=false",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.safefood360.com/document/GetDocument/{Id}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'WithContent' => 'false',
'WithURL' => 'false',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'WithContent': 'false',
'WithURL': 'false',
})
try:
conn = httplib.HTTPSConnection('api.safefood360.com')
conn.request("GET", "/document/GetDocument/{Id}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'WithContent': 'false',
'WithURL': 'false',
})
try:
conn = http.client.HTTPSConnection('api.safefood360.com')
conn.request("GET", "/document/GetDocument/{Id}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://api.safefood360.com/document/GetDocument/{Id}')
query = URI.encode_www_form({
# Request parameters
'WithContent' => 'false',
'WithURL' => 'false'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body