groupModel

Namespace: http://filecatalyst.com/model
XML Schema: model.xsd

User Group model class

XML

Attributes

name type description
href string Hyperlink reference to the resource

Elements

name (type) min/max
occurs
description
groupName (string) 0/1 Group name.
jobsShared (boolean) 0/1 If this flag is set, users within the group will be able to view each other's jobs.
sharedFolder (boolean) 0/1 Flag to enabled Group File Area for the all the users of the group. This is separate from "My File Area," which is the individual user's personal space.
myFileArea (boolean) 0/1 Flag to enabled My File Area for the all the users of the group.
ftpSite (nameHrefModel) 0/1 Will be the server assigned to host the Group Folder. The server can be defined in FTP/FC Locations. Only Enterprise version allows for multiple FTP/FC Sites.
readOnly (boolean) 0/1 Read permission will allow all user to download files from the group folder.
writeOnly (boolean) 0/1 Will allow all users to upload to the group folder. Overwriting the path of a group folder, allows to create 2 groups pointing to the same group folder but with different permissions. One group could only have READ access while a different group could have both READ and WRITE access.
folderPathFromRoot (string) 0/1 If left blank the path to the share folder will be: //public_folders/ The path can be overwritten, to point to any directory under FTPRoot of the server.
orderform (nameHrefModel) 0/unbounded List of order forms associated with this group.
user (nameHrefModel) 0/unbounded List of users associated with this group.

JSON

property type description
href string Hyperlink reference to the resource
groupName groupName (string) Group name.
jobsShared jobsShared (boolean) If this flag is set, users within the group will be able to view each other's jobs.
sharedFolder sharedFolder (boolean) Flag to enabled Group File Area for the all the users of the group. This is separate from "My File Area," which is the individual user's personal space.
myFileArea myFileArea (boolean) Flag to enabled My File Area for the all the users of the group.
ftpSite ftpSite (nameHrefModel) Will be the server assigned to host the Group Folder. The server can be defined in FTP/FC Locations. Only Enterprise version allows for multiple FTP/FC Sites.
readOnly readOnly (boolean) Read permission will allow all user to download files from the group folder.
writeOnly writeOnly (boolean) Will allow all users to upload to the group folder. Overwriting the path of a group folder, allows to create 2 groups pointing to the same group folder but with different permissions. One group could only have READ access while a different group could have both READ and WRITE access.
folderPathFromRoot folderPathFromRoot (string) If left blank the path to the share folder will be: //public_folders/ The path can be overwritten, to point to any directory under FTPRoot of the server.
orderform array of orderform (nameHrefModel) List of order forms associated with this group.
user array of user (nameHrefModel) List of users associated with this group.