Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

dsd-client-conn-lib

Package Overview
Dependencies
3
Maintainers
1
Versions
172
Issues
File Explorer

Advanced tools

dsd-client-conn-lib

Provides convenient way to call PDS server API of edzLabs.com's PDS service. Full API reference is located at [app.dase.io](https:*app.dase.io)

    3.3.3latest

Version published
Maintainers
1
Yearly downloads
8,276
decreased by-5.85%

Weekly downloads

Readme

Source

Description

Provides convenient way to call PDS server API of edzLabs.com's PDS service. Full API reference is located at app.dase.io

Examples

var CONN = require("dsd-client-conn-lib"); var dsdConn = CONN.connClient2; var dsdCst = CONN.Consts; //default host for all is "partner.dase.io" //but you may specify different hosts and ports like that: //dsdConn.setCoreServer({ host: "partner.dase.io", port: 5090 }); //dsdConn.setDaseServer({ host: "partner.dase.io", port: 5100 }); //dsdConn.setPdsServer({ host: "partner.dase.io", port: 5200 }); //dsdConn.setKeychainServer({ host: "partner.dase.io", port: 5110 }); function log(title, msg) { console.log(title, msg ? msg : ""); } log("sendSilver should success"); dsdConn.getCoreClient().sendSilver({ senderId: "0x003e8c791cb39b4cad756b9c25431d6eb3fed85c", senderPassword: "12345678", silverAmount: 100, toUserId: "0xb35ef3e31f2944d252eda42801caf5d890d1d7f9" }).then( ok => { log("sendSilver ok: ", ok); }, err => { log("sendSilver err: ", err); } ); log("sendSilver2 should error"); dsdConn.getDaseClient().sendSilver({ senderId: "0x003e8c791cb39b4cad756b9c25431d6eb3fed85c", senderPassword: "12345678", toUserId: "0xb35ef3e31f2944d252eda42801caf5d890d1d7f9" }).then( ok => { log("sendSilver2 ok: ", ok); }, err => { log("sendSilver2 err: ", err); //specify error handlers if necessary if(err.code === dsdCst.errorCodes.WrongParametersCount.id) { log("I have wrong parameters count..."+dsdCst.errorCodes.WrongParametersCount.name); //do something } else if(err.code === dsdCst.errorCodes.ServerSideError.id) { log("I have server error..."+ dsdCst.errorCodes.ServerSideError.name); //do something } } ); console.log("addDab should success"); dsdConn.getPdsClient().addDab({ ownerId: "0x003e8c791cb39b4cad756b9c25431d6eb3fed85c", assetUrl: "http:*localhost", ownerPassword: "12345678", publicDescription: "new client lib asset" }).then( ok => { log("addDab ok: ", ok); }, err => { log("addDab err: ", err); } );

API reference

Core API methods here

DASE API methods here

PDS API methods here

Keychain API methods here

Deprecated API

Core API methods here

DASE API methods here

PDS API methods here

Keychain API methods here

CORE API methods

(Back)

Functions

newUser(bchainTypeCode, credentials)Keys

Description: Method newUser

getLastBlock(bchainTypeCode)Integer

Description: Method getLastBlock

sendLeos(currencyTypeCode, senderId, senderCredentials, amount, toUserId)Integer

Description: Method sendLeos

transfer(srcCurrencyTypeCode, senderId, senderCredentials, srcLeosAmount)Integer

Description: Method transfer

silverCostInGold(userId, silverLeosAmount)Integer

Description: Method silverCostInGold

goldCostInSilver(userId, goldLeosAmount)Integer

Description: Method goldCostInSilver

completeAppCashProductPurchase(userId, paymentInfo, engineName)Integer

Description: Method completeAppCashProductPurchase

getAppCashProducts(appId, engineName)Object

Description: Method getAppCashProducts

sendWeis_Ethereum(sender, senderCredentials, receiver, weisAmount, databytes)Integer

Description: Method sendWeis_Ethereum

getSystemAccounts()Object

Description: Method getSystemAccounts

getBalances(zetUserId, ethUserId)Object

Description: Method getBalances

v_getEligibilityValue(userId)Integer

Description: Method v_getEligibilityValue

v_wantVote(userId, userCredentials, iWish)Boolean

Description: Method v_wantVote

v_supportVoter(userId, userCredentials, voterToSupport)Boolean

Description: Method v_supportVoter

v_getAccountsByCoinbases(coinbases)Array_of_Address

Description: Method v_getAccountsByCoinbases

v_getVoteCostInSilverLeos(userId)Integer

Description: Method v_getVoteCostInSilverLeos

v_getContractVoters(userId)Array_of_Address

Description: Method v_getContractVoters

v_getQuorumVoters()Array_of_Address

Description: Method v_getQuorumVoters

v_getCandidatesPool(userId)Array_of_Address

Description: Method v_getCandidatesPool

v_isInCandidatesPool(userId)Boolean

Description: Method v_isInCandidatesPool

v_hasPledge(userId)Boolean

Description: Method v_hasPledge

v_isLicensedForVoting(userId)Boolean

Description: Method v_isLicensedForVoting

getMyCoinbase()Address

Description: Method getMyCoinbase

v_withdrawPledge(userId, userCredentials)Boolean

Description: Method v_withdrawPledge

v_offerBuyVoting(userId, userCredentials, silverLeosAmount)Boolean

Description: Method v_offerBuyVoting

offerCurrencyExchangeGoldForWeis(sellerId, sellerCredentials, buyerId, goldLeosAmount, weisAmount)Boolean

Description: Method offerCurrencyExchangeGoldForWeis

offerCurrencyExchangeWeisForGold(sellerId, sellerCredentials, buyerId, goldLeosAmount, weisAmount)Boolean

Description: Method offerCurrencyExchangeWeisForGold

cancelCurrencyExchangeOffer(sellerId, sellerCredentials, offerId)Boolean

Description: Method cancelCurrencyExchangeOffer

getCurrencyExchangeOffers(userId, offersIds)Array_of_Object

Description: Method getCurrencyExchangeOffers

acceptCurrencyExchangeGoldForWeisOffer(buyerId, buyerCredentials, offerId, goldLeosAmount)Boolean

Description: Method acceptCurrencyExchangeGoldForWeisOffer

acceptCurrencyExchangeWeisForGoldOffer(buyerId, buyerCredentials, offerId, weisAmount)Boolean

Description: Method acceptCurrencyExchangeWeisForGoldOffer

rejectCurrencyExchangeOffer(buyerId, buyerCredentials, offerId)Boolean

Description: Method rejectCurrencyExchangeOffer

getCurrencyExchangeOffersIdsToMe(userId, pos, size)Array_of_Integer

Description: Method getCurrencyExchangeOffersIdsToMe

getCurrencyExchangeOffersCountToMe(userId)Integer

Description: Method getCurrencyExchangeOffersCountToMe

getCurrencyExchangeTradeHistory(tradeTypeCode, userId, startBlock)Array_of_Event

Description: Method getCurrencyExchangeTradeHistory

offerTokenExchangeGoldForPnft(sellerId, sellerCredentials, buyerId, goldLeosAmount, pnftId)Boolean

Description: Method offerTokenExchangeGoldForPnft

offerTokenExchangePnftForGold(sellerId, sellerCredentials, buyerId, goldLeosAmount, pnftId)Boolean

Description: Method offerTokenExchangePnftForGold

cancelTokenExchangeOffer(sellerId, sellerCredentials, offerId)Boolean

Description: Method cancelTokenExchangeOffer

getTokenExchangeOffers(userId, offersIds)Array_of_Object

Description: Method getTokenExchangeOffers

acceptTokenExchangeGoldForPnftOffer(buyerId, buyerCredentials, offerId, goldLeosAmount)Boolean

Description: Method acceptTokenExchangeGoldForPnftOffer

acceptTokenExchangePnftForGoldOffer(buyerId, buyerCredentials, offerId, pnftId)Boolean

Description: Method acceptTokenExchangePnftForGoldOffer

rejectTokenExchangeOffer(buyerId, buyerCredentials, offerId)Boolean

Description: Method rejectTokenExchangeOffer

getTokenExchangeOffersIdsToMe(userId, pos, size)Array_of_Integer

Description: Method getTokenExchangeOffersIdsToMe

getTokenExchangeOffersCountToMe(userId)Integer

Description: Method getTokenExchangeOffersCountToMe

getTokenExchangeTradeHistory(tradeTypeCode, userId, startBlock)Array_of_Event

Description: Method getTokenExchangeTradeHistory

importFromNft(userId, credentials, erc721Addr, tokenId, pnftId)Integer

Description: Method importFromNft

exportToNft(userId, credentials, pnftId)Boolean

Description: Method exportToNft

getPnft(pnftId)Object

Description: Method getPnft

erc721_safeTransferFrom(userId, credentials, erc721Addr, from, to, tokenId)Boolean

Description: Method erc721_safeTransferFrom

erc721_transferFrom(userId, credentials, erc721Addr, from, to, tokenId)Boolean

Description: Method erc721_transferFrom

erc721_approve(userId, credentials, erc721Addr, approved, tokenId)Boolean

Description: Method erc721_approve

erc721_setApprovalForAll(userId, credentials, erc721Addr, operator, approved)Boolean

Description: Method erc721_setApprovalForAll

erc721_balanceOf(erc721Addr, owner)Integer

Description: Method erc721_balanceOf

erc721_ownerOf(erc721Addr, tokenId)Address

Description: Method erc721_ownerOf

erc721_getApproved(erc721Addr, tokenId)Address

Description: Method erc721_getApproved

erc721_isApprovedForAll(erc721Addr, owner, operator)Boolean

Description: Method erc721_isApprovedForAll

erc721_tokenOfOwnerByIndex(erc721Addr, owner, index)Integer

Description: Method erc721_tokenOfOwnerByIndex

newUser(bchainTypeCode, credentials) ⇒ Keys

Description: Method newUser

Kind: global function
Returns: Keys - Look at Type description in Docs.

ParamTypeDescription
bchainTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
credentialsString(optional. default: null)

Example
1st:

Call (in pseudo-code):

newUser(1,'12345678');

Response json-data:

{"result":{"userId":"0xa6338a68b941684b5adb7524a06ccc396ebad5a6","pubKey":"0x0535aaa59911be010f44950df20f9b680b90f77f8d6b27fef5615b208dbdc20ca2ab237d56bd5d4aee340192e0f385e8a53d49d82e02b0d5e9dcec5abb845d31","prvKey":"0x43725c1cf6ae8ad9b88d0f49e24e2181c6ac5b9e01d4c00f578ae0909fdc07ea"}}

Example
2nd:

Call (in pseudo-code):

newUser(1,'12345678_Zetonium');

Response json-data:

{"result":{"userId":"0x5387953b5ae9761ba82381cd4bf90c0c2d610836","pubKey":"0x5749e2716c8e1f27f7f566ffef4c3862cc26fd4cfacb136c37a2f7f660b771ec9d7edb4cb0da980ceb9b8aef7bff16e6749be5627da182b79cc953831f7129f2","prvKey":"0xf3bfb49352772533c94e3363a64517e676e8cc802577045061002515114c143c"}}

Example
3th:

Call (in pseudo-code):

newUser(2,'12345678_Ethereum');

Response json-data:

{"result":{"userId":"0xec437de270daa9c9afbc431e8b280da08433c65e","pubKey":"0x8a84cff8fde8a9c2b3e166a846f1002903807238a0dfe78fd2b1837dc3e335b9ba296676e18c2f441a4e011f79d42444bb197c8e4517e5b4b24361e1f828027b","prvKey":"0xd53db5f115befcb00b7d3ea019daf731e2bfa72cfb0918de106664d79ce330ec"}}

getLastBlock(bchainTypeCode) ⇒ Integer

Description: Method getLastBlock

Kind: global function

ParamTypeDescription
bchainTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.

sendLeos(currencyTypeCode, senderId, senderCredentials, amount, toUserId) ⇒ Integer

Description: Method sendLeos

Kind: global function
Returns: Integer - newSrcBalance

ParamTypeDescription
currencyTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
senderIdAddress
senderCredentialsString
amountInteger
toUserIdAddress

Example
1st:

Call (in pseudo-code):

sendLeos(1,'0x003e8c791cb39b4cad756b9c25431d6eb3fed85c','12345678',500000000,'0xa6338a68b941684b5adb7524a06ccc396ebad5a6');

Response json-data:

{"result":"855736620000"}

Example
2nd:

Call (in pseudo-code):

sendLeos(1,'0x003e8c791cb39b4cad756b9c25431d6eb3fed85c','12345678',500000000,'0x9189313f9823231685571d81bc084f35617a9f4c');

Response json-data:

{"result":"855236620000"}

Example
3th:

Call (in pseudo-code):

sendLeos(1,'0x003e8c791cb39b4cad756b9c25431d6eb3fed85c','12345678',500000000,'0x14302f1785fd47583c929cf3684953116cbeaa95');

Response json-data:

{"result":"854736620000"}

transfer(srcCurrencyTypeCode, senderId, senderCredentials, srcLeosAmount) ⇒ Integer

Description: Method transfer

Kind: global function
Returns: Integer - newSrcBalance

ParamTypeDescription
srcCurrencyTypeCodeConstant_of_IntegerLook at Constants description in Docs.
senderIdAddress
senderCredentialsString
srcLeosAmountInteger

silverCostInGold(userId, silverLeosAmount) ⇒ Integer

Description: Method silverCostInGold

Kind: global function

ParamType
userIdAddress
silverLeosAmountInteger

goldCostInSilver(userId, goldLeosAmount) ⇒ Integer

Description: Method goldCostInSilver

Kind: global function

ParamType
userIdAddress
goldLeosAmountInteger

Example
1st:

Call (in pseudo-code):

goldCostInSilver('0xe7e0f3cddec426b44589cd1877f0aa392b207c13',1000000);

Response json-data:

{"result":"1000000"}

completeAppCashProductPurchase(userId, paymentInfo, engineName) ⇒ Integer

Description: Method completeAppCashProductPurchase

Kind: global function
Returns: Integer - statusCode

ParamType
userIdAddress
paymentInfoObject
engineNameString

getAppCashProducts(appId, engineName) ⇒ Object

Description: Method getAppCashProducts

Kind: global function
Returns: Object - products

ParamType
appIdString
engineNameString

sendWeis_Ethereum(sender, senderCredentials, receiver, weisAmount, databytes) ⇒ Integer

Description: Method sendWeis_Ethereum

Kind: global function
Returns: Integer - newSrcBalance

ParamType
senderAddress
senderCredentialsString
receiverAddress
weisAmountInteger
databytesString

Example
1st:

Call (in pseudo-code):

sendWeis_Ethereum('0x0c46effd09207e466fdf188ab12c352fbe3377ec','12345678','0xe7e0f3cddec426b44589cd1877f0aa392b207c13',100000,null);

Response json-data:

{"result":"9998999999999999400000"}

getSystemAccounts() ⇒ Object

Description: Method getSystemAccounts

Kind: global function

getBalances(zetUserId, ethUserId) ⇒ Object

Description: Method getBalances

Kind: global function

ParamTypeDescription
zetUserIdAddress(optional. default: null)
ethUserIdAddress(optional. default: null)

Example
1st:

Call (in pseudo-code):

getBalances('0xa6338a68b941684b5adb7524a06ccc396ebad5a6',null);

Response json-data:

{"result":{"silver_leos":"489000000"}}

Example
2nd:

Call (in pseudo-code):

getBalances('0x9189313f9823231685571d81bc084f35617a9f4c',null);

Response json-data:

{"result":{"silver_leos":"489000000"}}

Example
3th:

Call (in pseudo-code):

getBalances('0x14302f1785fd47583c929cf3684953116cbeaa95',null);

Response json-data:

{"result":{"silver_leos":"489000000"}}

v_getEligibilityValue(userId) ⇒ Integer

Description: Method v_getEligibilityValue

Kind: global function

ParamType
userIdAddress

v_wantVote(userId, userCredentials, iWish) ⇒ Boolean

Description: Method v_wantVote

Kind: global function
Returns: Boolean - isOk

ParamType
userIdAddress
userCredentialsString
iWishBoolean

v_supportVoter(userId, userCredentials, voterToSupport) ⇒ Boolean

Description: Method v_supportVoter

Kind: global function
Returns: Boolean - isOk

ParamType
userIdAddress
userCredentialsString
voterToSupportAddress

Example
1st:

Call (in pseudo-code):

v_supportVoter('0x003e8c791cb39b4cad756b9c25431d6eb3fed85c','12345678','0x082b4e4e0f686a9a249799acea9f05dc2fe83a4a');

Response json-data:

{"result":true}

v_getAccountsByCoinbases(coinbases) ⇒ Array_of_Address

Description: Method v_getAccountsByCoinbases

Kind: global function

ParamType
coinbasesArray_of_Address

v_getVoteCostInSilverLeos(userId) ⇒ Integer

Description: Method v_getVoteCostInSilverLeos

Kind: global function

ParamType
userIdAddress

v_getContractVoters(userId) ⇒ Array_of_Address

Description: Method v_getContractVoters

Kind: global function

ParamType
userIdAddress

v_getQuorumVoters() ⇒ Array_of_Address

Description: Method v_getQuorumVoters

Kind: global function

v_getCandidatesPool(userId) ⇒ Array_of_Address

Description: Method v_getCandidatesPool

Kind: global function

ParamType
userIdAddress

v_isInCandidatesPool(userId) ⇒ Boolean

Description: Method v_isInCandidatesPool

Kind: global function

ParamType
userIdAddress

v_hasPledge(userId) ⇒ Boolean

Description: Method v_hasPledge

Kind: global function

ParamType
userIdAddress

v_isLicensedForVoting(userId) ⇒ Boolean

Description: Method v_isLicensedForVoting

Kind: global function

ParamType
userIdAddress

getMyCoinbase() ⇒ Address

Description: Method getMyCoinbase

Kind: global function

v_withdrawPledge(userId, userCredentials) ⇒ Boolean

Description: Method v_withdrawPledge

Kind: global function
Returns: Boolean - isOk

ParamType
userIdAddress
userCredentialsString

v_offerBuyVoting(userId, userCredentials, silverLeosAmount) ⇒ Boolean

Description: Method v_offerBuyVoting

Kind: global function
Returns: Boolean - isOk

ParamType
userIdAddress
userCredentialsString
silverLeosAmountInteger

offerCurrencyExchangeGoldForWeis(sellerId, sellerCredentials, buyerId, goldLeosAmount, weisAmount) ⇒ Boolean

Description: Method offerCurrencyExchangeGoldForWeis

Kind: global function

ParamType
sellerIdAddress
sellerCredentialsString
buyerIdAddress
goldLeosAmountInteger
weisAmountInteger

offerCurrencyExchangeWeisForGold(sellerId, sellerCredentials, buyerId, goldLeosAmount, weisAmount) ⇒ Boolean

Description: Method offerCurrencyExchangeWeisForGold

Kind: global function

ParamType
sellerIdAddress
sellerCredentialsString
buyerIdAddress
goldLeosAmountInteger
weisAmountInteger

cancelCurrencyExchangeOffer(sellerId, sellerCredentials, offerId) ⇒ Boolean

Description: Method cancelCurrencyExchangeOffer

Kind: global function

ParamType
sellerIdAddress
sellerCredentialsString
offerIdInteger

getCurrencyExchangeOffers(userId, offersIds) ⇒ Array_of_Object

Description: Method getCurrencyExchangeOffers

Kind: global function

ParamType
userIdAddress
offersIdsArray_of_Integer

acceptCurrencyExchangeGoldForWeisOffer(buyerId, buyerCredentials, offerId, goldLeosAmount) ⇒ Boolean

Description: Method acceptCurrencyExchangeGoldForWeisOffer

Kind: global function

ParamType
buyerIdAddress
buyerCredentialsString
offerIdInteger
goldLeosAmountInteger

acceptCurrencyExchangeWeisForGoldOffer(buyerId, buyerCredentials, offerId, weisAmount) ⇒ Boolean

Description: Method acceptCurrencyExchangeWeisForGoldOffer

Kind: global function

ParamType
buyerIdAddress
buyerCredentialsString
offerIdInteger
weisAmountInteger

rejectCurrencyExchangeOffer(buyerId, buyerCredentials, offerId) ⇒ Boolean

Description: Method rejectCurrencyExchangeOffer

Kind: global function

ParamType
buyerIdAddress
buyerCredentialsString
offerIdInteger

getCurrencyExchangeOffersIdsToMe(userId, pos, size) ⇒ Array_of_Integer

Description: Method getCurrencyExchangeOffersIdsToMe

Kind: global function

ParamTypeDescription
userIdAddress
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getCurrencyExchangeOffersCountToMe(userId) ⇒ Integer

Description: Method getCurrencyExchangeOffersCountToMe

Kind: global function

ParamType
userIdAddress

getCurrencyExchangeTradeHistory(tradeTypeCode, userId, startBlock) ⇒ Array_of_Event

Description: Method getCurrencyExchangeTradeHistory

Kind: global function
Returns: Array_of_Event - Look at Type description in Docs.

ParamTypeDescription
tradeTypeCodeConstant_of_IntegerLook at Constants description in Docs.
userIdAddress
startBlockInteger

offerTokenExchangeGoldForPnft(sellerId, sellerCredentials, buyerId, goldLeosAmount, pnftId) ⇒ Boolean

Description: Method offerTokenExchangeGoldForPnft

Kind: global function

ParamType
sellerIdAddress
sellerCredentialsString
buyerIdAddress
goldLeosAmountInteger
pnftIdInteger

offerTokenExchangePnftForGold(sellerId, sellerCredentials, buyerId, goldLeosAmount, pnftId) ⇒ Boolean

Description: Method offerTokenExchangePnftForGold

Kind: global function

ParamType
sellerIdAddress
sellerCredentialsString
buyerIdAddress
goldLeosAmountInteger
pnftIdInteger

cancelTokenExchangeOffer(sellerId, sellerCredentials, offerId) ⇒ Boolean

Description: Method cancelTokenExchangeOffer

Kind: global function

ParamType
sellerIdAddress
sellerCredentialsString
offerIdInteger

getTokenExchangeOffers(userId, offersIds) ⇒ Array_of_Object

Description: Method getTokenExchangeOffers

Kind: global function

ParamType
userIdAddress
offersIdsArray_of_Integer

acceptTokenExchangeGoldForPnftOffer(buyerId, buyerCredentials, offerId, goldLeosAmount) ⇒ Boolean

Description: Method acceptTokenExchangeGoldForPnftOffer

Kind: global function

ParamType
buyerIdAddress
buyerCredentialsString
offerIdInteger
goldLeosAmountInteger

acceptTokenExchangePnftForGoldOffer(buyerId, buyerCredentials, offerId, pnftId) ⇒ Boolean

Description: Method acceptTokenExchangePnftForGoldOffer

Kind: global function

ParamType
buyerIdAddress
buyerCredentialsString
offerIdInteger
pnftIdInteger

rejectTokenExchangeOffer(buyerId, buyerCredentials, offerId) ⇒ Boolean

Description: Method rejectTokenExchangeOffer

Kind: global function

ParamType
buyerIdAddress
buyerCredentialsString
offerIdInteger

getTokenExchangeOffersIdsToMe(userId, pos, size) ⇒ Array_of_Integer

Description: Method getTokenExchangeOffersIdsToMe

Kind: global function

ParamTypeDescription
userIdAddress
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getTokenExchangeOffersCountToMe(userId) ⇒ Integer

Description: Method getTokenExchangeOffersCountToMe

Kind: global function

ParamType
userIdAddress

getTokenExchangeTradeHistory(tradeTypeCode, userId, startBlock) ⇒ Array_of_Event

Description: Method getTokenExchangeTradeHistory

Kind: global function
Returns: Array_of_Event - Look at Type description in Docs.

ParamTypeDescription
tradeTypeCodeConstant_of_IntegerLook at Constants description in Docs.
userIdAddress
startBlockInteger

importFromNft(userId, credentials, erc721Addr, tokenId, pnftId) ⇒ Integer

Description: Method importFromNft

Kind: global function
Returns: Integer - pnftId

ParamType
userIdAddress
credentialsString
erc721AddrAddress
tokenIdInteger
pnftIdInteger

exportToNft(userId, credentials, pnftId) ⇒ Boolean

Description: Method exportToNft

Kind: global function

ParamType
userIdAddress
credentialsString
pnftIdInteger

getPnft(pnftId) ⇒ Object

Description: Method getPnft

Kind: global function

ParamType
pnftIdInteger

erc721_safeTransferFrom(userId, credentials, erc721Addr, from, to, tokenId) ⇒ Boolean

Description: Method erc721_safeTransferFrom

Kind: global function

ParamTypeDescription
userIdAddress
credentialsString
erc721AddrAddress(optional. default: null)
fromAddress
toAddress
tokenIdInteger

erc721_transferFrom(userId, credentials, erc721Addr, from, to, tokenId) ⇒ Boolean

Description: Method erc721_transferFrom

Kind: global function

ParamTypeDescription
userIdAddress
credentialsString
erc721AddrAddress(optional. default: null)
fromAddress
toAddress
tokenIdInteger

erc721_approve(userId, credentials, erc721Addr, approved, tokenId) ⇒ Boolean

Description: Method erc721_approve

Kind: global function

ParamTypeDescription
userIdAddress
credentialsString
erc721AddrAddress(optional. default: null)
approvedAddress
tokenIdInteger

erc721_setApprovalForAll(userId, credentials, erc721Addr, operator, approved) ⇒ Boolean

Description: Method erc721_setApprovalForAll

Kind: global function

ParamTypeDescription
userIdAddress
credentialsString
erc721AddrAddress(optional. default: null)
operatorAddress
approvedBoolean

erc721_balanceOf(erc721Addr, owner) ⇒ Integer

Description: Method erc721_balanceOf

Kind: global function
Returns: Integer - numberOfNfts

ParamTypeDescription
erc721AddrAddress(optional. default: null)
ownerAddress

erc721_ownerOf(erc721Addr, tokenId) ⇒ Address

Description: Method erc721_ownerOf

Kind: global function
Returns: Address - owner

ParamTypeDescription
erc721AddrAddress(optional. default: null)
tokenIdInteger

erc721_getApproved(erc721Addr, tokenId) ⇒ Address

Description: Method erc721_getApproved

Kind: global function
Returns: Address - operator

ParamTypeDescription
erc721AddrAddress(optional. default: null)
tokenIdInteger

erc721_isApprovedForAll(erc721Addr, owner, operator) ⇒ Boolean

Description: Method erc721_isApprovedForAll

Kind: global function

ParamTypeDescription
erc721AddrAddress(optional. default: null)
ownerAddress
operatorAddress

erc721_tokenOfOwnerByIndex(erc721Addr, owner, index) ⇒ Integer

Description: Method erc721_tokenOfOwnerByIndex

Kind: global function
Returns: Integer - tokenId

ParamTypeDescription
erc721AddrAddress(optional. default: null)
ownerAddress
indexInteger

DASE API methods

(Back)

Functions

getCountOfSatsForTag(tagId, doFiltration, apiVersionCode)Integer

Description: Method getCountOfSatsForTag

getSatsForTag(tagId, pos, size, doFiltration, apiVersionCode)Array_of_Integer

Description: Method getSatsForTag

getSatLimitsForDab(dabId, apiVersionCode)Object

Description: Method getSatLimitsForDab

setSatLimitsForDab(dabOwnerId, dabOwnerCredentials, dabId, globalCountLimit, apiVersionCode)Object

Description: Method setSatLimitsForDab

createSat(satSellerId, satSellerCredentials, dabId, description, dealIndex, apiVersionCode)Integer

Description: Method createSat

linkSat(satSellerId, satSellerCredentials, satId, dabIds, apiVersionCode)Boolean

Description: Method linkSat

getCountOfSatsForDab(dabId, apiVersionCode)Integer

Description: Method getCountOfSatsForDab

getCountOfDabsForSat(satId, apiVersionCode)Integer

Description: Method getCountOfDabsForSat

getSatsForDab(dabId, pos, size, apiVersionCode)Array_of_Integer

Description: Method getSatsForDab

getDabsForSat(satId, pos, size, apiVersionCode)Array_of_Integer

Description: Method getDabsForSat

getTotalDealRoyaltyForDab(dabId)Integer

Description: Method getTotalDealRoyaltyForDab

addAsset(ownerId, ownerCredentials, assetUrl, publicDescription, linkedDabId, custodians, dataHash)Integer

Description: Method addAsset

addAssetsList(ownerId, ownerCredentials, dataArr)Array_of_Integer

Description: Method addAssetsList

addTag(ownerId, ownerCredentials, publicDescription, custodians, title, encryptedKey)Integer

Description: Method addTag

getDirectLabelsForDab(userId, dabId, pos, size)Array_of_Dab

Description: Method getDirectLabelsForDab

getDabs(userId, dabIds, dabTypeCode)Array_of_Asset

Description: Method getDabs

getDabPreviousVersionsIds(userId, dabId, maxLength)Array_of_Integer

Description: Method getDabPreviousVersionsIds

getTagEncryptedKey(buyerId, sellerId, tagId)Key

Description: Method getTagEncryptedKey

exploreLabelsHierarchy(userId, userCredentials, rootTagId, tagId, pos, size)Array_of_Dab

Description: Method exploreLabelsHierarchy

getCountForLicenseAgreements(userId, tradeTypeCode, dabTypeCode, licenseTypeCode, dabId)Integer

Description: Method getCountForLicenseAgreements

getCountForLicenseOffers(userId, offerDirectionTypeCode, tradeTypeCode, dabTypeCode, licenseTypeCode, dabId)Integer

Description: Method getCountForLicenseOffers

getCountForTradedDabs(userId, tradeTypeCode, dabTypeCode, licenseTypeCode)Integer

Description: Method getCountForTradedDabs

getCountForLabelsHierarchy(userId, userCredentials, rootTagId, tagId)Integer

Description: Method getCountForLabelsHierarchy

getCountForDirectLabelsForDab(userId, dabId)Integer

Description: Method getCountForDirectLabelsForDab

getLicenseAgreements(userId, tradeTypeCode, dabTypeCode, licenseTypeCode, dabId, pos, size)Array_of_License

Description: Method getLicenseAgreements

getLicenseOffers(userId, offerDirectionTypeCode, tradeTypeCode, dabTypeCode, licenseTypeCode, dabId, pos, size)Array_of_License

Description: Method getLicenseOffers

getTradedDabs(userId, tradeTypeCode, dabTypeCode, licenseTypeCode, pos, size)Array_of_Object

Description: Method getTradedDabs

getTradedDabsIds(userId, tradeTypeCode, dabTypeCode, licenseTypeCode, pos, size)Array_of_Object

Description: Method getTradedDabsIds

actualiseDeals(userId, userCredentials, tradeTypeCode, licenseTypeCode)Boolean

Description: Method actualiseDeals

marketSellLicenseOffer(sellerId, sellerCredentials, sellerDabId, buyerDabId, licenseTypeCode, minLeosPrice, maxSells, ttlInSec, licenseTermSheetTemplate, licenseTerms)Constant_of_Integer

Description: Method marketSellLicenseOffer

cancelMarketSellLicenseOffer(licenseTypeCode, userId, userCredentials, sellerDabId, buyerDabId)Boolean

Description: Method cancelMarketSellLicenseOffer

areVerifiedParticipants(sellerId, buyerId, dabId, licenseTypeCode)Boolean

Description: Method areVerifiedParticipants

marketSellRoyaltyLicenseOffer(sellerId, sellerCredentials, sellerDabId, minLeosPrice, dealPctg, usagePctg, maxSells, ttlInSec, termSheetTemplate, terms)Constant_of_Integer

Description: Method marketSellRoyaltyLicenseOffer

isRoyaltyRelationAllowed(paidDabId, beneficiaryDabId)Boolean

Description: Method isRoyaltyRelationAllowed

appendUserToDealVerifierList(restrictorId, restrictorCredentials, userRestrictedId, isSeller, isRestricted)Boolean

Description: Method appendUserToDealVerifierList

removeUserFromDealVerifierList(restrictorId, restrictorCredentials, userRestrictedId, isSeller, isRestricted)Boolean

Description: Method removeUserFromDealVerifierList

clearDealVerifierListByUsers(restrictorId, restrictorCredentials, isSeller, isRestricted)Boolean

Description: Method clearDealVerifierListByUsers

appendDabIdToDealVerifierList(restrictorId, restrictorCredentials, dabId, userRestrictedId, isSeller, isRestricted)Boolean

Description: Method appendDabIdToDealVerifierList

removeDabIdFromDealVerifierList(restrictorId, restrictorCredentials, dabId, userRestrictedId, isSeller, isRestricted)Boolean

Description: Method removeDabIdFromDealVerifierList

clearDealVerifierListByDabId(restrictorId, restrictorCredentials, dabId, isSeller, isRestricted)Boolean

Description: Method clearDealVerifierListByDabId

appendLicenseTypeToDealVerifierList(restrictorId, restrictorCredentials, licenseTypeCode, userRestrictedId, isSeller, isRestricted)Boolean

Description: Method appendLicenseTypeToDealVerifierList

removeLicenseTypeFromDealVerifierList(restrictorId, restrictorCredentials, licenseTypeCode, userRestrictedId, isSeller, isRestricted)Boolean

Description: Method removeLicenseTypeFromDealVerifierList

clearDealVerifierListByLicenseType(restrictorId, restrictorCredentials, licenseTypeCode, isSeller, isRestricted)Boolean

Description: Method clearDealVerifierListByLicenseType

getRestrictionsRange(restrictorId, isSeller, isRestricted, pos, size)Array_of_Address

Description: Method getRestrictionsRange

getRestrictionsRangeForDabId(restrictorId, dabId, isSeller, isRestricted, pos, size)Array_of_Address

Description: Method getRestrictionsRangeForDabId

getRestrictionsRangeForLicenseType(restrictorId, licenseTypeCode, isSeller, isRestricted, pos, size)Array_of_Address

Description: Method getRestrictionsRangeForLicenseType

getRestrictionsCount(restrictorId, isSeller, isRestricted)Integer

Description: Method getRestrictionsCount

getRestrictionsCountForDabId(restrictorId, dabId, isSeller, isRestricted)Integer

Description: Method getRestrictionsCountForDabId

getRestrictionsCountForLicenseType(restrictorId, licenseTypeCode, isSeller, isRestricted)Integer

Description: Method getRestrictionsCountForLicenseType

offerSellCommonLicense(licenseTypeCode, sellerId, sellerCredentials, buyerId, dabId, minLeosPrice, termSheetTemplate, terms)Constant_of_Integer

Description: Method offerSellCommonLicense

offerBuyCommonLicense(licenseTypeCode, buyerId, buyerCredentials, dabId, maxLeosPrice, termSheetTemplate, terms)Constant_of_Integer

Description: Method offerBuyCommonLicense

offerBuyAccessLicenseFromReseller(buyerId, buyerCredentials, dabId, maxLeosPrice, resellerId, termSheetTemplate, terms)Boolean

Description: Method offerBuyAccessLicenseFromReseller

offerSellExploreLicense(sellerId, sellerCredentials, buyerId, dabId, minLeosPrice, buyerPubKeyEncryptedTagKey, termSheetTemplate, terms)Constant_of_Integer

Description: Method offerSellExploreLicense

offerSellLabelLicense(licenseTypeCode, sellerId, sellerCredentials, buyerId, minLeosPrice, tagId, dabId, termSheetTemplate, terms)Constant_of_Integer

Description: Method offerSellLabelLicense

offerBuyLabelLicense(licenseTypeCode, buyerId, buyerCredentials, maxLeosPrice, tagId, dabId, termSheetTemplate, terms)Constant_of_Integer

Description: Method offerBuyLabelLicense

offerSellRoyaltyLicense(sellerId, sellerCredentials, buyerId, minLeosPrice, sellerDabId, buyerDabId, dealPctg, usagePctg, termSheetTemplate, terms)Constant_of_Integer

Description: Method offerSellRoyaltyLicense

offerBuyRoyaltyLicense(buyerId, buyerCredentials, maxLeosPrice, sellerDabId, buyerDabId, dealPctg, usagePctg, termSheetTemplate, terms)Constant_of_Integer

Description: Method offerBuyRoyaltyLicense

approveCommonLicenseDeal(licenseTypeCode, custodianId, custodianCredentials, buyerId, dabId)Boolean

Description: Method approveCommonLicenseDeal

approveLabelLicenseDeal(licenseTypeCode, custodianId, custodianCredentials, buyerId, tagId, dabId)Boolean

Description: Method approveLabelLicenseDeal

approveRoyaltyLicenseDeal(custodianId, custodianCredentials, buyerId, sellerDabId, buyerDabId)Boolean

Description: Method approveRoyaltyLicenseDeal

getCustodiansForCommonOffer(licenseTypeCode, buyerId, dabId)Object

Description: Method getCustodiansForCommonOffer

getCustodiansForLabelOffer(licenseTypeCode, buyerId, tagId, dabId)Object

Description: Method getCustodiansForLabelOffer

getCustodiansForRoyaltyOffer(buyerId, sellerDabId, buyerDabId)Object

Description: Method getCustodiansForRoyaltyOffer

smart_proposeRelation(relationTypeCode, eitherDabOwnerId, eitherDabOwnerCredentials, parentDabId, childDabId, termSheetTemplate, terms)Integer

Description: Method smart_proposeRelation

smart_destroyRelation(relationTypeCode, eitherDabOwnerId, eitherDabOwnerCredentials, parentDabId, childDabId, termSheetTemplate, terms)Integer

Description: Method smart_destroyRelation

smart_getDirectParentsForDab(relationTypeCode, dabId, pos, size)Array_of_Dab

Description: Method smart_getDirectParentsForDab

smart_getCountOfDirectParentsForDab(relationTypeCode, dabId)Integer

Description: Method smart_getCountOfDirectParentsForDab

smart_getDirectChildsForDab(relationTypeCode, dabId, pos, size)Array_of_Dab

Description: Method smart_getDirectChildsForDab

smart_getCountOfDirectChildsForDab(relationTypeCode, dabId)Integer

Description: Method smart_getCountOfDirectChildsForDab

smart_getAllParentsForDab(relationTypeCode, dabId, pos, size)Array_of_Dab

Description: Method smart_getAllParentsForDab

smart_getCountOfAllParentsForDab(relationTypeCode, dabId)Integer

Description: Method smart_getCountOfAllParentsForDab

smart_getAllChildsForDab(relationTypeCode, dabId, pos, size)Array_of_Dab

Description: Method smart_getAllChildsForDab

smart_getCountOfAllChildsForDab(relationTypeCode, dabId)Integer

Description: Method smart_getCountOfAllChildsForDab

smart_isHierarchicalChildOf(relationTypeCode, parentDabId, childDabId)Boolean

Description: Method smart_isHierarchicalChildOf

smart_isDirectChildOf(relationTypeCode, parentDabId, childDabId)Boolean

Description: Method smart_isDirectChildOf

smart_isAllowedRelation(relationTypeCode, parentDabId, childDabId)Boolean

Description: Method smart_isAllowedRelation

addRelation(userId, userCredentials, licenseTypeCode, fromDabId, toDabId, usageArgsTerms)Boolean

Description: Method addRelation

isHierarchicalChildOf(userId, parentDabId, dabId)Boolean

Description: Method isHierarchicalChildOf

cancelCommonLicenseOffer(licenseTypeCode, userId, userCredentials, buyerId, dabId)Boolean

Description: Method cancelCommonLicenseOffer

cancelLabelLicenseOffer(licenseTypeCode, userId, userCredentials, buyerId, tagId, dabId)Boolean

Description: Method cancelLabelLicenseOffer

cancelRoyaltyLicenseOffer(userId, userCredentials, buyerId, sellerDabId, buyerDabId)Boolean

Description: Method cancelRoyaltyLicenseOffer

revokeCommonLicenseDeal(licenseTypeCode, sellerId, sellerCredentials, buyerId, dabId)Boolean

Description: Method revokeCommonLicenseDeal

revokeSatCreateLicenseDeal(licenseTypeCode, sellerId, sellerCredentials, buyerId, dabId, dealIndex)Boolean

Description: Method revokeSatCreateLicenseDeal

revokeLabelLicenseDeal(licenseTypeCode, sellerId, sellerCredentials, buyerId, tagId, dabId)Boolean

Description: Method revokeLabelLicenseDeal

revokeRoyaltyLicenseDeal(sellerId, sellerCredentials, buyerId, sellerDabId, buyerDabId)Boolean

Description: Method revokeRoyaltyLicenseDeal

getLicenseUsageCount(userId, licenseTypeCode, dabId, buyerId)Integer

Description: Method getLicenseUsageCount

setPaymentSource(userId, credentials, termSheetTemplate, terms)Boolean

Description: Method setPaymentSource

getPaymentSource(userId)Object

Description: Method getPaymentSource

fundUser(funderId, funderCredentials, userToFund, termSheetTemplate, terms)Boolean

Description: Method fundUser

unfundUser(funderId, funderCredentials, userToUnfund)Boolean

Description: Method unfundUser

getFunders(userId)Array_of_Object

Description: Method getFunders

getUsersIFund(funderId, fromTimestampInSec, timeAmountInSec)Array_of_Address

Description: Method getUsersIFund

getFunderFundingHistory(funderId, pos, size, fromTimestampInSec, timeAmountInSec)Array_of_Object

Description: Method getFunderFundingHistory

getFunding(funderId, userId, fromTimestampInSec, timeAmountInSec)Array_of_Object

Description: Method getFunding

getFunderInfo(funderId, fromTimestampInSec, timeAmountInSec)Array_of_Object

Description: Method getFunderInfo

getFundedInfo(userId, fromTimestampInSec, timeAmountInSec)Array_of_Object

Description: Method getFundedInfo

getBalanceHistory(userId, pos, size, fromTimestampInSec, timeAmountInSec, isFlowIn)Array_of_Object

Description: Method getBalanceHistory

transferSync(srcBlockchainTypeCode, srcUserId, srcUserCredentials, dstUserId, dstUserCredentials, srcLeosAmount)Object

Description: Method transferSync

transferIn(dstBlockchainTypeCode, srcReqId, dstUserCredentials)Object

Description: Method transferIn

transferOut(srcBlockchainTypeCode, srcUserId, srcUserCredentials, dstUserId, srcLeosAmount)Object

Description: Method transferOut

getTransferStatus(srcBlockchainTypeCode, srcReqId)Object

Description: Method getTransferStatus

getIncompleteRequestsIds(srcBlockchainTypeCode, srcUserId, fromTimeInSec, timeAmountInSec)Array_of_Integer

Description: Method getIncompleteRequestsIds

sat_getPaired(satId, nftId, erc721Addr)Object

Description: Method sat_getPaired

sat_transferSync(srcBlockchainTypeCode, srcUserId, srcUserCredentials, dstUserId, dstUserCredentials, srcNftId)Object

Description: Method sat_transferSync

sat_transferIn(dstBlockchainTypeCode, srcReqId, dstUserCredentials)Object

Description: Method sat_transferIn

sat_transferOut(srcBlockchainTypeCode, srcUserId, srcUserCredentials, dstUserId, srcNftId)Object

Description: Method sat_transferOut

sat_getTransferStatus(srcBlockchainTypeCode, srcReqId)Object

Description: Method sat_getTransferStatus

sat_getIncompleteRequestsIds(srcBlockchainTypeCode, srcUserId, fromTimeInSec, timeAmountInSec)Array_of_Integer

Description: Method sat_getIncompleteRequestsIds

getCountOfSatsForTag(tagId, doFiltration, apiVersionCode) ⇒ Integer

Description: Method getCountOfSatsForTag

Kind: global function
Returns: Integer - countOfSats

ParamTypeDescription
tagIdInteger
doFiltrationBoolean(optional. default: false)
apiVersionCodeInteger(optional. default: 0)

getSatsForTag(tagId, pos, size, doFiltration, apiVersionCode) ⇒ Array_of_Integer

Description: Method getSatsForTag

Kind: global function
Returns: Array_of_Integer - satIds

ParamTypeDescription
tagIdInteger
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)
doFiltrationBoolean(optional. default: false)
apiVersionCodeInteger(optional. default: 0)

getSatLimitsForDab(dabId, apiVersionCode) ⇒ Object

Description: Method getSatLimitsForDab

Kind: global function

ParamTypeDescription
dabIdInteger
apiVersionCodeInteger(optional. default: 0)

setSatLimitsForDab(dabOwnerId, dabOwnerCredentials, dabId, globalCountLimit, apiVersionCode) ⇒ Object

Description: Method setSatLimitsForDab

Kind: global function
Returns: Object - isOk

ParamTypeDescription
dabOwnerIdAddress
dabOwnerCredentialsString
dabIdInteger
globalCountLimitInteger
apiVersionCodeInteger(optional. default: 0)

createSat(satSellerId, satSellerCredentials, dabId, description, dealIndex, apiVersionCode) ⇒ Integer

Description: Method createSat

Kind: global function
Returns: Integer - satId

