http://www.xmlpipe.org/xpe/db/record

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
dict String false dictionary for binary store, required for binary store
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
recAccess String false Access policy for records Default to 'rwrwr-'
size int false The maximum size of each record Default to '1048576'
store String true The name of the store
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/unique/record/get

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
defaultSearch String false Default search param and value if no search parameters are supplied
dict String false dictionary for binary store, required for binary store
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String true list fields that require inverted indexes
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
limit int false Default limit Default to '10'
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
primaryKey String true The primary key of the db, records with the same key will be overwritten
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
resolve String false resolve a foreign key into a json object
reverse boolean false If set to true, reverse the listing order Default to 'false'
seqKey boolean false If set to true, will use sequntail key indexer Default to 'false'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
start int false The start index of search result Default to '-1'
startingId int false Default to '0'
store String true The name of the store
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/unique/record/get/xml

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
defaultSearch String false Default search param and value if no search parameters are supplied
dict String false dictionary for binary store, required for binary store
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String true list fields that require inverted indexes
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
limit int false Default limit Default to '10'
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
primaryKey String true The primary key of the db, records with the same key will be overwritten
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
resolve String false resolve a foreign key into a json object
reverse boolean false If set to true, reverse the listing order Default to 'false'
seqKey boolean false If set to true, will use sequntail key indexer Default to 'false'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
start int false The start index of search result Default to '-1'
startingId int false Default to '0'
store String true The name of the store
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/unique/record/del

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
dict String false dictionary for binary store, required for binary store
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String true list fields that require inverted indexes
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
primaryKey String true The primary key of the db, records with the same key will be overwritten
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
resolve String false resolve a foreign key into a json object
seqKey boolean false If set to true, will use sequntail key indexer Default to 'false'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
startingId int false Default to '0'
store String true The name of the store
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/unique/record/template

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
dict String false dictionary for binary store, required for binary store
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
recAccess String false Access policy for records Default to 'rwrwr-'
size int false The maximum size of each record Default to '1048576'
store String true The name of the store
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/unique/record/id

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
dict String false dictionary for binary store, required for binary store
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String true list fields that require inverted indexes
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
primaryKey String true The primary key of the db, records with the same key will be overwritten
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
resolve String false resolve a foreign key into a json object
seqKey boolean false If set to true, will use sequntail key indexer Default to 'false'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
startingId int false Default to '0'
store String true The name of the store
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/unique/record/post

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
dict String false dictionary for binary store, required for binary store
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String true list fields that require inverted indexes
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxRequestSize int false Maximum request size Default to '65536'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
primaryKey String true The primary key of the db, records with the same key will be overwritten
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
resolve String false resolve a foreign key into a json object
seqKey boolean false If set to true, will use sequntail key indexer Default to 'false'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
startingId int false Default to '0'
store String true The name of the store
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/pk

Parameter Type Required Help
store String true The name of the store

http://www.xmlpipe.org/xpe/db/pk/post

Parameter Type Required Help
store String true The name of the store

http://www.xmlpipe.org/xpe/db/search

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
cacheSize int false Default to '1024'
defaultSearch String false Default search param and value if no search parameters are supplied
dict String false dictionary for binary store, required for binary store
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String true list fields that require inverted indexes
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
initCapacity int false Default to '1024'
limit int false Default limit Default to '10'
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
ownerOnly boolean false Default to 'false'
queryFilter String false list params allowed separated by ','. Empty value will filter out all params. Wildcard '*' will allow all params. Default to '*'
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
resolve String false resolve a foreign key into a json object
reverse boolean false If set to true, reverse the listing order Default to 'false'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
start int false The start index of search result Default to '-1'
store String true The name of the store
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/suburb

Parameter Type Required Help

http://www.xmlpipe.org/xpe/db/search/template

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
cacheSize int false Default to '1024'
defaultSearch String false Default search param and value if no search parameters are supplied
dict String false dictionary for binary store, required for binary store
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String true list fields that require inverted indexes
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
initCapacity int false Default to '1024'
limit int false Default limit Default to '10'
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
ownerOnly boolean false Default to 'false'
queryFilter String false list params allowed separated by ','. Empty value will filter out all params. Wildcard '*' will allow all params. Default to '*'
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
resolve String false resolve a foreign key into a json object
reverse boolean false If set to true, reverse the listing order Default to 'false'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
start int false The start index of search result Default to '-1'
store String true The name of the store
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/validate

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/login

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
sessionIdName String false The cookie name of session id Default to 'xsid'
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/password/reset

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/password/reset/token

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/nonce

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
sessionIdName String false The cookie name of session id Default to 'xsid'
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/session/get

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
sessionIdName String false The cookie name of session id Default to 'xsid'
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/session/profile

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
sessionIdName String false The cookie name of session id Default to 'xsid'
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/session/list

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
sessionIdName String false The cookie name of session id Default to 'xsid'
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/session/changepassword

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
sessionIdName String false The cookie name of session id Default to 'xsid'
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/session/update

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
sessionIdName String false The cookie name of session id Default to 'xsid'
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/session/signoff

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
sessionIdName String false The cookie name of session id Default to 'xsid'
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/register

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/token/reset

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/admin/group

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
sessionIdName String false The cookie name of session id Default to 'xsid'
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/user/admin/del

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
activationMode int false Activation mode: 0-not required 1-manual 2-complete activation code Default to '0'
assignGroup String false assign groups to the root user Default to ''
capacity int false number of users allowed in the store Default to '1024'
dict String false dictionary for binary store, required for binary store
email String false root's email Default to 'root@sample.xml'
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
groups String false Default to 'guest'
listMask String false Default to 'id,username,email,group,profile'
loginTimeout int false timeout before a new nounce is generated, default to 2 mins Default to '120000'
maxProfileSize int false maximum size allowed for user profile Default to '8192'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
password String false root's password Default to 'changeme'
recAccess String false Access policy for records Default to 'rwrwr-'
root String false root's username
sessionIdName String false The cookie name of session id Default to 'xsid'
size int false The maximum size of each record Default to '1048576'
store String false Default to 'users.db'
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
tokenStoreSize int false Token store initial size, default to 16 Default to '16'
tokenStyle String false Token style: simple or normal. Simple style is a 5 digit numebr suitable for SMS while normal style is an encrypted message suitable for email Default to 'simple'
tokenTimeout int false timeout before a token expired, default to 30 mins Default to '1800000'
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/db/id

Parameter Type Required Help

http://www.xmlpipe.org/xpe/db/time

Parameter Type Required Help

http://www.xmlpipe.org/xpe/db/ad/next

Parameter Type Required Help

http://www.xmlpipe.org/xpe/db/ad/stat

Parameter Type Required Help

http://www.xmlpipe.org/xpe/db/resource/get

Parameter Type Required Help

http://www.xmlpipe.org/xpe/db/resource/list

Parameter Type Required Help

http://www.xmlpipe.org/xpe/db/resource/update

Parameter Type Required Help