Skip to content

getUserConsentsForDirectory ​

Returns all Consents made by a User against a given Directory

Request ​

http
GET /rest/smartdirectory/{smartDirectoryUUID}/userConsents

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

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

Response ​

200 OK ​

json
[
    {
        "userId": 8,
        "value": "Y",
        "consent": {
            "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"
        }
    },
    {
        "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"
        }
    }
]

Errors ​

ExceptionDescription
WSInvalidAuthTokenExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions
WSInvalidParameterExceptionSee Error Definitions
WSSmartDirectoryNotFoundExceptionSee Error Definitions
WSSmartDirectoryServiceExceptioSee Error Definitions
WSSmartDirectoryNotEnabledForCompanyExceptionSee Error Definitions
WSUserContactNotFoundExceptionSee Error Definitions
WSUserNotInSmartDirectoryExceptionSee Error Definitions