ids.getSchema REST

Skip to end of metadata
Go to start of metadata

 

Note: If you plan on integrating Gigya's Profile Management (IDS), we highly recommend reading the Identity Storage Guide. Profile Management (IDS) is a premium platform that requires separate activation. If it is not yet a part of your existing site package, please contact Gigya Support via the Support link in the top menu of your Console Dashboard or email support@gigya.com.

Description

This API retrieves the schema of the Profile object and the Data object (the site specific custom data object) in Gigya's Profile Management. 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.

 

 

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
filterstringSpecifies what parts of the schema to return, can be one of the following options: 
  • full (default) - return the complete schema including implicit fields and dynamic fields.
  • explicitOnly- return only the parts of the schema that were explicitly set by the partner using a setSchema call.
  • clientOnly- return only the fields in the schema that allow client access. For those fields return only the type and format and required properties (see the format definition of the schema object).
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.
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.

Please refer to the Authorization Parameters section for details. 

 

Response Data

FieldTypeDescription
 
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
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.
statusReason string A brief explanation of the status code.
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.
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

 

 

profileSchemaJSON objectA JSON object defining the schema of the Profile object. See the format definition of the schema object
dataSchemaJSON objectA JSON object defining the schema of the Data object (the site specific custom data object). See the format definition of the schema object

 

Response Example

{
  "profileSchema": {"fields":
	{
	"age":{"writeAccess":"clientModify","type":"integer"},
	"email":{"writeAccess":"clientModify","type":"string"},
	"gender":{"writeAccess":"clientModify","type":"string"},
	"birthMonth":{"writeAccess":"clientModify","type":"integer"},
	"birthDay":{"writeAccess":"clientModify","type":"integer"}
	}},
  "dataSchema": {},
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK",
  "callId": "323beb60290b430c8834a2c699d90ca7",
  "time": "2015-03-22T11:42:25.943Z"
}