{ "JSONPService": [ { "name": "GetCurrentUser", "method": "GET", "endpoint": "\/JSONP\/GetBungieNetUser\/", "params": { "callback": { "desc": "", "link": "" } }, "post": [], "path": [], "access": "Private" } ], "ApplicationService": [ { "name": "ApplicationSearch", "method": "POST", "endpoint": "\/App\/Search\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "ChangeApiKeyStatus", "method": "POST", "endpoint": "\/App\/ChangeApiKeyState\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "CreateApiKey", "method": "POST", "endpoint": "\/App\/CreateApiKey\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "CreateApplication", "method": "POST", "endpoint": "\/App\/CreateApplication\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "EditApplication", "method": "POST", "endpoint": "\/App\/EditApplication\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "GetAccessTokensFromCode", "method": "POST", "endpoint": "\/App\/GetAccessTokensFromCode\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "GetAccessTokensFromRefreshToken", "method": "POST", "endpoint": "\/App\/GetAccessTokensFromRefreshToken\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "GetApplication", "method": "GET", "endpoint": "\/App\/Application\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetApplicationApiKeys", "method": "GET", "endpoint": "\/App\/ApplicationApiKeys\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetAuthorizations", "method": "GET", "endpoint": "\/App\/Authorizations\/{param1}\/", "params": { "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "PrivateApplicationSearch", "method": "POST", "endpoint": "\/App\/PrivateSearch\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "RevokeAuthorization", "method": "POST", "endpoint": "\/App\/RevokeAuthorization\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "Private" } ], "UserService": [ { "name": "CreateUser", "method": "POST", "endpoint": "\/User\/CreateUser\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "EditSuccessMessageFlags", "method": "POST", "endpoint": "\/User\/MessageFlags\/Success\/Update\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "GetAvailableAvatars", "method": "GET", "endpoint": "\/User\/GetAvailableAvatars\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "GetAvailableAvatarsAdmin", "method": "GET", "endpoint": "\/User\/GetAvailableAvatarsAdmin\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetAvailableThemes", "method": "GET", "endpoint": "\/User\/GetAvailableThemes\/", "params": [], "post": [], "path": [], "access": "Public" }, { "name": "GetBungieAccount", "method": "GET", "endpoint": "\/User\/GetBungieAccount\/{membershipId}\/{membershipType}\/", "params": [], "post": [], "path": { "membershipId": { "desc": "A valid Bungie.net membership ID.", "link": "" }, "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" } }, "access": "Public" }, { "name": "GetBungieNetUserById", "method": "GET", "endpoint": "\/User\/GetBungieNetUserById\/{membershipId}\/", "params": [], "post": [], "path": { "membershipId": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetCountsForCurrentUser", "method": "GET", "endpoint": "\/User\/GetCounts\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "GetCredentialTypesForAccount", "method": "GET", "endpoint": "\/User\/GetCredentialTypesForAccount\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetCurrentBungieAccount", "method": "GET", "endpoint": "\/User\/GetCurrentBungieAccount\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetCurrentBungieNetUser", "method": "GET", "endpoint": "\/User\/GetCurrentBungieNetUser\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetCurrentUser-(User)", "method": "GET", "endpoint": "\/User\/GetBungieNetUser\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "GetMobileAppPairings", "method": "GET", "endpoint": "\/User\/GetMobileAppPairings\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetMobileAppPairingsUncached", "method": "GET", "endpoint": "\/User\/GetMobileAppPairingsUncached\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetNotificationSettings", "method": "GET", "endpoint": "\/User\/GetNotificationSettings\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetPartnerships", "method": "GET", "endpoint": "\/User\/{param1}\/Partnerships\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetPlatformApiKeysForUser", "method": "GET", "endpoint": "\/User\/GetPlatformApiKeysForUser\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetSignOutUrl", "method": "GET", "endpoint": "\/User\/GetSignOutUrl\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetUserAliases", "method": "GET", "endpoint": "\/User\/GetUserAliases\/{membershipId}\/", "params": [], "post": [], "path": { "membershipId": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetUserMembershipIds", "method": "GET", "endpoint": "\/User\/GetMembershipIds\/", "params": { "excludebungienet": { "desc": "", "link": "" } }, "post": [], "path": [], "access": "" }, { "name": "LinkOverride", "method": "POST", "endpoint": "\/User\/LinkOverride\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "RegisterMobileAppPair", "method": "POST", "endpoint": "\/User\/RegisterMobileAppPair\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "RemovePartnership", "method": "POST", "endpoint": "\/User\/Partnerships\/{param1}\/Remove\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "SearchUsers", "method": "GET", "endpoint": "\/User\/SearchUsers\/", "params": { "q": { "desc": "A valid Bungie.net username", "link": "" } }, "post": [], "path": [], "access": "Public" }, { "name": "SearchUsersPaged", "method": "GET", "endpoint": "\/User\/SearchUsersPaged\/{searchTerm}\/{page}\/", "params": [], "post": [], "path": { "searchTerm": { "desc": "", "link": "" }, "page": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "access": "" }, { "name": "SearchUsersPagedV2", "method": "GET", "endpoint": "\/User\/SearchUsersPaged\/{searchTerm}\/{page}\/{param3}\/", "params": [], "post": [], "path": { "searchTerm": { "desc": "", "link": "" }, "page": { "desc": "The current page to return. Starts at 1.", "link": "" }, "param3": { "desc": "", "link": "" } }, "access": "" }, { "name": "SetAcknowledged", "method": "POST", "endpoint": "\/User\/Acknowledged\/{ackId}\/", "params": [], "post": [], "path": { "ackId": { "desc": "The acknowledge id of a given item.", "link": "" } }, "access": "Private" }, { "name": "UnregisterMobileAppPair", "method": "POST", "endpoint": "\/User\/UnregisterMobileAppPair\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "UpdateDestinyEmblemAvatar", "method": "POST", "endpoint": "\/User\/UpdateDestinyEmblemAvatar\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "UpdateNotificationSetting", "method": "POST", "endpoint": "\/User\/Notification\/Update\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "UpdateStateInfoForMobileAppPair", "method": "POST", "endpoint": "\/User\/UpdateStateInfoForMobileAppPair\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "UpdateUser", "method": "POST", "endpoint": "\/User\/UpdateUser\/", "params": [], "post": { "about": { "desc": "", "link": "" }, "adultMode": { "desc": "true or false", "link": "" }, "displayName": { "desc": "", "link": "" }, "emailAddress": { "desc": "", "link": "" }, "emailUsage": { "desc": "Default 31?", "link": "" }, "locale": { "desc": "", "link": "" }, "localeInheritDefault": { "desc": "true or false", "link": "" }, "profilePicture": { "desc": "A valid profilePictureId.", "link": "" }, "profileTheme": { "desc": "A valid profileThemeId.", "link": "" }, "showActivity": { "desc": "true or false", "link": "" }, "showFacebookPublic": { "desc": "true or false", "link": "" }, "showGamertagPublic": { "desc": "true or false", "link": "" }, "showGroupMessaging": { "desc": "true or false", "link": "" }, "showPsnPublic": { "desc": "true or false", "link": "" }, "uniqueName": { "desc": "Default to membershipId.", "link": "" } }, "path": [], "access": "Private" }, { "name": "UpdateUserAdmin", "method": "POST", "endpoint": "\/User\/UpdateUserAdmin\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" } ], "MessageService": [ { "name": "CreateConversation", "method": "POST", "endpoint": "\/Message\/CreateConversation\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "CreateConversationV2", "method": "POST", "endpoint": "\/Message\/CreateConversationV2\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "GetAllianceInvitedToJoinInvitations", "method": "GET", "endpoint": "\/Message\/AllianceInvitations\/InvitationsToJoinAnotherGroup\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetAllianceJoinInvitations", "method": "GET", "endpoint": "\/Message\/AllianceInvitations\/RequestsToJoinYourGroup\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetConversationById", "method": "GET", "endpoint": "\/Message\/GetConversationById\/{conversationId}\/", "params": [], "post": [], "path": { "conversationId": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetConversationByIdV2", "method": "GET", "endpoint": "\/Message\/GetConversationByIdV2\/{param1}\/", "params": { "format": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetConversationsV2", "method": "GET", "endpoint": "\/Message\/GetConversationsV2\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetConversationsV3", "method": "GET", "endpoint": "\/Message\/GetConversationsV3\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetConversationsV4", "method": "GET", "endpoint": "\/Message\/GetConversationsV4\/{param1}\/", "params": { "format": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetConversationsV5", "method": "GET", "endpoint": "\/Message\/GetConversationsV5\/{currentPage}\/", "params": { "format": { "desc": "Unknown. Default is 0.", "link": "" } }, "post": [], "path": { "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "access": "Private" }, { "name": "GetConversationThreadV2", "method": "GET", "endpoint": "\/Message\/GetConversationThreadV2\/{param1}\/{param2}\/{param3}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" }, "param3": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetConversationThreadV3", "method": "GET", "endpoint": "\/Message\/GetConversationThreadV3\/{param1}\/{param2}\/", "params": { "format": { "desc": "", "link": "" }, "before": { "desc": "", "link": "" }, "after": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetConversationWithMemberId", "method": "GET", "endpoint": "\/Message\/GetConversationWithMember\/{memberId}\/", "params": [], "post": [], "path": { "memberId": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetConversationWithMemberIdV2", "method": "GET", "endpoint": "\/Message\/GetConversationWithMemberV2\/{param1}\/", "params": { "format": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetGroupConversations", "method": "GET", "endpoint": "\/Message\/GetGroupConversations\/{param1}\/", "params": { "format": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetInvitationDetails", "method": "GET", "endpoint": "\/Message\/Invitations\/{param1}\/Details\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetTotalConversationCount", "method": "GET", "endpoint": "\/Message\/GetTotalConversationCount\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetUnreadConversationCountV2", "method": "GET", "endpoint": "\/Message\/GetUnreadPrivateConversationCount\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetUnreadConversationCountV3", "method": "GET", "endpoint": "\/Message\/GetUnreadConversationCountV3\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetUnreadConversationCountV4", "method": "GET", "endpoint": "\/Message\/GetUnreadConversationCountV4\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetUnreadGroupConversationCount", "method": "GET", "endpoint": "\/Message\/GetUnreadGroupConversationCount\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "LeaveConversation", "method": "GET", "endpoint": "\/Message\/LeaveConversation\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "ModerateGroupWall", "method": "POST", "endpoint": "\/Message\/ModerateGroupWall\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "ReviewAllInvitations", "method": "POST", "endpoint": "\/Message\/Invitations\/ReviewAllDirect\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "ReviewInvitation", "method": "POST", "endpoint": "\/Message\/Invitations\/{param1}\/{param2}\/{param3}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" }, "param3": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "ReviewInvitationDirect", "method": "POST", "endpoint": "\/Message\/Invitations\/ReviewDirect\/{invitationId}\/{invitationResponseState}\/", "params": [], "post": [], "path": { "invitationId": { "desc": "A valid invitationId.", "link": "" }, "invitationResponseState": { "desc": "How to respond to the invitation.", "link": "Enums#InvitationResponseState" } }, "access": "Private" }, { "name": "ReviewInvitations", "method": "POST", "endpoint": "\/Message\/Invitations\/ReviewListDirect\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "SaveMessageV2", "method": "POST", "endpoint": "\/Message\/SaveMessageV2\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "SaveMessageV3", "method": "POST", "endpoint": "\/Message\/SaveMessageV3\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "SaveMessageV4", "method": "POST", "endpoint": "\/Message\/SaveMessageV4\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "UpdateConversationLastViewedTimestamp", "method": "POST", "endpoint": "\/Message\/Conversations\/UpdateLastViewedTimestamp\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "UserIsTyping", "method": "POST", "endpoint": "\/Message\/UserIsTyping\/", "params": [], "post": [], "path": [], "access": "Private" } ], "NotificationService": [ { "name": "GetRealTimeEvents", "method": "GET", "endpoint": "\/Notification\/Events\/{param1}\/{param2}\/", "params": { "timeout": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetRecentNotificationCount", "method": "GET", "endpoint": "\/Notification\/GetCount\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetRecentNotifications", "method": "GET", "endpoint": "\/Notification\/GetRecent\/", "params": { "format": { "desc": "Unknown. Default is 0.", "link": "" } }, "post": [], "path": [], "access": "Private" }, { "name": "ResetNotification", "method": "GET", "endpoint": "\/Notification\/Reset\/", "params": [], "post": [], "path": [], "access": "" } ], "ContentService": [ { "name": "GetCareer", "method": "GET", "endpoint": "\/Content\/Careers\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetCareers", "method": "GET", "endpoint": "\/Content\/Careers\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetContentById", "method": "GET", "endpoint": "\/Content\/GetContentById\/{param1}\/{param2}\/", "params": { "head": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetContentByTagAndType", "method": "GET", "endpoint": "\/Content\/GetContentByTagAndType\/{param1}\/{param2}\/{param3}\/", "params": { "head": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" }, "param3": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetContentType", "method": "GET", "endpoint": "\/Content\/GetContentType\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetDestinyContent", "method": "GET", "endpoint": "\/Content\/Site\/Destiny\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetDestinyContentV2", "method": "GET", "endpoint": "\/Content\/Site\/Destiny\/V2\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetFeaturedArticle", "method": "GET", "endpoint": "\/Content\/Site\/Featured\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetHomepageContent", "method": "GET", "endpoint": "\/Content\/Site\/Homepage\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetHomepageContentV2", "method": "GET", "endpoint": "\/Content\/Site\/Homepage\/V2\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetJobs", "method": "GET", "endpoint": "\/Content\/Site\/Jobs\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetNews", "method": "GET", "endpoint": "\/Content\/Site\/News\/{param1}\/{param2}\/", "params": { "itemsperpage": { "desc": "", "link": "" }, "currentpage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetPromoWidget", "method": "GET", "endpoint": "\/Content\/Site\/Destiny\/Promo\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetPublications", "method": "GET", "endpoint": "\/Content\/Site\/Publications\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "SearchCareers", "method": "GET", "endpoint": "\/Content\/Careers\/Search\/", "params": { "searchtext": { "desc": "", "link": "" } }, "post": [], "path": [], "access": "" }, { "name": "SearchContentByTagAndType", "method": "GET", "endpoint": "\/Content\/SearchContentByTagAndType\/{param1}\/{param2}\/{param3}\/", "params": { "head": { "desc": "", "link": "" }, "currentpage": { "desc": "The current page to return. Starts at 1.", "link": "" }, "itemsperpage": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" }, "param3": { "desc": "", "link": "" } }, "access": "" }, { "name": "SearchContentEx", "method": "POST", "endpoint": "\/Content\/SearchEx\/{param1}\/", "params": { "head": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "SearchContentWithText", "method": "GET", "endpoint": "\/Content\/Search\/{param1}\/", "params": { "head": { "desc": "", "link": "" }, "ctype": { "desc": "", "link": "" }, "tag": { "desc": "", "link": "" }, "currentpage": { "desc": "The current page to return. Starts at 1.", "link": "" }, "searchtext": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" } ], "ExternalSocialService": [ { "name": "GetAggregatedSocialFeed", "method": "GET", "endpoint": "\/ExternalSocial\/GetAggregatedSocialFeed\/{param1}\/", "params": { "types": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" } ], "SurveyService": [ { "name": "GetSurvey", "method": "GET", "endpoint": "\/Survey\/GetSurvey\/", "params": [], "post": [], "path": [], "access": "" } ], "ForumService": [ { "name": "ApproveFireteamThread", "method": "POST", "endpoint": "\/Forum\/Recruit\/Approve\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "ChangeLockState", "method": "POST", "endpoint": "\/Forum\/ChangeLockState\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "ChangePinState", "method": "POST", "endpoint": "\/Forum\/ChangePinState\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "CreateContentComment", "method": "POST", "endpoint": "\/Forum\/CreateContentComment\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "CreatePost", "method": "POST", "endpoint": "\/Forum\/CreatePost\/", "params": [], "post": { "body": { "desc": "The body of the post.", "link": "" }, "category": { "desc": "The forum post category.", "link": "Enums#ForumPostCategory" }, "groupId": { "desc": "A valid groupId.", "link": "" }, "isGroupPrivate": { "desc": "true or false", "link": "" }, "metadata": { "desc": "", "link": "" }, "parentPostId": { "desc": "A valid parentPostId.", "link": "" }, "subTopicOverride": { "desc": "true or false", "link": "" }, "subject": { "desc": "The subject of the post.", "link": "" }, "urlLinkOrImage": { "desc": "", "link": "" } }, "path": [], "access": "Private" }, { "name": "DeletePost", "method": "POST", "endpoint": "\/Forum\/DeletePost\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "EditPost", "method": "POST", "endpoint": "\/Forum\/EditPost\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "GetCoreTopicsPaged", "method": "GET", "endpoint": "\/Forum\/GetCoreTopicsPaged\/{param1}\/{param2}\/{param3}\/{param4}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" }, "param3": { "desc": "", "link": "" }, "param4": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetForumTagCountEstimate", "method": "GET", "endpoint": "\/Forum\/GetForumTagCountEstimate\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetForumTagSuggestions", "method": "GET", "endpoint": "\/Forum\/GetForumTagSuggestions\/", "params": { "partialtag": { "desc": "", "link": "" } }, "post": [], "path": [], "access": "" }, { "name": "GetPoll", "method": "GET", "endpoint": "\/Forum\/Poll\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetPopularTags", "method": "GET", "endpoint": "\/Forum\/GetPopularTags\/", "params": { "quantity": { "desc": "", "link": "" }, "tagsSinceDate": { "desc": "", "link": "" } }, "post": [], "path": [], "access": "" }, { "name": "GetPostAndParent", "method": "GET", "endpoint": "\/Forum\/GetPostAndParent\/{childPostId}\/", "params": { "showbanned": { "desc": "", "link": "" } }, "post": [], "path": { "childPostId": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetPostAndParentAwaitingApproval", "method": "GET", "endpoint": "\/Forum\/GetPostAndParentAwaitingApproval\/{childPostId}\/", "params": { "showbanned": { "desc": "", "link": "" } }, "post": [], "path": { "childPostId": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetPostsThreadedPaged", "method": "GET", "endpoint": "\/Forum\/GetPostsThreadedPaged\/{parentPostId}\/{page}\/{pageSize}\/{replySize}\/{getParentPost}\/{rootThreadMode}\/{sortMode}\/", "params": { "showbanned": { "desc": "", "link": "" } }, "post": [], "path": { "parentPostId": { "desc": "", "link": "" }, "page": { "desc": "The current page to return. Starts at 1.", "link": "" }, "pageSize": { "desc": "", "link": "" }, "replySize": { "desc": "", "link": "" }, "getParentPost": { "desc": "", "link": "" }, "rootThreadMode": { "desc": "", "link": "" }, "sortMode": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetPostsThreadedPagedFromChild", "method": "GET", "endpoint": "\/Forum\/GetPostsThreadedPagedFromChild\/{childPostId}\/{page}\/{pageSize}\/{replySize}\/{rootThreadMode}\/{sortMode}\/", "params": { "showbanned": { "desc": "", "link": "" } }, "post": [], "path": { "childPostId": { "desc": "", "link": "" }, "page": { "desc": "The current page to return. Starts at 1.", "link": "" }, "pageSize": { "desc": "", "link": "" }, "replySize": { "desc": "", "link": "" }, "rootThreadMode": { "desc": "", "link": "" }, "sortMode": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetRecruitmentThreadSummaries", "method": "POST", "endpoint": "\/Forum\/Recruit\/Summaries\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "GetTopicForContent", "method": "GET", "endpoint": "\/Forum\/GetTopicForContent\/{contentId}\/", "params": [], "post": [], "path": { "contentId": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetTopicsPaged", "method": "GET", "endpoint": "\/Forum\/GetTopicsPaged\/{page}\/{pageSize}\/{group}\/{sort}\/{quickDate}\/{categoryFilter}\/", "params": { "tagstring": { "desc": "Filter by tags. Comma separated.", "link": "" } }, "post": [], "path": { "page": { "desc": "The current page to return. Starts at 1.", "link": "" }, "pageSize": { "desc": "The number of results to return. Seems to ignore this and returns 25 results.", "link": "" }, "group": { "desc": "A valid groupId. Use 0 to get all forum posts.", "link": "" }, "sort": { "desc": "How to sort the result. Default is 0 (Default).", "link": "Enums#ForumTopicsSort" }, "quickDate": { "desc": "Return results from a predefined date range. Default is 0 (All).", "link": "Enums#ForumTopicsQuickDate" }, "categoryFilter": { "desc": "Filter results by a topic category. Default is 0 (None).", "link": "Enums#ForumTopicsCategoryFilters" } }, "access": "Public" }, { "name": "JoinFireteamThread", "method": "POST", "endpoint": "\/Forum\/Recruit\/Join\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "KickBanFireteamApplicant", "method": "POST", "endpoint": "\/Forum\/Recruit\/KickBan\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "LeaveFireteamThread", "method": "POST", "endpoint": "\/Forum\/Recruit\/Leave\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "MarkReplyAsAnswer", "method": "POST", "endpoint": "\/Forum\/MarkReplyAsAnswer\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "ModerateGroupPost", "method": "POST", "endpoint": "\/Forum\/Post\/{param1}\/GroupModerate\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "ModeratePost", "method": "POST", "endpoint": "\/Forum\/Post\/{param1}\/Moderate\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "ModerateTag", "method": "POST", "endpoint": "\/Forum\/Tags\/{param1}\/Moderate\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "PollVote", "method": "POST", "endpoint": "\/Forum\/Poll\/Vote\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "RatePost", "method": "POST", "endpoint": "\/Forum\/RatePost\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "UnmarkReplyAsAnswer", "method": "POST", "endpoint": "\/Forum\/UnmarkReplyAsAnswer\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" } ], "ActivityService": [ { "name": "FollowTag", "method": "POST", "endpoint": "\/Activity\/Tag\/Follow\/", "params": { "tag": { "desc": "", "link": "" } }, "post": [], "path": [], "access": "Private" }, { "name": "FollowUser", "method": "POST", "endpoint": "\/Activity\/User\/{param1}\/Follow\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "GetApplicationActivityForUser", "method": "GET", "endpoint": "\/Activity\/User\/{param1}\/Activities\/Application\/{param2}\/", "params": { "currentpage": { "desc": "The current page to return. Starts at 1.", "link": "" }, "format": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetEntitiesFollowedByCurrentUser", "method": "GET", "endpoint": "\/Activity\/Following\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetEntitiesFollowedByCurrentUserV2", "method": "GET", "endpoint": "\/Activity\/Following\/V2\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetEntitiesFollowedByUser", "method": "GET", "endpoint": "\/Activity\/User\/{param1}\/Following\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetEntitiesFollowedByUserV2", "method": "GET", "endpoint": "\/Activity\/User\/{param1}\/Following\/V2\/{param2}\/{param3}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" }, "param3": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetFollowersOfTag", "method": "GET", "endpoint": "\/Activity\/Tag\/Followers\/", "params": { "tag": { "desc": "", "link": "" }, "itemsperpage": { "desc": "", "link": "" }, "currentpage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "post": [], "path": [], "access": "" }, { "name": "GetFollowersOfUser", "method": "GET", "endpoint": "\/Activity\/User\/{profileId}\/Followers\/", "params": { "itemsperpage": { "desc": "The number of items per page. Default is 50.", "link": "" }, "currentpage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "post": [], "path": { "profileId": { "desc": "A valid Bungie.net membership ID.", "link": "" } }, "access": "Public" }, { "name": "GetForumActivityForUser", "method": "GET", "endpoint": "\/Activity\/User\/{param1}\/Activities\/Forums\/", "params": { "itemsperpage": { "desc": "", "link": "" }, "currentpage": { "desc": "The current page to return. Starts at 1.", "link": "" }, "format": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetForumActivityForUserV2", "method": "GET", "endpoint": "\/Activity\/User\/{param1}\/Activities\/ForumsV2\/", "params": { "currentpage": { "desc": "The current page to return. Starts at 1.", "link": "" }, "format": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetFriends", "method": "GET", "endpoint": "\/Activity\/Friends\/", "params": [], "post": [], "path": [], "access": "Public" }, { "name": "GetFriendsAllNoPresence", "method": "GET", "endpoint": "\/Activity\/Friends\/AllNoPresence\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetFriendsPaged", "method": "GET", "endpoint": "\/Activity\/Friends\/Paged\/{membershipType}\/{currentPage}\/", "params": [], "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "access": "Private" }, { "name": "GetGroupsFollowedByCurrentUser", "method": "GET", "endpoint": "\/Activity\/Following\/Groups\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetGroupsFollowedByUser", "method": "GET", "endpoint": "\/Activity\/User\/{param1}\/Following\/Groups\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetGroupsFollowedPagedByCurrentUser", "method": "GET", "endpoint": "\/Activity\/Following\/Groups\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetGroupsFollowedPagedByUser", "method": "GET", "endpoint": "\/Activity\/User\/{param1}\/Following\/Groups\/Paged\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetLikeAndShareActivityForUser", "method": "GET", "endpoint": "\/Activity\/User\/{param1}\/Activities\/LikesAndShares\/", "params": { "itemsperpage": { "desc": "", "link": "" }, "currentpage": { "desc": "The current page to return. Starts at 1.", "link": "" }, "format": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetLikeAndShareActivityForUserV2", "method": "GET", "endpoint": "\/Activity\/User\/{param1}\/Activities\/LikesAndSharesV2\/", "params": { "currentpage": { "desc": "The current page to return. Starts at 1.", "link": "" }, "format": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetLikeShareAndForumActivityForUser", "method": "GET", "endpoint": "\/Activity\/User\/{param1}\/Activities\/LikeShareAndForum\/", "params": { "currentpage": { "desc": "The current page to return. Starts at 1.", "link": "" }, "format": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetUsersFollowedByCurrentUser", "method": "GET", "endpoint": "\/Activity\/Following\/Users\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "UnfollowTag", "method": "POST", "endpoint": "\/Activity\/Tag\/Unfollow\/", "params": { "tag": { "desc": "A hashtag.", "link": "" } }, "post": [], "path": [], "access": "Private" }, { "name": "UnfollowUser", "method": "POST", "endpoint": "\/Activity\/User\/{param1}\/Unfollow\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" } ], "GroupService": [ { "name": "ApproveAllPending", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/ApproveAll\/", "params": [], "post": { "message": { "desc": "A message to include with the approval.", "link": "" } }, "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "ApproveGroupMembership", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/{membershipId}\/Approve\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "membershipId": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "ApproveGroupMembershipV2", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/{membershipId}\/ApproveV2\/", "params": [], "post": { "message": { "desc": "A message to include with the approval.", "link": "" } }, "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "membershipId": { "desc": "A valid Bungie.net membershipId that is in the group.", "link": "" } }, "access": "Private" }, { "name": "ApprovePendingForList", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/ApproveList\/", "params": [], "post": { "message": { "desc": "A message to include with the approval.", "link": "" }, "membershipIds": { "desc": "An array of Bungie.net membershipIds.", "link": "" } }, "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "BanMember", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/{membershipId}\/Ban\/", "params": [], "post": { "comment": { "desc": "A comment to send to the member with the ban.", "link": "" }, "length": { "desc": "The length of the ban. 1=Week, 2=Two Weeks, 3=Three Weeks, 4=Month, 5=Three Months, 6=Six Months, 7=Year, 8=Forever, 9=Three Minutes, 10=An Hour, 11=Thirty Days", "link": "" } }, "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "membershipId": { "desc": "A valid Bungie.net membershipId that is in the group.", "link": "" } }, "access": "Private" }, { "name": "BreakAlliance", "method": "POST", "endpoint": "\/Group\/{groupId}\/Relationship\/{allyGroupId}\/BreakAlliance\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "allyGroupId": { "desc": "The groupId of the ally.", "link": "" } }, "access": "Private" }, { "name": "BreakAlliances", "method": "POST", "endpoint": "\/Group\/{groupId}\/BreakAlliances\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "CreateGroup", "method": "POST", "endpoint": "\/Group\/Create\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "CreateGroupV2", "method": "POST", "endpoint": "\/Group\/Create\/V2\/", "params": [], "post": { "name": { "desc": "The name of the group.", "link": "" }, "clanCallSign": { "desc": "The 4 letter A-Z0-9 Clan ID.", "link": "" }, "motto": { "desc": "The group motto.", "link": "" }, "about": { "desc": "The group mission statement.", "link": "" }, "theme": { "desc": "", "link": "" }, "tags": { "desc": "Comma separated list of tags.", "link": "" }, "avatarImageIndex": { "desc": "", "link": "" }, "isPublic": { "desc": "", "link": "" }, "membershipOption": { "desc": "", "link": "" }, "isPublicTopicAdminOnly": { "desc": "", "link": "" }, "isDefaultPostPublic": { "desc": "", "link": "" }, "clanMembershipTypes": { "desc": "A list of clanMembershipTypes. 1=Xbox, 2=PSN, 10=Demon", "link": "" }, "attributes": { "desc": "", "link": "" }, "allowChat": { "desc": "", "link": "" }, "locale": { "desc": "", "link": "" }, "clanReviewType": { "desc": "", "link": "" }, "clanName": { "desc": "", "link": "" } }, "path": [], "access": "Private" }, { "name": "CreateMinimalGroup", "method": "POST", "endpoint": "\/Group\/Create\/Minimal\/", "params": [], "post": { "groupName": { "desc": "The name of the group.", "link": "" }, "groupAbout": { "desc": "A description about the group.", "link": "" } }, "path": [], "access": "Private" }, { "name": "DenyAllPending", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/DenyAll\/", "params": [], "post": { "message": { "desc": "A message to include with the denial. ", "link": "" } }, "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "DenyGroupMembership", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/{membershipId}\/Deny\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "membershipId": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "DenyGroupMembershipV2", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/{membershipId}\/DenyV2\/", "params": [], "post": { "message": { "desc": "A message to send to the pending member.", "link": "" } }, "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "membershipId": { "desc": "A valid Bungie.net membershipId that is in the group.", "link": "" } }, "access": "Private" }, { "name": "DenyPendingForList", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/DenyList\/", "params": [], "post": { "message": { "desc": "A message to send to the pending member.", "link": "" }, "membershipIds": { "desc": "An array of Bungie.net membershipIds.", "link": "" } }, "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "DisableClanForGroup", "method": "POST", "endpoint": "\/Group\/{groupId}\/Clans\/Disable\/{clanMembershipType}\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "clanMembershipType": { "desc": "A valid clan membership type. 1=Xbox, 2=PSN, 10=Demon", "link": "Enums#BungieMembershipType" } }, "access": "Private" }, { "name": "DisbandAlliance", "method": "POST", "endpoint": "\/Group\/{groupId}\/BreakAllAlliances\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "EditGroup", "method": "POST", "endpoint": "\/Group\/{groupId}\/Edit\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "EditGroupMembership", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/{membershipId}\/SetMembershipType\/{groupMembershipType}\/", "params": { "clanPlatformType": { "desc": "Unknown. Default is 0.", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "membershipId": { "desc": "A valid Bungie.net membershipId that is in the group.", "link": "" }, "groupMembershipType": { "desc": "A valid group membershipType. 0=Member, 1=Admin, 2=Founder (probably will throw an error)", "link": "" } }, "access": "Private" }, { "name": "EditGroupV2", "method": "POST", "endpoint": "\/Group\/{groupId}\/EditV2\/", "params": [], "post": { "name": { "desc": "The name of the group. Max 25 characters.", "link": "" }, "clanCallSign": { "desc": "", "link": "" }, "motto": { "desc": "One line statement about the group.", "link": "" }, "about": { "desc": "Description about the group.", "link": "" }, "theme": { "desc": "", "link": "" }, "tags": { "desc": "List of tags this group applies to. Comma separated.", "link": "" }, "avatarImageIndex": { "desc": "", "link": "" }, "chatSecurity": { "desc": "", "link": "" }, "allowChat": { "desc": "", "link": "" }, "membershipOptions": { "desc": "", "link": "" }, "homepage": { "desc": "", "link": "" }, "locale": { "desc": "", "link": "" }, "isPublic": { "desc": "", "link": "" }, "isPublicTopicAdminOnly": { "desc": "", "link": "" }, "defaultPublicity": { "desc": "", "link": "" }, "isDefaultPostPublic": { "desc": "", "link": "" }, "clanReviewType": { "desc": "", "link": "" }, "enableInvitationMessagingForAdmins": { "desc": "", "link": "" }, "clanName": { "desc": "", "link": "" }, "clanMembershipTypes": { "desc": "An array of clanMembershipTypes. 1=Xbox, 2=PSN, 10=Demon", "link": "Enums#BungieMembershipType" } }, "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "EnableClanForGroup", "method": "POST", "endpoint": "\/Group\/{groupId}\/Clans\/Enable\/{clanMembershipType}\/", "params": { "clanName": { "desc": "", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "clanMembershipType": { "desc": "A valid clan membership type. 1=Xbox, 2=PSN, 10=Demon", "link": "Enums#BungieMembershipType" } }, "access": "Private" }, { "name": "FollowGroupsWithGroup", "method": "POST", "endpoint": "\/Group\/{groupId}\/FollowList\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "FollowGroupWithGroup", "method": "POST", "endpoint": "\/Group\/{groupId}\/Follow\/{followGroupId}\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "followGroupId": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "GetAdminsOfGroup", "method": "GET", "endpoint": "\/Group\/{groupId}\/Admins\/", "params": { "itemsPerPage": { "desc": "", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "" }, { "name": "GetAdminsOfGroupV2", "method": "GET", "endpoint": "\/Group\/{groupId}\/AdminsV2\/", "params": { "itemsPerPage": { "desc": "Items per page. Default is 10.", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Public" }, { "name": "GetAllFoundedGroupsForMember", "method": "GET", "endpoint": "\/Group\/User\/{param1}\/Founded\/All\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetAllGroupsForCurrentMember", "method": "GET", "endpoint": "\/Group\/MyGroups\/All\/", "params": { "clanonly": { "desc": "true or false. Default false.", "link": "" }, "populatefriends": { "desc": "true or false. Default false.", "link": "" } }, "post": [], "path": [], "access": "Private" }, { "name": "GetAllGroupsForMember", "method": "GET", "endpoint": "\/Group\/User\/{membershipId}\/All\/", "params": { "clanonly": { "desc": "true or false. Default false.", "link": "" }, "populatefriends": { "desc": "true or false. Default false.", "link": "" } }, "post": [], "path": { "membershipId": { "desc": "A valid Bungie.net membershipId.", "link": "" } }, "access": "Public" }, { "name": "GetAlliedGroups", "method": "GET", "endpoint": "\/Group\/{groupId}\/Allies\/", "params": { "currentpage": { "desc": "The current page to return. Starts at 1.", "link": "" }, "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Public" }, { "name": "GetAvailableAvatars-(Group)", "method": "GET", "endpoint": "\/Group\/GetAvailableAvatars\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetAvailableThemes-(Group)", "method": "GET", "endpoint": "\/Group\/GetAvailableThemes\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetBannedMembersOfGroup", "method": "GET", "endpoint": "\/Group\/{groupId}\/Banned\/", "params": { "itemsPerPage": { "desc": "", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "" }, { "name": "GetBannedMembersOfGroupV2", "method": "GET", "endpoint": "\/Group\/{groupId}\/BannedV2\/", "params": { "itemsPerPage": { "desc": "Items per page. Default is 10.", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "GetClanAttributeDefinitions", "method": "GET", "endpoint": "\/Group\/GetClanAttributeDefinitions\/", "params": [], "post": [], "path": [], "access": "Public" }, { "name": "GetDeletedGroupsForCurrentMember", "method": "GET", "endpoint": "\/Group\/MyGroups\/Deleted\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetFoundedGroupsForMember", "method": "GET", "endpoint": "\/Group\/User\/{membershipId}\/Founded\/{currentPage}\/", "params": { "clanonly": { "desc": "", "link": "" }, "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "membershipId": { "desc": "", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "access": "" }, { "name": "GetGroup", "method": "GET", "endpoint": "\/Group\/{groupId}\/", "params": { "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "" }, { "name": "GetGroupByName", "method": "GET", "endpoint": "\/Group\/Name\/{groupName}\/", "params": { "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "groupName": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetGroupsFollowedByGroup", "method": "GET", "endpoint": "\/Group\/{groupId}\/Following\/{currentPage}\/", "params": { "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "access": "" }, { "name": "GetGroupsFollowingGroup", "method": "GET", "endpoint": "\/Group\/{groupId}\/FollowedBy\/{currentPage}\/", "params": { "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "access": "" }, { "name": "GetGroupTagSuggestions", "method": "GET", "endpoint": "\/Group\/GetGroupTagSuggestions\/", "params": { "partialtag": { "desc": "", "link": "" } }, "post": [], "path": [], "access": "" }, { "name": "GetJoinedGroupsForCurrentMember", "method": "GET", "endpoint": "\/Group\/MyGroups\/", "params": { "clanonly": { "desc": "", "link": "" }, "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": [], "access": "" }, { "name": "GetJoinedGroupsForCurrentMemberV2", "method": "GET", "endpoint": "\/Group\/MyGroups\/V2\/{currentPage}\/", "params": { "clanonly": { "desc": "", "link": "" }, "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "access": "" }, { "name": "GetJoinedGroupsForMember", "method": "GET", "endpoint": "\/Group\/User\/{membershipId}\/", "params": { "clanonly": { "desc": "", "link": "" }, "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "membershipId": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetJoinedGroupsForMemberV2", "method": "GET", "endpoint": "\/Group\/User\/{membershipId}\/Joined\/{currentPage}\/", "params": { "clanonly": { "desc": "", "link": "" }, "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "membershipId": { "desc": "", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "access": "" }, { "name": "GetJoinedGroupsForMemberV3", "method": "GET", "endpoint": "\/Group\/User\/{membershipId}\/JoinedV3\/{currentPage}\/", "params": { "populatefriends": { "desc": "true or false", "link": "" } }, "post": [], "path": { "membershipId": { "desc": "A valid Bungie.net membershipId.", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "access": "Public" }, { "name": "GetMembersOfClan", "method": "GET", "endpoint": "\/Group\/{groupId}\/ClanMembers\/", "params": { "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" }, "memberType": { "desc": "Default is -1. -1=All Members, 0=Member, 1=Admin, 2=Founder", "link": "" }, "sort": { "desc": "Default is 0.", "link": "" }, "platformType": { "desc": "A valid clan membership type. Default is 0. Required. 0=None, 1=Xbox, 2=PSN", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Public" }, { "name": "GetMembersOfGroup", "method": "GET", "endpoint": "\/Group\/{groupId}\/Members\/", "params": { "itemsPerPage": { "desc": "", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" }, "memberType": { "desc": "", "link": "" }, "platformType": { "desc": "", "link": "" }, "sort": { "desc": "", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "" }, { "name": "GetMembersOfGroupV2", "method": "GET", "endpoint": "\/Group\/{groupId}\/MembersV2\/", "params": { "itemsPerPage": { "desc": "", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" }, "memberType": { "desc": "", "link": "" }, "platformType": { "desc": "", "link": "" }, "sort": { "desc": "", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "" }, { "name": "GetMembersOfGroupV3", "method": "GET", "endpoint": "\/Group\/{groupId}\/MembersV3\/", "params": { "itemsPerPage": { "desc": "Items per page. Default is 10.", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" }, "memberType": { "desc": "Default is -1. -1=All Members, 0=Member, 1=Admin, 2=Founder", "link": "" }, "platformType": { "desc": "A valid clan membership type. Default is 0. 0=None, 1=Xbox, 2=PSN", "link": "" }, "sort": { "desc": "Default is 0.", "link": "" }, "nameSearch": { "desc": "Not working?", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Public" }, { "name": "GetMyClanMemberships", "method": "GET", "endpoint": "\/Group\/MyClans\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetPendingClanMemberships", "method": "GET", "endpoint": "\/Group\/{groupId}\/Clan\/{clanMembershipType}\/Pending\/{currentPage}\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "clanMembershipType": { "desc": "A valid clan membership type. 1=Xbox, 2=PSN, 10=Demon", "link": "Enums#BungieMembershipType" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "access": "Private" }, { "name": "GetPendingGroupsForCurrentMember", "method": "GET", "endpoint": "\/Group\/MyPendingGroups\/", "params": { "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": [], "access": "" }, { "name": "GetPendingGroupsForCurrentMemberV2", "method": "GET", "endpoint": "\/Group\/MyPendingGroups\/V2\/{currentPage}\/", "params": { "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "access": "" }, { "name": "GetPendingGroupsForMember", "method": "GET", "endpoint": "\/Group\/User\/{membershipId}\/Pending\/", "params": { "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "membershipId": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetPendingGroupsForMemberV2", "method": "GET", "endpoint": "\/Group\/User\/{membershipId}\/PendingV2\/{currentPage}\/", "params": { "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "membershipId": { "desc": "", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "access": "" }, { "name": "GetPendingMemberships", "method": "GET", "endpoint": "\/Group\/{groupId}\/Members\/Pending\/", "params": { "itemsPerPage": { "desc": "", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "" }, { "name": "GetPendingMembershipsV2", "method": "GET", "endpoint": "\/Group\/{groupId}\/Members\/PendingV2\/", "params": { "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "GetRecommendedGroups", "method": "POST", "endpoint": "\/Group\/Recommended\/", "params": { "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": [], "access": "Private" }, { "name": "GroupSearch", "method": "POST", "endpoint": "\/Group\/Search\/", "params": { "populatefriends": { "desc": "true or false.", "link": "" } }, "post": { "contents.searchValue": { "desc": "Group name to search for.", "link": "" }, "contents.searchType": { "desc": "Filter by group type. Default 0.", "link": "Enums#GroupTypeSearchFilter" }, "creationDate": { "desc": "", "link": "" }, "currentPage": { "desc": "The current page to return. Starts at 1.", "link": "" }, "groupMemberCountFilter": { "desc": "Filter groups based on how many members they have.", "link": "Enums#GroupMemberCountFilter" }, "itemsPerPage": { "desc": "Number of results per page. Default is 10.", "link": "" }, "localeFilter": { "desc": "", "link": "" }, "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "sortBy": { "desc": "Default 0.", "link": "" }, "tagText": { "desc": "", "link": "" } }, "path": [], "access": "Public" }, { "name": "InviteClanMember", "method": "POST", "endpoint": "\/Group\/{groupId}\/InviteToClan\/{membershipId}\/{clanMembershipType}\/", "params": [], "post": { "title": { "desc": "The message title. Not displayed anywhere.", "link": "" }, "message": { "desc": "The message to send with the invitation.", "link": "" } }, "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "membershipId": { "desc": "A valid Bungie.net membershipId that is in the group.", "link": "" }, "clanMembershipType": { "desc": "A valid clan membership type. 1=Xbox, 2=PSN, 10=Demon", "link": "Enums#BungieMembershipType" } }, "access": "Private" }, { "name": "InviteGroupMember", "method": "POST", "endpoint": "\/Group\/{groupId}\/Invite\/{membershipId}\/", "params": [], "post": { "title": { "desc": "The message title. Not displayed anywhere.", "link": "" }, "message": { "desc": "The message to send with the invitation.", "link": "" } }, "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "membershipId": { "desc": "A valid Bungie.net membershipId.", "link": "" } }, "access": "Private" }, { "name": "InviteManyToJoinAlliance", "method": "POST", "endpoint": "\/Group\/{groupId}\/Allies\/InviteMany\/", "params": [], "post": { "targetIds": { "desc": "An array of groupIds.", "link": "" }, "messageContent.message": { "desc": "A message to include in the invite.", "link": "" } }, "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "InviteToJoinAlliance", "method": "POST", "endpoint": "\/Group\/{groupId}\/Allies\/Invite\/{allyGroupId}\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "allyGroupId": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "JoinClanForGroup", "method": "POST", "endpoint": "\/Group\/{groupId}\/Clans\/Join\/{clanMembershipType}\/", "params": [], "post": { "message": { "desc": "A message to include with the request.", "link": "" } }, "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "clanMembershipType": { "desc": "A valid clan membership type. 1=Xbox, 2=PSN, 10=Demon", "link": "Enums#BungieMembershipType" } }, "access": "Private" }, { "name": "KickMember", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/{membershipId}\/Kick\/", "params": { "clanPlatformType": { "desc": "A valid clan membership type. 0=Group, 1=Xbox, 2=PSN", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "membershipId": { "desc": "A valid Bungie.net membershipId that is in the group.", "link": "" } }, "access": "Private" }, { "name": "LeaveClanForGroup", "method": "POST", "endpoint": "\/Group\/{groupId}\/Clans\/Leave\/{clanMembershipType}\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "clanMembershipType": { "desc": "A valid clan membership type. 1=Xbox, 2=PSN, 10=Demon", "link": "Enums#BungieMembershipType" } }, "access": "Private" }, { "name": "Migrate", "method": "POST", "endpoint": "\/Group\/{param1}\/Migrate\/{param2}\/{param3}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" }, "param3": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "OverrideFounderAdmin", "method": "POST", "endpoint": "\/Group\/{groupId}\/Admin\/FounderOverride\/{membershipType}\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" } }, "access": "Private" }, { "name": "RefreshClanSettingsInDestiny", "method": "POST", "endpoint": "\/Group\/MyClans\/Refresh\/{clanMembershipType}\/", "params": [], "post": [], "path": { "clanMembershipType": { "desc": "A valid clan membership type. 1=Xbox, 2=PSN, 10=Demon", "link": "Enums#BungieMembershipType" } }, "access": "Private" }, { "name": "RequestGroupMembership", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/Apply\/", "params": { "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "RequestGroupMembershipV2", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/ApplyV2\/", "params": { "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "RequestToJoinAlliance", "method": "POST", "endpoint": "\/Group\/{groupId}\/Allies\/RequestToJoin\/{allyGroupId}\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "allyGroupId": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "RescindGroupMembership", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/Rescind\/", "params": { "populatefriends": { "desc": "", "link": "" } }, "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "SetGroupAsAlliance", "method": "POST", "endpoint": "\/Group\/{groupId}\/SetAsAlliance\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "SetPrivacy", "method": "POST", "endpoint": "\/Group\/{groupId}\/Privacy\/{param2}\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "UnbanMember", "method": "POST", "endpoint": "\/Group\/{groupId}\/Members\/{membershipId}\/Unban\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "membershipId": { "desc": "A valid Bungie.net membershipId that is in the group.", "link": "" } }, "access": "Private" }, { "name": "UndeleteGroup", "method": "POST", "endpoint": "\/Group\/{groupId}\/Undelete\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "UnfollowAllGroupsWithGroup", "method": "POST", "endpoint": "\/Group\/{groupId}\/UnfollowAll\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "UnfollowGroupsWithGroup", "method": "POST", "endpoint": "\/Group\/{groupId}\/UnfollowList\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" } }, "access": "Private" }, { "name": "UnfollowGroupWithGroup", "method": "POST", "endpoint": "\/Group\/{groupId}\/Unfollow\/{followGroupId}\/", "params": [], "post": [], "path": { "groupId": { "desc": "A valid groupId.", "link": "" }, "followGroupId": { "desc": "The groupId of the group to unfollow.", "link": "" } }, "access": "Private" } ], "IgnoreService": [ { "name": "FlagItem", "method": "POST", "endpoint": "\/Ignore\/Flag\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "GetIgnoresForUser", "method": "POST", "endpoint": "\/Ignore\/MyIgnores\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "GetIgnoreStatusForPost", "method": "GET", "endpoint": "\/Ignore\/MyIgnores\/Posts\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetIgnoreStatusForUser", "method": "GET", "endpoint": "\/Ignore\/MyIgnores\/Users\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetReportContext", "method": "GET", "endpoint": "\/Ignore\/ReportContext\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "IgnoreItem", "method": "POST", "endpoint": "\/Ignore\/Ignore\/", "params": [], "post": { "ignoredItemId": { "desc": "A valid ignoredItemId.", "link": "" }, "ignoredItemType": { "desc": "The type of item to ignore.", "link": "Enums#IgnoredItemType" }, "comment": { "desc": "", "link": "" }, "reason": { "desc": "", "link": "" }, "itemContextId": { "desc": "", "link": "" }, "itemContextType": { "desc": "", "link": "" }, "ModeratorRequest": { "desc": "", "link": "" } }, "path": [], "access": "Private" }, { "name": "MyLastReport", "method": "GET", "endpoint": "\/Ignore\/MyLastReport\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "UnignoreItem", "method": "POST", "endpoint": "\/Ignore\/Unignore\/", "params": [], "post": [], "path": [], "access": "Private" } ], "GameService": [ { "name": "GetPlayerGamesById", "method": "GET", "endpoint": "\/Game\/GetPlayerGamesById\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "ReachModelSneakerNet", "method": "POST", "endpoint": "\/Game\/ReachModelSneakerNet\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" } ], "AdminService": [ { "name": "AdminUserSearch", "method": "GET", "endpoint": "\/Admin\/Member\/Search\/", "params": { "q": { "desc": "", "link": "" } }, "post": [], "path": [], "access": "" }, { "name": "BulkEditPost", "method": "POST", "endpoint": "\/Admin\/BulkEditPost\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "GetAdminHistory", "method": "GET", "endpoint": "\/Admin\/GlobalHistory\/{param1}\/{param2}\/", "params": { "membershipFilter": { "desc": "", "link": "" }, "startdate": { "desc": "", "link": "" }, "enddate": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetAssignedReports", "method": "POST", "endpoint": "\/Admin\/Assigned\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "GetDisciplinedReportsForMember", "method": "POST", "endpoint": "\/Admin\/Member\/{param1}\/Reports\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "GetRecentDisciplineAndFlagHistoryForMember", "method": "GET", "endpoint": "\/Admin\/Member\/{param1}\/RecentIncludingFlags\/{param2}", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetResolvedReports", "method": "POST", "endpoint": "\/Admin\/Reports\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "GetUserBanState", "method": "GET", "endpoint": "\/Admin\/Member\/{param1}\/GetBanState\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetUserPostHistory", "method": "GET", "endpoint": "\/Admin\/Member\/{param1}\/PostHistory\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetUserWebClientIpHistory", "method": "GET", "endpoint": "\/Admin\/Member\/{param1}\/GetWebClientIpHistory\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GloballyIgnoreItem", "method": "POST", "endpoint": "\/Admin\/Ignores\/GloballyIgnore\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "OverrideBanOnUser", "method": "POST", "endpoint": "\/Admin\/Member\/{param1}\/SetBan\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "OverrideGlobalIgnore", "method": "POST", "endpoint": "\/Admin\/Ignores\/OverrideGlobalIgnore\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "OverrideGroupWallBanOnUser", "method": "POST", "endpoint": "\/Admin\/Member\/{param1}\/SetGroupWallBan\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "OverrideMsgBanOnUser", "method": "POST", "endpoint": "\/Admin\/Member\/{param1}\/SetMsgBan\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "OverturnReport", "method": "POST", "endpoint": "\/Admin\/Reports\/Overturn\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "ResolveReport", "method": "POST", "endpoint": "\/Admin\/Assigned\/Resolve\/", "params": [], "post": [], "path": [], "access": "Private" } ], "TokensService": [ { "name": "ApplyOfferToCurrentDestinyMembership", "method": "POST", "endpoint": "\/Tokens\/ApplyOfferToCurrentDestinyMembership\/{param1}\/{param2}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "BreakBond", "method": "POST", "endpoint": "\/Tokens\/RAF\/BreakBond\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "ClaimAndApplyOnToken", "method": "POST", "endpoint": "\/Tokens\/ClaimAndApplyToken\/{tokenType}\/", "params": [], "post": { "redeemCode": { "desc": "", "link": "" } }, "path": { "tokenType": { "desc": "Default is 0.", "link": "" } }, "access": "Private" }, { "name": "ClaimToken", "method": "POST", "endpoint": "\/Tokens\/Claim\/", "params": [], "post": { "redeemCode": { "desc": "", "link": "" } }, "path": [], "access": "Private" }, { "name": "ConsumeMarketplacePlatformCodeOffer", "method": "POST", "endpoint": "\/Tokens\/ConsumeMarketplacePlatformCodeOffer\/{param1}\/{param2}\/{param3}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" }, "param3": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "GetCurrentUserOfferHistory", "method": "GET", "endpoint": "\/Tokens\/OfferHistory\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetCurrentUserThrottleState", "method": "GET", "endpoint": "\/Tokens\/ThrottleState\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetRAFEligibility", "method": "GET", "endpoint": "\/Tokens\/RAF\/GetEligibility\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "MarketplacePlatformCodeOfferHistory", "method": "GET", "endpoint": "\/Tokens\/MarketplacePlatformCodeOfferHistory\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "RAFClaim", "method": "POST", "endpoint": "\/Tokens\/RAF\/Claim\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "RAFGenerateReferralCode", "method": "POST", "endpoint": "\/Tokens\/RAF\/GenerateReferralCode\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "RAFGetNewPlayerBondDetails", "method": "GET", "endpoint": "\/Tokens\/RAF\/GetNewPlayerBondDetails\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "RAFGetVeteranBondDetails", "method": "GET", "endpoint": "\/Tokens\/RAF\/GetVeteranBondDetails\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "VerifyAge", "method": "POST", "endpoint": "\/Tokens\/VerifyAge\/", "params": [], "post": [], "path": [], "access": "Private" } ], "DestinyService": [ { "name": "BuyItem", "method": "POST", "endpoint": "\/Destiny\/BuyItem\/", "params": [], "post": [], "path": [], "access": "Private" }, { "name": "EquipItem", "method": "POST", "endpoint": "\/Destiny\/EquipItem\/", "params": [], "post": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "itemId": { "desc": "The instanceId of an equipable item.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "path": [], "access": "Private" }, { "name": "EquipItems", "method": "POST", "endpoint": "\/Destiny\/EquipItems\/", "params": [], "post": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" }, "itemIds": { "desc": "An array of item instanceIds to equip.", "link": "" } }, "path": [], "access": "Private" }, { "name": "GetAccount", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Account\/{destinyMembershipId}\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" } }, "access": "Public" }, { "name": "GetAccountSummary", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Account\/{destinyMembershipId}\/Summary\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" } }, "access": "" }, { "name": "GetActivityBlob", "method": "GET", "endpoint": "\/Destiny\/Stats\/ActivityBlob\/{e}\/", "params": [], "post": [], "path": { "e": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetActivityHistory", "method": "GET", "endpoint": "\/Destiny\/Stats\/ActivityHistory\/{membershipType}\/{destinyMembershipId}\/{characterId}\/", "params": { "mode": { "desc": "Game mode to return. Required.", "link": "Enums#DestinyActivityModeType" }, "count": { "desc": "The number of results to return.", "link": "" }, "page": { "desc": "The current page to return. Starts at 1.", "link": "" }, "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "Public" }, { "name": "GetAdvisorsForAccount", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Account\/{destinyMembershipId}\/Advisors\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" } }, "access": "" }, { "name": "GetAdvisorsForCharacter", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Account\/{destinyMembershipId}\/Character\/{characterId}\/Advisors\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "Public" }, { "name": "GetAdvisorsForCharacterV2", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Account\/{destinyMembershipId}\/Character\/{characterId}\/Advisors\/V2\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "" }, { "name": "GetAdvisorsForCurrentCharacter", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/MyAccount\/Character\/{characterId}\/Advisors\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "Private" }, { "name": "GetAllItemsSummary", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Account\/{destinyMembershipId}\/Items\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" } }, "access": "Public" }, { "name": "GetAllVendorsForCurrentCharacter", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/MyAccount\/Character\/{characterId}\/Vendors\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "" }, { "name": "GetBondAdvisors", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/MyAccount\/Advisors\/Bonds\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" } }, "access": "" }, { "name": "GetCharacter", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Account\/{destinyMembershipId}\/Character\/{characterId}\/Complete\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "Private" }, { "name": "GetCharacterActivities", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Account\/{destinyMembershipId}\/Character\/{characterId}\/Activities\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "Public" }, { "name": "GetCharacterInventory", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Account\/{destinyMembershipId}\/Character\/{characterId}\/Inventory\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "Public" }, { "name": "GetCharacterInventorySummary", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Account\/{destinyMembershipId}\/Character\/{characterId}\/Inventory\/Summary\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "" }, { "name": "GetCharacterProgression", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Account\/{destinyMembershipId}\/Character\/{characterId}\/Progression\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "Public" }, { "name": "GetCharacterSummary", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Account\/{destinyMembershipId}\/Character\/{characterId}\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "Public" }, { "name": "GetClanLeaderboards", "method": "GET", "endpoint": "\/Destiny\/Stats\/ClanLeaderboards\/{param1}\/", "params": { "modes": { "desc": "", "link": "" }, "statid": { "desc": "", "link": "" }, "maxtop": { "desc": "", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetDestinyAggregateActivityStats", "method": "GET", "endpoint": "\/Destiny\/Stats\/AggregateActivityStats\/{membershipType}\/{destinyMembershipId}\/{characterId}\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "Public" }, { "name": "GetDestinyExplorerItems", "method": "GET", "endpoint": "\/Destiny\/Explorer\/Items\/", "params": { "tpage": { "desc": "", "link": "" }, "count": { "desc": "The number of results to return. Default is 10.", "link": "" }, "name": { "desc": "Filter by name.", "link": "" }, "order": { "desc": "Order results.", "link": "Enums#DestinyExplorerOrderBy" }, "orderstathash": { "desc": "", "link": "" }, "direction": { "desc": "", "link": "" }, "rarity": { "desc": "Filter by item rarity.", "link": "Enums#TierType" }, "step": { "desc": "", "link": "" }, "categories": { "desc": "", "link": "" }, "weaponPerformance": { "desc": "", "link": "" }, "impactEffects": { "desc": "", "link": "" }, "guardianAttributes": { "desc": "", "link": "" }, "lightAbilities": { "desc": "", "link": "" }, "damageTypes": { "desc": "Filter by damage type.", "link": "Enums#DamageType" }, "matchrandomsteps": { "desc": "", "link": "" }, "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" }, "sourcecat": { "desc": "", "link": "" }, "sourcehash": { "desc": "", "link": "" } }, "post": [], "path": [], "access": "Public" }, { "name": "GetDestinyExplorerTalentNodeSteps", "method": "GET", "endpoint": "\/Destiny\/Explorer\/TalentNodeSteps\/", "params": { "page": { "desc": "The current page to return. Starts at 1.", "link": "" }, "count": { "desc": "The number of results per page. Default is 10.", "link": "" }, "name": { "desc": "Filter by name.", "link": "" }, "direction": { "desc": "", "link": "" }, "weaponPerformance": { "desc": "", "link": "" }, "impactEffects": { "desc": "", "link": "" }, "guardianAttributes": { "desc": "", "link": "" }, "lightAbilities": { "desc": "", "link": "" }, "damageTypes": { "desc": "Filter by damage type.", "link": "Enums#DamageType" }, "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": [], "access": "Public" }, { "name": "GetDestinyLiveTileContentItems", "method": "GET", "endpoint": "\/Destiny\/LiveTiles\/", "params": [], "post": [], "path": [], "access": "Public" }, { "name": "GetDestinyManifest", "method": "GET", "endpoint": "\/Destiny\/Manifest\/", "params": [], "post": [], "path": [], "access": "Public" }, { "name": "GetDestinySingleDefinition", "method": "GET", "endpoint": "\/Destiny\/Manifest\/{definitionType}\/{definitionId}\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" }, "version": { "desc": "", "link": "" } }, "post": [], "path": { "definitionType": { "desc": "The type of definition to return.", "link": "Enums#DestinyDefinitionType" }, "definitionId": { "desc": "A valid definitionId.", "link": "" } }, "access": "Public" }, { "name": "GetExcellenceBadges", "method": "GET", "endpoint": "\/Destiny\/Stats\/GetExcellenceBadges\/{membershipType}\/{destinyMembershipId}\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" } }, "access": "Public" }, { "name": "GetGrimoireByMembership", "method": "GET", "endpoint": "\/Destiny\/Vanguard\/Grimoire\/{membershipType}\/{destinyMembershipId}\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" }, "flavour": { "desc": "Indicates flavour stats should be included with player card data. More testing needed.", "link": "" }, "single": { "desc": "Return data for a single cardId.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" } }, "access": "Public" }, { "name": "GetGrimoireDefinition", "method": "GET", "endpoint": "\/Destiny\/Vanguard\/Grimoire\/Definition\/", "params": [], "post": [], "path": [], "access": "Public" }, { "name": "GetHistoricalStats", "method": "GET", "endpoint": "\/Destiny\/Stats\/{membershipType}\/{destinyMembershipId}\/{characterId}\/", "params": { "periodType": { "desc": "Indicates a specific period type to return.", "link": "Enums#PeriodType" }, "modes": { "desc": "Game modes to return. Comma separated.", "link": "Enums#DestinyActivityModeType" }, "groups": { "desc": "Group of stats to include, otherwise only general stats are returned. Comma separated.", "link": "Enums#DestinyStatsGroupType" }, "monthstart": { "desc": "First month to return when monthly stats are requested. Use the format YYYY-MM.", "link": "" }, "monthend": { "desc": "Last month to return when monthly stats are requested. Use the format YYYY-MM.", "link": "" }, "daystart": { "desc": "First day to return when daily stats are requested. Use the format YYYY-MM-DD.", "link": "" }, "dayend": { "desc": "Last day to return when daily stats are requested. Use the format YYYY-MM-DD.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "Public" }, { "name": "GetHistoricalStatsDefinition", "method": "GET", "endpoint": "\/Destiny\/Stats\/Definition\/", "params": [], "post": [], "path": [], "access": "Public" }, { "name": "GetHistoricalStatsForAccount", "method": "GET", "endpoint": "\/Destiny\/Stats\/Account\/{membershipType}\/{destinyMembershipId}\/", "params": { "groups": { "desc": "Groups of stats to include, otherwise only general stats are returned. Comma separated.", "link": "Enums#DestinyStatsGroupType" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" } }, "access": "Public" }, { "name": "GetItemDetail", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Account\/{destinyMembershipId}\/Character\/{characterId}\/Inventory\/{itemInstanceId}\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" }, "itemInstanceId": { "desc": "A valid item instance that is in the character's inventory.", "link": "" } }, "access": "Public" }, { "name": "GetItemReferenceDetail", "method": "GET", "endpoint": "\/Destiny\/{param1}\/Account\/{param2}\/Character\/{param3}\/ItemReference\/{param4}\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" }, "param3": { "desc": "", "link": "" }, "param4": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetLeaderboards", "method": "GET", "endpoint": "\/Destiny\/Stats\/Leaderboards\/{membershipType}\/{destinyMembershipId}\/", "params": { "modes": { "desc": "Game modes to return. Comma separated.", "link": "Enums#DestinyActivityModeType" }, "statid": { "desc": "", "link": "" }, "maxtop": { "desc": "", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" } }, "access": "Private" }, { "name": "GetLeaderboardsForCharacter", "method": "GET", "endpoint": "\/Destiny\/Stats\/Leaderboards\/{membershipType}\/{destinyMembershipId}\/{characterId}\/", "params": { "modes": { "desc": "Game modes to return. Comma separated.", "link": "Enums#DestinyActivityModeType" }, "statid": { "desc": "", "link": "" }, "maxtop": { "desc": "", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "Private" }, { "name": "GetLeaderboardsForPsn", "method": "GET", "endpoint": "\/Destiny\/Stats\/LeaderboardsForPsn\/", "params": { "modes": { "desc": "Game modes to return. Comma separated.", "link": "Enums#DestinyActivityModeType" }, "code": { "desc": "Unknown, further testing needed.", "link": "" } }, "post": [], "path": [], "access": "Private" }, { "name": "GetMembershipIdByDisplayName", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Stats\/GetMembershipIdByDisplayName\/{displayName}\/", "params": { "ignorecase": { "desc": "Default is false when not specified. True to cause a caseless search to be used.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "displayName": { "desc": "A valid PSN Id or Gamertag display name.", "link": "" } }, "access": "Public" }, { "name": "GetMyGrimoire", "method": "GET", "endpoint": "\/Destiny\/Vanguard\/Grimoire\/{membershipType}\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" }, "flavour": { "desc": "Indicates flavour stats should be included with player card data. More testing needed.", "link": "" }, "single": { "desc": "Return data for a single cardId.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" } }, "access": "Private" }, { "name": "GetPostGameCarnageReport", "method": "GET", "endpoint": "\/Destiny\/Stats\/PostGameCarnageReport\/{activityInstanceId}\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "activityInstanceId": { "desc": "A valid activityInstanceId.", "link": "" } }, "access": "Public" }, { "name": "GetPublicAdvisors", "method": "GET", "endpoint": "\/Destiny\/Advisors\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": [], "access": "Public" }, { "name": "GetPublicAdvisorsV2", "method": "GET", "endpoint": "\/Destiny\/Advisors\/V2\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": [], "access": "" }, { "name": "GetPublicVendor", "method": "GET", "endpoint": "\/Destiny\/Vendors\/{vendorId}\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "vendorId": { "desc": "A valid vendorId.", "link": "" } }, "access": "Public" }, { "name": "GetPublicVendorWithMetadata", "method": "GET", "endpoint": "\/Destiny\/Vendors\/{vendorId}\/Metadata\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "vendorId": { "desc": "A valid vendorId.", "link": "" } }, "access": "Public" }, { "name": "GetPublicXurVendor", "method": "GET", "endpoint": "\/Destiny\/Advisors\/Xur\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": [], "access": "Public" }, { "name": "GetRecordBookCompletionStatus", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/MyAccount\/RecordBooks\/{recordBookHash}\/Completion\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "recordBookHash": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "GetSpecialEventAdvisors", "method": "GET", "endpoint": "\/Destiny\/Events\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": [], "access": "Public" }, { "name": "GetTriumphs", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/Account\/{destinyMembershipId}\/Triumphs\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" } }, "access": "Public" }, { "name": "GetUniqueWeaponHistory", "method": "GET", "endpoint": "\/Destiny\/Stats\/UniqueWeapons\/{membershipType}\/{destinyMembershipId}\/{characterId}\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "destinyMembershipId": { "desc": "A valid destinyMembershipId.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "Public" }, { "name": "GetVault", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/MyAccount\/Vault\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" }, "accountId": { "desc": "A valid destinyMembershipId.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" } }, "access": "Private" }, { "name": "GetVaultSummary", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/MyAccount\/Vault\/Summary\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" }, "accountId": { "desc": "A valid destinyMembershipId.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" } }, "access": "" }, { "name": "GetVendorForCurrentCharacter", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/MyAccount\/Character\/{characterId}\/Vendor\/{vendorId}\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" }, "vendorId": { "desc": "A valid vendorId.", "link": "" } }, "access": "Private" }, { "name": "GetVendorForCurrentCharacterWithMetadata", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/MyAccount\/Character\/{characterId}\/Vendor\/{vendorId}\/Metadata\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" }, "vendorId": { "desc": "A valid vendorId.", "link": "" } }, "access": "Private" }, { "name": "GetVendorItemDetailForCurrentCharacter", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/MyAccount\/Character\/{characterId}\/Vendor\/{vendorId}\/Item\/{itemId}\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" }, "vendorId": { "desc": "A valid vendorId.", "link": "" }, "itemId": { "desc": "A valid vendorItemIndex see [[GetVendorForCurrentCharacter]]", "link": "" } }, "access": "Private" }, { "name": "GetVendorItemDetailForCurrentCharacterWithMetadata", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/MyAccount\/Character\/{characterId}\/Vendor\/{vendorId}\/Item\/{itemId}\/Metadata\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" }, "vendorId": { "desc": "A valid vendorId.", "link": "" }, "itemId": { "desc": "A valid vendorItemIndex see [[GetVendorForCurrentCharacter]]", "link": "" } }, "access": "Private" }, { "name": "GetVendorSummariesForCurrentCharacter", "method": "GET", "endpoint": "\/Destiny\/{membershipType}\/MyAccount\/Character\/{characterId}\/Vendors\/Summaries\/", "params": { "definitions": { "desc": "Include definitions in the response. Use while testing.", "link": "" } }, "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" } }, "access": "Private" }, { "name": "RefundItem", "method": "POST", "endpoint": "\/Destiny\/{param1}\/RefundItem\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "SearchDestinyPlayer", "method": "GET", "endpoint": "\/Destiny\/SearchDestinyPlayer\/{membershipType}\/{displayName}\/", "params": [], "post": [], "path": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "displayName": { "desc": "A valid display name to search for.", "link": "" } }, "access": "Public" }, { "name": "SetItemLockState", "method": "POST", "endpoint": "\/Destiny\/SetLockState\/", "params": [], "post": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "itemId": { "desc": "A valid instanceId of an item to lock\/unlock.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" }, "state": { "desc": "The item lock state, true to lock, false to unlock.", "link": "" } }, "path": [], "access": "Private" }, { "name": "SetQuestTrackedState", "method": "POST", "endpoint": "\/Destiny\/SetQuestTrackedState\/", "params": [], "post": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "membershipId": { "desc": "A valid membership ID.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" }, "itemId": { "desc": "The unique item hash of the quest item.", "link": "" }, "state": { "desc": "true = tracked, false = not-tracked", "link": "" } }, "path": [], "access": "Private" }, { "name": "TransferItem", "method": "POST", "endpoint": "\/Destiny\/TransferItem\/", "params": [], "post": { "membershipType": { "desc": "A valid Bungie.net membershipType.", "link": "Enums#BungieMembershipType" }, "itemReferenceHash": { "desc": "The inventoryItemHash for an item.", "link": "" }, "itemId": { "desc": "The instanceId of an equipable item. Should be \"0\" otherwise.", "link": "" }, "stackSize": { "desc": "How many items to transfer. Should be \"1\" for equipable items.", "link": "" }, "characterId": { "desc": "A valid characterId that is associated with the given account.", "link": "" }, "transferToVault": { "desc": "Move the item to or from the vault; true or false", "link": "" } }, "path": [], "access": "Private" } ], "CommunitycontentService": [ { "name": "AlterApprovalState", "method": "POST", "endpoint": "\/CommunityContent\/AlterApprovalState\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "EditContent", "method": "POST", "endpoint": "\/CommunityContent\/Edit\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "Private" }, { "name": "GetApprovalQueue", "method": "GET", "endpoint": "\/CommunityContent\/Queue\/{param1}\/{param2}\/{param3}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" }, "param3": { "desc": "", "link": "" } }, "access": "" }, { "name": "GetCommunityContent", "method": "GET", "endpoint": "\/CommunityContent\/Get\/{param1}\/{param2}\/{param3}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" }, "param2": { "desc": "", "link": "" }, "param3": { "desc": "", "link": "" } }, "access": "" }, { "name": "SubmitContent", "method": "POST", "endpoint": "\/CommunityContent\/Submit\/", "params": [], "post": [], "path": [], "access": "Private" } ], "CoreService": [ { "name": "GetAvailableLocales", "method": "GET", "endpoint": "\/\/GetAvailableLocales\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetCommonSettings", "method": "GET", "endpoint": "\/\/Settings\/", "params": [], "post": [], "path": [], "access": "" }, { "name": "GetGlobalAlerts", "method": "GET", "endpoint": "\/\/GlobalAlerts\/", "params": { "includestreaming": { "desc": "", "link": "" } }, "post": [], "path": [], "access": "Public" }, { "name": "GetSystemStatus", "method": "GET", "endpoint": "\/\/Status\/{param1}\/", "params": [], "post": [], "path": { "param1": { "desc": "", "link": "" } }, "access": "" }, { "name": "HelloWorld", "method": "GET", "endpoint": "\/\/HelloWorld\/", "params": [], "post": [], "path": [], "access": "" } ] }