Source

This page was generated with Wiki Builder. Do not change the format!

Info

Allows a recruitment thread owner to kick a join user from the fireteam. Returns the new state of the fireteam.

Parameters

Path Parameters

Name Schema Required Description
targetMembershipId integer:int64 Yes The id of the user you wish to kick.
topicId integer:int64 Yes The post id of the recruitment topic you wish to join.

Query String Parameters

None

Example

Request

POST https://www.bungie.net/Platform/Forum/Recruit/KickBan/{topicId}/{targetMembershipId}/

Response

PlatformErrorCode: 200

{
    // Type: ForumRecruitmentDetail
    "Response": {
        // Type: integer:int64
        "topicId": 0,
        // Type: boolean
        "microphoneRequired": false,
        // Type: ForumRecruitmentIntensityLabel:Enum
        "intensity": 0,
        // Type: ForumRecruitmentToneLabel:Enum
        "tone": 0,
        // Type: boolean
        "approved": false,
        // Type: integer:int64:nullable
        "conversationId": 0,
        // Type: integer:int32
        "playerSlotsTotal": 0,
        // Type: integer:int32
        "playerSlotsRemaining": 0,
        // Type: GeneralUser[]
        "Fireteam": [
           // Type: GeneralUser
            {
                // Type: integer:int64
                "membershipId": 0,
                // Type: string
                "uniqueName": "",
                // Type: string
                "normalizedName": "",
                // Type: string
                "displayName": "",
                // Type: integer:int32
                "profilePicture": 0,
                // Type: integer:int32
                "profileTheme": 0,
                // Type: integer:int32
                "userTitle": 0,
                // Type: integer:int64
                "successMessageFlags": 0,
                // Type: boolean
                "isDeleted": false,
                // Type: string
                "about": "",
                // Type: string:date-time:nullable
                "firstAccess": "",
                // Type: string:date-time:nullable
                "lastUpdate": "",
                // Type: integer:int64:nullable
                "legacyPortalUID": 0,
                // Type: UserToUserContext
                "context": {
                    // Type: boolean
                    "isFollowing": false,
                    // Type: IgnoreResponse
                    "ignoreStatus": {
                        // Type: boolean
                        "isIgnored": false,
                        // Type: IgnoreStatus:Enum
                        "ignoreFlags": 0
                    },
                    // Type: string:date-time:nullable
                    "globalIgnoreEndDate": ""
                },
                // Type: string
                "psnDisplayName": "",
                // Type: string
                "xboxDisplayName": "",
                // Type: string
                "fbDisplayName": "",
                // Type: boolean:nullable
                "showActivity": false,
                // Type: string
                "locale": "",
                // Type: boolean
                "localeInheritDefault": false,
                // Type: integer:int64:nullable
                "lastBanReportId": 0,
                // Type: boolean
                "showGroupMessaging": false,
                // Type: string
                "profilePicturePath": "",
                // Type: string
                "profilePictureWidePath": "",
                // Type: string
                "profileThemeName": "",
                // Type: string
                "userTitleDisplay": "",
                // Type: string
                "statusText": "",
                // Type: string:date-time
                "statusDate": "",
                // Type: string:date-time:nullable
                "profileBanExpire": "",
                // Type: string
                "blizzardDisplayName": ""
            }
        ],
        // Type: integer:int64[]
        "kickedPlayerIds": [
           // Type: integer:int64
            0
        ]
    },
    // Type: PlatformErrorCodes:Enum
    "ErrorCode": 0,
    // Type: integer:int32
    "ThrottleSeconds": 0,
    // Type: string
    "ErrorStatus": "",
    // Type: string
    "Message": "",
    // Type: Dictionary<string,string>
    "MessageData": {
        "{string}": ""
    },
    // Type: object
}

References

  1. https://bungie-net.github.io/multi/operation_post_Forum-KickBanFireteamApplicant.html#operation_post_Forum-KickBanFireteamApplicant