getDirectoryMetadataByUUID

Returns all necessary metadata relating to a Smart Directory including: 1.) Fields 2.) Filters 3.) Directory Consents (could be mixture of Required or Not Required) 4.) User Consents - as they relate to above consents

Request

GET /rest/smartdirectory/{smartDirectoryUUID}

Headers

Header	Required	Description
x-nextinteract-authtoken	Yes	Auth token returned from loginUser

Parameters

smartDirectoryUUID - path parameter. UUID of the Smart Directory as set up in SAM.

Response

200 OK

{
    "id": 1,
    "companyId": 3,
    "name": "Default Directory",
    "desc": "Default Directory Description",
    "accessUserDirectoryData": "Y",
    "contactsInitiallyVisible": "Y",
    "filters": [],
    "fields": [
        {
            "directoryFieldId": 1,
            "fieldName": "email",
            "fieldLabel": "Email Address",
            "jsonName": "contactEmail1",
            "type": "text",
            "maxLength": 254,
            "order" : 1
        },
        {
            "directoryFieldId": 2,
            "fieldName": "firstName",
            "fieldLabel": "First Name",
            "jsonName": "contactFirstname",
            "type": "text",
            "maxLength": 50,
            "order" : 2
        },
        {
            "directoryFieldId": 3,
            "fieldName": "lastName",
            "fieldLabel": "Last Name",
            "jsonName": "contactLastname",
            "type": "text",
            "maxLength": 50,
            "order" : 3
        }
    ],
    "directoryConsents": [
        {
            "id": 2,
            "name": "Sync my User Profile with this Directory",
            "desc": "Sync my User Profile with this Directory",
            "consentType": {
                "name": "Sync my User Profile with this Directory",
                "desc": "Sync my User Profile with this Directory"
            },
            "required": "N"
        },
        {
            "id": 1,
            "name": "Share Details",
            "desc": "Your details will be shared with others in the directory",
            "consentType": {
                "name": "Share personal details with others in a directory",
                "desc": "Share personal details with others in a directory..."
            },
            "required": "Y"
        }
    ],
    "userConsents": [
        {
            "userId": 8,
            "value": "Y",
            "consent": {
                "id": 1,
                "name": "Share Details",
                "desc": "Your details will be shared with others in the directory",
                "consentType": {
                    "name": "Share personal details with others in a directory",
                    "desc": "Share personal details with others in a directory..."
                },
                "required": "Y"
            }
        }
    ],
    "uuid": "defaultdirectoryuuid"
}

Errors

Exception	Description
WSInvalidAuthTokenException	See Error Definitions
WSCacheServiceException	See Error Definitions
WSInvalidParameterException	See Error Definitions
WSSmartDirectoryNotFoundException	See Error Definitions
WSSmartDirectoryServiceExceptio	See Error Definitions
WSSmartDirectoryNotEnabledForCompanyException	See Error Definitions
WSUserContactNotFoundException	See Error Definitions
WSUserNotInSmartDirectoryException	See Error Definitions