showOrHideDirectoryFieldsForUser

Enables a User to show/hide fields from the Directory they exist within (mainly for privacy purposes)

Request

POST /rest/smartdirectory/{directoryUUID}/directoryFields/showOrHide

Headers

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

Parameters

Path Params:

Parameter	Type	Required	Description
directoryUUID	String	Yes	UUID of the Smart Directory as setup in SAM

JSON Request Fields:

Parameter	Type	Required	Description
fields.id	Integer	Yes	Internal id of the field. See getDirectoryMetadataByUUID
fields.hide	String	Yes	Y/N value specifying whether the field should be hidden or not

JSON Request:

{
  "fields": [
    {
      "id": 1,
      "hide": "Y"
    },
    {
      "id": 2,
      "hide": "Y"
    },
    {
      "id": 3,
      "hide": "Y"
    }
  ]
}

Response

200 OK

JSON response of the fields and their updated show/hide statuses.

{
  "fields": [
    {
      "id": 1,
      "hide": "Y"
    },
    {
      "id": 2,
      "hide": "Y"
    },
    {
      "id": 3,
      "hide": "Y"
    }
  ],
  "fieldsToBeShown": [],
  "fieldsToBeHidden": [
    1,
    2,
    3
  ]
}

Errors

Exception	Description
WSInvalidAuthTokenException	See Error Definitions
WSCacheServiceException	See Error Definitions
WSInvalidParameterException	See Error Definitions
WSSmartDirectoryNotFoundException	See Error Definitions
WSSmartDirectoryServiceException	See Error Definitions
WSUserNotConsentedException	See Error Definitions
WSSmartDirectoryNotEnabledForCompanyException	See Error Definitions
WSUserContactNotFoundException	See Error Definitions
WSUserNotInSmartDirectoryException	See Error Definitions
WSSmartDirectoryInactiveException	See Error Definitions
WSAddressServiceException	See Error Definitions
WSAddressAlreadyFullException	See Error Definitions
WSContactNotFoundException	See Error Definitions
WSNoAddressFieldsInDirectoryException	See Error Definitions
WSFieldLengthException	See Error Definitions