GET api/v2/ThyngDetails?thyngCode={thyngCode}&verification={verification}&appUserID={appUserID}&techCode={techCode}&version={version}

Retrieve information about any given Thyng

Complete URL https://api.thyngs.net/api/v2/ThyngDetails?thyngCode={thyngCode}&verification={verification}&appUserID={appUserID}&techCode={techCode}&version={version}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
thyngCode

The Thyng Code to return i.e ANA00014. For iBeacon requests use comma separted values (CSV) for UUID, Major, Minor e.g "UUID 5DA978B9-7BED-4274-8631-5869EE593183,1,1"

string

Required

verification

Optional parameter used to send additional verification information

string

None.

appUserID

ID of User from the App. Must be set to a valid user to receive beacon notifications

string

None.

techCode

Technology used to scan the thyng: Q - QR, N - NFC and U - URL

string

Default value is U

version

Version number of the Thyng. This can be used to show historic version of the page if loading from history

string

None.

Body Parameters

None.

Response Information

Resource Description

ThyngInfoModel
NameDescriptionTypeAdditional information
Code

Unique ID for a Thyng

string

None.

ThyngName

User friendly name for this Thyng

string

None.

Bio

Description of this Thyng

string

None.

ThyngOwner

Company that this Thyng belongs to

string

None.

Colour

Default colour used in the branding of this Thyng

string

None.

ThumbImg

URL of the image which represents this Thyng for use in Thumbnails

string

None.

FavouritesImg

URL of the image which represents this Thyng for use in Favourites display

string

None.

LoadingImg

URL of the image which should be displayed whilst loading this Thyng

string

None.

Technology

Technology used to load this Thyng

string

None.

ProductType

The Type of Thyng product. e.g. Hidden Sticker or Pynger

string

None.

Category

Category which this Thyng is grouped into

string

None.

OfficialThyng

Returns text to state if the interaction is officially supported by Thyngs

string

None.

Version

Current version reference for the Thyng Page that is linked to this Thyng

string

None.

NotificationEvents

List of push notifications associated with this thyng

Collection of NotificationEvent

None.

Response Formats

application/json, text/json

Sample:
{
  "Code": "sample string 1",
  "ThyngName": "sample string 2",
  "Bio": "sample string 3",
  "ThyngOwner": "sample string 4",
  "Colour": "sample string 5",
  "ThumbImg": "sample string 6",
  "FavouritesImg": "sample string 7",
  "LoadingImg": "sample string 8",
  "Technology": "sample string 9",
  "ProductType": "sample string 10",
  "Category": "sample string 11",
  "OfficialThyng": "sample string 12",
  "Version": "sample string 13",
  "NotificationEvents": [
    {
      "Event": "sample string 1",
      "Data": "sample string 2",
      "NotificationTitle": "sample string 3",
      "NotificationBody": "sample string 4"
    },
    {
      "Event": "sample string 1",
      "Data": "sample string 2",
      "NotificationTitle": "sample string 3",
      "NotificationBody": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<ThyngInfoModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models">
  <Bio>sample string 3</Bio>
  <Category>sample string 11</Category>
  <Code>sample string 1</Code>
  <Colour>sample string 5</Colour>
  <FavouritesImg>sample string 7</FavouritesImg>
  <LoadingImg>sample string 8</LoadingImg>
  <NotificationEvents>
    <NotificationEvent>
      <Data>sample string 2</Data>
      <Event>sample string 1</Event>
      <NotificationBody>sample string 4</NotificationBody>
      <NotificationTitle>sample string 3</NotificationTitle>
    </NotificationEvent>
    <NotificationEvent>
      <Data>sample string 2</Data>
      <Event>sample string 1</Event>
      <NotificationBody>sample string 4</NotificationBody>
      <NotificationTitle>sample string 3</NotificationTitle>
    </NotificationEvent>
  </NotificationEvents>
  <OfficialThyng>sample string 12</OfficialThyng>
  <ProductType>sample string 10</ProductType>
  <Technology>sample string 9</Technology>
  <ThumbImg>sample string 6</ThumbImg>
  <ThyngName>sample string 2</ThyngName>
  <ThyngOwner>sample string 4</ThyngOwner>
  <Version>sample string 13</Version>
</ThyngInfoModel>