Jump to

• Request
• Response

Remove the members from the specified group.

delete

/social/api/v1/groups/{groupID}/members

Member cannot be removed from the IDCS group. NOTE : Query Param 'disableNotifications' can be set during the Rest request. If 'disableNotifications' is set to true, then no Notification will be sent to the removed members.

Request

Supported Media Types

• application/json

Path Parameters

• groupID: integer(int64)
  The group ID. The object's unique identifier from a long integer representation.

Body ()

The request body defines the details of the request.

Root Schema : XV1GroupMemberDeleteInfo

Type: object

V1 Group Member Delete Information.

Show Source

• userIds(optional): array userIds
  The member List to be removed from the group. Required.

{
    "description":"V1 Group Member Delete Information.",
    "properties":{
        "userIds":{
            "description":"The member List to be removed from the group. Required.",
            "type":"array",
            "items":{
                "description":"The member List to be removed from the group. Required.",
                "type":"string"
            }
        }
    }
}

Nested Schema : userIds

Type: array

The member List to be removed from the group. Required.

Show Source

• Array of: string
  The member List to be removed from the group. Required.

{
    "description":"The member List to be removed from the group. Required.",
    "type":"array",
    "items":{
        "description":"The member List to be removed from the group. Required.",
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : XV1GroupMemberInfo

Type: object

V1 Group Direct Member Information DTO.

Show Source

• altitude(optional): number(double)
  The object's altitude.
• collectionURL(optional): string(url)
  A URL to this object's containing collection.
• conversationURL(optional): string(url)
  A URL to this object's containing conversation.
• createdByID(optional):
  An object's unique identifier from a long integer representation.
• createdByURL(optional): string(url)
  A URL to the user that created this object.
• createdByUserDisplayName(optional): string
  The display name of the user that created this object.
• createdByUserName(optional): string
  The name of the user that created this object.
• createdDate(optional): string(date)
  The date this object was created.
• createdDateInISO8601Format(optional): string
  The date this object was created, in ISO 8601 format.
• displayName(optional): string
  The display name of this object.
• groupURL(optional): string(url)
  A URL to the containing group.
• id(optional):
  An object's unique identifier from a long integer representation.
• isDirect(optional): boolean
  The member's direct status.
• isRemoved(optional): boolean
  True if this message has been removed.
• latitude(optional): number(double)
  The object's latitude.
• longitude(optional): number(double)
  The object's longitude.
• membersURL(optional): string(url)
  A URL to the members of this Group.
• modifiedByID(optional):
  An object's unique identifier from a long integer representation.
• modifiedByURL(optional): string(url)
  A URL to the user that last modified this object.
• modifiedByUserDisplayName(optional): string
  The display name of the user that last modified this object.
• modifiedByUserName(optional): string
  The name of the user that last modified this object.
• modifiedDate(optional): string(date)
  The date this object was last modified.
• modifiedDateInISO8601Format(optional): string
  The date this object was last modified, in ISO 8601 format.
• name(optional): string
  The name of this object.
• objectType(optional): string
  The type of this object.
• removedByID(optional):
  An object's unique identifier from a long integer representation.
• removedByURL(optional): string(url)
  A URL to the user that last removed this object.
• removedByUserDisplayName(optional): string
  The display name of the user that last removed this object.
• removedByUserName(optional): string
  The name of the user that last removed this object.
• removedDate(optional): string(date)
  The date this object was removed.
• removedDateInISO8601Format(optional): string
  The date this object was removed, in ISO 8601 format.
• role(optional): object XV1ConversationRole
• socialObjectURL(optional): string(url)
  A URL to this object's containing collaboration object.
• url(optional): string(url)
  A URL to this object.

{
    "description":"V1 Group Direct Member Information DTO.",
    "properties":{
        "groupURL":{
            "description":"A URL to the containing group.",
            "type":"string",
            "format":"url"
        },
        "isDirect":{
            "description":"The member's direct status.",
            "type":"boolean"
        },
        "membersURL":{
            "description":"A URL to the members of this Group.",
            "type":"string",
            "format":"url"
        },
        "role":{
            "$ref":"#/definitions/XV1ConversationRole"
        },
        "altitude":{
            "description":"The object's altitude.",
            "type":"number",
            "format":"double"
        },
        "collectionURL":{
            "description":"A URL to this object's containing collection.",
            "type":"string",
            "format":"url"
        },
        "conversationURL":{
            "description":"A URL to this object's containing conversation.",
            "type":"string",
            "format":"url"
        },
        "createdByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "createdByURL":{
            "description":"A URL to the user that created this object.",
            "type":"string",
            "format":"url"
        },
        "createdByUserDisplayName":{
            "description":"The display name of the user that created this object.",
            "type":"string"
        },
        "createdByUserName":{
            "description":"The name of the user that created this object.",
            "type":"string"
        },
        "createdDate":{
            "description":"The date this object was created.",
            "type":"string",
            "format":"date"
        },
        "createdDateInISO8601Format":{
            "description":"The date this object was created, in ISO 8601 format.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name of this object.",
            "type":"string"
        },
        "id":{
            "$ref":"#/definitions/XObjectID"
        },
        "isRemoved":{
            "description":"True if this message has been removed.",
            "type":"boolean"
        },
        "latitude":{
            "description":"The object's latitude.",
            "type":"number",
            "format":"double"
        },
        "longitude":{
            "description":"The object's longitude.",
            "type":"number",
            "format":"double"
        },
        "modifiedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "modifiedByURL":{
            "description":"A URL to the user that last modified this object.",
            "type":"string",
            "format":"url"
        },
        "modifiedByUserDisplayName":{
            "description":"The display name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedByUserName":{
            "description":"The name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedDate":{
            "description":"The date this object was last modified.",
            "type":"string",
            "format":"date"
        },
        "modifiedDateInISO8601Format":{
            "description":"The date this object was last modified, in ISO 8601 format.",
            "type":"string"
        },
        "name":{
            "description":"The name of this object.",
            "type":"string"
        },
        "objectType":{
            "description":"The type of this object.",
            "type":"string"
        },
        "removedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "removedByURL":{
            "description":"A URL to the user that last removed this object.",
            "type":"string",
            "format":"url"
        },
        "removedByUserDisplayName":{
            "description":"The display name of the user that last removed this object.",
            "type":"string"
        },
        "removedByUserName":{
            "description":"The name of the user that last removed this object.",
            "type":"string"
        },
        "removedDate":{
            "description":"The date this object was removed.",
            "type":"string",
            "format":"date"
        },
        "removedDateInISO8601Format":{
            "description":"The date this object was removed, in ISO 8601 format.",
            "type":"string"
        },
        "socialObjectURL":{
            "description":"A URL to this object's containing collaboration object.",
            "type":"string",
            "format":"url"
        },
        "url":{
            "description":"A URL to this object.",
            "type":"string",
            "format":"url"
        }
    }
}

Nested Schema : XV1ConversationRole

Type: object

Show Source

• field(optional): string
  Allowed Values: [ "ADMIN", "BYPASS", "CONTRIBUTOR", "DISCOVERER", "GROUP_MANAGER", "GROUP_MEMBER", "HOST", "MANAGER", "MEMBER", "MODERATOR", "NONE", "VIEWER" ]

  V1 Conversation Roles.

  Conversation roles are used to define grantable and nongrantable access to conversations.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Conversation Roles. <p/> Conversation roles are used to define grantable and nongrantable access to conversations.",
            "enum":[
                "ADMIN",
                "BYPASS",
                "CONTRIBUTOR",
                "DISCOVERER",
                "GROUP_MANAGER",
                "GROUP_MEMBER",
                "HOST",
                "MANAGER",
                "MEMBER",
                "MODERATOR",
                "NONE",
                "VIEWER"
            ]
        }
    }
}

Back to Top