getUsernameStructure: Get an UsernameStructure
In samterfa/rqmlativ: Creates R Functions for Skyward Qmlativ's Generic API

This function returns a dataframe or json object of an UsernameStructure

getUsernameStructure(
  UsernameStructureID,
  CharacterLimitGroupID = F,
  CreatedTime = F,
  GroupTruncationOrder = F,
  IsEmployeeEmail = F,
  IsEmployeeUser = F,
  IsGuardianUser = F,
  IsStaffUser = F,
  IsStudentEmail = F,
  IsStudentUser = F,
  LimitCharacterNumber = F,
  LimitCharacterType = F,
  MinimumLength = F,
  MinimumTiebreakerLength = F,
  ModifiedTime = F,
  PartType = F,
  Rank = F,
  Text = F,
  UserIDCreatedBy = F,
  UserIDModifiedBy = F,
  fieldPaths = NULL,
  entityId = 1,
  query = NULL,
  flatten = T,
  returnResponse = F
)

`UsernameStructureID`	The ID of the UsernameStructure to return.
`fieldPaths`	Fields from other objects with 'Many to One' or 'One to One' relationships to the given object listed as text. Run `getSchemaForObjects`('UsernameStructure') to get more field paths.
`entityId`	The id of the entity (school). Run `listEntities` for a list of entities. Defaults to 1 (district).
`query`	Queries to be added to the request. Ex. list(SchoolYearID = 1). Defaults to NULL.
`flatten`	Whether to flatten result into a dataframe or return the json object. Default is TRUE (flatten to dataframe).
`returnResponse`	Whether to return the server response instead of the results. Useful for debugging. Default is FALSE.
`fieldNames`	A TRUE or FALSE value determining whether or not to return the field for the given UsernameStructure. Defaults to FALSE for all return fields which, for convenience, returns all fields for the UsernameStructure.