UserManagement - PM web service
Avatar PM WEBSVC.UserManagement web service
This web service has the following calls:
- ActivateUser
- CreateUser
- DeactivateUser
- DoesUserExist
- GeneratePassword
- GetDictionaryItems
- GetUserRoleList
- IsUserActive
- UpdateUser
ActivateUser call
The following table lists the ActivateUser parameters, properties, accepted values, and associated dictionaries.
Parameters with no Properties
| Parameter | Property | Value Accepted | Notes |
| SystemCode | N/A | Avatar System Code | |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password | |
| User | N/A | Avatar User ID |
CreateUser call
The following tables list the CreateUser parameters, properties, accepted values, and associated dictionaries.
Parameters with no Properties
| Parameter | Property | Value Accepted | Notes |
| SystemCode | N/A | Avatar System Code | |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password |
Parameters with Properties
| Parameter | Property | Value Accepted | Notes |
|
UserDefinition |
AllowAccessToAlertError |
Y or N |
|
|
|
AllowAccessToRegEditor |
Y or N |
|
|
|
AllowCheckInOutAppts |
Y or N |
|
|
|
AllowDelApptWithProgNote |
"0, 1, or 2" |
|
|
|
AllowPostFromCheckInOut |
Y or N |
|
|
|
AllowSeeOtherCalendars |
Y or N |
|
|
|
AllowUserRenewal |
Y or N |
|
|
|
AllowUserToModPrtFonts |
Y or N |
|
|
|
AllowUserToViewConfNotes |
Y or N |
|
|
|
ApptSchedForms |
""&"" delimited String of form IDs |
|
|
|
AssociateUserToNetworkID |
"1, 2, or 3" |
|
|
|
ChartView |
View ID as defined in the View Definition form |
|
|
|
DateOfBirth |
Date |
|
|
|
DateOfHire |
Date |
|
|
|
DefaultAuthor |
UserID of default author |
|
|
|
DefaultSupervisor |
UserID of default supervisor |
|
|
|
Department |
Dictionary field # 57 in User file |
|
|
|
EmployeeID |
String |
|
|
|
ErrorAlertTypes |
""&"" delimited String of Alert Type IDs as defined in the Alert Type form |
|
|
|
EthnicOrigin |
Dictionary field # 53 in User file |
|
|
|
FinEligFormToLaunch |
"0, 1, or 2" |
|
|
|
FormsAllowedToPrint |
""&"" delimited String of Form IDs as defined in the Document Management Definition form |
|
|
|
FormsAllowedToScan |
""&"" delimited String of Form IDs as defined in the Document Management Definition form |
|
|
|
FormsAllowedToView |
""&"" delimited String of Form IDs as defined in the Document Management Definition form |
|
|
|
FormsAllowedToVoid |
""&"" delimited String of Form IDs as defined in the Document Management Definition form |
|
|
|
FormsForFinalApproval |
""&"" delimited String of myAvatar form IDs |
|
|
|
FormsRequireSupervisor |
""&"" delimited String of myAvatar form IDs |
|
|
|
Gender |
Dictionary field # 50 in User file |
|
|
|
HomeCity |
String |
|
|
|
HomePhoneNumber |
String |
|
|
|
HomeState |
String |
|
|
|
HomeStreetAddress1 |
String |
|
|
|
HomeStreetAddress2 |
String |
|
|
|
HomeView |
View ID as defined in the View Definition form |
|
|
|
HomeZIPCode |
String |
|
|
|
IsAvatarMobileUser |
Y or N |
|
|
|
IsUserAStaffMember |
Y or N |
|
|
|
IsUserAUnit |
Y or N |
|
|
|
IsUserDocManagementAdmin |
0 or 1 |
|
|
|
IsUserSystemAdministrator |
Y or N |
|
|
|
MaritalStatus |
Dictionary field # 51 in User file |
|
|
|
MobileAppUserRole |
"1, 2, 3, 4, 5, or 6" |
|
|
|
MobilePhoneCarrier |
Dictionary field # 1059 in User file |
|
|
|
MobilePhoneNumber |
String |
|
|
NetsmartCarePOVWdgtAccess |
Dictionary field # 6252 in User file |
||
|
|
NetsmartMobileAppAccess |
Dictionary field # 6250 |
|
|
|
OrganizationEmailAddress |
String |
|
|
|
PasswordTermDurationDays |
Integer |
|
|
|
PersonalEmailAddress |
String |
|
|
|
PositionClass |
Dictionary field # 1016 in User file |
|
|
|
PositionDescription |
String |
|
|
|
PreventUserFromAppLogout |
Y or N |
|
|
|
PreventUsrAcsToNonCaseClt |
Y or N |
|
|
PrimaryTwoFactorIDToken |
String |
||
|
|
PromptForUsernameAtOptEnt |
Y or N |
|
|
|
Race |
Dictionary field # 1013 in User file |
|
|
|
ReminderNoticeNumDays |
Integer |
|
|
|
ReqFilingAuthForAppOpts |
Y or N |
|
|
|
RequireDongleAuth |
Y or N |
|
|
SecondaryTwoFactorIDToken |
String |
||
|
|
SSNAccess |
"1, 2, or 3" |
|
|
|
SiteBookOutAllowedCounty |
""&"" delimited String of site IDs generated by 'Site Registration' |
|
|
|
SiteSchedUserCanModify |
""&"" delimited String of site IDs generated by 'Site Registration' |
|
|
|
SiteUserMayOverbook |
""&"" delimited String of site IDs generated by 'Site Registration' |
|
|
|
SiteUserMayOverbookClient |
""&"" delimited String of site IDs generated by 'Site Registration' |
|
|
|
SiteUserMayOverbookGroup |
""&"" delimited String of site IDs generated by 'Site Registration' |
|
|
|
SiteUserMayOverbookStaff |
""&"" delimited String of site IDs generated by 'Site Registration' |
|
|
|
SocialSecurityNumber |
String |
|
|
|
SpecifyFormsToPrint |
""&"" delimited String of Form IDs as defined in the Document Management Definition form |
|
|
|
SpecifyFormsToScan |
""&"" delimited String of Form IDs as defined in the Document Management Definition form |
|
|
|
SpecifyFormsToView |
""&"" delimited String of Form IDs as defined in the Document Management Definition form |
|
|
|
SpecifyFormsToVoid |
""&"" delimited String of Form IDs as defined in the Document Management Definition form |
|
|
|
StaffId |
Staff Id generated by 'Practitioner Enrollment' |
|
|
|
SupervisorApproveRequired |
Y or N |
|
|
|
SuppressSendingOfAlertsTo |
Dictionary field # 1060 in User file |
|
|
|
SystemCodes |
""&"" delimited String of facility numbers |
|
|
|
TimeZone |
"America/Adak, America/Anchorage, America/Atka, America/Boise, America/Chicago, America/Denver, America/Detroit, America/Fort_Wayne, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Los_Angeles,America/Louisville, America/Menominee, America/New_York, America/Nome, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Phoenix, America/Shiprock, America/Yakutat, Navajo, Pacific/Honolulu, SystemV/CST6CDT, SystemV/EST5EDT, SystemV/MST7MDT, SystemV/PST8PDT, SystemV/YST9YDT, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New" |
|
|
|
Transcriber |
Y or N |
|
|
|
TypeOfEmployee |
Dictionary field # 56 in User file |
|
|
|
UnitId |
""&"" delimited String of unit IDs |
|
|
|
UserCanBeFinalApprover |
Y or N |
|
|
|
UserDescription |
String |
|
|
|
UserId |
String |
|
|
|
UserIsColorblind |
Y or N |
|
|
|
UserRoles |
""&"" delimited String of user role IDs as defined in the User Role Definition form |
|
|
|
UserSecurityLevel |
"1, 2, 3, or 4" |
|
|
|
UserTimeoutSecond |
Integer |
|
|
|
ViewVoidedDocuments |
Y or N |
|
|
|
VoidReasonsAllowedToView |
Dictionary field # 10134 in Document Management file |
|
|
|
WFNotificationUserLists |
""&"" delimited String of Workflow Notification User List IDs as defined in the User List Management form |
|
|
|
WFRequirementUserLists |
""&"" delimited String of Workflow Required User List IDs as defined in the Required User List Management form |
|
|
|
WarnNonCaseloadAccess |
Y, U, or N |
DeactivateUser call
The following table lists the DeactivateUser parameters, properties, accepted values, and associated dictionaries.
Parameters with no Properties
| Parameter | Property | Value Accepted | Notes |
| SystemCode | N/A | Avatar System Code | |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password | |
| User | N/A | Avatar User ID |
DoesUserExist call
The following table lists the DoesUserExist parameters, properties, accepted values, and associated dictionaries.
Parameters with no Properties
| Parameter | Property | Value Accepted | Notes |
| SystemCode | N/A | Avatar System Code | |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password | |
| User | N/A | Avatar User ID |
GeneratePassword call
The following table lists the GeneratePassword parameters, properties, accepted values, and associated dictionaries.
Parameters with no Properties
| Parameter | Property | Value Accepted | Notes |
| SystemCode | N/A | Avatar System Code | |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password | |
| User | N/A | Avatar User ID |
GetDictionaryItems call
The following table lists the GetDictionaryItems parameters, properties, accepted values, and associated dictionaries.
Parameters with no Properties
| Parameter | Property | Value Accepted | Notes |
| SystemCode | N/A | Avatar System Code | |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password |
GetUserRoleList call
The following table lists the GetUserRoleList parameters, properties, accepted values, and associated dictionaries.
Parameters with no Properties
| Parameter | Property | Value Accepted | Notes |
| SystemCode | N/A | Avatar System Code | |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password |
IsUserActive call
The following table lists the IsUserActive parameters, properties, accepted values, and associated dictionaries.
Parameters with no Properties
| Parameter | Property | Value Accepted | Notes |
| SystemCode | N/A | Avatar System Code | |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password | |
| User | N/A | Avatar User ID |
UpdateUser call
The following tables list the UpdateUser parameters, properties, accepted values, and associated dictionaries.
Parameters with no Properties
| Parameter | Property | Value Accepted | Notes |
| SystemCode | N/A | Avatar System Code | |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password |
Parameters with Properties
| Parameter | Property | Value Accepted | Notes |
| UserDefinition | AllowAccessToAlertError | Y or N | |
|
| AllowAccessToRegEditor | Y or N | |
|
| AllowCheckInOutAppts | Y or N | |
|
| AllowDelApptWithProgNote | "0, 1, or 2" | |
|
| AllowPostFromCheckInOut | Y or N | |
|
| AllowSeeOtherCalendars | Y or N | |
|
| AllowUserRenewal | Y or N | |
|
| AllowUserToModPrtFonts | Y or N | |
|
| AllowUserToViewConfNotes | Y or N | |
|
| ApptSchedForms | ""&"" delimited String of form IDs | |
|
| AssociateUserToNetworkID | "1, 2, or 3" | |
|
| ChartView | View ID as defined in the View Definition form | |
|
| DateOfBirth | Date | |
|
| DateOfHire | Date | |
|
| DefaultAuthor | UserID of default author | |
|
| DefaultSupervisor | UserID of default supervisor | |
|
| Department | Dictionary field # 57 in User file | |
|
| EmployeeID | String | |
|
| ErrorAlertTypes | ""&"" delimited String of Alert Type IDs as defined in the Alert Type form | |
|
| EthnicOrigin | Dictionary field # 53 in User file | |
|
| FinEligFormToLaunch | "0, 1, or 2" | |
|
| FormsAllowedToPrint | ""&"" delimited String of Form IDs as defined in the Document Management Definition form | |
|
| FormsAllowedToScan | ""&"" delimited String of Form IDs as defined in the Document Management Definition form | |
|
| FormsAllowedToView | ""&"" delimited String of Form IDs as defined in the Document Management Definition form | |
|
| FormsAllowedToVoid | ""&"" delimited String of Form IDs as defined in the Document Management Definition form | |
|
| FormsForFinalApproval | ""&"" delimited String of myAvatar form IDs | |
|
| FormsRequireSupervisor | ""&"" delimited String of myAvatar form IDs | |
|
| Gender | Dictionary field # 50 in User file | |
|
| HomeCity | String | |
|
| HomePhoneNumber | String | |
|
| HomeState | String | |
|
| HomeStreetAddress1 | String | |
|
| HomeStreetAddress2 | String | |
|
| HomeView | View ID as defined in the View Definition form | |
|
| HomeZIPCode | String | |
|
| IsAvatarMobileUser | Y or N | |
|
| IsUserAStaffMember | Y or N | |
|
| IsUserAUnit | Y or N | |
|
| IsUserDocManagementAdmin | 0 or 1 | |
|
| IsUserSystemAdministrator | Y or N | |
|
| MaritalStatus | Dictionary field # 51 in User file | |
|
| MobileAppUserRole | "1, 2, 3, 4, 5, or 6" | |
|
| MobilePhoneCarrier | Dictionary field # 1059 in User file | |
|
| MobilePhoneNumber | String | |
|
| NetsmartMobileAppAccess | Dictionary field # 6250 | |
|
| OrganizationEmailAddress | String | |
|
| PasswordTermDurationDays | Integer | |
|
| PersonalEmailAddress | String | |
|
| PositionClass | Dictionary field # 1016 in User file | |
|
| PositionDescription | String | |
|
| PreventUserFromAppLogout | Y or N | |
|
| PreventUsrAcsToNonCaseClt | Y or N | |
|
| PromptForUsernameAtOptEnt | Y or N | |
|
| Race | Dictionary field # 1013 in User file | |
|
| ReminderNoticeNumDays | Integer | |
|
| ReqFilingAuthForAppOpts | Y or N | |
|
| RequireDongleAuth | Y or N | |
|
| SSNAccess | "1, 2, or 3" | |
|
| SiteBookOutAllowedCounty | ""&"" delimited String of site IDs generated by 'Site Registration' | |
|
| SiteSchedUserCanModify | ""&"" delimited String of site IDs generated by 'Site Registration' | |
|
| SiteUserMayOverbook | ""&"" delimited String of site IDs generated by 'Site Registration' | |
|
| SiteUserMayOverbookClient | ""&"" delimited String of site IDs generated by 'Site Registration' | |
|
| SiteUserMayOverbookGroup | ""&"" delimited String of site IDs generated by 'Site Registration' | |
|
| SiteUserMayOverbookStaff | ""&"" delimited String of site IDs generated by 'Site Registration' | |
|
| SocialSecurityNumber | String | |
|
| SpecifyFormsToPrint | ""&"" delimited String of Form IDs as defined in the Document Management Definition form | |
|
| SpecifyFormsToScan | ""&"" delimited String of Form IDs as defined in the Document Management Definition form | |
|
| SpecifyFormsToView | ""&"" delimited String of Form IDs as defined in the Document Management Definition form | |
|
| SpecifyFormsToVoid | ""&"" delimited String of Form IDs as defined in the Document Management Definition form | |
|
| StaffId | Staff ID generated by 'Practitioner Enrollment' | |
|
| SupervisorApproveRequired | Y or N | |
|
| SuppressSendingOfAlertsTo | Dictionary field # 1060 in User file | |
|
| SystemCodes | ""&"" delimited String of facility numbers | |
|
| TimeZone | "America/Adak, America/Anchorage, America/Atka, America/Boise, America/Chicago, America/Denver, America/Detroit, America/Fort_Wayne, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Los_Angeles,America/Louisville, America/Menominee, America/New_York, America/Nome, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Phoenix, America/Shiprock, America/Yakutat, Navajo, Pacific/Honolulu, SystemV/CST6CDT, SystemV/EST5EDT, SystemV/MST7MDT, SystemV/PST8PDT, SystemV/YST9YDT, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New" | |
|
| Transcriber | Y or N | |
|
| TypeOfEmployee | Dictionary field # 56 in User file | |
|
| UnitId | ""&"" delimited String of unit IDs | |
|
| UserCanBeFinalApprover | Y or N | |
|
| UserDescription | String | |
|
| UserId | String | |
|
| UserIsColorblind | Y or N | |
|
| UserRoles | ""&"" delimited String of user role IDs as defined in the User Role Definition form | |
|
| UserSecurityLevel | "1, 2, 3, or 4" | |
|
| UserTimeoutSecond | Integer | |
|
| ViewVoidedDocuments | Y or N | |
|
| VoidReasonsAllowedToView | Dictionary field # 10134 in Document Management file | |
|
| WFNotificationUserLists | ""&"" delimited String of Workflow Notification User List IDs as defined in the User List Management form | |
|
| WFRequirementUserLists | ""&"" delimited String of Workflow Required User List IDs as defined in the 'Required User List Management form | |
|
| WarnNonCaseloadAccess | "Y, U, or N" |