Source
This page was generated with Wiki Builder. Do not change the format!
Info
Schema
- Schema Type: Class
- Type: object
Properties
| Name | Type | Description |
|---|---|---|
| relatedPosts | PostResponse[] | |
| authors | GeneralUser[] | |
| groups | GroupResponse[] | |
| searchedTags | TagResponse[] | |
| polls | PollResponse[] | |
| recruitmentDetails | ForumRecruitmentDetail[] | |
| availablePages | integer:int32:nullable | |
| results | PostResponse[] | |
| totalResults | integer:int32 | |
| hasMore | boolean | |
| query | PagedQuery | |
| replacementContinuationToken | string | |
| useTotalResults | boolean | If useTotalResults is true, then totalResults represents an accurate count. If False, it does not, and may be estimated/only the size of the current page. Either way, you should probably always only trust hasMore. This is a long-held historical throwback to when we used to do paging with known total results. Those queries toasted our database, and we were left to hastily alter our endpoints and create backward- compatible shims, of which useTotalResults is one. |
Example
{
// Type: PostResponse[]
"relatedPosts": [
// Type: PostResponse
{
// Type: string:date-time
"lastReplyTimestamp": "",
// Type: boolean
"IsPinned": false,
// Type: ForumMediaType:Enum
"urlMediaType": 0,
// Type: string
"thumbnail": "",
// Type: ForumPostPopularity:Enum
"popularity": 0,
// Type: boolean
"isActive": false,
// Type: boolean
"isAnnouncement": false,
// Type: integer:int32
"userRating": 0,
// Type: boolean
"userHasRated": false,
// Type: boolean
"userHasMutedPost": false,
// Type: integer:int64
"latestReplyPostId": 0,
// Type: integer:int64
"latestReplyAuthorId": 0,
// Type: IgnoreResponse
"ignoreStatus": {
// Type: boolean
"isIgnored": false,
// Type: IgnoreStatus:Enum
"ignoreFlags": 0
},
// Type: string
"locale": ""
}
],
// Type: GeneralUser[]
"authors": [
// 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: GroupResponse[]
"groups": [
// Type: GroupResponse
{
// Type: GroupV2
"detail": {
// Type: integer:int64
"groupId": 0,
// Type: string
"name": "",
// Type: GroupType:Enum
"groupType": 0,
// Type: integer:int64
"membershipIdCreated": 0,
// Type: string:date-time
"creationDate": "",
// Type: string:date-time
"modificationDate": "",
// Type: string
"about": "",
// Type: string[]
"tags": [
// Type: string
""
],
// Type: integer:int32
"memberCount": 0,
// Type: boolean
"isPublic": false,
// Type: boolean
"isPublicTopicAdminOnly": false,
// Type: integer:int64
"primaryAlliedGroupId": 0,
// Type: string
"motto": "",
// Type: boolean
"allowChat": false,
// Type: boolean
"isDefaultPostPublic": false,
// Type: ChatSecuritySetting:Enum
"chatSecurity": 0,
// Type: string
"locale": "",
// Type: integer:int32
"avatarImageIndex": 0,
// Type: GroupHomepage:Enum
"homepage": 0,
// Type: MembershipOption:Enum
"membershipOption": 0,
// Type: GroupPostPublicity:Enum
"defaultPublicity": 0,
// Type: string
"theme": "",
// Type: string
"bannerPath": "",
// Type: string
"avatarPath": "",
// Type: boolean
"isAllianceOwner": false,
// Type: integer:int64
"conversationId": 0,
// Type: boolean
"enableInvitationMessagingForAdmins": false,
// Type: string:date-time:nullable
"banExpireDate": "",
// Type: GroupFeatures
"features": {
// Type: integer:int32
"maximumMembers": 0,
// Type: integer:int32
"maximumMembershipsOfGroupType": 0,
// Type: Capabilities:Enum
"capabilities": 0,
// Type: BungieMembershipType:Enum[]
"membershipTypes": [
// Type: BungieMembershipType:Enum
0
],
// Type: boolean
"invitePermissionOverride": false,
// Type: boolean
"updateCulturePermissionOverride": false,
// Type: HostGuidedGamesPermissionLevel:Enum
"hostGuidedGamePermissionOverride": {},
// Type: boolean
"updateBannerPermissionOverride": false,
// Type: RuntimeGroupMemberType:Enum
"joinLevel": {}
},
// Type: GroupV2ClanInfoAndInvestment
"clanInfo": {
// Type: Dictionary<integer:uint32,DestinyProgression>
"d2ClanProgressions": {
"0": {
// Type: Destiny.Definitions.DestinyProgressionDefinition:integer:uint32
"progressionHash": 0,
// Type: integer:int32
"dailyProgress": 0,
// Type: integer:int32
"dailyLimit": 0,
// Type: integer:int32
"weeklyProgress": 0,
// Type: integer:int32
"weeklyLimit": 0,
// Type: integer:int32
"currentProgress": 0,
// Type: integer:int32
"level": 0,
// Type: integer:int32
"levelCap": 0,
// Type: integer:int32
"stepIndex": 0,
// Type: integer:int32
"progressToNextLevel": 0,
// Type: integer:int32
"nextLevelAt": 0
}
},
// Type: string
"clanCallsign": "",
// Type: ClanBanner
"clanBannerData": {
// Type: integer:uint32
"decalId": 0,
// Type: integer:uint32
"decalColorId": 0,
// Type: integer:uint32
"decalBackgroundColorId": 0,
// Type: integer:uint32
"gonfalonId": 0,
// Type: integer:uint32
"gonfalonColorId": 0,
// Type: integer:uint32
"gonfalonDetailId": 0,
// Type: integer:uint32
"gonfalonDetailColorId": 0,
// Type: ClanBanner
}
}
},
// Type: GroupMember
"founder": {
// Type: RuntimeGroupMemberType:Enum
"memberType": 0,
// Type: boolean
"isOnline": false,
// Type: integer:int64
"groupId": 0,
// Type: UserInfoCard
"destinyUserInfo": {
// Type: string
"supplementalDisplayName": "",
// Type: string
"iconPath": "",
// Type: BungieMembershipType:Enum
"membershipType": {},
// Type: integer:int64
"membershipId": 0,
// Type: string
"displayName": ""
},
// Type: UserInfoCard
"bungieNetUserInfo": {
// Type: string
"supplementalDisplayName": "",
// Type: string
"iconPath": "",
// Type: BungieMembershipType:Enum
"membershipType": {},
// Type: integer:int64
"membershipId": 0,
// Type: string
"displayName": ""
},
// Type: string:date-time
"joinDate": ""
},
// Type: integer:int64[]
"alliedIds": [
// Type: integer:int64
0
],
// Type: GroupV2
"parentGroup": {
// Type: integer:int64
"groupId": 0,
// Type: string
"name": "",
// Type: GroupType:Enum
"groupType": 0,
// Type: integer:int64
"membershipIdCreated": 0,
// Type: string:date-time
"creationDate": "",
// Type: string:date-time
"modificationDate": "",
// Type: string
"about": "",
// Type: string[]
"tags": [
// Type: string
""
],
// Type: integer:int32
"memberCount": 0,
// Type: boolean
"isPublic": false,
// Type: boolean
"isPublicTopicAdminOnly": false,
// Type: integer:int64
"primaryAlliedGroupId": 0,
// Type: string
"motto": "",
// Type: boolean
"allowChat": false,
// Type: boolean
"isDefaultPostPublic": false,
// Type: ChatSecuritySetting:Enum
"chatSecurity": 0,
// Type: string
"locale": "",
// Type: integer:int32
"avatarImageIndex": 0,
// Type: GroupHomepage:Enum
"homepage": 0,
// Type: MembershipOption:Enum
"membershipOption": 0,
// Type: GroupPostPublicity:Enum
"defaultPublicity": 0,
// Type: string
"theme": "",
// Type: string
"bannerPath": "",
// Type: string
"avatarPath": "",
// Type: boolean
"isAllianceOwner": false,
// Type: integer:int64
"conversationId": 0,
// Type: boolean
"enableInvitationMessagingForAdmins": false,
// Type: string:date-time:nullable
"banExpireDate": "",
// Type: GroupFeatures
"features": {
// Type: integer:int32
"maximumMembers": 0,
// Type: integer:int32
"maximumMembershipsOfGroupType": 0,
// Type: Capabilities:Enum
"capabilities": 0,
// Type: BungieMembershipType:Enum[]
"membershipTypes": [
// Type: BungieMembershipType:Enum
0
],
// Type: boolean
"invitePermissionOverride": false,
// Type: boolean
"updateCulturePermissionOverride": false,
// Type: HostGuidedGamesPermissionLevel:Enum
"hostGuidedGamePermissionOverride": {},
// Type: boolean
"updateBannerPermissionOverride": false,
// Type: RuntimeGroupMemberType:Enum
"joinLevel": {}
},
// Type: GroupV2ClanInfoAndInvestment
"clanInfo": {
// Type: Dictionary<integer:uint32,DestinyProgression>
"d2ClanProgressions": {
"0": {
// Type: Destiny.Definitions.DestinyProgressionDefinition:integer:uint32
"progressionHash": 0,
// Type: integer:int32
"dailyProgress": 0,
// Type: integer:int32
"dailyLimit": 0,
// Type: integer:int32
"weeklyProgress": 0,
// Type: integer:int32
"weeklyLimit": 0,
// Type: integer:int32
"currentProgress": 0,
// Type: integer:int32
"level": 0,
// Type: integer:int32
"levelCap": 0,
// Type: integer:int32
"stepIndex": 0,
// Type: integer:int32
"progressToNextLevel": 0,
// Type: integer:int32
"nextLevelAt": 0
}
},
// Type: string
"clanCallsign": "",
// Type: ClanBanner
"clanBannerData": {
// Type: integer:uint32
"decalId": 0,
// Type: integer:uint32
"decalColorId": 0,
// Type: integer:uint32
"decalBackgroundColorId": 0,
// Type: integer:uint32
"gonfalonId": 0,
// Type: integer:uint32
"gonfalonColorId": 0,
// Type: integer:uint32
"gonfalonDetailId": 0,
// Type: integer:uint32
"gonfalonDetailColorId": 0,
// Type: ClanBanner
}
}
},
// Type: GroupAllianceStatus:Enum
"allianceStatus": 0,
// Type: integer:int32
"groupJoinInviteCount": 0,
// Type: Dictionary<BungieMembershipType:Enum,GroupMember>
"currentUserMemberMap": {
"0": {
// Type: RuntimeGroupMemberType:Enum
"memberType": 0,
// Type: boolean
"isOnline": false,
// Type: integer:int64
"groupId": 0,
// Type: UserInfoCard
"destinyUserInfo": {
// Type: string
"supplementalDisplayName": "",
// Type: string
"iconPath": "",
// Type: BungieMembershipType:Enum
"membershipType": {},
// Type: integer:int64
"membershipId": 0,
// Type: string
"displayName": ""
},
// Type: UserInfoCard
"bungieNetUserInfo": {
// Type: string
"supplementalDisplayName": "",
// Type: string
"iconPath": "",
// Type: BungieMembershipType:Enum
"membershipType": {},
// Type: integer:int64
"membershipId": 0,
// Type: string
"displayName": ""
},
// Type: string:date-time
"joinDate": ""
}
},
// Type: Dictionary<BungieMembershipType:Enum,GroupPotentialMember>
"currentUserPotentialMemberMap": {
"0": {
// Type: GroupPotentialMemberStatus:Enum
"potentialStatus": 0,
// Type: integer:int64
"groupId": 0,
// Type: UserInfoCard
"destinyUserInfo": {
// Type: string
"supplementalDisplayName": "",
// Type: string
"iconPath": "",
// Type: BungieMembershipType:Enum
"membershipType": {},
// Type: integer:int64
"membershipId": 0,
// Type: string
"displayName": ""
},
// Type: UserInfoCard
"bungieNetUserInfo": {
// Type: string
"supplementalDisplayName": "",
// Type: string
"iconPath": "",
// Type: BungieMembershipType:Enum
"membershipType": {},
// Type: integer:int64
"membershipId": 0,
// Type: string
"displayName": ""
},
// Type: string:date-time
"joinDate": ""
}
}
}
],
// Type: TagResponse[]
"searchedTags": [
// Type: TagResponse
{
// Type: string
"tagText": "",
// Type: IgnoreResponse
"ignoreStatus": {
// Type: boolean
"isIgnored": false,
// Type: IgnoreStatus:Enum
"ignoreFlags": 0
}
}
],
// Type: PollResponse[]
"polls": [
// Type: PollResponse
{
// Type: integer:int64
"topicId": 0,
// Type: PollResult[]
"results": [
// Type: PollResult
{
// Type: string
"answerText": "",
// Type: integer:int32
"answerSlot": 0,
// Type: string:date-time
"lastVoteDate": "",
// Type: integer:int32
"votes": 0,
// Type: boolean
"requestingUserVoted": false
}
],
// Type: integer:int32
"totalVotes": 0
}
],
// Type: ForumRecruitmentDetail[]
"recruitmentDetails": [
// Type: ForumRecruitmentDetail
{
// 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: integer:int32:nullable
"availablePages": 0,
// Type: PostResponse[]
"results": [
// Type: PostResponse
{
// Type: string:date-time
"lastReplyTimestamp": "",
// Type: boolean
"IsPinned": false,
// Type: ForumMediaType:Enum
"urlMediaType": 0,
// Type: string
"thumbnail": "",
// Type: ForumPostPopularity:Enum
"popularity": 0,
// Type: boolean
"isActive": false,
// Type: boolean
"isAnnouncement": false,
// Type: integer:int32
"userRating": 0,
// Type: boolean
"userHasRated": false,
// Type: boolean
"userHasMutedPost": false,
// Type: integer:int64
"latestReplyPostId": 0,
// Type: integer:int64
"latestReplyAuthorId": 0,
// Type: IgnoreResponse
"ignoreStatus": {
// Type: boolean
"isIgnored": false,
// Type: IgnoreStatus:Enum
"ignoreFlags": 0
},
// Type: string
"locale": ""
}
],
// 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
}