Index URL - http://localhost:8080/searchblox/api/rest/add

Document Syntax

<?xml version="1.0" encoding="utf-8"?>
<searchblox licenseid="302D02144F115712204DD54596EDDCCEDD284878D3BBFA130215008BF2501E38561A439C9260D509DBF12952619177">
<document colname="Custom_Collection" location="http://www.searchblox.com/features.html">
    <url>http://www.searchblox.com/FEATURES/</url>
    <title boost="1">SearchBlox Product Features</title>
    <keywords boost="1"></keywords>
    <content boost="1">test</content>
    <description boost="1">SearchBlox Content Search Software Features </description>
    <lastmodified>07 May 2005 06:19:42 GMT</lastmodified>
    <size>44244</size>
    <alpha>SearchBlox Features</alpha>
    <contenttype>HTML</contenttype>
    <uid>urlid12345</uid>
    <category>Home/Product</category>
    <category>Home/Features</category>
</document>
</searchblox>

XML tags in italics are optional. If included, these fields will override the information from the document.

Description

XML Tag	Attribute	Value
searchblox	licenseid	License value from license.xml file.
document	colname	Name of the Custom collection
document	location	Value of file location (http://.. or c:\documents\...)
url		url value to be returned with search results
title		title value of search result
title	boost	value range from 1-10
keywords		keyword value for document
keywords	boost	value range from 1-10
content		content for document
content	boost	value range from 1-10
description		description for search result
description	boost	value range from 1-10
lastmodified		Date in format 07 May 2005 06:19:42 GMT
size		size value
alpha		text value for sorting
contenttype		type of content value
uid		assigned unique identifer for a document (default when unassigned is url location)
category		value of category

Delete URL - http://localhost:8080/searchblox/api/rest/delete

Document Syntax

<?xml version="1.0" encoding="utf-8"?>
<searchblox licenseid="302D02144F115712204DD54596EDDCCEDD284878D3BBFA130215008BF2501E38561A439C9260D509DBF12952619177">
<document colname="Custom_Collection" uid="http://www.searchblox.com/features.html">
</document>
</searchblox>

Description

XML Tag	Attribute	Value
searchblox	licenseid	License value from license.xml file.
document	colname	Name of the Custom collection
document	uid	Value of unique identifier (file location http://..., file://c:/documents/.. or assigned uid)

Status URL - http://localhost:8080/searchblox/api/rest/status

Document Syntax

<?xml version="1.0" encoding="utf-8"?>
<searchblox licenseid="302D02144F115712204DD54596EDDCCEDD284878D3BBFA130215008BF2501E38561A439C9260D509DBF12952619177">
<document colname="Custom_Collection" uid="http://www.searchblox.com/features.html">
</document>
</searchblox>

Description

XML Tag	Attribute	Value
searchblox	licenseid	License value from license.xml file.
document	colname	Name of the Custom collection
document	uid	Value of unique identifier (file location http://..., file://c:/documents/.. or assigned uid)

Clear URL - http://localhost:8080/searchblox/api/rest/clear

Document Syntax

<?xml version="1.0" encoding="utf-8"?>
<searchblox licenseid="302D02144F115712204DD54596EDDCCEDD284878D3BBFA130215008BF2501E38561A439C9260D509DBF12952619177">
<document colname="Custom_Collection"/>
</searchblox>

Description

XML Tag	Attribute	Value
searchblox	licenseid	License value from license.xml file.
document	colname	Name of the Custom collection

Document Syntax

<?xml version="1.0" encoding="utf-8"?>
<searchblox>
<statuscode>100</statuscode>
<statusdesc>Document Indexed</statusdesc>
</searchblox>

Description

Status Code	Description
100	Document Indexed
101	Error Indexing Document
200	Document Deleted
201	Document requested for deletion does not exist
301	Document Not Found
400	Collection Cleared
401	Error Clearing Collection
500	Invalid Collection Name
501	Invalid Request
502	Invalid Document Location
503	Specified collection is not a CUSTOM collection
504	Licensed Document Limit Exceeded
601	Invalid LicenseID
602	Custom documents not supported by this edition of SearchBlox