Skip to content

Instantly share code, notes, and snippets.

@Robbilie
Created February 24, 2016 21:49
Show Gist options
  • Save Robbilie/3c79cf55bf628b04cf0f to your computer and use it in GitHub Desktop.
Save Robbilie/3c79cf55bf628b04cf0f to your computer and use it in GitHub Desktop.

/status/

  • GET
    • data detailing the logged in character
{
  user: <object:user:compact>,
  character: <object:character:compact>,
  loggedIn: <boolean>,
}

/users/:userID/

  • GET
    • user sheet
{
  id: <string>,
  isAdmin: <boolean>,
  characters: {
    href: <url>
  }
}

/users/:userID/characters/

  • GET
    • list of characters associated with the user
{
  items: <array:character>,
  totalCount: <integer>
}

/users/:userID/characters/:characterID/

  • DELETE
    • Remove Character from User
{}
  • POST
    • switch character
{}

/characters/

  • GET
    • List all known characters ?

/characters/:characterID/

  • GET
    • List Character Sheet (expanded if self/owned)
{
  id: <long>,
  name: <string>,
  href: <url>, // compact, rest !compact
  user: <object:user>, // extended
  corporation: <object:corporation>,
  alliance: <object:alliance>, // optional
  ts3uid: <string> // optional
}

/characters/:characterID/groups/

  • GET
    • Get Groups Character is in
  • POST
    • apply

/characters/:characterID/groups/:groupID/

  • DELETE
    • leave / remove from group

/characters/:characterID/mails/

  • GET
    • retrieve characters mails

/characters/:characterID/notifications/

  • GET
    • retrieve characters notifications

/characters/:characterID/notifications/:notificationID/

  • POST
    • set state / read
  • DELETE
    • delete notification

/groups/

  • GET
    • list available / known groups
  • POST
    • Create group if allowed
  • DELETE
    • delete group (admin for now)

/groups/:groupID/

  • GET
    • get group details if group is known

/groups/:groupID/members/

  • GET
    • get memberlist if member of
  • POST
    • add member to group

/groups/:groupID/moderators/

  • GET
    • get list of moderators
  • POST
    • make character moderator

/groups/:groupID/moderators/:moderatorID/

  • DELETE
    • remove moderator

/groups/:groupID/applications/

  • GET
    • get list of applications

/groups/:groupID/applications/:applicationID/

  • POST
    • accept application
  • DELETE
    • delete application

/groups/:groupID/permissions/

  • GET
    • get list of permissions

/groups/:groupID/permissions/:permissionID/

  • POST
    • add permission
  • DELETE
    • remove permission

/permissions/

  • GET
    • return all permissions

/permissions/:scope/

  • GET
    • return list of permissions by scope

/notifications/

  • GET
    • Types

/corporations/

  • GET
    • i dont think this is a good idea, performance wise

/corporations/:corporationID/

  • GET
    • get corporation sheet
{
  id: <long>,
  name: <string>,
  href: <url>, // compact, rest !compact
}

/corporations/:corporationID/members/

  • GET
    • get corporation members (character)
{
  items: <array:character>,
  totalCount: <integer>
}

/alliances/

  • GET
    • i dont think this is a good idea, performance wise

/alliances/:allianceID/

  • GET
    • get alliance sheet
{
  id: <long>,
  name: <string>,
  href: <url>, // compact, rest !compact
}

/alliances/:allianceID/members/

  • GET
    • get alliance members (character)
{
  items: <array:character>,
  totalCount: <integer>
}

/alliance/:allianceID/corporations/

  • GET
    • get member corporations
{
  items: <array:corporation>,
  totalCount: <integer>
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment