Table of Contents
/Tokens/AddTextNote
Adds a text note to a token.
JSON
- Request
{ "tokenId":Required(Str(PTokenId)), "note":Required(Str(PNote)), "personal":Required(Boolean(PPersonal)) }- Response (if successful)
{ "Note":Required(PNote) }
XML
- Request
<AddTextNote xmlns="https://waher.se/Schema/BrokerAgent.xsd" tokenId=(Required(Str(PTokenId))) note=(Required(Str(PNote))) personal=(Required(Boolean(PPersonal)))/>- Response (if successful)
<NoteResult xmlns="https://waher.se/Schema/BrokerAgent.xsd"> <Note> <[Required(PNote)]> </Note> </NoteResult>
Input Parameters
| Parameter | Description |
|---|---|
PTokenId |
ID of token. |
PNote |
Text note to add. |
PPersonal |
If the note is personal or note. Personal notes are deleted when the token changes owner. |
Response Parameters
| Parameter | Description |
|---|---|
PNote |
Generated note added to the token. |
Javascript Library
Use the following asynchronous method in the Javascript Library, to call this resource.
var Response = await AgentAPI.Tokens.AddTextNote(TokenId,Note,Personal);