Gigya Job Openings

accounts.getScreenSets REST

Skip to end of metadata
Go to start of metadata

 

This method retrieves one or more screen-sets hosted by Gigya.

This method call can only be made as a secured server request. In other words, you may use this method using one of our Server Side SDKs or direct REST API calls, and you must pass your Secret Key.

 

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.


 

Request URL

Where <Data_Center> is:
  • us1.gigya.com - For the US data center.
  • eu1.gigya.com - For the European data center.
  • au1.gigya.com - For the Australian data center.
  • ru1.gigya.com - For the Russian data center.
  • cn1.gigya-api.cn - For the Chinese data center.

If you are not sure of your site's data center, see Finding Your Data Center.

 

Parameters

RequiredNameTypeDescription
screenSetIDsarray or stringEither a comma separated list or an array of identifiers of the screen-sets to be retrieved. When not specified returns all the screen-sets associated with the site (apiKey). To return screen-sets outside of the local site, e.g., when in an SSO Group, you must specify the screenSetIDs of the screen-set to return.
includestring
A comma separated list of top level fields to include in the response. Possible values are:
  • screenSetID
  • html
  • css
  • javascript
  • translations
The default response includes all of the above.
lang If translations exist for the screen-set(s), you can specify which language to return. If not provided, lang defaults to NULL and the default localization is used. See Advanced Customizations and Localization for supported values.
format string Determines the format of the response. The options are:
  • json (default)
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
callback string This parameter is required only when the format parameter is set to jsonp (see above). In such cases this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
context string/JSON This parameter may be used to pass data through the current method and return it, unchanged, within the response.
dontHandleScreenSet Boolean This parameter may be used in order to suppress the showing of screen-sets as a result of API calls. Default is false.
httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if one occurred.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side IP rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:

  • accounts.login
  • socialize.login
  • accounts.notifyLogin
  • socialize.notifyLogin
  • accounts.finalizeRegistration
  • accounts.linkAccounts

Please refer to the Authorization Parameters section for details. 

Sample Requests

 

Response Data

FieldTypeDescription
screenSetsarrayAn array of screenSet objects that are returned with the top level fields that are defined in the include parameter, by default:
  • screenSetID - the identifier of the retrieved screen-set
  • html - the HTML code that defines the screen-set
  • css - the CSS that defines the style of the screen-set
 
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
fullEventName string The full name of the event that triggered the response. This is an internally used parameter that is not always returned and should not be relied upon by your implementation.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
This property is deprecated and only returned for backward compatibility.
statusReason string A brief explanation of the status code.
This property is deprecated and only returned for backward compatibility.

 

A field that does not contain data will not appear in the response.

 

Response Example

{
    "statusCode": 200,
    "errorCode": 0,
    "statusReason": "OK",
    "callId": "d283b155fcbc4c48836f29c4e87e77a8",
    "time": "2015-03-22T11:42:25.943Z",
    "screenSets": [
        {
            "screenSetID": "18091",
            "html":"<div class=\"gigya-screen-set\"  id=\"my-screens\" style=\"display:none\">
                    <div class=\"gigya-screen\"  id=\"screen1\">   ...  </div>
                    <div class=\"gigya-screen\"  id=\"screen2\" >   ...  </div>
                    <div class=\"gigya-screen\"  id=\"screen3\" >   ...  </div>
                    ...
                    </div>",
            "css": ".gigya-screen *, div.gigya-screen, .gigya-screen span, .gigya-screen a:hover, .gigya-screen a:visited, .gigya-screen a:link, .gigya-screen a:active {\r\n  
                    border: none;\r\n
                    padding: 0px;\r\n         
                    margin: 0px;\r\n
                    color: inherit;\r\n
                    text-decoration: none;\r\n
                    -moz-border-radius: 0;\r\n
                    font-family: arial;\r\n
                    font-size: 12px;\r\n
                    color: #333333;\r\n
                    text-align: left;\r\n
                    }",
        },
        {
            "screenSetID": "18091",
           "html":"<div class=\"gigya-screen-set\"  id=\"my-screens\" style=\"display:none\">
                    <div class=\"gigya-screen\"  id=\"screen1\">   ...  </div>
                    <div class=\"gigya-screen\"  id=\"screen2\" >   ...  </div>
                    <div class=\"gigya-screen\"  id=\"screen3\" >   ...  </div>
                    ...
                    </div>",
            "css": ".gigya-screen *, div.gigya-screen, .gigya-screen span, .gigya-screen a:hover, .gigya-screen a:visited, .gigya-screen a:link, .gigya-screen a:active {\r\n 
                    border: none;\r\n
                    padding: 0px;\r\n        
                    margin: 0px;\r\n
                    color: inherit;\r\n
                    text-decoration: none;\r\n
                    -moz-border-radius: 0;\r\n
                    font-family: arial;\r\n
                    font-size: 12px;\r\n
                    color: #333333;\r\n
                    text-align: left;\r\n
                    }",
        }
    ]
}