Dataset: Identity Protocol Settings

Dataset name: ds_identity_protocol_settings


Stores Identity protocol settings.

Fields in this dataset

Name Field Name Description Field Type Field Example
Identity Protocol Settings ID id The primary identifier for Identity Service protocol. serial 4
Name identity_protocol The name of the Identity protocol. varchar Profile
Email Setting identity_protocol_email_setting The email preference for this protocol. int
Email Setting Text identity_protocol_email_setting_text This will either be an email address or message text. varchar
ID identity_protocol_id The ID used with this protocol. varchar 2
Status identity_protocol_status Whether Identity protocol is enabled. int 1
Identity Protocol Settings Instance instance The instance this transaction relates to. int 3
Identity Protocol Settings Source source The source of the data - user or connection. varchar

Making an API request for this Dataset

Example Request to the Sandbox Server

Replace the following with your own details: UID KEY, API_KEY, CON_ID and instance N.

Replace sbx-api with api when making a connection to a real member on the production server (must be authenticated).

To return the data in XML, change UID.json to UID.xml.

Example Response

A response to this API request will be structured as follows.

  "4": {
    "id": "4",
    "ds_id": "4",
    "identity_protocol": "Profile",
    "identity_protocol_email_setting": "",
    "identity_protocol_email_setting_text": "",
    "identity_protocol_id": "2",
    "identity_protocol_status": "1"