"

DropDownValues API Overview

DropDownValue APIs return allowed values for GramChain code fields. These are used to populate dropdowns and can be filtered based on EntityID. Typically these values should be called once and cached locally by scanners on startup as their data rarely change.
The blockchain hash used to verify GramChain integrity hashes legible codes (values), not the Names/description associated with the codes.
For example, the international common code 'AU' is used as a MetalCode code to codify the more common Name/Description 'Gold'.
An advantage of this system is that the codes provide transparency (AU) while also allowing code the Name/Description fields to be in multiple languages

The DropDownValues API requires the following parameters:
  1. LanguageID = this field is a two character support for simple multi-language. Default value is 'en' for English, 'cn' for Chinese.
  2. EntityID = a field which allows for different results to be returned based on caller entity, (e.g. Cache, P2P, scanner) for scanner entries use empty string '' as default
  3. CallerID = the userID calling this API (if known). This allows for traceability of data access (required for scanner) but is not a required for public calls and can be left black.
  4. app = the calling app code. This filters events and other dropdown values based on the app. For vault scanners use 'scan' for P2P use 'p2p' for cache use 'cache'
  5. Optional Parameters = Parameters with a default of a empty string '' are optional or used as filters. if an empty string is passed they are ignored.

API Interfaces

GetDomainExplorerSettings (Link: GetDomainExplorerSettings?LanguageID=en&EntityID=&CallerID=UserID&Domain= )
Returns GetDomainExplorerSettings for GramChainExplorer based on the domain passed
Calling Parameters:

CurrencyByProvider (Link: CurrencyByProvider?LanguageID=en&EntityID=&CallerID=UserID&ProviderID=&PurposeCode= )
The Currencies accepted by a provider. PurposeCode desribes the required context, e.g. 'CustomerBank' returns the acceptable bank acccount currencies that a customer of the provider can have
Calling Parameters:

ProviderCodes (Link: ProviderCodes?LanguageID=en&EntityID=&CallerID=UserID&ScannerID=&app=scan&ProviderType=&CompanyID=&ProviderbyRoutesAndBids= )
The various vaults. For scanners use the ScannerID to retrieve the vault the scanner is assigned to.
Calling Parameters:

LanguagesForScanner (Link: LanguagesForScanner?LanguageID=&EntityID=&CallerID=UserID )
The various vaults. For scanners use the ScannerID to retrieve the vault the scanner is assigned to.
Calling Parameters:

GlobalSettingsSelect (Link: GlobalSettingsSelect?LanguageID=&EntityID=&SettingName=&Category=&CallerID=UserID )
Retrieves System wide Settings. Settings are Identified by a SettingName and functionally Grouped into categories
Calling Parameters:

LabelsForScanner (Link: LabelsForScanner?LanguageID=en&EntityID=&LabelGroup=&LabelCode= )
used for scanner labels, device = s
Calling Parameters:

LabelsForWeb (Link: LabelsForWeb?LanguageID=en&EntityID=&LabelGroup=&LabelCode= )
used for scanner labels, device = w
Calling Parameters:

LabelsDenormalized (Link: LabelsDenormalized?LanguageID=en&EntityID=&LabelGroup=&LabelCode=&Device=w )
used for scanner labels, device = w
Calling Parameters:

EventGroupings (Link: EventGroupings?LanguageID=&EntityID=&CallerID=UserID&VaultID=&CustodianID= )
Returns EventGrouping names. can be useful to group parcels together
Calling Parameters:

VaultLocations (Link: VaultLocations?LanguageID=&EntityID=&CallerID=UserID&VaultID=&CustodianID= )
Returns VaultLocation names. can be useful for inventory checking
Calling Parameters:

ItemCategoryCodes (Link: ItemCategoryCodes?LanguageID=en&EntityID=&ItemCategoryCode=&CallerID=UserID )
Bullion Type, Coins / Bars etc... Required field for Scanner. Default to 'Bar', short list.
Calling Parameters:

ItemTypeCodes (Link: ItemTypeCodes?LanguageID=en&EntityID=&CallerID=UserID&ItemCategoryCode= )
Bullion Type, Coins / Bars etc... Required field for Scanner. Default to 'Bar', short list.
Calling Parameters:

BrandCodes (Link: BrandCodes?LanguageID=en&EntityID=&CallerID=UserID&ItemCategoryCode= )
The Refiner Brands acceptable for GramChain listing. Required field for Scanner. This can be a long list
Calling Parameters:

CurrencyCodes (Link: CurrencyCodes?LanguageID=en&EntityID=&CallerID=UserID )
Currency codes implemented
Calling Parameters:

MetalCodes (Link: MetalCodes?LanguageID=en&EntityID=&CallerID=UserID )
Bullion Metal, such as gold, silver etc... Required field for Scanner, short list.
Calling Parameters:

MeasurementUnits (Link: MeasurementUnits?LanguageID=en&EntityID=&CallerID=UserID&measurementcode= )
Returns weight measurements and the ratio to convert them to grams. MeasurementCode is an optional parameter if only a specific row is desired (e.g. to know that 1 troy oz = 31.103500 grams) use empty string to return all
Calling Parameters:

EventTypeCodes (Link: EventTypeCodes?LanguageID=en&EntityID=&CallerID=UserID&app=scan )
The events that a user can perform, These are reflected in the Create/Audit and WithDraw buttons.
Calling Parameters:

EventTypeCodesByRFID (Link: EventTypeCodesByRFID?LanguageID=en&EntityID=&CallerID=UserID&RFID=&app=scan )
The events that a user can perform, These are reflected in the Create/Audit and WithDraw buttons used by Scanners. This API has an RFID statud dependent button enabler
Calling Parameters:

ShippingRates (Link: ShippingRates?LanguageID=en&EntityID=&CallerID=UserID&CompanyID=&RateName=&ShippingRateID=0 )
Returns the Rates for the given parameter filters. Use a \"\"(string) or 0 (numeric) defaults if a filter is not needed
Calling Parameters:

BidOverSpot (Link: BidOverSpot?LanguageID=en&EntityID=&CallerID=UserOne&CompanyID=&ProviderID=&BidKGMinimum=0&BidOverSpotID=0 )
Returns the Rates for the given parameter filters. Use a \"\"(string) or 0 (numeric) defaults if a filter is not needed
Calling Parameters:

ShippingRoute (Link: ShippingRoute?LanguageID=en&EntityID=&CallerID=UserOne&CompanyID=&ProviderID=&ToCountryCode=&ZipFrom=0&ZipTo=0&PostalCodeStart=&ShippingRateID=0&ShippingRouteID=0 )
Returns the Rates for the given parameter filters. Use a \"\"(string) or 0 (numeric) defaults if a filter is not needed
Calling Parameters:

UtilizationLockCodes (Link: UtilizationLockCodes?LanguageID=en&EntityID=&CallerID=UserID&app=scan )
Used by locking applications. Scanner does not need this.
Calling Parameters:

"