ParamTypeDescription
satSellerIdAddress
satSellerCredentialsString
dabIdInteger
descriptionString(optional. default: "Regular SAT")
dealIndexInteger(optional. default: -1)
apiVersionCodeInteger(optional. default: 0)

linkSat(satSellerId, satSellerCredentials, satId, dabIds, apiVersionCode) ⇒ Boolean

Description: Method linkSat

Kind: global function
Returns: Boolean - isOk

ParamTypeDescription
satSellerIdAddress
satSellerCredentialsString
satIdInteger
dabIdsArray_of_Integer
apiVersionCodeInteger(optional. default: 0)

getCountOfSatsForDab(dabId, apiVersionCode) ⇒ Integer

Description: Method getCountOfSatsForDab

Kind: global function
Returns: Integer - countOfSats

ParamTypeDescription
dabIdInteger
apiVersionCodeInteger(optional. default: 0)

getCountOfDabsForSat(satId, apiVersionCode) ⇒ Integer

Description: Method getCountOfDabsForSat

Kind: global function
Returns: Integer - countOfDabs

ParamTypeDescription
satIdInteger
apiVersionCodeInteger(optional. default: 0)

getSatsForDab(dabId, pos, size, apiVersionCode) ⇒ Array_of_Integer

Description: Method getSatsForDab

Kind: global function
Returns: Array_of_Integer - satIds

ParamTypeDescription
dabIdInteger
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)
apiVersionCodeInteger(optional. default: 0)

getDabsForSat(satId, pos, size, apiVersionCode) ⇒ Array_of_Integer

Description: Method getDabsForSat

Kind: global function
Returns: Array_of_Integer - dabIds

ParamTypeDescription
satIdInteger
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)
apiVersionCodeInteger(optional. default: 0)

getTotalDealRoyaltyForDab(dabId) ⇒ Integer

Description: Method getTotalDealRoyaltyForDab

Kind: global function
Returns: Integer - percents

ParamType
dabIdInteger

addAsset(ownerId, ownerCredentials, assetUrl, publicDescription, linkedDabId, custodians, dataHash) ⇒ Integer

Description: Method addAsset

Kind: global function

ParamTypeDescription
ownerIdAddress
ownerCredentialsString
assetUrlString
publicDescriptionString
linkedDabIdInteger(optional. default: 0)
custodiansArray_of_Address(optional. default: [])
dataHashString(optional. default: 0)

addAssetsList(ownerId, ownerCredentials, dataArr) ⇒ Array_of_Integer

Description: Method addAssetsList

Kind: global function

ParamType
ownerIdAddress
ownerCredentialsString
dataArrArray_of_Object

Example
1st:

Call (in pseudo-code):

addAssetsList('0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678',[{'assetUrl':null,'publicDescription':'dab 01'},{'assetUrl':null,'publicDescription':'dab 02'},{'assetUrl':null,'publicDescription':'dab 03'}]);

Response json-data:

{"result":["639","640","641"]}

addTag(ownerId, ownerCredentials, publicDescription, custodians, title, encryptedKey) ⇒ Integer

Description: Method addTag

Kind: global function

ParamTypeDescription
ownerIdAddress
ownerCredentialsString
publicDescriptionString
custodiansArray_of_Address(optional. default: [])
titleString
encryptedKeyString(optional. default: null)

Example
1st:

Call (in pseudo-code):

addTag('0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678','custody-label/tag/description',[],'custody-label/tag/title',null);

Response json-data:

{"result":"568"}

Example
2nd:

Call (in pseudo-code):

addTag('0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678','custody-label/tag/description',[],'custody-label/tag/title',null);

Response json-data:

{"result":"569"}

Example
3th:

Call (in pseudo-code):

addTag('0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678','TAG description',[],'TAG title','TAG encryption key');

Response json-data:

{"result":"576"}

Example
4th:

Call (in pseudo-code):

addTag('0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','harmed_passwd_12345678','the tag should be created with correct password',[],'the tag should be created with correct password',null);

Response json-data:

{"result":"Invalid credentials (user's id/password) - account unlock was failed. For method addTag(0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2,harmed_passwd_12345678,the tag should be created with correct password,,the tag should be created with correct password,); "}

getDirectLabelsForDab(userId, dabId, pos, size) ⇒ Array_of_Dab

Description: Method getDirectLabelsForDab

Kind: global function
Returns: Array_of_Dab - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabIdInteger
posInteger(optional. default: 0)
sizeInteger(optional. default: 100)

Example
1st:

Call (in pseudo-code):

getDirectLabelsForDab('0xbf903df49703dd05709a9a3bb542d7229b3049c9','598',0,100);

Response json-data:

{"result":[{"dabId":"597","dabTypeCode":"2","description":"the buyer's tag to mark the seller's dab","ownerId":"0xbf903df49703dd05709a9a3bb542d7229b3049c9","custodians":[],"timestamp":"1579640973"}]}

Example
2nd:

Call (in pseudo-code):

getDirectLabelsForDab('0xbf903df49703dd05709a9a3bb542d7229b3049c9','600',0,100);

Response json-data:

{"result":[{"dabId":"599","dabTypeCode":"2","description":"the buyer's tag to mark the seller's dab","ownerId":"0xbf903df49703dd05709a9a3bb542d7229b3049c9","custodians":[],"timestamp":"1579640976"}]}

Example
3th:

Call (in pseudo-code):

getDirectLabelsForDab('0xbf903df49703dd05709a9a3bb542d7229b3049c9','602',0,100);

Response json-data:

{"result":[{"dabId":"601","dabTypeCode":"2","description":"the seller's tag to mark the buyer's dab","ownerId":"0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2","custodians":[],"timestamp":"1579640980"}]}

getDabs(userId, dabIds, dabTypeCode) ⇒ Array_of_Asset

Description: Method getDabs

Kind: global function
Returns: Array_of_Asset - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabIdsArray_of_Integer
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.

Example
1st:

Call (in pseudo-code):

getDabs('0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2',['575'],null);

Response json-data:

{"result":[{"dabId":"575","dabTypeCode":"1","description":"Data-asset for sell testing","ownerId":"0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2","custodians":[],"timestamp":"1579640642"}]}

Example
2nd:

Call (in pseudo-code):

getDabs('0xa6338a68b941684b5adb7524a06ccc396ebad5a6',['580'],null);

Response json-data:

{"result":[{"dabId":"580","dabTypeCode":"1","description":"Data-asset for sell testing","ownerId":"0xa6338a68b941684b5adb7524a06ccc396ebad5a6","custodians":[],"timestamp":"1579640735"}]}

Example
3th:

Call (in pseudo-code):

getDabs('0x9189313f9823231685571d81bc084f35617a9f4c',['581'],null);

Response json-data:

{"result":[{"dabId":"581","dabTypeCode":"1","description":"Data-asset for sell testing","ownerId":"0x9189313f9823231685571d81bc084f35617a9f4c","custodians":[],"timestamp":"1579640736"}]}

getDabPreviousVersionsIds(userId, dabId, maxLength) ⇒ Array_of_Integer

Description: Method getDabPreviousVersionsIds

Kind: global function

ParamTypeDescription
userIdAddress
dabIdInteger
maxLengthInteger(optional. default: 1)

getTagEncryptedKey(buyerId, sellerId, tagId) ⇒ Key

Description: Method getTagEncryptedKey

Kind: global function
Returns: Key - Look at Type description in Docs.

ParamType
buyerIdAddress
sellerIdAddress
tagIdInteger

exploreLabelsHierarchy(userId, userCredentials, rootTagId, tagId, pos, size) ⇒ Array_of_Dab

Description: Method exploreLabelsHierarchy

Kind: global function
Returns: Array_of_Dab - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
userCredentialsString
rootTagIdInteger
tagIdInteger
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getCountForLicenseAgreements(userId, tradeTypeCode, dabTypeCode, licenseTypeCode, dabId) ⇒ Integer

Description: Method getCountForLicenseAgreements

Kind: global function
Returns: Integer - count

ParamTypeDescription
userIdAddress
tradeTypeCodeConstant_of_IntegerLook at Constants description in Docs.
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
dabIdInteger(optional. default: null)

Example
1st:

Call (in pseudo-code):

getCountForLicenseAgreements('0xacb3a424d5e926e7e798b13190a25e11ba41884c',2,1,2,null);

Response json-data:

{"result":"3"}

getCountForLicenseOffers(userId, offerDirectionTypeCode, tradeTypeCode, dabTypeCode, licenseTypeCode, dabId) ⇒ Integer

Description: Method getCountForLicenseOffers

Kind: global function
Returns: Integer - count

ParamTypeDescription
userIdAddress
offerDirectionTypeCodeConstant_of_IntegerLook at Constants description in Docs.
tradeTypeCodeConstant_of_IntegerLook at Constants description in Docs.
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
dabIdInteger(optional. default: null)

Example
1st:

Call (in pseudo-code):

getCountForLicenseOffers('0xacb3a424d5e926e7e798b13190a25e11ba41884c',1,1,1,2,null);

Response json-data:

{"result":"0"}

Example
2nd:

Call (in pseudo-code):

getCountForLicenseOffers('0xacb3a424d5e926e7e798b13190a25e11ba41884c',1,1,1,1,null);

Response json-data:

{"result":"1"}

getCountForTradedDabs(userId, tradeTypeCode, dabTypeCode, licenseTypeCode) ⇒ Integer

Description: Method getCountForTradedDabs

Kind: global function
Returns: Integer - count

ParamTypeDescription
userIdAddress
tradeTypeCodeConstant_of_IntegerLook at Constants description in Docs.
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.

Example
1st:

Call (in pseudo-code):

getCountForTradedDabs('0xacb3a424d5e926e7e798b13190a25e11ba41884c',1,1,2);

Response json-data:

{"result":"1"}

getCountForLabelsHierarchy(userId, userCredentials, rootTagId, tagId) ⇒ Integer

Description: Method getCountForLabelsHierarchy

Kind: global function
Returns: Integer - count

ParamType
userIdAddress
userCredentialsString
rootTagIdInteger
tagIdInteger

Example
1st:

Call (in pseudo-code):

getCountForLabelsHierarchy('0xacb3a424d5e926e7e798b13190a25e11ba41884c','12345678',1,1);

Response json-data:

{"result":"0"}

getCountForDirectLabelsForDab(userId, dabId) ⇒ Integer

Description: Method getCountForDirectLabelsForDab

Kind: global function
Returns: Integer - count

ParamType
userIdAddress
dabIdInteger

Example
1st:

Call (in pseudo-code):

getCountForDirectLabelsForDab('0xacb3a424d5e926e7e798b13190a25e11ba41884c','673');

Response json-data:

{"result":"0"}

getLicenseAgreements(userId, tradeTypeCode, dabTypeCode, licenseTypeCode, dabId, pos, size) ⇒ Array_of_License

Description: Method getLicenseAgreements

Kind: global function
Returns: Array_of_License - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
tradeTypeCodeConstant_of_IntegerLook at Constants description in Docs.
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
dabIdInteger(optional. default: null)
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

Example
1st:

Call (in pseudo-code):

getLicenseAgreements('0xbf903df49703dd05709a9a3bb542d7229b3049c9',2,null,null,566,0,10);

Response json-data:

{"result":[{"dabId":"566","buyer":"0xBF903dF49703dD05709A9A3bB542D7229b3049c9","seller":"0xB9AC1D430841bC99B6C03E772E6F7d755eFb1dF2","timestamp":"1579640589","relatedDabId":"0","sellerReceivedValue":"14700000","buyerSpentValue":"25000000","dealRevokeValue":"15000000","sellOfferId":"143","buyOfferId":"148","stateBits":"1","totalUsageCount":"0","termSheetData":null,"termSheetTemplate":"licenseUnrestrictedTerms","licenseTypeCode":"2","dabTypeCode":"1"}]}

Example
2nd:

Call (in pseudo-code):

getLicenseAgreements('0xdfe1fcc2d0b7cc479b9b8a78fdbc58083779be40',2,null,610,583,0,10);

Response json-data:

{"result":[{"dabId":"583","buyer":"0xDFE1fCC2D0b7Cc479b9B8a78FdBC58083779bE40","seller":"0x9F97E747eACBDB78CFd422ED407C42fB9E78FFF3","timestamp":"1579640782","relatedDabId":"582","sellerReceivedValue":"98000000","buyerSpentValue":"110000000","dealRevokeValue":"100000000","sellOfferId":"77","buyOfferId":"55","stateBits":"1","totalUsageCount":"0","termSheetData":null,"termSheetTemplate":"licenseUnrestrictedTerms","licenseTypeCode":"610","dabTypeCode":"1"}]}

Example
3th:

Call (in pseudo-code):

getLicenseAgreements('0xef6bf44c7371a2dbcbc0a0c4a45ad7fc281b8195',2,null,2,587,0,10);

Response json-data:

{"result":[{"dabId":"587","buyer":"0xEf6bF44C7371A2DbcBc0A0C4A45ad7Fc281B8195","seller":"0x63Fc4DeC08384A2622a758fAF70Fb4CcbaC28790","timestamp":"1579640891","relatedDabId":"0","sellerReceivedValue":"14700000","buyerSpentValue":"25000000","dealRevokeValue":"15000000","sellOfferId":"153","buyOfferId":"158","stateBits":"1","totalUsageCount":"0","termSheetData":null,"termSheetTemplate":"licenseUnrestrictedTerms","licenseTypeCode":"2","dabTypeCode":"1"}]}

getLicenseOffers(userId, offerDirectionTypeCode, tradeTypeCode, dabTypeCode, licenseTypeCode, dabId, pos, size) ⇒ Array_of_License

Description: Method getLicenseOffers

Kind: global function
Returns: Array_of_License - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
offerDirectionTypeCodeConstant_of_IntegerLook at Constants description in Docs.
tradeTypeCodeConstant_of_IntegerLook at Constants description in Docs.
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
dabIdInteger(optional. default: null)
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

Example
1st:

Call (in pseudo-code):

getLicenseOffers('0x9f97e747eacbdb78cfd422ed407c42fb9e78fff3',2,1,null,null,null,0,1);

Response json-data:

{"result":[{"dabId":"583","buyer":"0xDFE1fCC2D0b7Cc479b9B8a78FdBC58083779bE40","termSheetData":null,"timestamp":"1579640779","relatedDabId":"582","seller":"0x9F97E747eACBDB78CFd422ED407C42fB9E78FFF3","termSheetTemplate":"licenseUnrestrictedTerms","sellerMinPrice":"100000000","licenseTypeCode":"610","dabTypeCode":"1"}]}

Example
2nd:

Call (in pseudo-code):

getLicenseOffers('0x0000000000000000000000000000000000000001',1,1,null,null,587,0,10);

Response json-data:

{"result":[{"dabId":"587","buyer":"0x0000000000000000000000000000000000000001","termSheetData":null,"timestamp":"1579640887","relatedDabId":"0","seller":"0x63Fc4DeC08384A2622a758fAF70Fb4CcbaC28790","termSheetTemplate":"licenseUnrestrictedTerms","sellerMinPrice":"15000000","licenseTypeCode":"2","dabTypeCode":"1"}]}

Example
3th:

Call (in pseudo-code):

getLicenseOffers('0x0000000000000000000000000000000000000001',1,1,null,null,588,0,10);

Response json-data:

{"result":[{"dabId":"588","buyer":"0x0000000000000000000000000000000000000001","termSheetData":null,"timestamp":"1579640892","relatedDabId":"0","seller":"0x02Cf3218906B3512cd9Eee3D43c15912a9f3558E","termSheetTemplate":"licenseUnrestrictedTerms","sellerMinPrice":"15000000","licenseTypeCode":"64","dabTypeCode":"1"}]}

getTradedDabs(userId, tradeTypeCode, dabTypeCode, licenseTypeCode, pos, size) ⇒ Array_of_Object

Description: Method getTradedDabs

Kind: global function
Returns: Array_of_Object - dabsAndLicensesCodes

ParamTypeDescription
userIdAddress
tradeTypeCodeConstant_of_IntegerLook at Constants description in Docs.
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getTradedDabsIds(userId, tradeTypeCode, dabTypeCode, licenseTypeCode, pos, size) ⇒ Array_of_Object

Description: Method getTradedDabsIds

Kind: global function
Returns: Array_of_Object - dabsIdsAndLicensesCodes

ParamTypeDescription
userIdAddress
tradeTypeCodeConstant_of_IntegerLook at Constants description in Docs.
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

actualiseDeals(userId, userCredentials, tradeTypeCode, licenseTypeCode) ⇒ Boolean

Description: Method actualiseDeals

Kind: global function

ParamTypeDescription
userIdAddress
userCredentialsString
tradeTypeCodeConstant_of_IntegerLook at Constants description in Docs.
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.

marketSellLicenseOffer(sellerId, sellerCredentials, sellerDabId, buyerDabId, licenseTypeCode, minLeosPrice, maxSells, ttlInSec, licenseTermSheetTemplate, licenseTerms) ⇒ Constant_of_Integer

Description: Method marketSellLicenseOffer

Kind: global function
Returns: Constant_of_Integer - tradeStatusCode Look at Constants description in Docs.

ParamTypeDescription
sellerIdAddress
sellerCredentialsString
sellerDabIdInteger
buyerDabIdInteger(optional. default: 0)
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
minLeosPriceInteger
maxSellsInteger(optional. default: -1)
ttlInSecInteger(optional. default: -1)
licenseTermSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
licenseTermsObject(optional. default: null)

Example
1st:

Call (in pseudo-code):

marketSellLicenseOffer('0x4e31c24881124358301e246ce5df77f42bcc0d99','123',587,0,2,15000000,-1,-1,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"401"}

Example
2nd:

Call (in pseudo-code):

