Description Usage Arguments Value
This function modifies an UsernameStructure
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | modifyUsernameStructure(
UsernameStructureID,
CharacterLimitGroupID = NULL,
GroupTruncationOrder = NULL,
IsEmployeeEmail = NULL,
IsEmployeeUser = NULL,
IsGuardianUser = NULL,
IsStaffUser = NULL,
IsStudentEmail = NULL,
IsStudentUser = NULL,
LimitCharacterNumber = NULL,
LimitCharacterType = NULL,
MinimumLength = NULL,
MinimumTiebreakerLength = NULL,
PartType = NULL,
Rank = NULL,
Text = NULL,
entityId = 1,
query = NULL,
flatten = T,
returnResponse = F
)
|
entityId |
The id of the entity (school). Run |
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 |
The field values to give the modified UsernameStructure. Each defaults to NULL. |
The modified UsernameStructure Skyward's Knowledge Hub
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.