beetaggcore
Data types
Property
A generic property of a Code or Code Series.

Reserved property names for Teams (Providers):
dir A folder name. Invalid characters: ":", "/". Max. chars: 30
tag A tag name. Invalid characters: ":". Max. chars: 30


Reserved property names for Codes and Code Series:
starred A Code / Code Series that has been starred.
comment A comment about a Code / Code Series
dir A folder name. Invalid characters: ":", "/". Max. chars: 30
hostname The Custom Hostname that should be used for the QR Code or Datamatrix
displaypropertyname Defines which offset property name is used as a title. Used with Code Series only.


NamestringThe identifier of the property.
ValuestringThe value of the property.
Provider
Describes a Team.
IDint64The id of the Team.
NamestringThe name of the Team.
Creditsint64The amount of BeeTagg Credits available for the Team.
BillingContactint64The user id of the billing contact.
OwnerContactint64The user id of the owner contact.
TechnicalContactint64The user id of the technical contact.
Range
Attributes used to describe a Dynamic Code, Static Code or Code Series. This does not contain its size or redirect properties.
IDint64The id of the Dynamic Code, Static Code or Code Series.
ParentRangeIDint64To be ignored.
ProviderIDint64The id of the Team.
TitlestringThe title of the Code or Code Series.
EncryptionKeystringA key that can be used to encrypt parts of the target URL (Redirect Pattern). See also Encrypted Codes
PremiumboolTo be ignored.
TamperProtectionboolTo be ignored.
ControlledByint64To be ignored.
SecureboolTo be ignored.
Sizestring (used as BigInteger)The size of the Code Series. 1 for single Codes.
CreateDatestringThe date when the Code has been created (UTC). Format: YYYY-MM-DD HH24:MM:SS
ApplicationID The id of the application that handles the Code or Code Series.

1 : Dynamic Link
2 : Not available
3 : BeeTagg Contact
4 : Static Link
5 : Static Call
6 : Static Text
7 : Static Geo
8 : Not available
9 : Static SMS
10 : Static Email
11 : Static Contact (vCard)
Visibilitystring The visibility of the code:
  • Active (The Code works normally)
  • Trash (The Code does not redirect anymore, but can be worked with via APIs)
  • Deleted (The Code does not redirect and cannot be worked with via APIs, except with special permissions)
StaticCodestringA StaticCode data type of a Static Code.
RangeInfo
Most useful properties of a Code or Code Series.
RangeIDint64The id of the Dynamic Code, Static Code or Code Series.
ParentRangeIDint64To be ignored.
ProviderIDint64The id of the Team.
TitlestringThe title of the Code or Code Series.
PremiumboolTo be ignored.
TamperProtectionboolTo be ignored.
SecureboolTo be ignored.
Sizestring (used as BigInteger)The size of the Code Series. 1 for single Codes.
CodeSystemstringThe code system of the Code:
  • Honeycomb
  • QRCode
  • Datamatrix
MimeTypestringThe Mime Type of the Code's content. (E.g. text/html)
StaticboolTrue, if it is a Static Code. False for Dynamic Codes and Code Series.
CreateDatestringThe date when the Code has been created (UTC). Format: YYYY-MM-DD HH24:MM:SS
ApplicationID The id of the application that handles the Code or Code Series.

1 : Dynamic Link
2 : Not available
3 : BeeTagg Contact
4 : Static Link
5 : Static Call
6 : Static Text
7 : Static Geo
8 : Not available
9 : Static SMS
10 : Static Email
11 : Static Contact (vCard)
RangePropertiesArray of PropertyProperties of the Code or Code Series.
Visibilitystring The visibility of the code:
  • Active (The Code works normally)
  • Trash (The Code does not redirect anymore, but can be worked with via APIs)
  • Deleted (The Code does not redirect and cannot be worked with via APIs, except with special permissions)
RedirectPattern
A pattern which allows to compute a URL at the time of a scan / click. The pattern can contain variables, which will be replaced at scan time.
RangeIDint64The id of the Dynamic Code, Static Code or Code Series.
IDint64The Redirect Pattern Id. Used for manipulation.
TitlestringThe title of the Redirect Pattern.
MimeTypestringMime type of target of pattern. Null if unknown.
PatternstringPattern used to create the redirect target URL from. E.g. http://www.mymobilepage.com/?page=123
DefaultboolTo be ignored.
ClientSpecificboolTo be ignored.
StaticCode
A data type that describes a Static Code.
IDint64The id of the Static Code.
ContentstringThe content of the Static Code
MimeTypestringThe mime type of the content of the Static Code.
EncodingstringThe encoding of the content of the Static Code. E.g. UTF-8
CodeSystemstringThe used code system of the Static Code. Possible values are QRCode and Datamatrix.
©2005-2018 connvision AG - Datenschutzerklärung - Nutzungsbedingungen - Kontakt
English