createUsernameStructure: Create new UsernameStructure.

In samterfa/SkywardSDK: Creates R Functions for Skyward Generic API Functions

Description

This function creates a new UsernameStructure.

Usage

createUsernameStructure(
  EntityID = 1,
  setCharacterLimitGroupID = NULL,
  setGroupTruncationOrder = NULL,
  setIsEmployeeEmail = NULL,
  setIsEmployeeUser = NULL,
  setIsGuardianUser = NULL,
  setIsStaffUser = NULL,
  setIsStudentEmail = NULL,
  setIsStudentUser = NULL,
  setLimitCharacterNumber = NULL,
  setLimitCharacterType = NULL,
  setLimitCharacterTypeCode = NULL,
  setMinimumLength = NULL,
  setMinimumTiebreakerLength = NULL,
  setPartType = NULL,
  setPartTypeCode = NULL,
  setRank = NULL,
  setText = NULL
)

Arguments

EntityID	The id of the entity. Run getAllEntities for a list of entities.
setFieldName	Values to set FieldName to for the given object. Defaults to NULL for all set fields which does not set the field's value.

Value

The fields used to define the newly created UsernameStructure.

References

{yourApiUrl}/swagger

Skyward's Knowledge Hub

samterfa/SkywardSDK documentation built on Oct. 13, 2020, 6:53 a.m.