Gigya Job Openings

ds.getSchema JS

Skip to end of metadata
Go to start of metadata

Description

 

This method retrieves the schema of the Profile object and the Data object (the site specific custom data object) in Gigya's Accounts Storage. The schema defines a set of properties for static data fields. The properties act as meta-data, guiding Gigya how to handle the data in the specified fields.

Note: If you plan on integrating Gigya's Accounts API, we highly recommend reading the Registration-as-a-Service Guide. Registration-as-a-Service (RaaS) is a premium platform that requires separate activation. If RaaS is not part of your site package, please contact Gigya by filling in a support form through the Console. You can access the support page by clicking Support on the upper menu after logging into the Gigya Console.


Note: This method is also supported in our REST API. If you wish to execute this method from your server, please refer to

REST API > ds.getSchema

Syntax

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription
callbackfunctionA reference to a callback function. Gigya calls the specified function along with the results of the API method when the API method completes.
The callback function should be defined with the following signature: functionName(response).

Code Sample

<script type="text/javascript">
    function showSchemaInfo(response) {
        alert(JSON.stringify(response));
    }

    function getSchemaInfo() {
        var params = { //set up the callback to handle the response 
            callback: showSchemaInfo
        };

        gigya.ds.getSchema(params);
    }
</script>

Notes:

  • This sample is not meant to be fully functional code. For brevity's sake, only the code required for demonstrating the API call itself is presented.
  • To run the code on your own domain, add your Gigya API key to the gigya.js URL. A Gigya API key can be obtained on the Site Dashboard page on Gigya's website. Please make sure that the domain from which you are loading the page is the same domain name that you used for generating the API key.
  • In some cases it is necessary to connect/login the user to a provider ? prior to calling the API method. You can learn more in the Social Login guide.


  • No labels