Full Administration API Resources
The Administration API provides access for appropriately authenticated administrator users to add, create, update, and delete SmartSearch resources.
Databases
Calls for the management of databases.
Create Database: Creates a new database
Get Databases: Get a database details
Update Database: Edit the properties of a database
Delete Database: Delete a database
Database Index Rebuild: Run an index rebuild on the database
Archives
Calls for the management of archives on a given database. Includes calls for the management of global archive options.
Create Archive: Create a new archive
Get Archives: Get a list of archives
Update Archive: Edit the properties of an archive
Delete Archive: Delete an archive
Get Archive Options: Get current global archive options
Update Archive Options: Update current global archive options
Content Index Rebuild: Run content index rebuild on a specified archive
Inboxes
Calls for the management of inboxes. Inboxes are independent of databases. Includes calls for global inbox options. Inboxes do not currently support editing. Normal procedure for changing an inbox would be to create a new inbox and delete the original, as such no Update Inbox call is defined.
Get Inbox Options: Get current global inbox options
Update Inbox Options: Update the values of inbox options
Create Inbox: Create a new inbox
Get Inboxes: Get a list of all inboxes
Fields
Calls for the management of the field catalog.
Create Field: Create a new field
Get Fields: Retrieve the field catalog
Update Field: Update the properties of a field
Create Table Field: Create a new table field
Get Table Fields: Get a list of table fields
Update Table Fields: Update a table field
Delete Table Field: Delete a table field
Get Lists: Get a list of lists
Create list: Create a new list
Update List: Update the properties of a list
Load assembly list: Test load an assembly list
Searches
Calls for the management of searches, as defined in relationship to their parent archive.
Create Search: Create a new search
Get Searches: Get a list of searches
Update Search: Update a search
Delete Search: Delete a search
Email Notification Options
Calls for the management of email notification settings, and configuration of the outgoing mail server. These settings are per database.
Set Email Options: Configure the outgoing mail server settings
Get Email Options: Get the current outgoing mail server settings
Stamps
Calls for the management of stamp annotations. These are global elements, and database independent, currently they are stored both on clients as a flat file and globally on the server. These are currently not respected for use in GSW.
Create Stamp: Create a new stamp
Get Stamps: Get a list of stamps
DataXChange Sources
Calls for the management of DataXChange sources as defined on an archive.
Create DataXChange Source: Create a new DataXChange source
Get DataXChange Source: Get a list of DataXChange sources and properties
Update DataXChange Source: Update an existing DataXChange source
Delete DataXChange Source: Delete a DataXChange source
Registration
Calls for managing an installations registration.
Get Registration: Get the server’s current registration status
Request Web Registration: Submits a request to Square 9 for registration data
API Call:
POST /admin/databases
Description
Creates a new database
Parameters:
[RAW]:
POST Request body should contain the database object with the values modified as required for the update:
{
"name": "GetSmart",
"auth": {
"type": "windows",
"user": "",
"pass": ""
},
"server": "(local)\\GETSMART"
}
Returns
{ "ID": 1, "Name": "GetSmart", "Auth": { "Type": "windows", "User": "", "Pass": "" }, "Server": "(local)\\\\GETSMART" }
API Call:
GET /admin/databases/{id}
Description
Returns a list of databases with all properties. If optional {id} is provided, returns only the matching database.
Parameters:
id Optional:
Return only the matching database ID
Returns
[ { "id": 1, "name": "GetSmart", "auth": { "type": "windows", "user": "", "pass": "" }, "server": "(local)\\GETSMART" } ]
API Call:
PUT /admin/databases/{id}
Description
Edit the properties of an existing database. The only currently editable value for a database is the name. All other attempted changes should return an appropriate error. Returns the updated database record.
Parameters:
[RAW]:
PUT Request body should contain the database object with the values modified as required for the update:
{
"id": 1,
"name": "GetSmarter",
"auth": {
"type": "windows",
"user": "",
"pass": ""
},
"server": "(local)\\GETSMART"
}
id:
ID of the database to modify.
Returns
{ "id": 1, "name": "GetSmarter", "auth": { "type": "windows", "user": "", "pass": "" }, "server": "(local)\\GETSMART" }
API Call:
DELETE /admin/databases/{id}?Drop={true|false}
Description
Delete the specified database.
Parameters:
id:
ID of the database to delete
Drop Optional:
If drop is set to false the connection strings will be removed from the database and the web config. If drop is set to false it will drop the database from the instance as well.
Returns
Nothing.
API Call:
PUT /admin/databases/{db}/archives/{id}
Description
Edit the properties of an existing archive. Returns the updated archive record.
Parameters:
[RAW]:
PUT Request body should contain the archive object with the values modified as required for the update:
{
"id": 2,
"name": "Employees",
"basePath": {
"default": true,
"path": "C:\\SmartSearch\\Archive\\GetSmart\\Employees"
},
"fields": [
13,
3456
],
"views": {
"enabled": false,
"statusField": null,
"values": []
},
"contentSearch": false,
"revisionControl": 0,
"convertPdf": false,
"notifications": {
"to": null,
"from": null,
"subject": null,
"message": null
}
}
db:
Database ID
id:
Archive ID
Returns
{ "id": 2, "name": "Employees", "basePath": { "default": true, "path": "C:\\SmartSearch\\Archive\\GetSmart\\Employees" }, "fields": [ 13, 3456 ], "views": { "enabled": false, "statusField": null, "values": [] }, "contentSearch": false, "revisionControl": 0, "convertPdf": false, "notifications": { "to": null, "from": null, "subject": null, "message": null } }
API Call:
POST /admin/database/{db}/archives
Description
Create a new archive
Parameters:
db:
Database ID
[RAW] Optional:
POST body expects database creation object of the following JSON schema:
{
"name": "Accounts",
"basePath": {
"default": true,
"path": ""
},
"createBrowse": true,
"fields": [
12,
23,
65,
13
],
"views": {
"enabled": true,
"statusField": 12,
"values": [
{
"label": "Approved",
"value": "approved",
"color": "0,255,0"
},
{
"label": "Denied",
"value": "denied",
"color": "255,0,0"
}
]
},
"contentSearch": true,
"revisionControl": 0,
"convertPdf": false,
"notifications": {
"to": "bob@company.com",
"from": "noreply@company.com",
"subject": "Accounts Notification",
"message": "Message"
}
}
Returns
{ "id": 1, "name": "Accounts", "basePath": { "default": true, "path": "C:\\SmartSearch\\Archive\\GetSmart\\Accounts" }, "createBrowse": true, "fields": [ 12, 23, 65, 13 ], "views": { "enabled": true, "statusField": 12, "values": [ { "label": "Approved", "value": "approved", "color": "0,255,0" }, { "label": "Denied", "value": "denied", "color": "255,0,0" } ] }, "contentSearch": true, "revisionControl": 0, "convertPdf": false, "notifications": { "to": "bob@company.com", "from": "noreply@company.com", "subject": "Accounts Notification", "message": "Message" } }
API Call:
GET /admin/databases/{db}/archives/{id}
Description
Gets a list of archives with their properties. With the optional {id} parameter, only the matching database is returned.
Parameters:
db:
Database ID
id Optional:
Archive ID
Returns
[ { "id": 1, "name": "Accounts", "basePath": { "default": true, "path": "C:\\SmartSearch\\Archive\\GetSmart\\Accounts" }, "createBrowse": true, "fields": [ 12, 23, 65, 13 ], "views": { "enabled": true, "statusField": 12, "values": [ { "label": "Approved", "value": "approved", "color": "0,255,0" }, { "label": "Denied", "value": "denied", "color": "255,0,0" } ] }, "contentSearch": true, "revisionControl": 0, "convertPdf": false, "notifications": { "to": "bob@company.com", "from": "noreply@company.com", "subject": "Accounts Notification", "message": "Message" } }, { "id": 2, "name": "Employees", "basePath": { "default": true, "path": "C:\\SmartSearch\\Archive\\GetSmart\\Employees" }, "fields": [ 23, 65, 13, 3456 ], "views": { "enabled": false, "statusField": null, "values": [] }, "contentSearch": true, "revisionControl": 0, "convertPdf": false, "notifications": { "to": null, "from": null, "subject": null, "message": null } } ]
API Call:
PUT /admin/databases/{db}/archives/{id}
Description
Edit the properties of an existing archive. Returns the updated archive record.
Parameters:
[RAW]:
PUT Request body should contain the archive object with the values modified as required for the update:
{
"id": 2,
"name": "Employees",
"basePath": {
"default": true,
"path": "C:\\SmartSearch\\Archive\\GetSmart\\Employees"
},
"fields": [
13,
3456
],
"views": {
"enabled": false,
"statusField": null,
"values": []
},
"contentSearch": false,
"revisionControl": 0,
"convertPdf": false,
"notifications": {
"to": null,
"from": null,
"subject": null,
"message": null
}
}
db:
Database ID
id:
Archive ID
Returns
{ "id": 2, "name": "Employees", "basePath": { "default": true, "path": "C:\\SmartSearch\\Archive\\GetSmart\\Employees" }, "fields": [ 13, 3456 ], "views": { "enabled": false, "statusField": null, "values": [] }, "contentSearch": false, "revisionControl": 0, "convertPdf": false, "notifications": { "to": null, "from": null, "subject": null, "message": null } }
API Call:
DELETE /admin/databases/{db}/archives/{id}
Description
Delete an archive with the specified ID.
Returns
Nothing.
API Call:
GET /admin/databases/{db}/options/archives
Description
Get the current global archive options. This only includes "show all archives" at this time.
Parameters:
db:
Database ID
Returns
{ "showAll": true }
API Call:
PUT /admin/databases/{db}/options/archives
Description
Updated the values of current global archive options. This currently only includes the "show all archives option".
Parameters:
[RAW]:
PUT Request body should contain an archive options object containing the desired values:
{
"showAll": false
}
db:
Database ID
Returns
{ "showAll": false }
API Call:
GET api/admin/databases/{db}/archives/{archive}/indexRebuild/docCount={count}
Description
Send a number of documents to the queue to be run through content indexing.
Parameters:
archive:
Archive ID
count:
Number of the most recent documents to index
db:
Database ID
Returns
true
API Call:
GET /admin/options/inboxes
Description
Get the current global inbox options. This only includes "show all inboxes" at this time.
Returns
{ "showAll": true }
API Call:
PUT /admin/options/inboxes
Description
Update the values of global inbox options. This currently only includes the "show all inboxes option".
Parameters:
[RAW]:
PUT Request body should contain an archive options object containing the desired values:
{
"showAll": false
}
Returns
{ "showAll": false }
API Call:
POST /admin/inboxes
Description
Creates a new inbox. Inboxes are global, so these are not associated with a given database and do not require a database ID.
Parameters:
[RAW]:
POST Request body must contain a new inbox object of the following schema:
{
"name": "Incomming Faxes",
"basePath": {
"default": true,
"path": null
},
"uniqueName": false
}
Returns
Nothing.
API Call:
DELETE /admin/inboxes/{id}
Description
Deletes the specified inbox
Parameters:
id:
Inbox ID
Returns
Nothing.
API Call:
GET /admin/inboxes
Description
Get a list of all inboxes
Returns
[ { "id": 1, "name": "Incomming Faxes", "basePath": { "path": "C:\\SmartSearch\\inboxes\\Incomming Faxes" } }, { "id": 2, "name": "Incomming Bills", "basePath": { "path": "C:\\SmartSearch\\inboxes\\Incomming Bills" } } ]
API Call:
POST /admin/databases/{db}/fields
Description
Creates a new field in the specified databases field catalog.
Parameters:
[RAW]:
POST Request body expects a field creation object matching the following schema:{ "name": "Customer Name", "type": "character", "format": "", "regex": "", "length": 50, "required": false, "multiValue": false, "systemField": "", "list": { "type": "dropdown", "listId": 4, "primary": 12, "secondary": null, "mapping": [ { "primaryValue": "New York", "secondaryValue": "", "listId": 5 }, { "primaryValue": "Connecticut", "secondaryValue": "", "listId": 6 } ] } }The following values are used as strings for various types, you may use any of these types as appropriate: Field Types (field.type): character numeric datetime decimalList Types (field.list.type): dropdown typeaheadSystem Fields (field.systemField): indexedBy (character field only) lastModified (datetime or character field only) dateEntered (datetime field only) pageCount (numeric field only) fileType (character field only) readOnly
db:
Database ID
Returns
Nothing.
API Call:
GET /admin/databases/{db}/fields/{id}
Description
Retrieves a list of fields (or if an {id} is specified, a single field) and all of the field properties.
Parameters:
db:
Database ID
id Optional:
Field ID
Returns
[ { "id": 1, "name": "Customer Name", "type": "character", "format": "", "regex": "", "length": 50, "required": false, "multiValue": false, "systemField": "", "list": { "type": "dropdown", "listId": 4, "primary": 12, "secondary": null, "mapping": [ { "primaryValue": "New York", "secondaryValue": "", "listId": 5 }, { "primaryValue": "Connecticut", "secondaryValue": "", "listId": 6 } ] } }, { "id": 2, "name": "Vendor ID", "type": "numeric", "format": "", "regex": "", "length": 10, "required": false, "multiValue": false, "systemField": "", "list": { "type": "", "listId": null, "primary": null, "secondary": null, "mapping": [] } } ]
API Call:
PUT /admin/databases/{db}/fields/{id}
Description
Update the properties of a selected field.
Parameters:
[RAW]:
PUT Request Body of the field object JSON schema:
{
"id": 2,
"name": "Vendor ID",
"type": "numeric",
"format": "#####_#####",
"regex": "",
"length": 10,
"required": false,
"multiValue": false,
"systemField": "readOnly",
"list": {
"type": "",
"listId": null,
"primary": null,
"secondary": null,
"mapping": []
}
}
db:
Database ID
id:
Field ID
Returns
Nothing.
API Call:
DELETE /admin/databases/{db}/fields/{id}
Description
Delete a field from a databases field catalog by ID.
Parameters:
db:
Database ID
id:
Field ID
Returns
Nothing.
API Call:
POST /admin/databases/{db}/tablefields
Description
Create a new table field on the specified database.
Parameters:
[RAW]:
POST Request body of the table field creation JSON schema:
{
"name": "Invoiced Items",
"fields": [
62,
5,
23
]
}
db:
Database ID
Returns
Nothing.
API Call:
GET /admin/databases/{db}/tablefields/{id}
Description
Get a list of table fields and their properties on a specified database. Optionally get single table field and its properties with specified table field ID.
Parameters:
db:
Database ID
id Optional:
Table Field ID
Returns
[ { "id": 1, "name": "Invoiced Items", "fields": [ 62, 5, 23 ] }, { "id": 2, "name": "Purchase Order Items", "fields": [ 2, 51, 23 ] } ]
API Call:
PUT /admin/database/{db}/tablefields/{id}
Description
Update a table fields properties.
Parameters:
[RAW]:
PUT Request body with a table field object containing the required changes in the following JSON schema:
{
"name": "Invoiced Items",
"fields": [
62,
5,
23,
56
]
}
db:
Database ID
id:
Table Field ID
Returns
Nothing.
API Call:
DELETE /admin/databases/{db}/tablefields/{id}
Description
Delete a table field by ID from the specified databases field catalog.
Parameters:
db:
Database ID
id:
Table field ID
Returns
Nothing.
API Call:
GET /admin/databases/{db}/lists/{id}
Description
Gets a list of lists and their values. Optionally a single list if the list ID is provided.
Parameters:
db:
Database ID
id Optional:
List ID
Returns
[ { "ID": 1, "Name": "Invoice Approval Status", "AssemblyPath": "", "AssemblyParameters": "", "Values": [ "Approved", "Declined", "New", "On Hold", "Pending", "Escalate" ] }, { "ID": 2, "Name": "Invoice Match Status", "AssemblyPath": "", "AssemblyParameters": "", "Values": [ "Unmatched", "Matched" ] } ]
API Call:
POST api/admin/databases/{db}/lists
Description
POST Request body expects a list creation object matching the following schema:
{
"Name": "Invoice Approval Status",
"AssemblyPath": "",
"AssemblyParameters": "",
"Values": [
"Approved",
"Declined",
"Escalate",
"New",
"On Hold",
"Pending"
]
}
Parameters:
db:
Database ID
Returns
Nothing.
API Call:
PUT api/admin/databases/{db}/lists/{id}
Description
PUT Request body with a list object containing the required changes in the following JSON schema:
{
"Name": "Invoice Approval Status",
"AssemblyPath": "",
"AssemblyParameters": "",
"Values": [
"Approved",
"Declined",
"New",
"On Hold",
"Pending",
"Escalate"
]
}
Parameters:
db:
Database ID
id:
List ID
Returns
Nothing.
API Call:
DELETE api/admin/databases/{db}/lists/{id}
Description
Delete a list by ID from the specified databases field catalog.
Parameters:
db:
Database ID
id Optional:
List ID
Returns
Nothing.
API Call:
PUT api/admin/databases/42/lists
Description
Load values returned from an assembly to a list object
PUT Request body expects a list creation object matching the following schema:
{
"Name": "Assembly List",
"AssemblyPath": "C:\\GetSmart\\staticAssemblyBoundList.dll",
"AssemblyParameters": "",
"Values": []
}
Returns
{ "Name": "Assembly List", "AssemblyPath": "C:\\GetSmart\\staticAssemblyBoundList.dll", "AssemblyParameters": "", "Values": [ "Item 1", "Item 2", "Item 3", "Item 4", "Item 5" ] }
API Call:
POST /admin/databases/{db}/searches
Description
Creates a new search on the specified archive of a given database.
Parameters:
[RAW]:
POST Request body containing a search creation object of the following JSON schema:
{
"name": "Dealer Invoice Search",
"parent": 1,
"parameters": [
{
"field": 12,
"condition": "equals",
"prompt": "Invoice No:"
},
{
"field": 25,
"condition": "contains",
"prompt": "Dealer Name:"
}
],
"advancedGrouping": "1 AND 2",
"grantAll": true,
"imageXChange": false,
"contentSearch": {
"enabled": false,
"phonics": false,
"stemming": false,
"fuzziness": false,
"fuzzinessValue": 0
},
"multiValue": false,
"displayViewTabs": false,
"archives": [
14,
5
]
}
db:
Database ID
Returns
Nothing.
API Call:
GET /admin/databases/{db}/searches/{id}
Description
Gets a list of searches and their properties. Optionally a single search if the search ID is provided.
Parameters:
db:
Database ID
id Optional:
Search ID
Returns
[ { "id": 42, "name": "Dealer Invoice Search", "parent": 1, "parameters": [ { "field": 12, "condition": "equals", "prompt": "Invoice No:" }, { "field": 25, "condition": "contains", "prompt": "Dealer Name:" } ], "advancedGrouping": "1 AND 2", "grantAll": true, "imageXChange": false, "contentSearch": { "enabled": false, "phonics": false, "stemming": false, "fuzziness": false, "fuzzinessValue": 0 }, "multiValue": false, "displayViewTabs": false, "archives": [ 14, 5 ] }, { "id": 43, "name": "Invoice Search", "parameters": [ { "field": 12, "condition": "equals", "prompt": "Invoice No:" } ], "advancedGrouping": "1 AND 2", "grantAll": true, "imageXChange": false, "contentSearch": { "enabled": false, "phonics": false, "stemming": false, "fuzziness": false, "fuzzinessValue": 0 }, "multiValue": false, "displayViewTabs": false, "archives": [ 14, 5 ] } ]
API Call:
PUT /admin/databases/{db}/searches/{id}
Description
Updates the properties of the specified search.
Parameters:
[RAW]:
PUT Request body with required changes to the search object in the following JSON schema:
{
"id": 42,
"name": "Invoices by Dealer Search",
"parent": 1,
"parameters": [
{
"field": 12,
"condition": "equals",
"prompt": "Invoice No:"
},
{
"field": 25,
"condition": "contains",
"prompt": "Dealer Name:"
}
],
"advancedGrouping": "1 AND 2",
"imageXChange": false,
"contentSearch": {
"enabled": false,
"phonics": false,
"stemming": false,
"fuzziness": false,
"fuzzinessValue": 0
},
"multiValue": false,
"displayViewTabs": false,
"archives": [
14,
5
]
}
db:
Database ID
id:
Search ID
Returns
Nothing.
API Call:
DELETE /admin/databases/{db}/searches/{id}
Description
Delete the specified search by ID from an archive.
Parameters:
db:
Database ID
id:
Search ID
Returns
Nothing.
API Call:
PUT /admin/databases/{db}/notifications
Description
Configure the settings for the outgoing email server used for email notifications.
Parameters:
[RAW]:
PUT Request body with the following JSON schema:
{
"server": "mail.server.com",
"port": "25",
"auth": {
"user": "ssuser",
"password": "m41lm3"
}
}
db:
Database ID
Returns
Nothing.
API Call:
GET /admin/databases/{db}/notifications
Description
Get the currently configured options for an archives configured email notification.
Parameters:
db:
Database ID
Returns
{ "server": "mail.server.com", "port": 25, "auth": { "user": "ssuser", "password": "m41lm3" } }
API Call:
POST /admin/stamps
Description
Creates a new system wide stamp.
Parameters:
[RAW]:
POST Request body with the following JSON schema:
{ "text": "Confidential" }
Returns
Nothing.
API Call:
GET /admin/stamps
Description
Gets a list of the system wide stamps.
Returns
[ { "id": 1, "text": "Confidential" }, { "id": 2, "text": "Important" }, { "id": 3, "text": "Paid" } ]
API Call:
DELETE /admin/stamps/{id}
Description
Delete the specified system wise stamp by ID.
Parameters:
id:
Stamp ID
Returns
Nothing.
API Call:
POST /admin/databases/{db}/archives/{archive}/dxc
Description
Creates a new DataXChange source on the specified archive.
Parameters:
[RAW]:
POST Request body of the new DataXChange source object in the following JSON schema:
{
"name": "PO Lookup",
"connectionString": "Provider=SQLOLEDB.1;Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=BrewHaven;Data Source=(local)\\Getsmart",
"mapping": [
{
"archiveField": 17,
"mappedField": "dbo.[ssFields].[Field17]"
},
{
"archiveField": 18,
"mappedField": "dbo.[ssFields].[Field18]"
},
{
"archiveField": 19,
"mappedField": "dbo.[ssFields].[Field19]"
},
{
"archiveField": 20,
"mappedField": "dbo.[ssFields].[Field20]"
}
]
}
archive:
Parent archive ID
db:
Database ID
Returns
Nothing.
API Call:
GET /admin/databases/{db}/archives/{archive}/dxc/{id}
Description
Gets a list of all of an archives DataXChange sources and their properties. Gets a single DataXChange sources detail if an ID is provided.
Parameters:
archive:
Parent archive ID
db:
Database ID
id Optional:
DataXChange ID
Returns
[ { "id": 23, "name": "PO Lookup", "connectionString": "Provider=SQLOLEDB.1;Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=BrewHaven;Data Source=(local)\\Getsmart", "mapping": [ { "archiveField": 17, "mappedField": "dbo.[ssFields].[Field17]" }, { "archiveField": 18, "mappedField": "dbo.[ssFields].[Field18]" }, { "archiveField": 19, "mappedField": "dbo.[ssFields].[Field19]" }, { "archiveField": 20, "mappedField": "dbo.[ssFields].[Field20]" } ] } ]
API Call:
PUT /admin/databases/{db}/archives/{archive}/dxc/{id}
Description
Update the properties of an existing DataXChange source.
Parameters:
[RAW]:
PUT Request body of the updated DataXChange source object in the following JSON schema:
{
"id": 1,
"name": "PO Lookup",
"connectionString": "Provider=SQLOLEDB.1;Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=BrewHaven;Data Source=(local)\Getsmart",
"mapping": [
{
"archiveField": 17,
"mappedField": "dbo.[ssFields].[Field17]"
},
{
"archiveField": 18,
"mappedField": "dbo.[ssFields].[Field18]"
},
{
"archiveField": 19,
"mappedField": "dbo.[ssFields].[Field19]"
},
{
"archiveField": 20,
"mappedField": "dbo.[ssFields].[Field20]"
}
]
}
archive:
Parent archive ID
db:
Database ID
id:
DataXChange source ID
Returns
Nothing.
API Call:
DELETE /admin/databases/{db}/archives/{archive}/dxc/{id}
Description
Delete an existing DataXChange source from an archive.
Parameters:
archive:
Parent archive ID
db:
Database ID
id:
DataXChange source ID
Returns
Nothing.
API Call:
GET /admin/registration
Description
Get the status of the server's current registration.
Returns
{ "status": "full", "uniqueId": "612355423", "serial": "584D2B16E4CB9AE4A60B", "registration": "884848B61A82542EC934" }
API Call:
POST /admin/registration
Description
Submits a request to Square 9's registration server for the customers current registration data.
Parameters:
[RAW]:
POST Request body must contain the required registration data object the following JSON schema:
{
"uniqueId": "612355423",
"serial": "584D2B16E4CB9AE4A60B"
}
Returns
Nothing.
API Call:
PUT /admin/registration
Description
Manually registers the server using the provided registration number rather than requesting it from Square 9's servers.
Parameters:
[RAW]:
PUT Request body must contain the complete registration object in the following JSON schema:
{
"uniqueId": "612355423",
"serial": "584D2B16E4CB9AE4A60B",
"registration": "884848B61A82542EC934"
}
Returns
Nothing.
API Call:
GET /admin/registration?features=true
Description
Returns a list of all feature prefixes and product descriptions currently registered
Returns
{ "XLT": "XML Transform", "TFC": "Table Fields", "OCR": "Text Recognition", "WED": "Web Only Licenses", "MDB": "Multi database", "WXC": "GlobalSearch", "KOW": "Kyocera Connector", "LAN": "Full Licenses", "SCA": "Smart Capture", "LFD": "GlobalForms", "SOW": "Sharp Connector", "DWF": "Document Workflow", "WRO": "Web Read Only Licenses", "CSH": "Content Search", "IXC": "Image XChange", "SSF": "SmartSearch", "FFS": "GlobalForms ODBC Connector", "GAW": "Global Action", "PDF": "PDF Conversion" }
