curl --request POST \
--url https://safe.dfda.earth/api/v3/userTags \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conversionFactor": 123,
"taggedVariableId": 123,
"tagVariableId": 123
}
'{
"description": "<string>",
"summary": "<string>",
"errors": [
{
"message": "<string>"
}
],
"status": "<string>",
"success": true,
"code": 123,
"link": "<string>",
"card": {
"id": "<string>",
"actionSheetButtons": [
{
"link": "<string>",
"text": "<string>",
"accessibilityText": "<string>",
"action": {},
"additionalInformation": "<string>",
"color": "<string>",
"confirmationText": "<string>",
"functionName": "<string>",
"parameters": {},
"html": "<string>",
"id": "<string>",
"image": "<string>",
"ionIcon": "<string>",
"stateName": "<string>",
"stateParams": {},
"successToastText": "<string>",
"successAlertTitle": "<string>",
"successAlertBody": "<string>",
"tooltip": "<string>",
"webhookUrl": "<string>"
}
],
"avatar": "<string>",
"avatarCircular": "<string>",
"backgroundColor": "<string>",
"buttons": [
{
"link": "<string>",
"text": "<string>",
"accessibilityText": "<string>",
"action": {},
"additionalInformation": "<string>",
"color": "<string>",
"confirmationText": "<string>",
"functionName": "<string>",
"parameters": {},
"html": "<string>",
"id": "<string>",
"image": "<string>",
"ionIcon": "<string>",
"stateName": "<string>",
"stateParams": {},
"successToastText": "<string>",
"successAlertTitle": "<string>",
"successAlertBody": "<string>",
"tooltip": "<string>",
"webhookUrl": "<string>"
}
],
"buttonsSecondary": [
{
"link": "<string>",
"text": "<string>",
"accessibilityText": "<string>",
"action": {},
"additionalInformation": "<string>",
"color": "<string>",
"confirmationText": "<string>",
"functionName": "<string>",
"parameters": {},
"html": "<string>",
"id": "<string>",
"image": "<string>",
"ionIcon": "<string>",
"stateName": "<string>",
"stateParams": {},
"successToastText": "<string>",
"successAlertTitle": "<string>",
"successAlertBody": "<string>",
"tooltip": "<string>",
"webhookUrl": "<string>"
}
],
"content": "<string>",
"headerTitle": "<string>",
"html": "<string>",
"htmlContent": "<string>",
"image": "<string>",
"inputFields": [
{
"displayName": "<string>",
"type": "check_box",
"helpText": "<string>",
"hint": "<string>",
"icon": "<string>",
"id": "<string>",
"image": "<string>",
"key": "<string>",
"labelLeft": "<string>",
"labelRight": "<string>",
"link": "<string>",
"maxLength": 123,
"maxValue": 123,
"minLength": 123,
"minValue": 123,
"options": [
"<string>"
],
"placeholder": "<string>",
"postUrl": "<string>",
"required": true,
"show": true,
"submitButton": {
"link": "<string>",
"text": "<string>",
"accessibilityText": "<string>",
"action": {},
"additionalInformation": "<string>",
"color": "<string>",
"confirmationText": "<string>",
"functionName": "<string>",
"parameters": {},
"html": "<string>",
"id": "<string>",
"image": "<string>",
"ionIcon": "<string>",
"stateName": "<string>",
"stateParams": {},
"successToastText": "<string>",
"successAlertTitle": "<string>",
"successAlertBody": "<string>",
"tooltip": "<string>",
"webhookUrl": "<string>"
},
"validationPattern": "<string>",
"value": "<string>"
}
],
"ionIcon": "<string>",
"link": "<string>",
"parameters": {},
"selectedButton": {
"link": "<string>",
"text": "<string>",
"accessibilityText": "<string>",
"action": {},
"additionalInformation": "<string>",
"color": "<string>",
"confirmationText": "<string>",
"functionName": "<string>",
"parameters": {},
"html": "<string>",
"id": "<string>",
"image": "<string>",
"ionIcon": "<string>",
"stateName": "<string>",
"stateParams": {},
"successToastText": "<string>",
"successAlertTitle": "<string>",
"successAlertBody": "<string>",
"tooltip": "<string>",
"webhookUrl": "<string>"
},
"sharingBody": "<string>",
"sharingButtons": [
{
"link": "<string>",
"text": "<string>",
"accessibilityText": "<string>",
"action": {},
"additionalInformation": "<string>",
"color": "<string>",
"confirmationText": "<string>",
"functionName": "<string>",
"parameters": {},
"html": "<string>",
"id": "<string>",
"image": "<string>",
"ionIcon": "<string>",
"stateName": "<string>",
"stateParams": {},
"successToastText": "<string>",
"successAlertTitle": "<string>",
"successAlertBody": "<string>",
"tooltip": "<string>",
"webhookUrl": "<string>"
}
],
"sharingTitle": "<string>",
"subHeader": "<string>",
"subTitle": "<string>",
"title": "<string>"
}
}This endpoint allows users to tag foods with their ingredients. This information will then be used to infer the user intake of the different ingredients by just entering the foods. The inferred intake levels will then be used to determine the effects of different nutrients on the user during analysis.
curl --request POST \
--url https://safe.dfda.earth/api/v3/userTags \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conversionFactor": 123,
"taggedVariableId": 123,
"tagVariableId": 123
}
'{
"description": "<string>",
"summary": "<string>",
"errors": [
{
"message": "<string>"
}
],
"status": "<string>",
"success": true,
"code": 123,
"link": "<string>",
"card": {
"id": "<string>",
"actionSheetButtons": [
{
"link": "<string>",
"text": "<string>",
"accessibilityText": "<string>",
"action": {},
"additionalInformation": "<string>",
"color": "<string>",
"confirmationText": "<string>",
"functionName": "<string>",
"parameters": {},
"html": "<string>",
"id": "<string>",
"image": "<string>",
"ionIcon": "<string>",
"stateName": "<string>",
"stateParams": {},
"successToastText": "<string>",
"successAlertTitle": "<string>",
"successAlertBody": "<string>",
"tooltip": "<string>",
"webhookUrl": "<string>"
}
],
"avatar": "<string>",
"avatarCircular": "<string>",
"backgroundColor": "<string>",
"buttons": [
{
"link": "<string>",
"text": "<string>",
"accessibilityText": "<string>",
"action": {},
"additionalInformation": "<string>",
"color": "<string>",
"confirmationText": "<string>",
"functionName": "<string>",
"parameters": {},
"html": "<string>",
"id": "<string>",
"image": "<string>",
"ionIcon": "<string>",
"stateName": "<string>",
"stateParams": {},
"successToastText": "<string>",
"successAlertTitle": "<string>",
"successAlertBody": "<string>",
"tooltip": "<string>",
"webhookUrl": "<string>"
}
],
"buttonsSecondary": [
{
"link": "<string>",
"text": "<string>",
"accessibilityText": "<string>",
"action": {},
"additionalInformation": "<string>",
"color": "<string>",
"confirmationText": "<string>",
"functionName": "<string>",
"parameters": {},
"html": "<string>",
"id": "<string>",
"image": "<string>",
"ionIcon": "<string>",
"stateName": "<string>",
"stateParams": {},
"successToastText": "<string>",
"successAlertTitle": "<string>",
"successAlertBody": "<string>",
"tooltip": "<string>",
"webhookUrl": "<string>"
}
],
"content": "<string>",
"headerTitle": "<string>",
"html": "<string>",
"htmlContent": "<string>",
"image": "<string>",
"inputFields": [
{
"displayName": "<string>",
"type": "check_box",
"helpText": "<string>",
"hint": "<string>",
"icon": "<string>",
"id": "<string>",
"image": "<string>",
"key": "<string>",
"labelLeft": "<string>",
"labelRight": "<string>",
"link": "<string>",
"maxLength": 123,
"maxValue": 123,
"minLength": 123,
"minValue": 123,
"options": [
"<string>"
],
"placeholder": "<string>",
"postUrl": "<string>",
"required": true,
"show": true,
"submitButton": {
"link": "<string>",
"text": "<string>",
"accessibilityText": "<string>",
"action": {},
"additionalInformation": "<string>",
"color": "<string>",
"confirmationText": "<string>",
"functionName": "<string>",
"parameters": {},
"html": "<string>",
"id": "<string>",
"image": "<string>",
"ionIcon": "<string>",
"stateName": "<string>",
"stateParams": {},
"successToastText": "<string>",
"successAlertTitle": "<string>",
"successAlertBody": "<string>",
"tooltip": "<string>",
"webhookUrl": "<string>"
},
"validationPattern": "<string>",
"value": "<string>"
}
],
"ionIcon": "<string>",
"link": "<string>",
"parameters": {},
"selectedButton": {
"link": "<string>",
"text": "<string>",
"accessibilityText": "<string>",
"action": {},
"additionalInformation": "<string>",
"color": "<string>",
"confirmationText": "<string>",
"functionName": "<string>",
"parameters": {},
"html": "<string>",
"id": "<string>",
"image": "<string>",
"ionIcon": "<string>",
"stateName": "<string>",
"stateParams": {},
"successToastText": "<string>",
"successAlertTitle": "<string>",
"successAlertBody": "<string>",
"tooltip": "<string>",
"webhookUrl": "<string>"
},
"sharingBody": "<string>",
"sharingButtons": [
{
"link": "<string>",
"text": "<string>",
"accessibilityText": "<string>",
"action": {},
"additionalInformation": "<string>",
"color": "<string>",
"confirmationText": "<string>",
"functionName": "<string>",
"parameters": {},
"html": "<string>",
"id": "<string>",
"image": "<string>",
"ionIcon": "<string>",
"stateName": "<string>",
"stateParams": {},
"successToastText": "<string>",
"successAlertTitle": "<string>",
"successAlertBody": "<string>",
"tooltip": "<string>",
"webhookUrl": "<string>"
}
],
"sharingTitle": "<string>",
"subHeader": "<string>",
"subTitle": "<string>",
"title": "<string>"
}
}Enter your bearer token in the format Bearer access_token_here
Contains the new user tag data
Number by which we multiply the tagged variable value to obtain the tag variable (ingredient) value
This is the id of the variable being tagged with an ingredient or something.
This is the id of the ingredient variable whose value is determined based on the value of the tagged variable.
Successful Operation
Can be used as body of help info popup
Can be used as title in help info popup
ex. OK or ERROR
true or false
Response code such as 200
A super neat url you might want to share with your users!
Show child attributes
HTML element id
Show child attributes
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Smaller square image
Smaller circular image
Ex: #f2f2f2
Show child attributes
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Show child attributes
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: Content
Ex: Title
HTML for the entire card.
Ex:
Larger image of variable dimensions
Show child attributes
Ex: Title
check_box, date, email, number, postal_code, select_option, string, switch, text_area, unit, variable_category HTML element id
Selector list options
Ex: Title
Ex: Title
Show child attributes
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
See https://html5pattern.com/ for examples
Ex: ion-refresh
A link to a web page or something. Not much more to say about that.
Key value pairs derived from user input fields, button clicks, or preset defaults
Show child attributes
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: sharingBody
Show child attributes
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
Ex: connect
HTML element id
Ex: ion-refresh
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: sharingTitle
Ex: subTitle
Ex: subTitle
Ex: Title