Source

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

Info

Returns info about community members who are live streaming among your friends.

Parameters

Path Parameters

Name Schema Required Description
page integer:int32 Yes Zero based page.
partnershipType PartnershipType:Enum Yes The type of partnership for which the status should be returned.
sort CommunityStatusSort:Enum Yes The sort mode.

Query String Parameters

None

Example

Request

GET https://www.bungie.net/Platform/CommunityContent/Live/Friends/{partnershipType}/{sort}/{page}/

Response

PlatformErrorCode: 200

{
    // Type: SearchResultOfCommunityLiveStatus
    "Response": {
        // Type: CommunityLiveStatus[]
        "results": [
           // Type: CommunityLiveStatus
            {
                // Type: string:date-time
                "dateStatusUpdated": "",
                // Type: string
                "url": "",
                // Type: string
                "partnershipIdentifier": "",
                // Type: PartnershipType:Enum
                "partnershipType": 0,
                // Type: string
                "thumbnail": "",
                // Type: string
                "thumbnailSmall": "",
                // Type: string
                "thumbnailLarge": "",
                // Type: integer:int64
                "destinyCharacterId": 0,
                // Type: UserInfoCard
                "userInfo": {
                    // Type: string
                    "supplementalDisplayName": "",
                    // Type: string
                    "iconPath": "",
                    // Type: BungieMembershipType:Enum
                    "membershipType": {},
                    // Type: integer:int64
                    "membershipId": 0,
                    // Type: string
                    "displayName": ""
                },
                // Type: integer:uint32
                "currentActivityHash": 0,
                // Type: string:date-time
                "dateLastPlayed": "",
                // Type: string:date-time
                "dateStreamStarted": "",
                // Type: string
                "locale": "",
                // Type: integer:int32
                "currentViewers": 0,
                // Type: integer:int32
                "followers": 0,
                // Type: integer:int32
                "overallViewers": 0,
                // Type: boolean
                "isFeatured": false,
                // Type: string
                "title": "",
                // Type: integer:uint32
                "activityModeHash": 0,
                // Type: string:date-time:nullable
                "dateFeatured": "",
                // Type: number:float
                "trendingValue": 0,
                // Type: boolean
                "isSubscribable": false
            }
        ],
        // Type: integer:int32
        "totalResults": 0,
        // Type: boolean
        "hasMore": false,
        // Type: PagedQuery
        "query": {
            // Type: integer:int32
            "itemsPerPage": 0,
            // Type: integer:int32
            "currentPage": 0,
            // Type: string
            "requestContinuationToken": ""
        },
        // Type: string
        "replacementContinuationToken": "",
        // Type: boolean
        "useTotalResults": false
    },
    // 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_get_CommunityContent-GetCommunityLiveStatusesForFriends.html#operation_get_CommunityContent-GetCommunityLiveStatusesForFriends