API Guide

API
1. ABOUT
About SFD.
1.1 GET /about
Get information about SFD.
This API should be invoked to get SFD version and service-tag.
REQUEST
No request parameters
RESPONSE
STATUS CODE - 200: Get SFD version and service-tag information.
RESPONSE MODEL - application/json
{
version string
version of SFD.
service_tag string
unique service tag provided with SFD purchase.
manifest_file_version string
The manifest le version.
}
STATUS CODE - 401: You are not authorized to perform this operation.
RESPONSE MODEL - application/json
{
new_object_id string
This represents the id of the new object created for the POST API call.
id string
This represents the key for the localized property le to be used by UI to show the localized
string.
message string
Success or error message
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params
in the Message in the localized le.
messages [{
Array of object:
id string
This represents the key for the localized property le to be used by UI to show the
localized string.
message string
Success or error message
field_name string
Field name where the error was seen
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the
params in the Message in the localized le.
}]
}
STATUS CODE - default: success or error response
RESPONSE MODEL - application/json
{
new_object_id string
This represents the id of the new object created for the POST API call.
id string
This represents the key for the localized property le to be used by UI to show the localized
string.
message string
Success or error message
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params
in the Message in the localized le.
messages [{
Array of object:
9 of 340