API V1

    ApiAccountLoginPost

    Logs in an account based on the name and password combination. Returns a JsonWebToken used for authorization in any further calls to the API.

            Example Usage: POST api/account/login
    Request
    POST /api/Account/login
    Parameters
    Name Type Value Notes
    accountRequest {PlayGen.SUGAR.Contracts.AccountRequest} object that contains the account details provided.
    Responses
    Status Code Description Samples
    204 No Content

    ApiAccountRegisterPost

    Register a new account and creates an associated user. Requires the {PlayGen.SUGAR.Contracts.AccountRequest.Name} to be unique. Returns a JsonWebToken used for authorization in any further calls to the API.

            Example Usage: POST api/account/register
    Request
    POST /api/Account/register
    Parameters
    Name Type Value Notes
    accountRequest {PlayGen.SUGAR.Contracts.AccountRequest} object that contains the details of the new Account.
    Responses
    Status Code Description Samples
    204 No Content

    ApiAccountByIdDelete

    Delete Account with the ID provided.

            Example Usage: DELETE api/account/1
    Request
    DELETE /api/Account/{id}
    Parameters
    Name Type Value Notes
    *id integer Account ID.
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsFindByTokenByGameIdGet

    Find an Achievement that matches and .

            Example Usage: GET api/achievements/find/ACHIEVEMENT_TOKEN/1
    Request
    GET /api/Achievements/find/{token}/{gameId}
    Parameters
    Name Type Value Notes
    *token string Token of Achievement
    *gameId integer ID of the Game the Achievement is for
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsFindByTokenGlobalGet

    Find an Achievement that matches and .

            Example Usage: GET api/achievements/find/ACHIEVEMENT_TOKEN/1
    Request
    GET /api/Achievements/find/{token}/global
    Parameters
    Name Type Value Notes
    *token string Token of Achievement
    *gameId integer ID of the Game the Achievement is for
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsGlobalListGet

    Find a list of Achievements that match . If global is provided instead of a gameId, get all global achievements, ie. achievements that are not associated with a specific game.

            Example Usage: GET api/achievements/game/1/list
    Request
    GET /api/Achievements/global/list
    Parameters
    Name Type Value Notes
    *gameId integer Game ID
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsGameByGameIdListGet

    Find a list of Achievements that match . If global is provided instead of a gameId, get all global achievements, ie. achievements that are not associated with a specific game.

            Example Usage: GET api/achievements/game/1/list
    Request
    GET /api/Achievements/game/{gameId}/list
    Parameters
    Name Type Value Notes
    *gameId integer Game ID
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsGameByGameIdEvaluateGet

    Find the current progress for all achievements for a for .

            Example Usage: GET api/achievements/game/1/evaluate/1
    Request
    GET /api/Achievements/game/{gameId}/evaluate
    Parameters
    Name Type Value Notes
    *gameId integer ID of Game
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsGlobalEvaluateGet

    Find the current progress for all achievements for a for .

            Example Usage: GET api/achievements/game/1/evaluate/1
    Request
    GET /api/Achievements/global/evaluate
    Parameters
    Name Type Value Notes
    *gameId integer ID of Game
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsGameByGameIdEvaluateByActorIdGet

    Find the current progress for all achievements for a for .

            Example Usage: GET api/achievements/game/1/evaluate/1
    Request
    GET /api/Achievements/game/{gameId}/evaluate/{actorId}
    Parameters
    Name Type Value Notes
    *gameId integer ID of Game
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsGlobalEvaluateByActorIdGet

    Find the current progress for all achievements for a for .

            Example Usage: GET api/achievements/game/1/evaluate/1
    Request
    GET /api/Achievements/global/evaluate/{actorId}
    Parameters
    Name Type Value Notes
    *gameId integer ID of Game
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsByTokenByGameIdEvaluateGet

    Find the current progress for an Achievement for .

            Example Usage: GET api/achievements/ACHIEVEMENT_TOKEN/1/evaluate/1
    Request
    GET /api/Achievements/{token}/{gameId}/evaluate
    Parameters
    Name Type Value Notes
    *token string Token of Achievement
    *gameId integer ID of the Game the Achievement is for
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsByTokenGlobalEvaluateGet

    Find the current progress for an Achievement for .

            Example Usage: GET api/achievements/ACHIEVEMENT_TOKEN/1/evaluate/1
    Request
    GET /api/Achievements/{token}/global/evaluate
    Parameters
    Name Type Value Notes
    *token string Token of Achievement
    *gameId integer ID of the Game the Achievement is for
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsByTokenByGameIdEvaluateByActorIdGet

    Find the current progress for an Achievement for .

            Example Usage: GET api/achievements/ACHIEVEMENT_TOKEN/1/evaluate/1
    Request
    GET /api/Achievements/{token}/{gameId}/evaluate/{actorId}
    Parameters
    Name Type Value Notes
    *token string Token of Achievement
    *gameId integer ID of the Game the Achievement is for
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsByTokenGlobalEvaluateByActorIdGet

    Find the current progress for an Achievement for .

            Example Usage: GET api/achievements/ACHIEVEMENT_TOKEN/1/evaluate/1
    Request
    GET /api/Achievements/{token}/global/evaluate/{actorId}
    Parameters
    Name Type Value Notes
    *token string Token of Achievement
    *gameId integer ID of the Game the Achievement is for
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsCreatePost

    Create a new Achievement. Requires {PlayGen.SUGAR.Contracts.AchievementRequest.Name} to be unique to that {PlayGen.SUGAR.Contracts.AchievementRequest.GameId}.

            Example Usage: POST api/achievements/create
    Request
    POST /api/Achievements/create
    Parameters
    Name Type Value Notes
    newAchievement {PlayGen.SUGAR.Contracts.AchievementRequest} object that holds the details of the new Achievement.
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsUpdatePut

    Update an existing Achievement.

            Example Usage: PUT api/achievements/update
    Request
    PUT /api/Achievements/update
    Parameters
    Name Type Value Notes
    achievement {PlayGen.SUGAR.Contracts.AchievementRequest} object that holds the details of the Achievement.
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsByTokenGlobalDelete

    Delete Achievement with the and provided.

            Example Usage: DELETE api/achievements/ACHIEVEMENT_TOKEN/1
    Request
    DELETE /api/Achievements/{token}/global
    Parameters
    Name Type Value Notes
    *token string Token of Achievement
    *gameId integer ID of the Game the Achievement is for
    Responses
    Status Code Description Samples
    204 No Content

    ApiAchievementsByTokenByGameIdDelete

    Delete Achievement with the and provided.

            Example Usage: DELETE api/achievements/ACHIEVEMENT_TOKEN/1
    Request
    DELETE /api/Achievements/{token}/{gameId}
    Parameters
    Name Type Value Notes
    *token string Token of Achievement
    *gameId integer ID of the Game the Achievement is for
    Responses
    Status Code Description Samples
    204 No Content

    ApiGameListGet

    Get a list of all Games.

            Example Usage: GET api/game/list
    Request
    GET /api/Game/list
    Responses
    Status Code Description Samples
    204 No Content

    ApiGameFindByNameGet

    Get a list of Games that match provided.

            Example Usage: GET api/game/find/game1
    Request
    GET /api/Game/find/{name}
    Parameters
    Name Type Value Notes
    *name string Game name
    Responses
    Status Code Description Samples
    204 No Content

    ApiGameFindbyidByIdGet

    Get Game that matches provided.

            Example Usage: GET api/game/findbyid/1
    Request
    GET /api/Game/findbyid/{id}
    Parameters
    Name Type Value Notes
    *id integer Game id
    Responses
    Status Code Description Samples
    204 No Content

    ApiGamePost

    Create a new Game. Requires the {PlayGen.SUGAR.Contracts.GameRequest.Name} to be unique.

            Example Usage: POST api/game
    Request
    POST /api/Game
    Parameters
    Name Type Value Notes
    newGame {PlayGen.SUGAR.Contracts.GameRequest} object that contains the details of the new Game.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGameUpdateByIdPut

    Update an existing Game.

            Example Usage: PUT api/game/update/1
    Request
    PUT /api/Game/update/{id}
    Parameters
    Name Type Value Notes
    *id integer Id of the existing Game.
    game {PlayGen.SUGAR.Contracts.GameRequest} object that holds the details of the Game.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGameByIdDelete

    Delete Game with the ID provided.

            Example Usage: DELETE api/game/1
    Request
    DELETE /api/Game/{id}
    Parameters
    Name Type Value Notes
    *id integer Game ID.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGameDataGet

    Find a list of all GameData that match the , and provided.

            Example Usage: GET api/gamedata?actorId=1&gameId=1&key=key1&key=key2
    Request
    GET /api/GameData
    Parameters
    Name Type Value Notes
    actorId integer ID of a User/Group.
    gameId integer ID of a Game.
    key array Array of Key names.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGameDataPost

    Create a new GameData record.

            Example Usage: POST api/gamedata
    Request
    POST /api/GameData
    Parameters
    Name Type Value Notes
    newData {PlayGen.SUGAR.Contracts.GameDataRequest} object that holds the details of the new GameData.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGroupListGet

    Get a list of all Groups.

            Example Usage: GET api/group/list
    Request
    GET /api/Group/list
    Responses
    Status Code Description Samples
    204 No Content

    ApiGroupFindByNameGet

    Get a list of Groups that match provided.

            Example Usage: GET api/group/find/group1
    Request
    GET /api/Group/find/{name}
    Parameters
    Name Type Value Notes
    *name string Group name.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGroupFindbyidByIdGet

    Get Group that matches provided.

            Example Usage: GET api/group/findbyid/1
    Request
    GET /api/Group/findbyid/{id}
    Parameters
    Name Type Value Notes
    *id integer Group id.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGroupPost

    Create a new Group. Requires the {PlayGen.SUGAR.Contracts.ActorRequest.Name} to be unique for Groups.

            Example Usage: POST api/group
    Request
    POST /api/Group
    Parameters
    Name Type Value Notes
    actor {PlayGen.SUGAR.Contracts.ActorRequest} object that holds the details of the new Group.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGroupUpdateByIdPut

    Update an existing Group.

            Example Usage: PUT api/group/update/1
    Request
    PUT /api/Group/update/{id}
    Parameters
    Name Type Value Notes
    *id integer Id of the existing Group.
    group {PlayGen.SUGAR.Contracts.ActorRequest} object that holds the details of the Group.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGroupByIdDelete

    Delete group with the provided.

            Example Usage: DELETE api/group/1
    Request
    DELETE /api/Group/{id}
    Parameters
    Name Type Value Notes
    *id integer Group ID.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGroupMemberRequestsByGroupIdGet

    Get a list of all Users that have relationship requests for this .

            Example Usage: GET api/groupmember/requests/1
    Request
    GET /api/GroupMember/requests/{groupId}
    Parameters
    Name Type Value Notes
    *groupId integer ID of the group.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGroupMemberSentrequestsByUserIdGet

    Get a list of all Groups that have been sent relationship requests for this .

            Example Usage: GET api/groupmember/sentrequests/1
    Request
    GET /api/GroupMember/sentrequests/{userId}
    Parameters
    Name Type Value Notes
    *userId integer ID of the user.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGroupMemberMembersByGroupIdGet

    Get a list of all Users that have relationships with this .

            Example Usage: GET api/groupmember/members/1
    Request
    GET /api/GroupMember/members/{groupId}
    Parameters
    Name Type Value Notes
    *groupId integer ID of the group.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGroupMemberUsergroupsByUserIdGet

    Get a list of all Groups that have relationships with this .

            Example Usage: GET api/groupmember/usergroups/1
    Request
    GET /api/GroupMember/usergroups/{userId}
    Parameters
    Name Type Value Notes
    *userId integer ID of the User.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGroupMemberPut

    Update an existing relationship between and . Requires the relationship to already exist between the User and Group.

            Example Usage: PUT api/groupmember
    Request
    PUT /api/GroupMember
    Parameters
    Name Type Value Notes
    relationship {PlayGen.SUGAR.Contracts.RelationshipStatusUpdate} object that holds the details of the relationship.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGroupMemberPost

    Create a new relationship request between the User and Group. Requires a relationship between the User and Group to not already exist.

            Example Usage: POST api/groupmember
    Request
    POST /api/GroupMember
    Parameters
    Name Type Value Notes
    relationship {PlayGen.SUGAR.Contracts.RelationshipRequest} object that holds the details of the new relationship request.
    Responses
    Status Code Description Samples
    204 No Content

    ApiGroupMemberRequestPut

    Update an existing relationship request between and . Requires the relationship request to already exist between the User and Group.

            Example Usage: PUT api/groupmember/request
    Request
    PUT /api/GroupMember/request
    Parameters
    Name Type Value Notes
    relationship {PlayGen.SUGAR.Contracts.RelationshipStatusUpdate} object that holds the details of the relationship.
    Responses
    Status Code Description Samples
    204 No Content

    ApiLeaderboardsGlobalListGet

    Find a list of leaderboards that match . If global is provided instead of a gameId, get all global leaderboards, ie. leaderboards that are not associated with a specific game.

            Example Usage: GET api/leaderboards/game/1/list
    Request
    GET /api/Leaderboards/global/list
    Parameters
    Name Type Value Notes
    *gameId integer Game ID
    Responses
    Status Code Description Samples
    204 No Content

    ApiLeaderboardsGameByGameIdListGet

    Find a list of leaderboards that match . If global is provided instead of a gameId, get all global leaderboards, ie. leaderboards that are not associated with a specific game.

            Example Usage: GET api/leaderboards/game/1/list
    Request
    GET /api/Leaderboards/game/{gameId}/list
    Parameters
    Name Type Value Notes
    *gameId integer Game ID
    Responses
    Status Code Description Samples
    204 No Content

    ApiLeaderboardsByTokenByGameIdGet

    Find a single leaderboard matching the token and gameId.

            Example Usage: GET api/leaderboards/LEADERBOARD_TOKEN/1
    Request
    GET /api/Leaderboards/{token}/{gameId}
    Parameters
    Name Type Value Notes
    *token string Token
    *gameId integer
    Responses
    Status Code Description Samples
    204 No Content

    ApiLeaderboardsByTokenByGameIdDelete

    Delete Leaderboard with the and provided.

            Example Usage: DELETE api/leaderboards/LEADERBOARD_TOKEN/1
    Request
    DELETE /api/Leaderboards/{token}/{gameId}
    Parameters
    Name Type Value Notes
    *token string Token of Leaderboard
    *gameId integer ID of the Game the Leaderboard is for
    Responses
    Status Code Description Samples
    204 No Content

    ApiLeaderboardsCreatePost

    Create a new Leaderboard. Requires {PlayGen.SUGAR.Contracts.LeaderboardRequest.Name} and {PlayGen.SUGAR.Contracts.LeaderboardRequest.Token} to be unique to that {PlayGen.SUGAR.Contracts.LeaderboardRequest.GameId}.

            Example Usage: POST api/leaderboards/create
    Request
    POST /api/Leaderboards/create
    Parameters
    Name Type Value Notes
    newLeaderboard {PlayGen.SUGAR.Contracts.LeaderboardRequest} object that holds the details of the new Leaderboard.
    Responses
    Status Code Description Samples
    204 No Content

    ApiLeaderboardsStandingsPost

    Get the standings for a Leaderboard using a {PlayGen.SUGAR.Contracts.LeaderboardStandingsRequest}.

            Example Usage: POST api/leaderboards/standings
    Request
    POST /api/Leaderboards/standings
    Parameters
    Name Type Value Notes
    leaderboardDetails {PlayGen.SUGAR.Contracts.LeaderboardStandingsRequest} object that holds the details that are wanted from the Leaderboard.
    Responses
    Status Code Description Samples
    204 No Content

    ApiLeaderboardsUpdatePut

    Update an existing Leaderboard.

            Example Usage: PUT api/leaderboards/update
    Request
    PUT /api/Leaderboards/update
    Parameters
    Name Type Value Notes
    leaderboard {PlayGen.SUGAR.Contracts.LeaderboardRequest} object that holds the details of the Leaderboard.
    Responses
    Status Code Description Samples
    204 No Content

    ApiLeaderboardsByTokenGlobalDelete

    Delete Leaderboard with the and provided.

            Example Usage: DELETE api/leaderboards/LEADERBOARD_TOKEN/1
    Request
    DELETE /api/Leaderboards/{token}/global
    Parameters
    Name Type Value Notes
    *token string Token of Leaderboard
    *gameId integer ID of the Game the Leaderboard is for
    Responses
    Status Code Description Samples
    204 No Content

    ApiResourceGet

    Find a list of all Resources filtered by the , and provided.

            Example Usage: GET api/resource?actorId=1&gameId=1&key=key1&key=key2
    Request
    GET /api/Resource
    Parameters
    Name Type Value Notes
    gameId integer ID of a Game.
    actorId integer ID of a User/Group.
    keys array Optional array of Key names to filter results by.
    Responses
    Status Code Description Samples
    204 No Content

    ApiResourcePost

    Creates or updates a Resource record.

            Example Usage: POST api/resource
    Request
    POST /api/Resource
    Parameters
    Name Type Value Notes
    resourceRequest {PlayGen.SUGAR.Contracts.ResourceAddRequest} object that holds the details of the ResourceData.
    Responses
    Status Code Description Samples
    204 No Content

    ApiResourceTransferPost

    Transfers a quantity of a specific resource.

            Example Usage: Post api/resource/transfer
    Request
    POST /api/Resource/transfer
    Parameters
    Name Type Value Notes
    transferRequest {PlayGen.SUGAR.Contracts.ResourceTransferRequest} object that holds the details of the resoruce transfer.
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsFindByTokenByGameIdGet

    Find a Skill that matches and .

            Example Usage: GET api/skills/find/SKILL_TOKEN/1
    Request
    GET /api/Skills/find/{token}/{gameId}
    Parameters
    Name Type Value Notes
    *token string Token of Skill
    *gameId integer ID of the Game the Skill is for
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsFindByTokenGlobalGet

    Find a Skill that matches and .

            Example Usage: GET api/skills/find/SKILL_TOKEN/1
    Request
    GET /api/Skills/find/{token}/global
    Parameters
    Name Type Value Notes
    *token string Token of Skill
    *gameId integer ID of the Game the Skill is for
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsGlobalListGet

    Find a list of Skills that match . If global is provided instead of a gameId, get all global skills, ie. skills that are not associated with a specific game.

            Example Usage: GET api/skills/game/1/list
    Request
    GET /api/Skills/global/list
    Parameters
    Name Type Value Notes
    *gameId integer Game ID
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsGameByGameIdListGet

    Find a list of Skills that match . If global is provided instead of a gameId, get all global skills, ie. skills that are not associated with a specific game.

            Example Usage: GET api/skills/game/1/list
    Request
    GET /api/Skills/game/{gameId}/list
    Parameters
    Name Type Value Notes
    *gameId integer Game ID
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsGameByGameIdEvaluateGet

    Find the current progress for all skills for a for .

            Example Usage: GET api/skills/game/1/evaluate/1
    Request
    GET /api/Skills/game/{gameId}/evaluate
    Parameters
    Name Type Value Notes
    *gameId integer ID of Game
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsGlobalEvaluateGet

    Find the current progress for all skills for a for .

            Example Usage: GET api/skills/game/1/evaluate/1
    Request
    GET /api/Skills/global/evaluate
    Parameters
    Name Type Value Notes
    *gameId integer ID of Game
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsGameByGameIdEvaluateByActorIdGet

    Find the current progress for all skills for a for .

            Example Usage: GET api/skills/game/1/evaluate/1
    Request
    GET /api/Skills/game/{gameId}/evaluate/{actorId}
    Parameters
    Name Type Value Notes
    *gameId integer ID of Game
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsGlobalEvaluateByActorIdGet

    Find the current progress for all skills for a for .

            Example Usage: GET api/skills/game/1/evaluate/1
    Request
    GET /api/Skills/global/evaluate/{actorId}
    Parameters
    Name Type Value Notes
    *gameId integer ID of Game
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsByTokenByGameIdEvaluateGet

    Find the current progress for a Skill for .

            Example Usage: GET api/skills/SKILL_TOKEN/1/evaluate/1
    Request
    GET /api/Skills/{token}/{gameId}/evaluate
    Parameters
    Name Type Value Notes
    *token string Token of Skill
    *gameId integer ID of the Game the Skill is for
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsByTokenGlobalEvaluateGet

    Find the current progress for a Skill for .

            Example Usage: GET api/skills/SKILL_TOKEN/1/evaluate/1
    Request
    GET /api/Skills/{token}/global/evaluate
    Parameters
    Name Type Value Notes
    *token string Token of Skill
    *gameId integer ID of the Game the Skill is for
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsByTokenByGameIdEvaluateByActorIdGet

    Find the current progress for a Skill for .

            Example Usage: GET api/skills/SKILL_TOKEN/1/evaluate/1
    Request
    GET /api/Skills/{token}/{gameId}/evaluate/{actorId}
    Parameters
    Name Type Value Notes
    *token string Token of Skill
    *gameId integer ID of the Game the Skill is for
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsByTokenGlobalEvaluateByActorIdGet

    Find the current progress for a Skill for .

            Example Usage: GET api/skills/SKILL_TOKEN/1/evaluate/1
    Request
    GET /api/Skills/{token}/global/evaluate/{actorId}
    Parameters
    Name Type Value Notes
    *token string Token of Skill
    *gameId integer ID of the Game the Skill is for
    *actorId integer ID of Group/User
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsCreatePost

    Create a new Skill. Requires {PlayGen.SUGAR.Contracts.AchievementRequest.Name} to be unique to that {PlayGen.SUGAR.Contracts.AchievementRequest.GameId}.

            Example Usage: POST api/skills/create
    Request
    POST /api/Skills/create
    Parameters
    Name Type Value Notes
    newSkill {PlayGen.SUGAR.Contracts.AchievementRequest} object that holds the details of the new Skill.
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsUpdatePut

    Update an existing Skill.

            Example Usage: PUT api/skills/update
    Request
    PUT /api/Skills/update
    Parameters
    Name Type Value Notes
    skill {PlayGen.SUGAR.Contracts.AchievementRequest} object that holds the details of the Skill.
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsByTokenGlobalDelete

    Delete Skill with the and provided.

            Example Usage: DELETE api/skills/SKILL_TOKEN/1
    Request
    DELETE /api/Skills/{token}/global
    Parameters
    Name Type Value Notes
    *token string Token of Skill
    *gameId integer ID of the Game the Skill is for
    Responses
    Status Code Description Samples
    204 No Content

    ApiSkillsByTokenByGameIdDelete

    Delete Skill with the and provided.

            Example Usage: DELETE api/skills/SKILL_TOKEN/1
    Request
    DELETE /api/Skills/{token}/{gameId}
    Parameters
    Name Type Value Notes
    *token string Token of Skill
    *gameId integer ID of the Game the Skill is for
    Responses
    Status Code Description Samples
    204 No Content

    ApiUserListGet

    Get a list of all Users.

            Example Usage: GET api/user/list
    Request
    GET /api/User/list
    Responses
    Status Code Description Samples
    204 No Content

    ApiUserFindByNameGet

    Get a list of Users that match provided.

            Example Usage: GET api/user/find/user1
    Request
    GET /api/User/find/{name}
    Parameters
    Name Type Value Notes
    *name string User name.
    exactMatch boolean
    Responses
    Status Code Description Samples
    204 No Content

    ApiUserFindbyidByIdGet

    Get User that matches provided.

            Example Usage: GET api/user/findbyid/1
    Request
    GET /api/User/findbyid/{id}
    Parameters
    Name Type Value Notes
    *id integer User id.
    Responses
    Status Code Description Samples
    204 No Content

    ApiUserPost

    Create a new User. Requires the {PlayGen.SUGAR.Contracts.ActorRequest.Name} to be unique for Users.

            Example Usage: POST api/user
    Request
    POST /api/User
    Parameters
    Name Type Value Notes
    actor {PlayGen.SUGAR.Contracts.ActorRequest} object that holds the details of the new User.
    Responses
    Status Code Description Samples
    204 No Content

    ApiUserUpdateByIdPut

    Update an existing User.

            Example Usage: PUT api/user/update/1
    Request
    PUT /api/User/update/{id}
    Parameters
    Name Type Value Notes
    *id integer Id of the existing User.
    user {PlayGen.SUGAR.Contracts.ActorRequest} object that holds the details of the User.
    Responses
    Status Code Description Samples
    204 No Content

    ApiUserByIdDelete

    Delete user with the provided.

            Example Usage: DELETE api/user/1
    Request
    DELETE /api/User/{id}
    Parameters
    Name Type Value Notes
    *id integer User ID.
    Responses
    Status Code Description Samples
    204 No Content

    ApiUserFriendRequestsByUserIdGet

    Get a list of all Users that have relationship requests for this .

            Example Usage: GET api/userfriend/requests/1
    Request
    GET /api/UserFriend/requests/{userId}
    Parameters
    Name Type Value Notes
    *userId integer ID of the group.
    Responses
    Status Code Description Samples
    204 No Content

    ApiUserFriendSentrequestsByUserIdGet

    Get a list of all Users that have been sent relationship requests for this .

            Example Usage: GET api/userfriend/sentrequests/1
    Request
    GET /api/UserFriend/sentrequests/{userId}
    Parameters
    Name Type Value Notes
    *userId integer ID of the user.
    Responses
    Status Code Description Samples
    204 No Content

    ApiUserFriendFriendsByUserIdGet

    Get a list of all Users that have relationships with this .

            Example Usage: GET api/userfriend/friends/1
    Request
    GET /api/UserFriend/friends/{userId}
    Parameters
    Name Type Value Notes
    *userId integer ID of the user.
    Responses
    Status Code Description Samples
    204 No Content

    ApiUserFriendPut

    Update an existing relationship between and . Requires the relationship to already exist between the two Users.

            Example Usage: PUT api/userfriend
    Request
    PUT /api/UserFriend
    Parameters
    Name Type Value Notes
    relationship {PlayGen.SUGAR.Contracts.RelationshipStatusUpdate} object that holds the details of the relationship.
    Responses
    Status Code Description Samples
    204 No Content

    ApiUserFriendPost

    Create a new relationship request between two Users. Requires a relationship between the two to not already exist.

            Example Usage: POST api/userfriend
    Request
    POST /api/UserFriend
    Parameters
    Name Type Value Notes
    relationship {PlayGen.SUGAR.Contracts.RelationshipRequest} object that holds the details of the new relationship request.
    Responses
    Status Code Description Samples
    204 No Content

    ApiUserFriendRequestPut

    Update an existing relationship request between and . Requires the relationship request to already exist between the two Users.

            Example Usage: PUT api/userfriend/request
    Request
    PUT /api/UserFriend/request
    Parameters
    Name Type Value Notes
    relationship {PlayGen.SUGAR.Contracts.RelationshipStatusUpdate} object that holds the details of the relationship.
    Responses
    Status Code Description Samples
    204 No Content