marketSellLicenseOffer('0x63fc4dec08384a2622a758faf70fb4ccbac28790','12345678',587,0,2,15000000,-1,-1,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

Example
3th:

Call (in pseudo-code):

marketSellLicenseOffer('0x63fc4dec08384a2622a758faf70fb4ccbac28790','12345678','587',0,2,15000000,1,-1,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

cancelMarketSellLicenseOffer(licenseTypeCode, userId, userCredentials, sellerDabId, buyerDabId) ⇒ Boolean

Description: Method cancelMarketSellLicenseOffer

Kind: global function
Returns: Boolean - isOk

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
userIdAddress
userCredentialsString
sellerDabIdInteger
buyerDabIdInteger(optional. default: 0)

Example
1st:

Call (in pseudo-code):

cancelMarketSellLicenseOffer(610,'0x9f97e747eacbdb78cfd422ed407c42fb9e78fff3','12345678',583,0);

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

cancelMarketSellLicenseOffer(2,'0x63fc4dec08384a2622a758faf70fb4ccbac28790','12345678',587,0);

Response json-data:

{"result":true}

areVerifiedParticipants(sellerId, buyerId, dabId, licenseTypeCode) ⇒ Boolean

Description: Method areVerifiedParticipants

Kind: global function
Returns: Boolean - verified

ParamTypeDescription
sellerIdAddress
buyerIdAddress
dabIdInteger(optional. default: 0)
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.

Example
1st:

Call (in pseudo-code):

areVerifiedParticipants('0x003e8c791cb39b4cad756b9c25431d6eb3fed85c','0x34b50375e1b7a7588c93873852029563b9ed00f3',0,null);

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

areVerifiedParticipants('0x003e8c791cb39b4cad756b9c25431d6eb3fed85c','0x5b995cc4482793ff875a62f97112287cd7b9cc72','586',null);

Response json-data:

{"result":true}

Example
3th:

Call (in pseudo-code):

areVerifiedParticipants('0xc24aca7b98a980d5662a365d1609be436b2ce988','0xd27fdf74f0d03c4a8558b6b6c29367cf0c677e79',0,512);

Response json-data:

{"result":true}

marketSellRoyaltyLicenseOffer(sellerId, sellerCredentials, sellerDabId, minLeosPrice, dealPctg, usagePctg, maxSells, ttlInSec, termSheetTemplate, terms) ⇒ Constant_of_Integer

Description: Method marketSellRoyaltyLicenseOffer

Kind: global function
Returns: Constant_of_Integer - tradeStatusCode Look at Constants description in Docs.

ParamTypeDescription
sellerIdAddress
sellerCredentialsString
sellerDabIdInteger
minLeosPriceInteger
dealPctgInteger
usagePctgInteger
maxSellsInteger(optional. default: -1)
ttlInSecInteger(optional. default: -1)
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

Example
1st:

Call (in pseudo-code):

marketSellRoyaltyLicenseOffer('0x9f97e747eacbdb78cfd422ed407c42fb9e78fff3','12345678',583,20000000,30,20,-1,-1,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

isRoyaltyRelationAllowed(paidDabId, beneficiaryDabId) ⇒ Boolean

Description: Method isRoyaltyRelationAllowed

Kind: global function
Returns: Boolean - isAllowed

ParamType
paidDabIdInteger
beneficiaryDabIdInteger

Example
1st:

Call (in pseudo-code):

isRoyaltyRelationAllowed(577,580);

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

isRoyaltyRelationAllowed(577,581);

Response json-data:

{"result":true}

appendUserToDealVerifierList(restrictorId, restrictorCredentials, userRestrictedId, isSeller, isRestricted) ⇒ Boolean

Description: Method appendUserToDealVerifierList

Kind: global function
Returns: Boolean - isOk

ParamType
restrictorIdAddress
restrictorCredentialsString
userRestrictedIdAddress
isSellerBoolean
isRestrictedBoolean

Example
1st:

Call (in pseudo-code):

appendUserToDealVerifierList('0x5b995cc4482793ff875a62f97112287cd7b9cc72','12345678','0xd27fdf74f0d03c4a8558b6b6c29367cf0c677e79',true,true);

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

appendUserToDealVerifierList('0x46abca4bb6111a77ae95789ff961b230ef23a1e1','12345678','0xd27fdf74f0d03c4a8558b6b6c29367cf0c677e79',true,false);

Response json-data:

{"result":true}

Example
3th:

Call (in pseudo-code):

appendUserToDealVerifierList('0x7f17359d286eb7f85a1af110f7aaf5cdd4a6d687','12345678','0x46abca4bb6111a77ae95789ff961b230ef23a1e1',false,true);

Response json-data:

{"result":true}

removeUserFromDealVerifierList(restrictorId, restrictorCredentials, userRestrictedId, isSeller, isRestricted) ⇒ Boolean

Description: Method removeUserFromDealVerifierList

Kind: global function
Returns: Boolean - isOk

ParamType
restrictorIdAddress
restrictorCredentialsString
userRestrictedIdAddress
isSellerBoolean
isRestrictedBoolean

Example
1st:

Call (in pseudo-code):

removeUserFromDealVerifierList('0x7f17359d286eb7f85a1af110f7aaf5cdd4a6d687','12345678','0x46abca4bb6111a77ae95789ff961b230ef23a1e1',false,true);

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

removeUserFromDealVerifierList('0x7f17359d286eb7f85a1af110f7aaf5cdd4a6d687','12345678','0x46abca4bb6111a77ae95789ff961b230ef23a1e1',true,true);

Response json-data:

{"result":true}

Example
3th:

Call (in pseudo-code):

removeUserFromDealVerifierList('0x46abca4bb6111a77ae95789ff961b230ef23a1e1','12345678','0xd27fdf74f0d03c4a8558b6b6c29367cf0c677e79',true,false);

Response json-data:

{"result":true}

clearDealVerifierListByUsers(restrictorId, restrictorCredentials, isSeller, isRestricted) ⇒ Boolean

Description: Method clearDealVerifierListByUsers

Kind: global function
Returns: Boolean - isOk

ParamType
restrictorIdAddress
restrictorCredentialsString
isSellerBoolean
isRestrictedBoolean

appendDabIdToDealVerifierList(restrictorId, restrictorCredentials, dabId, userRestrictedId, isSeller, isRestricted) ⇒ Boolean

Description: Method appendDabIdToDealVerifierList

Kind: global function
Returns: Boolean - isOk

ParamType
restrictorIdAddress
restrictorCredentialsString
dabIdInteger
userRestrictedIdAddress
isSellerBoolean
isRestrictedBoolean

Example
1st:

Call (in pseudo-code):

appendDabIdToDealVerifierList('0x46abca4bb6111a77ae95789ff961b230ef23a1e1','12345678','584','0x46abca4bb6111a77ae95789ff961b230ef23a1e1',false,true);

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

appendDabIdToDealVerifierList('0x46abca4bb6111a77ae95789ff961b230ef23a1e1','12345678','584','0x46abca4bb6111a77ae95789ff961b230ef23a1e1',true,true);

Response json-data:

{"result":true}

Example
3th:

Call (in pseudo-code):

appendDabIdToDealVerifierList('0x46abca4bb6111a77ae95789ff961b230ef23a1e1','12345678','584','0x46abca4bb6111a77ae95789ff961b230ef23a1e1',false,false);

Response json-data:

{"result":true}

removeDabIdFromDealVerifierList(restrictorId, restrictorCredentials, dabId, userRestrictedId, isSeller, isRestricted) ⇒ Boolean

Description: Method removeDabIdFromDealVerifierList

Kind: global function
Returns: Boolean - isOk

ParamType
restrictorIdAddress
restrictorCredentialsString
dabIdInteger
userRestrictedIdAddress
isSellerBoolean
isRestrictedBoolean

Example
1st:

Call (in pseudo-code):

removeDabIdFromDealVerifierList('0x46abca4bb6111a77ae95789ff961b230ef23a1e1','12345678','584','0x46abca4bb6111a77ae95789ff961b230ef23a1e1',false,true);

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

removeDabIdFromDealVerifierList('0x46abca4bb6111a77ae95789ff961b230ef23a1e1','12345678','584','0x46abca4bb6111a77ae95789ff961b230ef23a1e1',true,true);

Response json-data:

{"result":true}

Example
3th:

Call (in pseudo-code):

removeDabIdFromDealVerifierList('0x46abca4bb6111a77ae95789ff961b230ef23a1e1','12345678','584','0x46abca4bb6111a77ae95789ff961b230ef23a1e1',true,false);

Response json-data:

{"result":true}

clearDealVerifierListByDabId(restrictorId, restrictorCredentials, dabId, isSeller, isRestricted) ⇒ Boolean

Description: Method clearDealVerifierListByDabId

Kind: global function
Returns: Boolean - isOk

ParamType
restrictorIdAddress
restrictorCredentialsString
dabIdInteger
isSellerBoolean
isRestrictedBoolean

appendLicenseTypeToDealVerifierList(restrictorId, restrictorCredentials, licenseTypeCode, userRestrictedId, isSeller, isRestricted) ⇒ Boolean

Description: Method appendLicenseTypeToDealVerifierList

Kind: global function
Returns: Boolean - isOk

ParamTypeDescription
restrictorIdAddress
restrictorCredentialsString
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
userRestrictedIdAddress
isSellerBoolean
isRestrictedBoolean

Example
1st:

Call (in pseudo-code):

appendLicenseTypeToDealVerifierList('0x5b995cc4482793ff875a62f97112287cd7b9cc72','12345678',600,'0x5b995cc4482793ff875a62f97112287cd7b9cc72',false,true);

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

appendLicenseTypeToDealVerifierList('0x5b995cc4482793ff875a62f97112287cd7b9cc72','12345678',600,'0x5b995cc4482793ff875a62f97112287cd7b9cc72',true,true);

Response json-data:

{"result":true}

removeLicenseTypeFromDealVerifierList(restrictorId, restrictorCredentials, licenseTypeCode, userRestrictedId, isSeller, isRestricted) ⇒ Boolean

Description: Method removeLicenseTypeFromDealVerifierList

Kind: global function
Returns: Boolean - isOk

ParamTypeDescription
restrictorIdAddress
restrictorCredentialsString
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
userRestrictedIdAddress
isSellerBoolean
isRestrictedBoolean

clearDealVerifierListByLicenseType(restrictorId, restrictorCredentials, licenseTypeCode, isSeller, isRestricted) ⇒ Boolean

Description: Method clearDealVerifierListByLicenseType

Kind: global function
Returns: Boolean - isOk

ParamTypeDescription
restrictorIdAddress
restrictorCredentialsString
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
isSellerBoolean
isRestrictedBoolean

getRestrictionsRange(restrictorId, isSeller, isRestricted, pos, size) ⇒ Array_of_Address

Description: Method getRestrictionsRange

Kind: global function
Returns: Array_of_Address - restricted

ParamTypeDescription
restrictorIdAddress
isSellerBoolean
isRestrictedBoolean
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

Example
1st:

Call (in pseudo-code):

getRestrictionsRange('0x7f17359d286eb7f85a1af110f7aaf5cdd4a6d687',false,true,0,10);

Response json-data:

{"result":["0x46AbcA4bb6111a77ae95789FF961B230EF23a1E1"]}

getRestrictionsRangeForDabId(restrictorId, dabId, isSeller, isRestricted, pos, size) ⇒ Array_of_Address

Description: Method getRestrictionsRangeForDabId

Kind: global function
Returns: Array_of_Address - restricted

ParamTypeDescription
restrictorIdAddress
dabIdInteger
isSellerBoolean
isRestrictedBoolean
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getRestrictionsRangeForLicenseType(restrictorId, licenseTypeCode, isSeller, isRestricted, pos, size) ⇒ Array_of_Address

Description: Method getRestrictionsRangeForLicenseType

Kind: global function
Returns: Array_of_Address - restricted

ParamTypeDescription
restrictorIdAddress
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
isSellerBoolean
isRestrictedBoolean
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getRestrictionsCount(restrictorId, isSeller, isRestricted) ⇒ Integer

Description: Method getRestrictionsCount

Kind: global function
Returns: Integer - count

ParamType
restrictorIdAddress
isSellerBoolean
isRestrictedBoolean

Example
1st:

Call (in pseudo-code):

getRestrictionsCount('0x003e8c791cb39b4cad756b9c25431d6eb3fed85c',false,false);

Response json-data:

{"result":"0"}

Example
2nd:

Call (in pseudo-code):

getRestrictionsCount('0x34b50375e1b7a7588c93873852029563b9ed00f3',false,false);

Response json-data:

{"result":"0"}

Example
3th:

Call (in pseudo-code):

getRestrictionsCount('0x003e8c791cb39b4cad756b9c25431d6eb3fed85c',false,true);

Response json-data:

{"result":"0"}

getRestrictionsCountForDabId(restrictorId, dabId, isSeller, isRestricted) ⇒ Integer

Description: Method getRestrictionsCountForDabId

Kind: global function
Returns: Integer - count

ParamType
restrictorIdAddress
dabIdInteger
isSellerBoolean
isRestrictedBoolean

Example
1st:

Call (in pseudo-code):

getRestrictionsCountForDabId('0x003e8c791cb39b4cad756b9c25431d6eb3fed85c','586',false,false);

Response json-data:

{"result":"0"}

Example
2nd:

Call (in pseudo-code):

getRestrictionsCountForDabId('0x34b50375e1b7a7588c93873852029563b9ed00f3','586',false,false);

Response json-data:

{"result":"0"}

Example
3th:

Call (in pseudo-code):

getRestrictionsCountForDabId('0x003e8c791cb39b4cad756b9c25431d6eb3fed85c','586',false,true);

Response json-data:

{"result":"0"}

getRestrictionsCountForLicenseType(restrictorId, licenseTypeCode, isSeller, isRestricted) ⇒ Integer

Description: Method getRestrictionsCountForLicenseType

Kind: global function
Returns: Integer - count

ParamTypeDescription
restrictorIdAddress
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
isSellerBoolean
isRestrictedBoolean

Example
1st:

Call (in pseudo-code):

getRestrictionsCountForLicenseType('0x003e8c791cb39b4cad756b9c25431d6eb3fed85c',512,false,false);

Response json-data:

{"result":"0"}

Example
2nd:

Call (in pseudo-code):

getRestrictionsCountForLicenseType('0x34b50375e1b7a7588c93873852029563b9ed00f3',512,false,false);

Response json-data:

{"result":"0"}

Example
3th:

Call (in pseudo-code):

getRestrictionsCountForLicenseType('0x003e8c791cb39b4cad756b9c25431d6eb3fed85c',512,false,true);

Response json-data:

{"result":"0"}

offerSellCommonLicense(licenseTypeCode, sellerId, sellerCredentials, buyerId, dabId, minLeosPrice, termSheetTemplate, terms) ⇒ Constant_of_Integer

Description: Method offerSellCommonLicense

Kind: global function
Returns: Constant_of_Integer - tradeStatusCode Look at Constants description in Docs.

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
sellerIdAddress
sellerCredentialsString
buyerIdAddress
dabIdInteger
minLeosPriceInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

Example
1st:

Call (in pseudo-code):

offerSellCommonLicense(2,'0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','566',15000000,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

Example
2nd:

Call (in pseudo-code):

offerSellCommonLicense(2,'0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','575',55000000,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

Example
3th:

Call (in pseudo-code):

offerSellCommonLicense(1,'0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678','0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','576',55000000,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

offerBuyCommonLicense(licenseTypeCode, buyerId, buyerCredentials, dabId, maxLeosPrice, termSheetTemplate, terms) ⇒ Constant_of_Integer

Description: Method offerBuyCommonLicense

Kind: global function
Returns: Constant_of_Integer - tradeStatusCode Look at Constants description in Docs.

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
buyerIdAddress
buyerCredentialsString
dabIdInteger
maxLeosPriceInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

Example
1st:

Call (in pseudo-code):

offerBuyCommonLicense(2,'0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678','566',15000000,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

Example
2nd:

Call (in pseudo-code):

offerBuyCommonLicense(1,'0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678',576,55000000,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

Example
3th:

Call (in pseudo-code):

offerBuyCommonLicense(2,'0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678',575,55000000,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

offerBuyAccessLicenseFromReseller(buyerId, buyerCredentials, dabId, maxLeosPrice, resellerId, termSheetTemplate, terms) ⇒ Boolean

Description: Method offerBuyAccessLicenseFromReseller

Kind: global function

ParamTypeDescription
buyerIdAddress
buyerCredentialsString
dabIdInteger
maxLeosPriceInteger
resellerIdAddress
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

Example
1st:

Call (in pseudo-code):

offerBuyAccessLicenseFromReseller('0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678',595,5000000,'0xb6cc85fb525c1686831fc1029fb0d96e19c532c9','licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

Example
2nd:

Call (in pseudo-code):

offerBuyAccessLicenseFromReseller('0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678',596,5000000,'0xb6cc85fb525c1686831fc1029fb0d96e19c532c9','licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

offerSellExploreLicense(sellerId, sellerCredentials, buyerId, dabId, minLeosPrice, buyerPubKeyEncryptedTagKey, termSheetTemplate, terms) ⇒ Constant_of_Integer

Description: Method offerSellExploreLicense

Kind: global function
Returns: Constant_of_Integer - tradeStatusCode Look at Constants description in Docs.

ParamTypeDescription
sellerIdAddress
sellerCredentialsString
buyerIdAddress
dabIdInteger
minLeosPriceInteger
buyerPubKeyEncryptedTagKeyString(optional. default: null)
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

offerSellLabelLicense(licenseTypeCode, sellerId, sellerCredentials, buyerId, minLeosPrice, tagId, dabId, termSheetTemplate, terms) ⇒ Constant_of_Integer

Description: Method offerSellLabelLicense

Kind: global function
Returns: Constant_of_Integer - tradeStatusCode Look at Constants description in Docs.

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
sellerIdAddress
sellerCredentialsString
buyerIdAddress
minLeosPriceInteger
tagIdInteger(optional. default: 0)
dabIdInteger(optional. default: 0)
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

Example
1st:

Call (in pseudo-code):

offerSellLabelLicense(8,'0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9',15000000,'568','567','licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

Example
2nd:

Call (in pseudo-code):

offerSellLabelLicense(16,'0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9',15000000,'569','570','licenseUnrestrictedTerms',null);

Response json-data:

{"result":"202"}

Example
3th:

Call (in pseudo-code):

offerSellLabelLicense(32,'0x14302f1785fd47583c929cf3684953116cbeaa95','12345678','0xc61481fff926a24145fd446863021b76c47bca12',55000000,577,0,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

offerBuyLabelLicense(licenseTypeCode, buyerId, buyerCredentials, maxLeosPrice, tagId, dabId, termSheetTemplate, terms) ⇒ Constant_of_Integer

Description: Method offerBuyLabelLicense

Kind: global function
Returns: Constant_of_Integer - tradeStatusCode Look at Constants description in Docs.

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
buyerIdAddress
buyerCredentialsString
maxLeosPriceInteger
tagIdInteger(optional. default: 0)
dabIdInteger(optional. default: 0)
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

Example
1st:

Call (in pseudo-code):

offerBuyLabelLicense(8,'0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678',15000000,'568','567','licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

Example
2nd:

Call (in pseudo-code):

offerBuyLabelLicense(16,'0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678',15000000,'569','570','licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

Example
3th:

Call (in pseudo-code):

offerBuyLabelLicense(32,'0xc61481fff926a24145fd446863021b76c47bca12','12345678',55000000,577,0,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"202"}

offerSellRoyaltyLicense(sellerId, sellerCredentials, buyerId, minLeosPrice, sellerDabId, buyerDabId, dealPctg, usagePctg, termSheetTemplate, terms) ⇒ Constant_of_Integer

Description: Method offerSellRoyaltyLicense

Kind: global function
Returns: Constant_of_Integer - tradeStatusCode Look at Constants description in Docs.

ParamTypeDescription
sellerIdAddress
sellerCredentialsString
buyerIdAddress
minLeosPriceInteger
sellerDabIdInteger
buyerDabIdInteger
dealPctgInteger
usagePctgInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

Example
1st:

Call (in pseudo-code):

offerSellRoyaltyLicense('0xa6338a68b941684b5adb7524a06ccc396ebad5a6','12345678','0x14302f1785fd47583c929cf3684953116cbeaa95',100000000,580,577,30,20,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

Example
2nd:

Call (in pseudo-code):

offerSellRoyaltyLicense('0x9189313f9823231685571d81bc084f35617a9f4c','12345678','0xc61481fff926a24145fd446863021b76c47bca12',100000000,581,578,40,20,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

Example
3th:

Call (in pseudo-code):

offerSellRoyaltyLicense('0x9189313f9823231685571d81bc084f35617a9f4c','12345678','0x14302f1785fd47583c929cf3684953116cbeaa95',100000000,581,577,100,10,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

offerBuyRoyaltyLicense(buyerId, buyerCredentials, maxLeosPrice, sellerDabId, buyerDabId, dealPctg, usagePctg, termSheetTemplate, terms) ⇒ Constant_of_Integer

Description: Method offerBuyRoyaltyLicense

Kind: global function
Returns: Constant_of_Integer - tradeStatusCode Look at Constants description in Docs.

ParamTypeDescription
buyerIdAddress
buyerCredentialsString
maxLeosPriceInteger
sellerDabIdInteger
buyerDabIdInteger
dealPctgInteger
usagePctgInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

Example
1st:

Call (in pseudo-code):

offerBuyRoyaltyLicense('0x14302f1785fd47583c929cf3684953116cbeaa95','12345678',100000000,580,577,30,20,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"202"}

Example
2nd:

Call (in pseudo-code):

offerBuyRoyaltyLicense('0xc61481fff926a24145fd446863021b76c47bca12','12345678',100000000,581,578,40,20,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"202"}

Example
3th:

Call (in pseudo-code):

offerBuyRoyaltyLicense('0x14302f1785fd47583c929cf3684953116cbeaa95','12345678',100000000,581,577,100,10,'licenseUnrestrictedTerms',null);

Response json-data:

{"result":"201"}

approveCommonLicenseDeal(licenseTypeCode, custodianId, custodianCredentials, buyerId, dabId) ⇒ Boolean

Description: Method approveCommonLicenseDeal

Kind: global function

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
custodianIdAddress
custodianCredentialsString
buyerIdAddress
dabIdInteger

Example
1st:

Call (in pseudo-code):

approveCommonLicenseDeal(2,'0xebe59080e76f895899d4258970336ab56bd90b29','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','566');

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

approveCommonLicenseDeal(2,'0xecd36c088f63bd991373566079729c59f1d72060','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','566');

Response json-data:

{"result":true}

approveLabelLicenseDeal(licenseTypeCode, custodianId, custodianCredentials, buyerId, tagId, dabId) ⇒ Boolean

Description: Method approveLabelLicenseDeal

Kind: global function

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
custodianIdAddress
custodianCredentialsString
buyerIdAddress
tagIdInteger(optional. default: 0)
dabIdInteger(optional. default: 0)

Example
1st:

Call (in pseudo-code):

approveLabelLicenseDeal(8,'0xecd36c088f63bd991373566079729c59f1d72060','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','568','567');

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

approveLabelLicenseDeal(8,'0xebe59080e76f895899d4258970336ab56bd90b29','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','568','567');

Response json-data:

{"result":true}

approveRoyaltyLicenseDeal(custodianId, custodianCredentials, buyerId, sellerDabId, buyerDabId) ⇒ Boolean

Description: Method approveRoyaltyLicenseDeal

Kind: global function

ParamType
custodianIdAddress
custodianCredentialsString
buyerIdAddress
sellerDabIdInteger
buyerDabIdInteger

Example
1st:

Call (in pseudo-code):

approveRoyaltyLicenseDeal('0xebe59080e76f895899d4258970336ab56bd90b29','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','567','568');

Response json-data:

{"result":true}

getCustodiansForCommonOffer(licenseTypeCode, buyerId, dabId) ⇒ Object

Description: Method getCustodiansForCommonOffer

Kind: global function
Returns: Object - custodiansArrays

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
buyerIdAddress
dabIdInteger

Example
1st:

Call (in pseudo-code):

getCustodiansForCommonOffer(2,'0xbf903df49703dd05709a9a3bb542d7229b3049c9','566');

Response json-data:

{"result":{"licenseTypeCode":"2","tradeId":"153","got":[],"need":["0xEcD36C088f63BD991373566079729c59F1D72060","0xEbe59080e76f895899D4258970336aB56Bd90B29"]}}

Example
2nd:

Call (in pseudo-code):

getCustodiansForCommonOffer(2,'0xbf903df49703dd05709a9a3bb542d7229b3049c9','567');

Response json-data:

{"result":{"licenseTypeCode":"2","tradeId":"0","got":[],"need":["0xEcD36C088f63BD991373566079729c59F1D72060","0xEbe59080e76f895899D4258970336aB56Bd90B29"]}}

getCustodiansForLabelOffer(licenseTypeCode, buyerId, tagId, dabId) ⇒ Object

Description: Method getCustodiansForLabelOffer

Kind: global function
Returns: Object - custodiansArrays

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
buyerIdAddress
tagIdInteger(optional. default: 0)
dabIdInteger(optional. default: 0)

Example
1st:

Call (in pseudo-code):

getCustodiansForLabelOffer(8,'0xbf903df49703dd05709a9a3bb542d7229b3049c9','568','567');

Response json-data:

{"result":{"licenseTypeCode":"8","tradeId":"0","got":[],"need":["0xEcD36C088f63BD991373566079729c59F1D72060","0xEbe59080e76f895899D4258970336aB56Bd90B29"]}}

Example
2nd:

Call (in pseudo-code):

getCustodiansForLabelOffer(16,'0xbf903df49703dd05709a9a3bb542d7229b3049c9','569','570');

Response json-data:

{"result":{"licenseTypeCode":"16","tradeId":"24","got":[],"need":[]}}

Example
3th:

Call (in pseudo-code):

getCustodiansForLabelOffer(8,'0xbf903df49703dd05709a9a3bb542d7229b3049c9','569','570');

Response json-data:

{"result":{"licenseTypeCode":"8","tradeId":"0","got":[],"need":["0xEcD36C088f63BD991373566079729c59F1D72060","0xEbe59080e76f895899D4258970336aB56Bd90B29"]}}

getCustodiansForRoyaltyOffer(buyerId, sellerDabId, buyerDabId) ⇒ Object

Description: Method getCustodiansForRoyaltyOffer

Kind: global function
Returns: Object - custodiansArrays

ParamType
buyerIdAddress
sellerDabIdInteger
buyerDabIdInteger

Example
1st:

Call (in pseudo-code):

getCustodiansForRoyaltyOffer('0xbf903df49703dd05709a9a3bb542d7229b3049c9','567','568');

Response json-data:

{"result":{"licenseTypeCode":"610","tradeId":"0","got":[],"need":["0xEcD36C088f63BD991373566079729c59F1D72060","0xEbe59080e76f895899D4258970336aB56Bd90B29"]}}

Example
2nd:

Call (in pseudo-code):

getCustodiansForRoyaltyOffer('0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','567','568');

Response json-data:

{"result":{"licenseTypeCode":"610","tradeId":"55","got":["0xEbe59080e76f895899D4258970336aB56Bd90B29"],"need":["0xEcD36C088f63BD991373566079729c59F1D72060"]}}

Example
3th:

Call (in pseudo-code):

getCustodiansForRoyaltyOffer('0xdfe1fcc2d0b7cc479b9b8a78fdbc58083779be40',583,582);

Response json-data:

{"result":{"licenseTypeCode":"610","tradeId":"0","got":[],"need":[]}}

smart_proposeRelation(relationTypeCode, eitherDabOwnerId, eitherDabOwnerCredentials, parentDabId, childDabId, termSheetTemplate, terms) ⇒ Integer

Description: Method smart_proposeRelation

Kind: global function
Returns: Integer - status

ParamTypeDescription
relationTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
eitherDabOwnerIdAddress
eitherDabOwnerCredentialsString
parentDabIdInteger
childDabIdInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

smart_destroyRelation(relationTypeCode, eitherDabOwnerId, eitherDabOwnerCredentials, parentDabId, childDabId, termSheetTemplate, terms) ⇒ Integer

Description: Method smart_destroyRelation

Kind: global function
Returns: Integer - status

ParamTypeDescription
relationTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
eitherDabOwnerIdAddress
eitherDabOwnerCredentialsString
parentDabIdInteger
childDabIdInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

smart_getDirectParentsForDab(relationTypeCode, dabId, pos, size) ⇒ Array_of_Dab

Description: Method smart_getDirectParentsForDab

Kind: global function
Returns: Array_of_Dab - Look at Type description in Docs.

ParamTypeDescription
relationTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
dabIdInteger
posInteger(optional. default: 0)
sizeInteger(optional. default: 100)

smart_getCountOfDirectParentsForDab(relationTypeCode, dabId) ⇒ Integer

Description: Method smart_getCountOfDirectParentsForDab

Kind: global function
Returns: Integer - count

ParamTypeDescription
relationTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
dabIdInteger

smart_getDirectChildsForDab(relationTypeCode, dabId, pos, size) ⇒ Array_of_Dab

Description: Method smart_getDirectChildsForDab

Kind: global function
Returns: Array_of_Dab - Look at Type description in Docs.

ParamTypeDescription
relationTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
dabIdInteger
posInteger(optional. default: 0)
sizeInteger(optional. default: 100)

smart_getCountOfDirectChildsForDab(relationTypeCode, dabId) ⇒ Integer

Description: Method smart_getCountOfDirectChildsForDab

Kind: global function
Returns: Integer - count

ParamTypeDescription
relationTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
dabIdInteger

smart_getAllParentsForDab(relationTypeCode, dabId, pos, size) ⇒ Array_of_Dab

Description: Method smart_getAllParentsForDab

Kind: global function
Returns: Array_of_Dab - Look at Type description in Docs.

ParamTypeDescription
relationTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
dabIdInteger
posInteger(optional. default: 0)
sizeInteger(optional. default: 100)

smart_getCountOfAllParentsForDab(relationTypeCode, dabId) ⇒ Integer

Description: Method smart_getCountOfAllParentsForDab

Kind: global function
Returns: Integer - count

ParamTypeDescription
relationTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
dabIdInteger

smart_getAllChildsForDab(relationTypeCode, dabId, pos, size) ⇒ Array_of_Dab

Description: Method smart_getAllChildsForDab

Kind: global function
Returns: Array_of_Dab - Look at Type description in Docs.

ParamTypeDescription
relationTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
dabIdInteger
posInteger(optional. default: 0)
sizeInteger(optional. default: 100)

smart_getCountOfAllChildsForDab(relationTypeCode, dabId) ⇒ Integer

Description: Method smart_getCountOfAllChildsForDab

Kind: global function
Returns: Integer - count

ParamTypeDescription
relationTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
dabIdInteger

smart_isHierarchicalChildOf(relationTypeCode, parentDabId, childDabId) ⇒ Boolean

Description: Method smart_isHierarchicalChildOf

Kind: global function

ParamTypeDescription
relationTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
parentDabIdInteger
childDabIdInteger

smart_isDirectChildOf(relationTypeCode, parentDabId, childDabId) ⇒ Boolean

Description: Method smart_isDirectChildOf

Kind: global function

ParamTypeDescription
relationTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
parentDabIdInteger
childDabIdInteger

smart_isAllowedRelation(relationTypeCode, parentDabId, childDabId) ⇒ Boolean

Description: Method smart_isAllowedRelation

Kind: global function

ParamTypeDescription
relationTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
parentDabIdInteger
childDabIdInteger

addRelation(userId, userCredentials, licenseTypeCode, fromDabId, toDabId, usageArgsTerms) ⇒ Boolean

Description: Method addRelation

Kind: global function

ParamTypeDescription
userIdAddress
userCredentialsString
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
fromDabIdInteger
toDabIdInteger
usageArgsTermsObject(optional. default: null)

Example
1st:

Call (in pseudo-code):

addRelation('0xc61481fff926a24145fd446863021b76c47bca12','12345678',1,'578','579',null);

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

addRelation('0xc61481fff926a24145fd446863021b76c47bca12','12345678',32,'577','578',null);

Response json-data:

{"result":true}

Example
3th:

Call (in pseudo-code):

addRelation('0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678',8,'597','598',null);

Response json-data:

{"result":true}

isHierarchicalChildOf(userId, parentDabId, dabId) ⇒ Boolean

Description: Method isHierarchicalChildOf

Kind: global function

ParamType
userIdAddress
parentDabIdInteger
dabIdInteger

cancelCommonLicenseOffer(licenseTypeCode, userId, userCredentials, buyerId, dabId) ⇒ Boolean

Description: Method cancelCommonLicenseOffer

Kind: global function
Returns: Boolean - isOk

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
userIdAddress
userCredentialsString
buyerIdAddress
dabIdInteger

Example
1st:

Call (in pseudo-code):

cancelCommonLicenseOffer(1,'0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678','0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','576');

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

cancelCommonLicenseOffer(2,'0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','575');

Response json-data:

{"result":true}

Example
3th:

Call (in pseudo-code):

cancelCommonLicenseOffer(1,'0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','621');

Response json-data:

{"result":true}

cancelLabelLicenseOffer(licenseTypeCode, userId, userCredentials, buyerId, tagId, dabId) ⇒ Boolean

Description: Method cancelLabelLicenseOffer

Kind: global function
Returns: Boolean - isOk

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
userIdAddress
userCredentialsString
buyerIdAddress
tagIdInteger(optional. default: 0)
dabIdInteger(optional. default: 0)

cancelRoyaltyLicenseOffer(userId, userCredentials, buyerId, sellerDabId, buyerDabId) ⇒ Boolean

Description: Method cancelRoyaltyLicenseOffer

Kind: global function
Returns: Boolean - isOk

ParamType
userIdAddress
userCredentialsString
buyerIdAddress
sellerDabIdInteger
buyerDabIdInteger

Example
1st:

Call (in pseudo-code):

cancelRoyaltyLicenseOffer('0x9f97e747eacbdb78cfd422ed407c42fb9e78fff3','12345678','0xdfe1fcc2d0b7cc479b9b8a78fdbc58083779be40',583,582);

Response json-data:

{"result":true}

revokeCommonLicenseDeal(licenseTypeCode, sellerId, sellerCredentials, buyerId, dabId) ⇒ Boolean

Description: Method revokeCommonLicenseDeal

Kind: global function
Returns: Boolean - isOk

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
sellerIdAddress
sellerCredentialsString
buyerIdAddress
dabIdInteger

Example
1st:

Call (in pseudo-code):

revokeCommonLicenseDeal(2,'0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','575');

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

revokeCommonLicenseDeal(4,'0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','626');

Response json-data:

{"result":true}

Example
3th:

Call (in pseudo-code):

revokeCommonLicenseDeal(2,'0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','627');

Response json-data:

{"result":true}

revokeSatCreateLicenseDeal(licenseTypeCode, sellerId, sellerCredentials, buyerId, dabId, dealIndex) ⇒ Boolean

Description: Method revokeSatCreateLicenseDeal

Kind: global function
Returns: Boolean - isOk

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
sellerIdAddress
sellerCredentialsString
buyerIdAddress
dabIdInteger
dealIndexInteger

revokeLabelLicenseDeal(licenseTypeCode, sellerId, sellerCredentials, buyerId, tagId, dabId) ⇒ Boolean

Description: Method revokeLabelLicenseDeal

Kind: global function
Returns: Boolean - isOk

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
sellerIdAddress
sellerCredentialsString
buyerIdAddress
tagIdInteger(optional. default: 0)
dabIdInteger(optional. default: 0)

Example
1st:

Call (in pseudo-code):

revokeLabelLicenseDeal(8,'0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','629','628');

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

revokeLabelLicenseDeal(8,'0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','631','630');

Response json-data:

{"result":true}

Example
3th:

Call (in pseudo-code):

revokeLabelLicenseDeal(16,'0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9','633','632');

Response json-data:

{"result":true}

revokeRoyaltyLicenseDeal(sellerId, sellerCredentials, buyerId, sellerDabId, buyerDabId) ⇒ Boolean

Description: Method revokeRoyaltyLicenseDeal

Kind: global function
Returns: Boolean - isOk

ParamType
sellerIdAddress
sellerCredentialsString
buyerIdAddress
sellerDabIdInteger
buyerDabIdInteger

Example
1st:

Call (in pseudo-code):

revokeRoyaltyLicenseDeal('0x9f97e747eacbdb78cfd422ed407c42fb9e78fff3','12345678','0xdfe1fcc2d0b7cc479b9b8a78fdbc58083779be40',583,582);

Response json-data:

{"result":true}

getLicenseUsageCount(userId, licenseTypeCode, dabId, buyerId) ⇒ Integer

Description: Method getLicenseUsageCount

Kind: global function
Returns: Integer - newCount

ParamTypeDescription
userIdAddress
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
dabIdInteger
buyerIdAddress

Example
1st:

Call (in pseudo-code):

getLicenseUsageCount('0xbf903df49703dd05709a9a3bb542d7229b3049c9',2,'649','0xbf903df49703dd05709a9a3bb542d7229b3049c9');

Response json-data:

{"result":"1"}

Example
2nd:

Call (in pseudo-code):

getLicenseUsageCount('0xbf903df49703dd05709a9a3bb542d7229b3049c9',256,'660','0xbf903df49703dd05709a9a3bb542d7229b3049c9');

Response json-data:

{"result":"0"}

Example
3th:

Call (in pseudo-code):

getLicenseUsageCount('0xbf903df49703dd05709a9a3bb542d7229b3049c9',256,'658','0xbf903df49703dd05709a9a3bb542d7229b3049c9');

Response json-data:

{"result":"0"}

setPaymentSource(userId, credentials, termSheetTemplate, terms) ⇒ Boolean

Description: Method setPaymentSource

Kind: global function
Returns: Boolean - isOk

ParamTypeDescription
userIdAddress
credentialsString
termSheetTemplateConstant_of_String(optional. default: "selfPaymentTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

Example
1st:

Call (in pseudo-code):

setPaymentSource('0x75d64f67fc606a882d395bb37143258bca57f26d','12345678','externalPaymentTerms',null);

Response json-data:

{"result":true}

getPaymentSource(userId) ⇒ Object

Description: Method getPaymentSource

Kind: global function
Returns: Object - source

ParamType
userIdAddress

Example
1st:

Call (in pseudo-code):

getPaymentSource('0x75d64f67fc606a882d395bb37143258bca57f26d');

Response json-data:

{"result":{"termSheetTemplate":"selfPaymentTerms","terms":null}}

fundUser(funderId, funderCredentials, userToFund, termSheetTemplate, terms) ⇒ Boolean

Description: Method fundUser

Kind: global function
Returns: Boolean - isOk

ParamTypeDescription
funderIdAddress
funderCredentialsString
userToFundAddress
termSheetTemplateConstant_of_String(optional. default: "fundingTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

Example
1st:

Call (in pseudo-code):

fundUser('0x0709833ca65d49c0ece401b2759b58f2e6b8fe37','12345678','0x75d64f67fc606a882d395bb37143258bca57f26d','fundingTerms',{'totalLeos':12000000});

Response json-data:

{"result":true}

Example
2nd:

Call (in pseudo-code):

fundUser('0x0709833ca65d49c0ece401b2759b58f2e6b8fe37','12345678','0x75d64f67fc606a882d395bb37143258bca57f26d','fundingTerms',{'totalLeos':22000000,'leosPerTx':11000000,'ttl':60});

Response json-data:

{"result":true}

Example
3th:

Call (in pseudo-code):

fundUser('0x0b8bbf228470d8c5d9d73a9294cb93d71c976110','12345678','0x75d64f67fc606a882d395bb37143258bca57f26d','fundingTerms',{'totalLeos':1000000});

Response json-data:

{"result":true}

unfundUser(funderId, funderCredentials, userToUnfund) ⇒ Boolean

Description: Method unfundUser

Kind: global function
Returns: Boolean - isOk

ParamType
funderIdAddress
funderCredentialsString
userToUnfundAddress

Example
1st:

Call (in pseudo-code):

unfundUser('0x0709833ca65d49c0ece401b2759b58f2e6b8fe37','12345678','0x75d64f67fc606a882d395bb37143258bca57f26d');

Response json-data:

{"result":true}

getFunders(userId) ⇒ Array_of_Object

Description: Method getFunders

Kind: global function
Returns: Array_of_Object - funders

ParamType
userIdAddress

Example
1st:

Call (in pseudo-code):

getFunders('0x75d64f67fc606a882d395bb37143258bca57f26d');

Response json-data:

{"result":[{"funderId":"0x0709833Ca65d49C0ece401b2759B58f2e6b8FE37","termSheetTemplate":"fundingTerms","terms":{"totalLeos":"12000001","leosPerTx":"0","lastBlockSec":"0"},"isActualTerms":true}]}

getUsersIFund(funderId, fromTimestampInSec, timeAmountInSec) ⇒ Array_of_Address

Description: Method getUsersIFund

Kind: global function
Returns: Array_of_Address - usersIds

ParamTypeDescription
funderIdAddress
fromTimestampInSecInteger
timeAmountInSecInteger(optional. default: 31536000)

getFunderFundingHistory(funderId, pos, size, fromTimestampInSec, timeAmountInSec) ⇒ Array_of_Object

Description: Method getFunderFundingHistory

Kind: global function
Returns: Array_of_Object - fundings

ParamTypeDescription
funderIdAddress
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)
fromTimestampInSecInteger(optional. default: 0)
timeAmountInSecInteger(optional. default: 2678400)

getFunding(funderId, userId, fromTimestampInSec, timeAmountInSec) ⇒ Array_of_Object

Description: Method getFunding

Kind: global function
Returns: Array_of_Object - fundings

ParamTypeDescription
funderIdAddress
userIdAddress
fromTimestampInSecInteger
timeAmountInSecInteger(optional. default: 2678400)

getFunderInfo(funderId, fromTimestampInSec, timeAmountInSec) ⇒ Array_of_Object

Description: Method getFunderInfo

Kind: global function
Returns: Array_of_Object - funderInfo

ParamTypeDescription
funderIdAddress
fromTimestampInSecInteger
timeAmountInSecInteger(optional. default: 2678400)

getFundedInfo(userId, fromTimestampInSec, timeAmountInSec) ⇒ Array_of_Object

Description: Method getFundedInfo

Kind: global function
Returns: Array_of_Object - fundedInfo

ParamTypeDescription
userIdAddress
fromTimestampInSecInteger
timeAmountInSecInteger(optional. default: 2678400)

getBalanceHistory(userId, pos, size, fromTimestampInSec, timeAmountInSec, isFlowIn) ⇒ Array_of_Object

Description: Method getBalanceHistory

Kind: global function
Returns: Array_of_Object - transfers

ParamTypeDescription
userIdAddress
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)
fromTimestampInSecInteger(optional. default: 0)
timeAmountInSecInteger(optional. default: 2678400)
isFlowInBoolean(optional. default: false)

transferSync(srcBlockchainTypeCode, srcUserId, srcUserCredentials, dstUserId, dstUserCredentials, srcLeosAmount) ⇒ Object

Description: Method transferSync

Kind: global function

ParamTypeDescription
srcBlockchainTypeCodeConstant_of_IntegerLook at Constants description in Docs.
srcUserIdAddress
srcUserCredentialsString
dstUserIdAddress
dstUserCredentialsString
srcLeosAmountInteger

transferIn(dstBlockchainTypeCode, srcReqId, dstUserCredentials) ⇒ Object

Description: Method transferIn

Kind: global function

ParamTypeDescription
dstBlockchainTypeCodeConstant_of_IntegerLook at Constants description in Docs.
srcReqIdInteger
dstUserCredentialsString

transferOut(srcBlockchainTypeCode, srcUserId, srcUserCredentials, dstUserId, srcLeosAmount) ⇒ Object

Description: Method transferOut

Kind: global function

ParamTypeDescription
srcBlockchainTypeCodeConstant_of_IntegerLook at Constants description in Docs.
srcUserIdAddress
srcUserCredentialsString
dstUserIdAddress
srcLeosAmountInteger

Example
1st:

Call (in pseudo-code):

transferOut(1,'0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678','0xe7e0f3cddec426b44589cd1877f0aa392b207c13',10000000);

Response json-data:

{"result":"7612000000"}

Example
2nd:

Call (in pseudo-code):

transferOut(1,'0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678','0xe7e0f3cddec426b44589cd1877f0aa392b207c13',20000000);

Response json-data:

{"result":"7522700000"}

Example
3th:

Call (in pseudo-code):

transferOut(2,'0xe7e0f3cddec426b44589cd1877f0aa392b207c13','12345678','0xbf903df49703dd05709a9a3bb542d7229b3049c9',5000000);

Response json-data:

{"result":"124989500"}

getTransferStatus(srcBlockchainTypeCode, srcReqId) ⇒ Object

Description: Method getTransferStatus

Kind: global function

ParamTypeDescription
srcBlockchainTypeCodeConstant_of_IntegerLook at Constants description in Docs.
srcReqIdInteger

getIncompleteRequestsIds(srcBlockchainTypeCode, srcUserId, fromTimeInSec, timeAmountInSec) ⇒ Array_of_Integer

Description: Method getIncompleteRequestsIds

Kind: global function

ParamTypeDescription
srcBlockchainTypeCodeConstant_of_IntegerLook at Constants description in Docs.
srcUserIdAddress
fromTimeInSecInteger
timeAmountInSecInteger

sat_getPaired(satId, nftId, erc721Addr) ⇒ Object

Description: Method sat_getPaired

Kind: global function
Returns: Object - pair

ParamTypeDescription
satIdInteger(optional. default: null)
nftIdInteger(optional. default: null)
erc721AddrAddress(optional. default: null)

sat_transferSync(srcBlockchainTypeCode, srcUserId, srcUserCredentials, dstUserId, dstUserCredentials, srcNftId) ⇒ Object

Description: Method sat_transferSync

Kind: global function

ParamTypeDescription
srcBlockchainTypeCodeConstant_of_IntegerLook at Constants description in Docs.
srcUserIdAddress
srcUserCredentialsString
dstUserIdAddress
dstUserCredentialsString
srcNftIdInteger

sat_transferIn(dstBlockchainTypeCode, srcReqId, dstUserCredentials) ⇒ Object

Description: Method sat_transferIn

Kind: global function

ParamTypeDescription
dstBlockchainTypeCodeConstant_of_IntegerLook at Constants description in Docs.
srcReqIdInteger
dstUserCredentialsString

sat_transferOut(srcBlockchainTypeCode, srcUserId, srcUserCredentials, dstUserId, srcNftId) ⇒ Object

Description: Method sat_transferOut

Kind: global function

ParamTypeDescription
srcBlockchainTypeCodeConstant_of_IntegerLook at Constants description in Docs.
srcUserIdAddress
srcUserCredentialsString
dstUserIdAddress
srcNftIdInteger

sat_getTransferStatus(srcBlockchainTypeCode, srcReqId) ⇒ Object

Description: Method sat_getTransferStatus

Kind: global function

ParamTypeDescription
srcBlockchainTypeCodeConstant_of_IntegerLook at Constants description in Docs.
srcReqIdInteger

sat_getIncompleteRequestsIds(srcBlockchainTypeCode, srcUserId, fromTimeInSec, timeAmountInSec) ⇒ Array_of_Integer

Description: Method sat_getIncompleteRequestsIds

Kind: global function

ParamTypeDescription
srcBlockchainTypeCodeConstant_of_IntegerLook at Constants description in Docs.
srcUserIdAddress
fromTimeInSecInteger
timeAmountInSecInteger

PDS API methods

(Back)

Functions

addAssetsList(ownerId, ownerCredentials, dataArr)Array_of_Integer

Description: Method addAssetsList

basket_putDab(ownerId, ownerCredentials, rootDabId, itemDabId)Boolean

Description: Method basket_putDab

basket_extractDab(ownerId, ownerCredentials, rootDabId, itemDabId)Boolean

Description: Method basket_extractDab

basket_rootDab(dabId)Integer

Description: Method basket_rootDab

getTotalBasketSellRoyaltyForDab(dabId)Integer

Description: Method getTotalBasketSellRoyaltyForDab

getTotalPnftTransferRoyaltyForDab(dabId)Integer

Description: Method getTotalPnftTransferRoyaltyForDab

basket_getDirectParentForDab(dabId)Dab

Description: Method basket_getDirectParentForDab

basket_getDirectChildsForDab(dabId, pos, size)Array_of_Dab

Description: Method basket_getDirectChildsForDab

basket_getCountOfDirectChildsForDab(dabId)Integer

Description: Method basket_getCountOfDirectChildsForDab

basket_isDirectChildOf(parentDabId, childDabId)Boolean

Description: Method basket_isDirectChildOf

basket_isAllowedRelation(parentDabId, childDabId)Boolean

Description: Method basket_isAllowedRelation

useBulkLicense(buyerId, buyerCredentials, dabId, tagId, bulkSellerId)Integer

Description: Method useBulkLicense

useLicenses(buyerId, buyerCredentials, dabIds, licenseTypeCode, termsArray)Array_of_Integer

Description: Method useLicenses

getPdsPublicKey()String

Description: Method getPdsPublicKey

getSystemInfo()Object

Description: Method getSystemInfo

getUploadTicket(userId, userPubKey, vaultId)Ticket

Description: Method getUploadTicket

getLicenseUsageHistory(userId, dabId, licenseTypeCode, fromTimestampInSec, timeAmountInSec)Array_of_Object

Description: Method getLicenseUsageHistory

getAccessTicketSecured(dealMessageId, buyerId, sellerId, argsBuyerSignature, publicKey, vaultAuth)Ticket

Description: Method getAccessTicketSecured

getAccessTickets(dabIds, buyerId, sellerIds, argsBuyerSignature, publicKey)Ticket

Description: Method getAccessTickets

getBulkAccessTicket(dabId, buyerId, bulkSellerId, tagId, argsBuyerSignature, publicKey)Ticket

Description: Method getBulkAccessTicket

getSatAccessTicket(dabId, buyerId, satId, argsBuyerSignature, publicKey, apiVersionCode)Ticket

Description: Method getSatAccessTicket

getCopyTicket(dabId, buyerId, argsBuyerSignature, publicKey)Ticket

Description: Method getCopyTicket

getAccessDab(dabId, buyerId, sellerId, argsBuyerSignature, publicKey)Dab

Description: Method getAccessDab

getBulkAccessDab(dabId, buyerId, bulkSellerId, tagId, argsBuyerSignature, publicKey)Dab

Description: Method getBulkAccessDab

encrypt(data)String

Description: Method encrypt

setUsp(userId, userPublicKey, vaultId, usp, argsSignature)Boolean

Description: Method setUsp

getUsp(userId, vaultId)String

Description: Method getUsp

setAak(userId, userPublicKey, dabId, aak, argsSignature)Boolean

Description: Method setAak

getAak(dabId)String

Description: Method getAak

getVaultsIds(userId, pos, size)Array_of_Integer

Description: Method getVaultsIds

isVaultedDab(dabId)Boolean

Description: Method isVaultedDab

getVaultById(userId, vaultId)Object

Description: Method getVaultById

addAssetsList(ownerId, ownerCredentials, dataArr) ⇒ Array_of_Integer

Description: Method addAssetsList

Kind: global function

ParamType
ownerIdAddress
ownerCredentialsString
dataArrArray_of_Object

Example
1st:

Call (in pseudo-code):

addAssetsList('0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','12345678',[{'assetUrl':null,'publicDescription':'dab 01'},{'assetUrl':null,'publicDescription':'dab 02'},{'assetUrl':null,'publicDescription':'dab 03'}]);

Response json-data:

{"result":["639","640","641"]}

basket_putDab(ownerId, ownerCredentials, rootDabId, itemDabId) ⇒ Boolean

Description: Method basket_putDab

Kind: global function
Returns: Boolean - isOk

ParamType
ownerIdAddress
ownerCredentialsString
rootDabIdInteger
itemDabIdInteger

basket_extractDab(ownerId, ownerCredentials, rootDabId, itemDabId) ⇒ Boolean

Description: Method basket_extractDab

Kind: global function
Returns: Boolean - isOk

ParamTypeDescription
ownerIdAddress
ownerCredentialsString
rootDabIdInteger(optional. default: 0)
itemDabIdInteger

basket_rootDab(dabId) ⇒ Integer

Description: Method basket_rootDab

Kind: global function
Returns: Integer - rootDabId

ParamType
dabIdInteger

getTotalBasketSellRoyaltyForDab(dabId) ⇒ Integer

Description: Method getTotalBasketSellRoyaltyForDab

Kind: global function
Returns: Integer - price

ParamType
dabIdInteger

getTotalPnftTransferRoyaltyForDab(dabId) ⇒ Integer

Description: Method getTotalPnftTransferRoyaltyForDab

Kind: global function
Returns: Integer - price

ParamType
dabIdInteger

basket_getDirectParentForDab(dabId) ⇒ Dab

Description: Method basket_getDirectParentForDab

Kind: global function
Returns: Dab - Look at Type description in Docs.

ParamType
dabIdInteger

basket_getDirectChildsForDab(dabId, pos, size) ⇒ Array_of_Dab

Description: Method basket_getDirectChildsForDab

Kind: global function
Returns: Array_of_Dab - Look at Type description in Docs.

ParamTypeDescription
dabIdInteger
posInteger(optional. default: 0)
sizeInteger(optional. default: 100)

basket_getCountOfDirectChildsForDab(dabId) ⇒ Integer

Description: Method basket_getCountOfDirectChildsForDab

Kind: global function
Returns: Integer - count

ParamType
dabIdInteger

basket_isDirectChildOf(parentDabId, childDabId) ⇒ Boolean

Description: Method basket_isDirectChildOf

Kind: global function

ParamType
parentDabIdInteger
childDabIdInteger

basket_isAllowedRelation(parentDabId, childDabId) ⇒ Boolean

Description: Method basket_isAllowedRelation

Kind: global function

ParamType
parentDabIdInteger
childDabIdInteger

useBulkLicense(buyerId, buyerCredentials, dabId, tagId, bulkSellerId) ⇒ Integer

Description: Method useBulkLicense

Kind: global function
Returns: Integer - newUsageCount

ParamType
buyerIdAddress
buyerCredentialsString
dabIdInteger
tagIdInteger
bulkSellerIdAddress

Example
1st:

Call (in pseudo-code):

useBulkLicense('0xa6338a68b941684b5adb7524a06ccc396ebad5a6','12345678','579',578,'0xc61481fff926a24145fd446863021b76c47bca12');

Response json-data:

{"result":"1"}

Example
2nd:

Call (in pseudo-code):

useBulkLicense('0x9189313f9823231685571d81bc084f35617a9f4c','12345678','578',577,'0x14302f1785fd47583c929cf3684953116cbeaa95');

Response json-data:

{"result":"1"}

Example
3th:

Call (in pseudo-code):

useBulkLicense('0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678','659','660','0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2');

Response json-data:

{"result":"1"}

useLicenses(buyerId, buyerCredentials, dabIds, licenseTypeCode, termsArray) ⇒ Array_of_Integer

Description: Method useLicenses

Kind: global function
Returns: Array_of_Integer - newUsageCounts

ParamTypeDescription
buyerIdAddress
buyerCredentialsString
dabIdsArray_of_Integer
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
termsArrayArray_of_Object(optional. default: [])

Example
1st:

Call (in pseudo-code):

useLicenses('0xbf903df49703dd05709a9a3bb542d7229b3049c9','12345678',['650','651'],2,[]);

Response json-data:

{"result":["1","1"]}

getPdsPublicKey() ⇒ String

Description: Method getPdsPublicKey

Kind: global function
Returns: String - pubKey
Example
1st:

Call (in pseudo-code):

getPdsPublicKey();

Response json-data:

{"result":"0x533cd169d224435cf9ae352736257a033ce591f8629d294800c3cc7960ac010f784082f236db170372811231de9a8738abf9e94ecfb9ce099bb0c2bda7a4d273"}

getSystemInfo() ⇒ Object

Description: Method getSystemInfo

Kind: global function
Returns: Object - systemInfo
Example
1st:

Call (in pseudo-code):

getSystemInfo();

Response json-data:

{"result":{"pdsPublicKey":"0x533cd169d224435cf9ae352736257a033ce591f8629d294800c3cc7960ac010f784082f236db170372811231de9a8738abf9e94ecfb9ce099bb0c2bda7a4d273","systemAccounts":{"edzLabs":"0x003e8c791cb39b4cad756b9c25431d6eb3fed85c","treasury":"0x003e8c791cb39b4cad756b9c25431d6eb3fed85c","treasuryPublic":"0x0709833ca65d49c0ece401b2759b58f2e6b8fe37","reactionsTreasury":"0x003e8c791cb39b4cad756b9c25431d6eb3fed85c"},"feesFor1000leos":{"zFee":"1000000","sendMoneyFee":"30","transferOutFee":"30","tradeSellerGets":"980","tradeBuyerSpends":"10001000","depositFee":"10000000"}}}

getUploadTicket(userId, userPubKey, vaultId) ⇒ Ticket

Description: Method getUploadTicket

Kind: global function
Returns: Ticket - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
userPubKeyString(optional. default: null)
vaultIdInteger(optional. default: 1)

Example
1st:

Call (in pseudo-code):

getUploadTicket('0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','0x04da11059055b2b4f12f6e89f330308ed1289b3c1f7987830ab8f9c013fc9831849f291b9f2dcf92b549bf8e7baa2f1c8a8b0a90210ae931398cbdd2ce90364d52','1');

Response json-data:

{"result":{"id":"tid-637166.232378","type":"create","creationTimeInMs":"1579641133138","timeToLiveInMs":"1200000","userId":"0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2","assetUrl":null,"vaultUrl":"https://partner.dase.io:5081","vaultAuth":"ed1aef1da30d1537a841eef97c3e928124cc5a6bd5e45bb138ec7ff42c713ab65f07a6a32d18ab62abbf92a0c4e47c6cc55e52b94377f46d172e1333c2078e9f880780294b47ac071772666037d04c5224006a494cee95ad386f363a0a097fc991c7adf4","nonce":"n-575368","checksum":null,"pubKey":"0x04da11059055b2b4f12f6e89f330308ed1289b3c1f7987830ab8f9c013fc9831849f291b9f2dcf92b549bf8e7baa2f1c8a8b0a90210ae931398cbdd2ce90364d52","signature":"3044022027adda872c1fef13d8ec5c28d77ca33100f8221a558f06b0ecc53e34e577eac5022063775fbc3d8565402c262dc3e298e14dc541b7d3bb2b3f9fdffd66138e537ca0"}}

getLicenseUsageHistory(userId, dabId, licenseTypeCode, fromTimestampInSec, timeAmountInSec) ⇒ Array_of_Object

Description: Method getLicenseUsageHistory

Kind: global function
Returns: Array_of_Object - usages

ParamTypeDescription
userIdAddress
dabIdInteger
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
fromTimestampInSecInteger
timeAmountInSecInteger(optional. default: 31536000)

getAccessTicketSecured(dealMessageId, buyerId, sellerId, argsBuyerSignature, publicKey, vaultAuth) ⇒ Ticket

Description: Method getAccessTicketSecured

Kind: global function
Returns: Ticket - Look at Type description in Docs.

ParamTypeDescription
dealMessageIdInteger
buyerIdAddress
sellerIdAddress
argsBuyerSignatureString
publicKeyString
vaultAuthObject(optional. default: null)

getAccessTickets(dabIds, buyerId, sellerIds, argsBuyerSignature, publicKey) ⇒ Ticket

Description: Method getAccessTickets

Kind: global function
Returns: Ticket - Look at Type description in Docs.

ParamType
dabIdsArray_of_Integer
buyerIdAddress
sellerIdsArray_of_Address
argsBuyerSignatureString
publicKeyString

Example
1st:

Call (in pseudo-code):

getAccessTickets(['593'],'0xbf903df49703dd05709a9a3bb542d7229b3049c9',['0xbf903df49703dd05709a9a3bb542d7229b3049c9'],'30460221009d2be0357e6a0f1394ecd093c7dece1d129c50d62d45c2bab2a2facfe9ea6248022100ddc14f2151eb6a121ea91c36a812b064a52f63123962b9618e9601f17376ec14','0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7');

Response json-data:

{"result":[{"id":"tid-140775.248061","type":"read","creationTimeInMs":"1579640939399","timeToLiveInMs":"1200000","userId":"0xbf903df49703dd05709a9a3bb542d7229b3049c9","assetUrl":"proto://[email protected]/path/to/asset","vaultUrl":null,"vaultAuth":null,"nonce":"n-345068","checksum":null,"pubKey":"0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7","signature":"304502210085ecdad2a070a5ba8a197264bb34dcdd146d9448701697cecdf13c63ae9fbf9502201205cb07e0483beffc73f1881a344de23d16f4fb56212010882ba6d52645d436"}]}

Example
2nd:

Call (in pseudo-code):

getAccessTickets(['595'],'0xbf903df49703dd05709a9a3bb542d7229b3049c9',['0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2'],'304502205cf66be072c9ad217fae84b4044d1cab9d00c3c82a66702f215631e2c5f60fcf022100848ba6fb64eb8084af2bbc31d62781ba6ee4eb9c27c1372d50869e8dfbcc99c2','0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7');

Response json-data:

{"result":[{"id":"tid-707711.72273","type":"read","creationTimeInMs":"1579640967674","timeToLiveInMs":"1200000","userId":"0xbf903df49703dd05709a9a3bb542d7229b3049c9","assetUrl":"proto://[email protected]/path/to/asset","vaultUrl":null,"vaultAuth":null,"nonce":"n-874048","checksum":null,"pubKey":"0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7","signature":"3044022043eee7e0b07a934d335f009350c9ceddde52911923e92a9c1ea6354bbded86c8022064bbf7decc8dfee217ba7391b21e12ef6f0e93406a56007291b839ac91a56491"}]}

Example
3th:

Call (in pseudo-code):

getAccessTickets(['644'],'0xbf903df49703dd05709a9a3bb542d7229b3049c9',['0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2'],'3046022100fafc4690045eaff32487170d2d2eb17fd8ed0882b5d494f3a83c1dbd2cbfdd81022100f275efbcc2a28b208e2a44516f42c681fdc694315947c3eb20d47c5697a83584','0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7');

Response json-data:

{"result":[{"id":"tid-790281.203262","type":"read","creationTimeInMs":"1579641100862","timeToLiveInMs":"1200000","userId":"0xbf903df49703dd05709a9a3bb542d7229b3049c9","assetUrl":"proto://[email protected]/path/to/asset","vaultUrl":null,"vaultAuth":null,"nonce":"n-822299","checksum":null,"pubKey":"0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7","signature":"3045022100b4fdca6b8cd8f7488a032556bce09411764af657f79509c2b5fbf843d8a932ef022023e4ba3f56ddb5c47eb668f64beedb1d419d2a0a3f0b30b23217813805ce175c"}]}

Example
4th:

Call (in pseudo-code):

getAccessTickets(['648'],'0xbf903df49703dd05709a9a3bb542d7229b3049c9',['0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2'],'30460221009521d160b62c88039259956abb9f794c9e013404f4956ec840e1c0df6b4dc7a0022100ea1651607e5376481587a01a418176dcd36f33a4ef186c7f33b57297dab3daf0','0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7');

Response json-data:

{"result":"Invalid request (wrong method or parameters). For method getAccessTickets(648,0xbf903df49703dd05709a9a3bb542d7229b3049c9,0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2,30460221009521d160b62c88039259956abb9f794c9e013404f4956ec840e1c0df6b4dc7a0022100ea1651607e5376481587a01a418176dcd36f33a4ef186c7f33b57297dab3daf0,0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7); Error: Access denied..."}

Example
5th:

Call (in pseudo-code):

getAccessTickets(['649'],'0xbf903df49703dd05709a9a3bb542d7229b3049c9',['0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2'],'3046022100897a133ccce335d14eefa12a3fa4194bfa822d44d2b5c944cc7c07ce8485649702210084bd5613415bcce99f2cbb35122745a0d0e49f25ce462c624355a25898852241','0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7');

Response json-data:

{"result":"Invalid request (wrong method or parameters). For method getAccessTickets(649,0xbf903df49703dd05709a9a3bb542d7229b3049c9,0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2,3046022100897a133ccce335d14eefa12a3fa4194bfa822d44d2b5c944cc7c07ce8485649702210084bd5613415bcce99f2cbb35122745a0d0e49f25ce462c624355a25898852241,0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7); Error: Access denied..."}

getBulkAccessTicket(dabId, buyerId, bulkSellerId, tagId, argsBuyerSignature, publicKey) ⇒ Ticket

Description: Method getBulkAccessTicket

Kind: global function
Returns: Ticket - Look at Type description in Docs.

ParamType
dabIdInteger
buyerIdAddress
bulkSellerIdAddress
tagIdInteger
argsBuyerSignatureString
publicKeyString

Example
1st:

Call (in pseudo-code):

getBulkAccessTicket('656','0xbf903df49703dd05709a9a3bb542d7229b3049c9','0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','654','304402206b05f13c4f0664d1a030f5923c3adad24fe102158afadbadedaa6b8daa65eb1802206df2515ab4466e39e24e6cf3d4201fd5d672751271613ff05a324727e8cd732d','0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7');

Response json-data:

{"result":{"id":"tid-903358.414322","type":"read","creationTimeInMs":"1579641695946","timeToLiveInMs":"1200000","userId":"0xbf903df49703dd05709a9a3bb542d7229b3049c9","assetUrl":"proto://[email protected]/path/to/asset","vaultUrl":null,"vaultAuth":null,"nonce":"n-807414","checksum":null,"pubKey":"0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7","signature":"30450220291d16dc45d005a98498a970f9ebff0d42c277ea2899ef67684e71b592609c9f0221009570ea0dfab2910a1ce7ebfb1c1b215e1c2cfc931274ba946c1e3a0bad7a04a4"}}

Example
2nd:

Call (in pseudo-code):

getBulkAccessTicket('655','0xbf903df49703dd05709a9a3bb542d7229b3049c9','0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','654','304602210094577ab73c6c7623876f32276b7db8f8522c126b025d2aa427e612b1a26477e5022100d0fa5feb1625fca943770caab1de65e8e9dad674a7e71108666c9d3f527f85f1','0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7');

Response json-data:

{"result":{"id":"tid-960425.610091","type":"read","creationTimeInMs":"1579641710484","timeToLiveInMs":"1200000","userId":"0xbf903df49703dd05709a9a3bb542d7229b3049c9","assetUrl":"proto://[email protected]/path/to/asset","vaultUrl":null,"vaultAuth":null,"nonce":"n-214791","checksum":null,"pubKey":"0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7","signature":"304502210093e488d76642cd375ba3e2d3b3b713a67330ea04fa3749ee036bd25d742f1dc9022023c4e93ffcec85b95b66bddc89b3e92953047c93fee2484f1fbf9b5bba681e45"}}

Example
3th:

Call (in pseudo-code):

getBulkAccessTicket('657','0xbf903df49703dd05709a9a3bb542d7229b3049c9','0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','654','30440220261a472d16900c2af03ad6c4ee1d942372f868edfae38f041912c2fd0af125d5022025f645e730968a2d3a28f22f3f6fc6510469d8d9d3e5c5f641eaff1d5b6c38af','0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7');

Response json-data:

{"result":"Invalid request (wrong method or parameters). For method getBulkAccessTicket(657,0xbf903df49703dd05709a9a3bb542d7229b3049c9,0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2,654,30440220261a472d16900c2af03ad6c4ee1d942372f868edfae38f041912c2fd0af125d5022025f645e730968a2d3a28f22f3f6fc6510469d8d9d3e5c5f641eaff1d5b6c38af,0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7); Error: Access denied. Error: Error: Bulk Access denied..."}

Example
4th:

Call (in pseudo-code):

getBulkAccessTicket('659','0xbf903df49703dd05709a9a3bb542d7229b3049c9','0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','660','3045022100bad63cf5f9e722f881e1db2b93db32cc4db4b6667ada59a815151240c043bb910220067816b1b783276d82f0b58a010b313b25777280ac2390f8f01a0d6dcf33b058','0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7');

Response json-data:

{"result":{"id":"tid-69835.67169","type":"read","creationTimeInMs":"1579641751356","timeToLiveInMs":"1200000","userId":"0xbf903df49703dd05709a9a3bb542d7229b3049c9","assetUrl":"proto://[email protected]/path/to/asset","vaultUrl":null,"vaultAuth":null,"nonce":"n-681063","checksum":null,"pubKey":"0xfaa8fb6ab825488989fca408e69f855da2db64e9b1db00f1ad6754bbfb5f5bbafd3ece9683ae9e0a1f7234bd32cef2f6b33528275fdd4b96be709843910255b7","signature":"3044022006fdf71894f96d1d01eda2ecf974a19c71220412e9455728b707317ae11e10460220266db8b3c84d6faa07c25de55a79ea1913d8bd80f9a9c4ec2565f1e508fbd6cf"}}

getSatAccessTicket(dabId, buyerId, satId, argsBuyerSignature, publicKey, apiVersionCode) ⇒ Ticket

Description: Method getSatAccessTicket

Kind: global function
Returns: Ticket - Look at Type description in Docs.

ParamTypeDescription
dabIdInteger
buyerIdAddress
satIdInteger
argsBuyerSignatureString
publicKeyString
apiVersionCodeInteger(optional. default: 0)

getCopyTicket(dabId, buyerId, argsBuyerSignature, publicKey) ⇒ Ticket

Description: Method getCopyTicket

Kind: global function
Returns: Ticket - Look at Type description in Docs.

ParamType
dabIdInteger
buyerIdAddress
argsBuyerSignatureString
publicKeyString

getAccessDab(dabId, buyerId, sellerId, argsBuyerSignature, publicKey) ⇒ Dab

Description: Method getAccessDab

Kind: global function
Returns: Dab - Look at Type description in Docs.

ParamType
dabIdInteger
buyerIdAddress
sellerIdAddress
argsBuyerSignatureString
publicKeyString

getBulkAccessDab(dabId, buyerId, bulkSellerId, tagId, argsBuyerSignature, publicKey) ⇒ Dab

Description: Method getBulkAccessDab

Kind: global function
Returns: Dab - Look at Type description in Docs.

ParamType
dabIdInteger
buyerIdAddress
bulkSellerIdAddress
tagIdInteger
argsBuyerSignatureString
publicKeyString

encrypt(data) ⇒ String

Description: Method encrypt

Kind: global function
Returns: String - hex

ParamType
dataObject

Example
1st:

Call (in pseudo-code):

encrypt({'encodedByVault':'ed1aef1da30d1537a841eef97c3e928124cc5a6bd5e45bb138ec7ff42c713ab65f07f9a42718af31a8e29ef6c1e02e32c70a07ec4577a431137915609604dbca8c03832e1617f8011427306663814e5725526b4e10ebc7fc383131380b0b2ecfc39eadf4','encodedByUserPubKey':'84a26976c410acd8b0fdfd9171f84d9e4ab3b8164688ae657068656d5075626c69634b6579c44104415184b984979831d069d988e11850faeec2d38e5c903a0ccb1beec8f979be300c17e187f9e85f206497865dcde7e444df915b552391e34b4f2c6e13aaf7c75daa63697068657274657874c470a54a90608d6e3ce9c1c5c4186d562d6b0acc85be0010b83297f165ccb67316164e1a618e8b34584e728940e1fa9508743f91af2a9067a72f64406353decf198d24ff4bd73e4748803348df88e2fb0d6dc25920b64467b06cab9f3ac80029334a80f6777cb08475b17f89f79e33ac61f1a36d6163c4206e1ac5ff6e1dbfeec57599a07f60df75f08a43b7addd977d132b8ed9e36b2a0e'});

Response json-data:

{"result":"v2.0|8dc8097d0b0ca20e22fbae13a2390447f8d6362d0dae74abe64230ff1da0a04ad54405e8eccc81fd770f07f2135cb160098533a5dcb8aeaf741510dc8eae3fc20b76299175f314889009ff5b191ea773281c127c05320d64357beacaa0817ce25b362a86d5bba330cfbbab0b6dd98bc474cdd3fc0cf59a358122844b463b09b55b9925b4ea788efd383fce2f74c5b40eef102012ca551b9bd8a732fc981888f2af5c433c21c886695bf99fc818605e0c31ed9f410bb8c1467d384e35d9a297241911bf18bdb87889176848fa09ce13b1b7cb7d4c0c545ebc38badc59850b503f842e26bd48cd2512ade646ba4959647b127910b0fa07e2f0804c76ca2a474fb8b26d6cdd90577a42c564d3c3f29ba0467e399e9fa81f0143209412d109b13d55345b79336ae5e54ae7b403a99241b28019bc5bf1877fead56053e9be513f9f47d8e0160ceeda28e0b0dec5238cf5412d7f495e6539cd917e26c1b93717b1be02f829688d07603a72181b15d332349bb527c616b260d777644610679063d1646ff1dc8b25cecc3ab284bd87964501eaf8d421b56d145d6fb2cb3ac6a89265289b3d2553de8fc1943dc44a5c1793c02f65b87cdcac3a4f117e963d63dbbcd6814eb54433eba846d7d47bda1196e3dfb587ece9fe09b94e93c45dea4fdcec62620e6edf27335a9b90ec54c1a4394db9d15418d422152cb91c6213c4803a1165648f41b471adf480a94678ee0813cf2e4d337722fcc8aa3da0a8635ebf504ba745dac53f22a09a1c53b64c9dee2932b85476a47bd2c803efd661b7160e52a1f55b537eef09188f3e3b7cdfb7212bca67ed25762dd6db2731263f6f36b37b6d75657321e1baea1c33fa6b52c04f0db9ef41abb796bab4cebbdab8abd125dafc05ccdd3a1f2988836a9a9f754131e797b1d8048c2edec5af23410cb2464cc95a13b536926c9ce58f61b915987425234d0bfca45565b805e0fdc94d4c0aab69d1a076934cc6ef4721d36e8599717f56f86d2a1c4ef7f7909c04106c7ad0cb4b1785e40e5ca5dd598284d6b10952c62564fb478b171c479b0c2ce2f99d84d28e3d1aa19e6f0e8d135946145d1d31065a6d14d8f9d65aaa1872da79515f03ae9ec41c8ebe81351e2cb32e1a117392913d63cf30318b7b1881c08b1be85f45f32e0f81191633ad8a098bf7bf38a45b78aafe459e5f112a43ee1359297e99803683bb20f2ada78464d0503c91533614e4c6cbece75df79555c96f8cab2a769ff34e5d1062924211d0badf6dc67be9b12c2fb193a744d593b28b26faa8041fbb091d47e787"}

setUsp(userId, userPublicKey, vaultId, usp, argsSignature) ⇒ Boolean

Description: Method setUsp

Kind: global function
Returns: Boolean - isOk

ParamType
userIdAddress
userPublicKeyString
vaultIdInteger
uspString
argsSignatureString

Example
1st:

Call (in pseudo-code):

setUsp('0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','0x86e6f8578e725eb36e856580b1089255c79ecfe06bd79b6a08832be869871b90022c7c134e24c9ca0c36c3372be40fccc6a9875c650a6291b4e2a2eae881a5a1','1','v2.0|8dc8097d0b0ca20e22fbae13a2390447f8d6362d0dae74abe64230ff1da0a04ad54405e8eccc81fd770f07f2135cb160098533a5dcb8aeaf741510dc8eae3fc20b76299175f314889009ff5b191ea773281c127c05320d64357beacaa0817ce25b362a86d5bba330cfbbab0b6dd98bc474cdd3fc0cf59a358122844b463b09b55b9925b4ea788efd383fce2f74c5b40eef102012ca551b9bd8a732fc981888f2af5c433c21c886695bf99fc818605e0c31ed9f410bb8c1467d384e35d9a297241911bf18bdb87889176848fa09ce13b1b7cb7d4c0c545ebc38badc59850b503f842e26bd48cd2512ade646ba4959647b127910b0fa07e2f0804c76ca2a474fb8b26d6cdd90577a42c564d3c3f29ba0467e399e9fa81f0143209412d109b13d55345b79336ae5e54ae7b403a99241b28019bc5bf1877fead56053e9be513f9f47d8e0160ceeda28e0b0dec5238cf5412d7f495e6539cd917e26c1b93717b1be02f829688d07603a72181b15d332349bb527c616b260d777644610679063d1646ff1dc8b25cecc3ab284bd87964501eaf8d421b56d145d6fb2cb3ac6a89265289b3d2553de8fc1943dc44a5c1793c02f65b87cdcac3a4f117e963d63dbbcd6814eb54433eba846d7d47bda1196e3dfb587ece9fe09b94e93c45dea4fdcec62620e6edf27335a9b90ec54c1a4394db9d15418d422152cb91c6213c4803a1165648f41b471adf480a94678ee0813cf2e4d337722fcc8aa3da0a8635ebf504ba745dac53f22a09a1c53b64c9dee2932b85476a47bd2c803efd661b7160e52a1f55b537eef09188f3e3b7cdfb7212bca67ed25762dd6db2731263f6f36b37b6d75657321e1baea1c33fa6b52c04f0db9ef41abb796bab4cebbdab8abd125dafc05ccdd3a1f2988836a9a9f754131e797b1d8048c2edec5af23410cb2464cc95a13b536926c9ce58f61b915987425234d0bfca45565b805e0fdc94d4c0aab69d1a076934cc6ef4721d36e8599717f56f86d2a1c4ef7f7909c04106c7ad0cb4b1785e40e5ca5dd598284d6b10952c62564fb478b171c479b0c2ce2f99d84d28e3d1aa19e6f0e8d135946145d1d31065a6d14d8f9d65aaa1872da79515f03ae9ec41c8ebe81351e2cb32e1a117392913d63cf30318b7b1881c08b1be85f45f32e0f81191633ad8a098bf7bf38a45b78aafe459e5f112a43ee1359297e99803683bb20f2ada78464d0503c91533614e4c6cbece75df79555c96f8cab2a769ff34e5d1062924211d0badf6dc67be9b12c2fb193a744d593b28b26faa8041fbb091d47e787','30460221009de6ae7a4a6a53675b70f401975cc4dd8ee76e59b9a288c16ffa840697e9a0cf022100aedf865aaf30a671d01c88caee6305eda096925b93f217320b92de96be0206fc');

Response json-data:

{"result":true}

getUsp(userId, vaultId) ⇒ String

Description: Method getUsp

Kind: global function
Returns: String - usp

ParamType
userIdAddress
vaultIdInteger

Example
1st:

Call (in pseudo-code):

getUsp('0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','1');

Response json-data:

{"result":"v2.0|8dc8097d0b0ca20e22fbae13a2390447f8d6362d0dae74abe64230ff1da0a04ad54405e8eccc81fd770f07f2145ee5395d876df483ebf2fc771d40828af83e950f262d9321af12d8c05bf750191ea773281c127c05320d64357beacaa0817ce25b362a86d5bba330cfbbab0b6dd98bc424c8d7fb50f1c8388c208a444a3509e60fcc27b8b97183f1643c992572cdb40cbc132618ca5416ccd5f23cfa9c1bd9f3f40d423c7dc986375bf2cec3433c0e0938bb9d460dbc98147a634e3e8fa594201c16e71de6bc2b8c463d48fa099945b0e29d764a58555eb16bbd865fd80b076ed52c25ea1d9b2247ffe411bb1c59337c127910b0fa07e2f0804c76ca2a474fb8b26d6cdd90577a42c56486c6f7c2a141713b97c2ab4d0541219914d05db03c0266562b316fb2e01eb4b451f1c112bbd44db858a48377eede3552e8bb0f3b9a47d8e2450db88b21e7e3dcc47e8ba215297315543f33cfc0722494eb614cbcb905ae7c688f5f653b781c1e47816a309bb621944ae433867437174266c765876038fcdddc219b986aea8defd1944001baff8726b53842596fbe973bc7f8956875cc672f018e8f96916dc11c064395c02e6dea2e8da0384e417997683adbe6d4d44bb24460b9ac4dd0d47ade4cc2e688b7d4bfeeae5fb11cc79209b91cdbb06d610f64892c610e9c97ea0b96a4394db9d15418d422152cb91c3747c1d26b42676adb49b322aaf7d0af1729eb001a987a4c667374fa9fac3af3a1690abf0048a3158f956c7daf9f405bb04d9ab27934b30924f47dd1cd06bcd661b7160e52a1f55b537eef09188f3e3b7cdfb7212bca67ed25762dd6db2731263f6f36b37b6d75657321e1baea1c33fa6b52c04f0db9ef41abb796bab4cebbdab8abd125dafc05ccdd3a1f2988836a9a9f754131e797b1df0b8c29de96af234108b7454c935d47b561956a9ce08f65bc139d252521480ff9a1523fb803e0fdce4d495fab6dd4fc769549c5b54321d03282c3767f0df8692a1f4eabf2c4990417377ad6cb481280e1085ca3d85dde85d6b70957c62461f94788174042c80c2bb8fb9a83d28e384da1996f578d10591d115e1d6e5c583746d8f9d65aaa1872da79515f03ae9ec41a85bb87371d2cb32b4e1626c6946965cf3f6488791e8997d84db45547ae2e0a871c4463fc8f57d8f0bb68f55d79a9ad43ca0d4f7045b8155d737c9e8062d4e926a3a0f18930d2006c91016713b797cde6eb09a99755993a8cab7f7198a01a5d18349c4147d0bede3ac12defe47b28b1c7a6148395b68420feaa5219bb0e1d12e787"}

setAak(userId, userPublicKey, dabId, aak, argsSignature) ⇒ Boolean

Description: Method setAak

Kind: global function
Returns: Boolean - isOk

ParamType
userIdAddress
userPublicKeyString
dabIdInteger
aakString
argsSignatureString

getAak(dabId) ⇒ String

Description: Method getAak

Kind: global function
Returns: String - aak

ParamType
dabIdInteger

getVaultsIds(userId, pos, size) ⇒ Array_of_Integer

Description: Method getVaultsIds

Kind: global function
Returns: Array_of_Integer - vaultsIds

ParamTypeDescription
userIdAddress
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

Example
1st:

Call (in pseudo-code):

getVaultsIds('0x003e8c791cb39b4cad756b9c25431d6eb3fed85c',0,100);

Response json-data:

{"result":["1","3","4","6","7","9","10","12","13","15","16","18","19"]}

Example
2nd:

Call (in pseudo-code):

getVaultsIds('0xbf903df49703dd05709a9a3bb542d7229b3049c9',13,10);

Response json-data:

{"result":["20"]}

Example
3th:

Call (in pseudo-code):

getVaultsIds('0xbf903df49703dd05709a9a3bb542d7229b3049c9',0,200);

Response json-data:

{"result":["1","3","4","6","7","9","10","12","13","15","16","18","19","21","22"]}

isVaultedDab(dabId) ⇒ Boolean

Description: Method isVaultedDab

Kind: global function
Returns: Boolean - isVaulted

ParamType
dabIdInteger

getVaultById(userId, vaultId) ⇒ Object

Description: Method getVaultById

Kind: global function
Returns: Object - vault

ParamType
userIdAddress
vaultIdInteger

Example
1st:

Call (in pseudo-code):

getVaultById('0xbf903df49703dd05709a9a3bb542d7229b3049c9',1);

Response json-data:

{"result":{"ownerId":"0x003e8C791cb39b4CAD756b9C25431D6eb3Fed85c","pubKey":"0x046525fb685e4c366cea131b4c90f5213e10bceead084a71f3e954e13bfe0b22b3d2b0a29b68d483cc68cd32b361e856dfdc1f2c1189689100f8c7960b336d3cef","name":"DSD Google vault","id":"1","type":"1","url":"https://partner.dase.io:5081","description":"DSD Google vault"}}

Example
2nd:

Call (in pseudo-code):

getVaultById('0xbf903df49703dd05709a9a3bb542d7229b3049c9','20');

Response json-data:

{"result":{"ownerId":"0xB9AC1D430841bC99B6C03E772E6F7d755eFb1dF2","pubKey":"0x046882df9a080352541e74e5a19c25f3ff4dbb72f3edf16d0c7af3f2094dea61ac7caa94c7dc08b212f7b3d8b0a9fc5855aad7cff188583d5129d383e0eb2fc77a","name":"Lively NewVaultTest_0-12-2","id":"20","type":"1","url":"http://104.197.24.49:8085/vex-vault/api/lively/access","description":null}}

Example
3th:

Call (in pseudo-code):

getVaultById('0x003e8c791cb39b4cad756b9c25431d6eb3fed85c','20');

Response json-data:

{"result":{"ownerId":"0xBF903dF49703dD05709A9A3bB542D7229b3049c9","pubKey":"0x7b1fb93f375d0c3fa9d72668fa29287c06a30a2f7515755c1f3c058b3f7ae9edff","name":"name of the vault","id":"20","type":"2","url":null,"description":null}}

KEYCHAIN API methods

(Back)

Functions

newAccount(account, secret, encryptedKeyData)Boolean

Description: Method newAccount

getChallenge(account)String

Description: Method getChallenge

getEncryptedKeyData(account, responseOnChallenge)BytesArray

Description: Method getEncryptedKeyData

setUsp(userId, userPublicKey, vaultId, usp, argsSignature)Boolean

Description: Method setUsp

getUsp(userId, vaultId)String

Description: Method getUsp

setAak(userId, userPublicKey, dabId, aak, argsSignature)Boolean

Description: Method setAak

getAak(dabId)String

Description: Method getAak

newAccount(account, secret, encryptedKeyData) ⇒ Boolean

Description: Method newAccount

Kind: global function

ParamType
accountString
secretString
encryptedKeyDataBytesArray

getChallenge(account) ⇒ String

Description: Method getChallenge

Kind: global function

ParamType
accountString

getEncryptedKeyData(account, responseOnChallenge) ⇒ BytesArray

Description: Method getEncryptedKeyData

Kind: global function

ParamType
accountString
responseOnChallengeString

setUsp(userId, userPublicKey, vaultId, usp, argsSignature) ⇒ Boolean

Description: Method setUsp

Kind: global function
Returns: Boolean - isOk

ParamType
userIdAddress
userPublicKeyString
vaultIdInteger
uspString
argsSignatureString

Example
1st:

Call (in pseudo-code):

setUsp('0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','0x86e6f8578e725eb36e856580b1089255c79ecfe06bd79b6a08832be869871b90022c7c134e24c9ca0c36c3372be40fccc6a9875c650a6291b4e2a2eae881a5a1','1','v2.0|8dc8097d0b0ca20e22fbae13a2390447f8d6362d0dae74abe64230ff1da0a04ad54405e8eccc81fd770f07f2135cb160098533a5dcb8aeaf741510dc8eae3fc20b76299175f314889009ff5b191ea773281c127c05320d64357beacaa0817ce25b362a86d5bba330cfbbab0b6dd98bc474cdd3fc0cf59a358122844b463b09b55b9925b4ea788efd383fce2f74c5b40eef102012ca551b9bd8a732fc981888f2af5c433c21c886695bf99fc818605e0c31ed9f410bb8c1467d384e35d9a297241911bf18bdb87889176848fa09ce13b1b7cb7d4c0c545ebc38badc59850b503f842e26bd48cd2512ade646ba4959647b127910b0fa07e2f0804c76ca2a474fb8b26d6cdd90577a42c564d3c3f29ba0467e399e9fa81f0143209412d109b13d55345b79336ae5e54ae7b403a99241b28019bc5bf1877fead56053e9be513f9f47d8e0160ceeda28e0b0dec5238cf5412d7f495e6539cd917e26c1b93717b1be02f829688d07603a72181b15d332349bb527c616b260d777644610679063d1646ff1dc8b25cecc3ab284bd87964501eaf8d421b56d145d6fb2cb3ac6a89265289b3d2553de8fc1943dc44a5c1793c02f65b87cdcac3a4f117e963d63dbbcd6814eb54433eba846d7d47bda1196e3dfb587ece9fe09b94e93c45dea4fdcec62620e6edf27335a9b90ec54c1a4394db9d15418d422152cb91c6213c4803a1165648f41b471adf480a94678ee0813cf2e4d337722fcc8aa3da0a8635ebf504ba745dac53f22a09a1c53b64c9dee2932b85476a47bd2c803efd661b7160e52a1f55b537eef09188f3e3b7cdfb7212bca67ed25762dd6db2731263f6f36b37b6d75657321e1baea1c33fa6b52c04f0db9ef41abb796bab4cebbdab8abd125dafc05ccdd3a1f2988836a9a9f754131e797b1d8048c2edec5af23410cb2464cc95a13b536926c9ce58f61b915987425234d0bfca45565b805e0fdc94d4c0aab69d1a076934cc6ef4721d36e8599717f56f86d2a1c4ef7f7909c04106c7ad0cb4b1785e40e5ca5dd598284d6b10952c62564fb478b171c479b0c2ce2f99d84d28e3d1aa19e6f0e8d135946145d1d31065a6d14d8f9d65aaa1872da79515f03ae9ec41c8ebe81351e2cb32e1a117392913d63cf30318b7b1881c08b1be85f45f32e0f81191633ad8a098bf7bf38a45b78aafe459e5f112a43ee1359297e99803683bb20f2ada78464d0503c91533614e4c6cbece75df79555c96f8cab2a769ff34e5d1062924211d0badf6dc67be9b12c2fb193a744d593b28b26faa8041fbb091d47e787','30460221009de6ae7a4a6a53675b70f401975cc4dd8ee76e59b9a288c16ffa840697e9a0cf022100aedf865aaf30a671d01c88caee6305eda096925b93f217320b92de96be0206fc');

Response json-data:

{"result":true}

getUsp(userId, vaultId) ⇒ String

Description: Method getUsp

Kind: global function
Returns: String - usp

ParamType
userIdAddress
vaultIdInteger

Example
1st:

Call (in pseudo-code):

getUsp('0xb9ac1d430841bc99b6c03e772e6f7d755efb1df2','1');

Response json-data:

{"result":"v2.0|8dc8097d0b0ca20e22fbae13a2390447f8d6362d0dae74abe64230ff1da0a04ad54405e8eccc81fd770f07f2145ee5395d876df483ebf2fc771d40828af83e950f262d9321af12d8c05bf750191ea773281c127c05320d64357beacaa0817ce25b362a86d5bba330cfbbab0b6dd98bc424c8d7fb50f1c8388c208a444a3509e60fcc27b8b97183f1643c992572cdb40cbc132618ca5416ccd5f23cfa9c1bd9f3f40d423c7dc986375bf2cec3433c0e0938bb9d460dbc98147a634e3e8fa594201c16e71de6bc2b8c463d48fa099945b0e29d764a58555eb16bbd865fd80b076ed52c25ea1d9b2247ffe411bb1c59337c127910b0fa07e2f0804c76ca2a474fb8b26d6cdd90577a42c56486c6f7c2a141713b97c2ab4d0541219914d05db03c0266562b316fb2e01eb4b451f1c112bbd44db858a48377eede3552e8bb0f3b9a47d8e2450db88b21e7e3dcc47e8ba215297315543f33cfc0722494eb614cbcb905ae7c688f5f653b781c1e47816a309bb621944ae433867437174266c765876038fcdddc219b986aea8defd1944001baff8726b53842596fbe973bc7f8956875cc672f018e8f96916dc11c064395c02e6dea2e8da0384e417997683adbe6d4d44bb24460b9ac4dd0d47ade4cc2e688b7d4bfeeae5fb11cc79209b91cdbb06d610f64892c610e9c97ea0b96a4394db9d15418d422152cb91c3747c1d26b42676adb49b322aaf7d0af1729eb001a987a4c667374fa9fac3af3a1690abf0048a3158f956c7daf9f405bb04d9ab27934b30924f47dd1cd06bcd661b7160e52a1f55b537eef09188f3e3b7cdfb7212bca67ed25762dd6db2731263f6f36b37b6d75657321e1baea1c33fa6b52c04f0db9ef41abb796bab4cebbdab8abd125dafc05ccdd3a1f2988836a9a9f754131e797b1df0b8c29de96af234108b7454c935d47b561956a9ce08f65bc139d252521480ff9a1523fb803e0fdce4d495fab6dd4fc769549c5b54321d03282c3767f0df8692a1f4eabf2c4990417377ad6cb481280e1085ca3d85dde85d6b70957c62461f94788174042c80c2bb8fb9a83d28e384da1996f578d10591d115e1d6e5c583746d8f9d65aaa1872da79515f03ae9ec41a85bb87371d2cb32b4e1626c6946965cf3f6488791e8997d84db45547ae2e0a871c4463fc8f57d8f0bb68f55d79a9ad43ca0d4f7045b8155d737c9e8062d4e926a3a0f18930d2006c91016713b797cde6eb09a99755993a8cab7f7198a01a5d18349c4147d0bede3ac12defe47b28b1c7a6148395b68420feaa5219bb0e1d12e787"}

setAak(userId, userPublicKey, dabId, aak, argsSignature) ⇒ Boolean

Description: Method setAak

Kind: global function
Returns: Boolean - isOk

ParamType
userIdAddress
userPublicKeyString
dabIdInteger
aakString
argsSignatureString

getAak(dabId) ⇒ String

Description: Method getAak

Kind: global function
Returns: String - aak

ParamType
dabIdInteger

DEPRECATED.CORE API methods

(Back)

Functions

newUser_Zetonium(credentials)Keys
newUser_Ethereum(credentials)Keys
getKeys(bchainTypeCode, userId, credentials)Keys
getKeys_Zetonium(userId, credentials)Keys
getKeys_Ethereum(userId, credentials)Keys
getLastBlock_Zetonium()Integer
getLastBlock_Ethereum()Integer
isValidUser(bchainTypeCode, userId, credentials)Boolean
isValidUser_Zetonium(userId, credentials)Boolean
isValidUser_Ethereum(userId, credentials)Boolean
sendSilver(senderId, senderCredentials, silverAmount, toUserId)Transaction
sendGold_Ethereum(senderId, senderCredentials, goldAmount, toUserId)Transaction
getSilverBalance(userId)Integer
getGoldBalance_Zetonium(userId)Integer
getGoldBalance_Ethereum(userId)Integer
getBalanceWeis_Ethereum(userId)Integer
getCurrencyExchangeOffer(userId, offerId)Object
getCurrencyExchangePurchaseHistory(userId, startBlock)Array_of_Event
getCurrencyExchangeSellHistory(userId, startBlock)Array_of_Event

newUser_Zetonium(credentials) ⇒ Keys

Deprecated

Kind: global function
Returns: Keys - Look at Type description in Docs.

ParamTypeDescription
credentialsString(optional. default: null)

newUser_Ethereum(credentials) ⇒ Keys

Deprecated

Kind: global function
Returns: Keys - Look at Type description in Docs.

ParamTypeDescription
credentialsString(optional. default: null)

getKeys(bchainTypeCode, userId, credentials) ⇒ Keys

Deprecated

Kind: global function
Returns: Keys - Look at Type description in Docs.

ParamTypeDescription
bchainTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
userIdAddress
credentialsString

getKeys_Zetonium(userId, credentials) ⇒ Keys

Deprecated

Kind: global function
Returns: Keys - Look at Type description in Docs.

ParamType
userIdAddress
credentialsString

getKeys_Ethereum(userId, credentials) ⇒ Keys

Deprecated

Kind: global function
Returns: Keys - Look at Type description in Docs.

ParamType
userIdAddress
credentialsString

getLastBlock_Zetonium() ⇒ Integer

Deprecated

Kind: global function

getLastBlock_Ethereum() ⇒ Integer

Deprecated

Kind: global function

isValidUser(bchainTypeCode, userId, credentials) ⇒ Boolean

Deprecated

Kind: global function

ParamTypeDescription
bchainTypeCodeConstant_of_Integer(optional. default: 1) Look at Constants description in Docs.
userIdAddress
credentialsString

isValidUser_Zetonium(userId, credentials) ⇒ Boolean

Deprecated

Kind: global function

ParamType
userIdAddress
credentialsString

isValidUser_Ethereum(userId, credentials) ⇒ Boolean

Deprecated

Kind: global function

ParamType
userIdAddress
credentialsString

sendSilver(senderId, senderCredentials, silverAmount, toUserId) ⇒ Transaction

Deprecated

Kind: global function
Returns: Transaction - Look at Type description in Docs.

ParamType
senderIdAddress
senderCredentialsString
silverAmountInteger
toUserIdAddress

sendGold_Ethereum(senderId, senderCredentials, goldAmount, toUserId) ⇒ Transaction

Deprecated

Kind: global function
Returns: Transaction - Look at Type description in Docs.

ParamType
senderIdAddress
senderCredentialsString
goldAmountInteger
toUserIdAddress

getSilverBalance(userId) ⇒ Integer

Deprecated

Kind: global function

ParamType
userIdAddress

getGoldBalance_Zetonium(userId) ⇒ Integer

Deprecated

Kind: global function

ParamType
userIdAddress

getGoldBalance_Ethereum(userId) ⇒ Integer

Deprecated

Kind: global function

ParamType
userIdAddress

getBalanceWeis_Ethereum(userId) ⇒ Integer

Deprecated

Kind: global function

ParamType
userIdAddress

getCurrencyExchangeOffer(userId, offerId) ⇒ Object

Deprecated

Kind: global function

ParamType
userIdAddress
offerIdInteger

getCurrencyExchangePurchaseHistory(userId, startBlock) ⇒ Array_of_Event

Deprecated

Kind: global function
Returns: Array_of_Event - Look at Type description in Docs.

ParamType
userIdAddress
startBlockInteger

getCurrencyExchangeSellHistory(userId, startBlock) ⇒ Array_of_Event

Deprecated

Kind: global function
Returns: Array_of_Event - Look at Type description in Docs.

ParamType
userIdAddress
startBlockInteger

DEPRECATED.DASE API methods

(Back)

Functions

addDab(ownerId, ownerCredentials, assetUrl, publicDescription, linkedDabId, custodians, dataHash)Integer
addDabList(ownerId, ownerCredentials, dataArr)Array_of_Integer
getDirectLabelsIdsForDab(userId, dabId, pos, size)Array_of_Integer
getOwnedDabsIds(userId, pos, size)Array_of_Integer
getSharedDabsIds(userId)Array_of_Integer
getCustodiedDabsIds(userId)Array_of_Integer
getTags(userId, tagIds)Array_of_Tag
exploreTagRelationsPage(userId, userCredentials, rootTagId, tagId, pos)Array_of_Dab
getAvailableDabs(userId, dabTypeCode, licenseTypeCode, pos, size)Array_of_Dab
getAvailableLicenses(userId, dabTypeCode, licenseTypeCode, pos, size)Array_of_License
getAvailableLicensesForDab(userId, dabId, licenseTypeCode, pos, size)Array_of_License
getAlienSellOfferedLicenses(userId, dabTypeCode, licenseTypeCode, pos, size)Array_of_License
getAlienBuyOfferedLicenses(userId, dabTypeCode, licenseTypeCode, pos, size)Array_of_License
getAlienSellOfferedLicensesForDab(userId, dabId, licenseTypeCode, pos, size)Array_of_License
getAlienBuyOfferedLicensesForDab(userId, dabId, licenseTypeCode, pos, size)Array_of_License
actualiseBoughtDeals(userId, userCredentials, licenseTypeCode)Boolean
getSoldDabs(userId, dabTypeCode, licenseTypeCode, pos, size)Array_of_Dab
getSoldLicenses(userId, dabTypeCode, licenseTypeCode, pos, size)Array_of_License
getSoldLicensesForDab(userId, dabId, licenseTypeCode, pos, size)Array_of_License
getMySellOfferedLicenses(userId, dabTypeCode, licenseTypeCode, pos, size)Array_of_License
getMyBuyOfferedLicenses(userId, dabTypeCode, licenseTypeCode, pos, size)Array_of_License
getMySellOfferedLicensesForDab(userId, dabId, licenseTypeCode, pos, size)Array_of_License
getMyBuyOfferedLicensesForDab(userId, dabId, licenseTypeCode, pos, size)Array_of_License
actualiseSoldDeals(userId, userCredentials, licenseTypeCode)Boolean
offerBuyExploreLicense(buyerId, buyerCredentials, dabId, maxLeosPrice, termSheetTemplate, terms)Constant_of_Integer
offerSellOwnership(sellerId, sellerCredentials, buyerId, dabId, minPrice, termSheetTemplate, terms)Boolean
offerBuyOwnership(buyerId, buyerCredentials, dabId, maxPrice, termSheetTemplate, terms)Boolean
approveOwnershipDeal(custodianId, custodianCredentials, buyerId, dabId)Boolean
offerBuyCustody(buyerId, buyerCredentials, dabId, maxPrice, termSheetTemplate, terms)Boolean
offerSellCustody(sellerId, sellerCredentials, buyerId, dabId, minPrice, termSheetTemplate, terms)Boolean
approveCustodyDeal(custodianId, custodianCredentials, buyerId, dabId)Boolean
offerSellAccess(sellerId, sellerCredentials, buyerId, dabId, minPrice, termSheetTemplate, terms)Boolean
offerBuyAccess(buyerId, buyerCredentials, dabId, maxPrice, termSheetTemplate, terms)Boolean
approveAccessDeal(custodianId, custodianCredentials, buyerId, dabId)Boolean
offerSellReshare(sellerId, sellerCredentials, buyerId, dabId, minPrice, termSheetTemplate, terms)Boolean
approveReshareDeal(custodianId, custodianCredentials, buyerId, dabId)Boolean
offerSellTag(licenseTypeCode, sellerId, sellerCredentials, buyerId, dabId, minPrice, tagId, termSheetTemplate, terms)Boolean
offerBuyTag(licenseTypeCode, buyerId, buyerCredentials, dabId, maxPrice, tagId, termSheetTemplate, terms)Boolean
approveTagDeal(licenseTypeCode, custodianId, custodianCredentials, buyerId, dabId, tagId)Boolean
offerSellToTag(licenseTypeCode, sellerId, sellerCredentials, buyerId, buyerTagId, minPrice, sellerDabId, termSheetTemplate, terms)Boolean
offerBuyToTag(licenseTypeCode, buyerId, buyerCredentials, buyerTagId, maxPrice, sellerDabId, termSheetTemplate, terms)Boolean
approveToTagDeal(licenseTypeCode, custodianId, custodianCredentials, buyerId, buyerTagId, sellerDabId)Boolean
offerSellExplore(sellerId, sellerCredentials, buyerId, dabId, minPrice, buyerPubKeyEncryptedTagKey, termSheetTemplate, terms)Boolean
offerBuyExplore(buyerId, buyerCredentials, dabId, maxPrice, termSheetTemplate, terms)Boolean
approveExploreDeal(custodianId, custodianCredentials, buyerId, dabId)Boolean
offerSellBulk(sellerId, sellerCredentials, buyerId, dabId, minPrice, termSheetTemplate, terms)Boolean
offerBuyBulk(buyerId, buyerCredentials, dabId, maxPrice, termSheetTemplate, terms)Boolean
approveBulkDeal(custodianId, custodianCredentials, buyerId, dabId)Boolean
offerSellTransitive(sellerId, sellerCredentials, buyerId, dabId, minPrice, termSheetTemplate, terms)Boolean
offerBuyTransitive(buyerId, buyerCredentials, dabId, maxPrice, termSheetTemplate, terms)Boolean
approveTransitiveDeal(custodianId, custodianCredentials, buyerId, dabId)Boolean
trustToBuyAccess(sellerId, sellerCredentials, buyerId, dabId, minPrice)Boolean
trustToBuyOwnership(sellerId, sellerCredentials, buyerId, dabId, minPrice)Boolean
untrustToBuyAccess(sellerId, sellerCredentials, buyerId, dabId)Boolean
untrustToBuyOwnership(sellerId, sellerCredentials, buyerId, dabId)Boolean
recallOwnershipOffer(userId, userCredentials, buyerId, dabId)Boolean
rejectOwnershipDeal(sellerId, sellerCredentials, buyerId, dabId)Boolean
recallAccessOffer(userId, userCredentials, buyerId, dabId)Boolean
rejectAccessDeal(sellerId, sellerCredentials, buyerId, dabId)Boolean
cancelReshareLicenseOffer(userId, userCredentials, buyerId, dabId)Boolean
rejectReshareDeal(sellerId, sellerCredentials, buyerId, dabId)Boolean
recallBulkOffer(userId, userCredentials, buyerId, dabId)Boolean
rejectBulkDeal(sellerId, sellerCredentials, buyerId, dabId)Boolean
recallTransitiveOffer(userId, userCredentials, buyerId, dabId)Boolean
rejectTransitiveDeal(sellerId, sellerCredentials, buyerId, dabId)Boolean
recallCustodyOffer(userId, userCredentials, buyerId, dabId)Boolean
rejectCustodyDeal(sellerId, sellerCredentials, buyerId, dabId)Boolean
recallTagOffer(userId, userCredentials, buyerId, dabId, tagId)Boolean
rejectTagDeal(sellerId, sellerCredentials, buyerId, dabId, tagId)Boolean
recallToTagOffer(userId, userCredentials, buyerId, dabId, tagId)Boolean
rejectToTagDeal(sellerId, sellerCredentials, buyerId, dabId, tagId)Boolean
recallTagAccessOffer(userId, userCredentials, buyerId, dabId)Boolean
rejectTagAccessDeal(sellerId, sellerCredentials, buyerId, dabId)Boolean
recallExploreOffer(userId, userCredentials, buyerId, dabId)Boolean
rejectExploreDeal(sellerId, sellerCredentials, buyerId, dabId)Boolean
recallReshareOffer(userId, userCredentials, buyerId, dabId)Boolean
rejectReshareDeal(sellerId, sellerCredentials, buyerId, dabId)Boolean

addDab(ownerId, ownerCredentials, assetUrl, publicDescription, linkedDabId, custodians, dataHash) ⇒ Integer

Deprecated

Kind: global function

ParamTypeDescription
ownerIdAddress
ownerCredentialsString
assetUrlString
publicDescriptionString
linkedDabIdInteger(optional. default: 0)
custodiansArray_of_Address(optional. default: [])
dataHashString(optional. default: 0)

addDabList(ownerId, ownerCredentials, dataArr) ⇒ Array_of_Integer

Deprecated

Kind: global function

ParamType
ownerIdAddress
ownerCredentialsString
dataArrArray_of_Object

getDirectLabelsIdsForDab(userId, dabId, pos, size) ⇒ Array_of_Integer

Deprecated

Kind: global function

ParamTypeDescription
userIdAddress
dabIdInteger
posInteger(optional. default: 0)
sizeInteger(optional. default: 100)

getOwnedDabsIds(userId, pos, size) ⇒ Array_of_Integer

Deprecated

Kind: global function

ParamTypeDescription
userIdAddress
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getSharedDabsIds(userId) ⇒ Array_of_Integer

Deprecated

Kind: global function

ParamType
userIdAddress

getCustodiedDabsIds(userId) ⇒ Array_of_Integer

Deprecated

Kind: global function

ParamType
userIdAddress

getTags(userId, tagIds) ⇒ Array_of_Tag

Deprecated

Kind: global function
Returns: Array_of_Tag - Look at Type description in Docs.

ParamType
userIdAddress
tagIdsArray_of_Integer

exploreTagRelationsPage(userId, userCredentials, rootTagId, tagId, pos) ⇒ Array_of_Dab

Deprecated

Kind: global function
Returns: Array_of_Dab - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
userCredentialsString
rootTagIdInteger
tagIdInteger
posInteger(optional. default: 0)

getAvailableDabs(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒ Array_of_Dab

Deprecated

Kind: global function
Returns: Array_of_Dab - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getAvailableLicenses(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒ Array_of_License

Deprecated

Kind: global function
Returns: Array_of_License - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getAvailableLicensesForDab(userId, dabId, licenseTypeCode, pos, size) ⇒ Array_of_License

Deprecated

Kind: global function
Returns: Array_of_License - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabIdInteger
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getAlienSellOfferedLicenses(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒ Array_of_License

Deprecated

Kind: global function
Returns: Array_of_License - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getAlienBuyOfferedLicenses(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒ Array_of_License

Deprecated

Kind: global function
Returns: Array_of_License - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getAlienSellOfferedLicensesForDab(userId, dabId, licenseTypeCode, pos, size) ⇒ Array_of_License

Deprecated

Kind: global function
Returns: Array_of_License - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabIdInteger
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getAlienBuyOfferedLicensesForDab(userId, dabId, licenseTypeCode, pos, size) ⇒ Array_of_License

Deprecated

Kind: global function
Returns: Array_of_License - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabIdInteger
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

actualiseBoughtDeals(userId, userCredentials, licenseTypeCode) ⇒ Boolean

Deprecated

Kind: global function

ParamTypeDescription
userIdAddress
userCredentialsString
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.

getSoldDabs(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒ Array_of_Dab

Deprecated

Kind: global function
Returns: Array_of_Dab - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getSoldLicenses(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒ Array_of_License

Deprecated

Kind: global function
Returns: Array_of_License - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getSoldLicensesForDab(userId, dabId, licenseTypeCode, pos, size) ⇒ Array_of_License

Deprecated

Kind: global function
Returns: Array_of_License - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabIdInteger
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getMySellOfferedLicenses(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒ Array_of_License

Deprecated

Kind: global function
Returns: Array_of_License - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getMyBuyOfferedLicenses(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒ Array_of_License

Deprecated

Kind: global function
Returns: Array_of_License - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getMySellOfferedLicensesForDab(userId, dabId, licenseTypeCode, pos, size) ⇒ Array_of_License

Deprecated

Kind: global function
Returns: Array_of_License - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabIdInteger
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

getMyBuyOfferedLicensesForDab(userId, dabId, licenseTypeCode, pos, size) ⇒ Array_of_License

Deprecated

Kind: global function
Returns: Array_of_License - Look at Type description in Docs.

ParamTypeDescription
userIdAddress
dabIdInteger
licenseTypeCodeConstant_of_Integer(optional. default: null) Look at Constants description in Docs.
posInteger(optional. default: 0)
sizeInteger(optional. default: 10)

actualiseSoldDeals(userId, userCredentials, licenseTypeCode) ⇒ Boolean

Deprecated

Kind: global function

ParamTypeDescription
userIdAddress
userCredentialsString
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.

offerBuyExploreLicense(buyerId, buyerCredentials, dabId, maxLeosPrice, termSheetTemplate, terms) ⇒ Constant_of_Integer

Deprecated

Kind: global function
Returns: Constant_of_Integer - tradeStatusCode Look at Constants description in Docs.

ParamTypeDescription
buyerIdAddress
buyerCredentialsString
dabIdInteger
maxLeosPriceInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

offerSellOwnership(sellerId, sellerCredentials, buyerId, dabId, minPrice, termSheetTemplate, terms) ⇒ Boolean

Deprecated

Kind: global function

ParamTypeDescription
sellerIdAddress
sellerCredentialsString
buyerIdAddress
dabIdInteger
minPriceInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

offerBuyOwnership(buyerId, buyerCredentials, dabId, maxPrice, termSheetTemplate, terms) ⇒ Boolean

Deprecated

Kind: global function

ParamTypeDescription
buyerIdAddress
buyerCredentialsString
dabIdInteger
maxPriceInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

approveOwnershipDeal(custodianId, custodianCredentials, buyerId, dabId) ⇒ Boolean

Deprecated

Kind: global function

ParamType
custodianIdAddress
custodianCredentialsString
buyerIdAddress
dabIdInteger

offerBuyCustody(buyerId, buyerCredentials, dabId, maxPrice, termSheetTemplate, terms) ⇒ Boolean

Deprecated

Kind: global function

ParamTypeDescription
buyerIdAddress
buyerCredentialsString
dabIdInteger
maxPriceInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

offerSellCustody(sellerId, sellerCredentials, buyerId, dabId, minPrice, termSheetTemplate, terms) ⇒ Boolean

Deprecated

Kind: global function

ParamTypeDescription
sellerIdAddress
sellerCredentialsString
buyerIdAddress
dabIdInteger
minPriceInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

approveCustodyDeal(custodianId, custodianCredentials, buyerId, dabId) ⇒ Boolean

Deprecated

Kind: global function

ParamType
custodianIdAddress
custodianCredentialsString
buyerIdAddress
dabIdInteger

offerSellAccess(sellerId, sellerCredentials, buyerId, dabId, minPrice, termSheetTemplate, terms) ⇒ Boolean

Deprecated

Kind: global function

ParamTypeDescription
sellerIdAddress
sellerCredentialsString
buyerIdAddress
dabIdInteger
minPriceInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

offerBuyAccess(buyerId, buyerCredentials, dabId, maxPrice, termSheetTemplate, terms) ⇒ Boolean

Deprecated

Kind: global function

ParamTypeDescription
buyerIdAddress
buyerCredentialsString
dabIdInteger
maxPriceInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

approveAccessDeal(custodianId, custodianCredentials, buyerId, dabId) ⇒ Boolean

Deprecated

Kind: global function

ParamType
custodianIdAddress
custodianCredentialsString
buyerIdAddress
dabIdInteger

offerSellReshare(sellerId, sellerCredentials, buyerId, dabId, minPrice, termSheetTemplate, terms) ⇒ Boolean

Deprecated

Kind: global function

ParamTypeDescription
sellerIdAddress
sellerCredentialsString
buyerIdAddress
dabIdInteger
minPriceInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

approveReshareDeal(custodianId, custodianCredentials, buyerId, dabId) ⇒ Boolean

Deprecated

Kind: global function

ParamType
custodianIdAddress
custodianCredentialsString
buyerIdAddress
dabIdInteger

offerSellTag(licenseTypeCode, sellerId, sellerCredentials, buyerId, dabId, minPrice, tagId, termSheetTemplate, terms) ⇒ Boolean

Deprecated

Kind: global function
Returns: Boolean - isOK

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
sellerIdAddress
sellerCredentialsString
buyerIdAddress
dabIdInteger(optional. default: 0)
minPriceInteger
tagIdInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

offerBuyTag(licenseTypeCode, buyerId, buyerCredentials, dabId, maxPrice, tagId, termSheetTemplate, terms) ⇒ Boolean

Deprecated

Kind: global function
Returns: Boolean - isOK

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
buyerIdAddress
buyerCredentialsString
dabIdInteger(optional. default: 0)
maxPriceInteger
tagIdInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

approveTagDeal(licenseTypeCode, custodianId, custodianCredentials, buyerId, dabId, tagId) ⇒ Boolean

Deprecated

Kind: global function
Returns: Boolean - isOK

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
custodianIdAddress
custodianCredentialsString
buyerIdAddress
dabIdInteger
tagIdInteger

offerSellToTag(licenseTypeCode, sellerId, sellerCredentials, buyerId, buyerTagId, minPrice, sellerDabId, termSheetTemplate, terms) ⇒ Boolean

Deprecated

Kind: global function
Returns: Boolean - isOK

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
sellerIdAddress
sellerCredentialsString
buyerIdAddress
buyerTagIdInteger(optional. default: 0)
minPriceInteger
sellerDabIdInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

offerBuyToTag(licenseTypeCode, buyerId, buyerCredentials, buyerTagId, maxPrice, sellerDabId, termSheetTemplate, terms) ⇒ Boolean

Deprecated

Kind: global function
Returns: Boolean - isOK

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
buyerIdAddress
buyerCredentialsString
buyerTagIdInteger(optional. default: 0)
maxPriceInteger
sellerDabIdInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

approveToTagDeal(licenseTypeCode, custodianId, custodianCredentials, buyerId, buyerTagId, sellerDabId) ⇒ Boolean

Deprecated

Kind: global function
Returns: Boolean - isOK

ParamTypeDescription
licenseTypeCodeConstant_of_IntegerLook at Constants description in Docs.
custodianIdAddress
custodianCredentialsString
buyerIdAddress
buyerTagIdInteger
sellerDabIdInteger

offerSellExplore(sellerId, sellerCredentials, buyerId, dabId, minPrice, buyerPubKeyEncryptedTagKey, termSheetTemplate, terms) ⇒ Boolean

Deprecated

Kind: global function
Returns: Boolean - isOK

ParamTypeDescription
sellerIdAddress
sellerCredentialsString
buyerIdAddress
dabIdInteger
minPriceInteger
buyerPubKeyEncryptedTagKeyString(optional. default: null)
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

offerBuyExplore(buyerId, buyerCredentials, dabId, maxPrice, termSheetTemplate, terms) ⇒ Boolean

Deprecated

Kind: global function
Returns: Boolean - isOK

ParamTypeDescription
buyerIdAddress
buyerCredentialsString
dabIdInteger
maxPriceInteger
termSheetTemplateConstant_of_String(optional. default: "licenseUnrestrictedTerms") Look at Constants description in Docs.
termsObject(optional. default: null)

approveExploreDeal(custodianId, custodianCredentials, buyerId, dabId) ⇒ Boolean

Deprecated

Kind: global function
Returns: Boolean - isOK

ParamType
custodianIdAddress
custodianCredentialsString
buyerIdAddress
dabIdInteger

offerSellBulk(sellerId, sellerCredentials, buyerId, dabId, minPrice, termSheetTemplate, terms) ⇒ Boolean

Deprecated

Kind: global function
Returns: Boolean - isOK

ParamTypeDescription
sellerIdAddress
sellerCredentials