...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information. | 1 | ||
String | Yes | Click here for more information. | AX6DNTSsd7jKIwQw0/RKxw== | ||
AdditionalUserTypesClearFlag | Boolean | No | false | If set to true, the user's additional user types will be cleared. | false |
ClientClearFlag | Boolean | No | false | If set to true, the user's association with a client record will be set to null | false |
| EndDateClearFlag | Boolean | No | false | If set to true, the user's end date will be set to null. Between start date or end date, only one or neither can be set for a user. Please clear the unused date. | false |
| FullDetailFlag | Boolean | No | false | If set to "true", the complete resource detail will be included in response. | |
LoginNameClearFlag | Boolean | No | false | If set to true, the user's login name will be set to null. | false |
MiddleNameClearFlag | Boolean | No | false | If set to true, the user's middle name will be set to null. | false |
MobilePhoneClearFlag | Boolean | No | false | If set to true, the user's mobile phone number will be set to null. | false |
NewPassword (20) | String | No | A user's new temporary password. This can only be set when updating an existing user. | ||
NewUserDisplayName (90) | String | No | A user's new display name. This can only be set when updating an existing user. | ||
NewUserReferenceSystemId (20) | String | No | A user's new reference system id. This can only be set when updating an existing user. | ||
OfficePhoneClearFlag | Boolean | No | false | If set to true, the user's office phone number will be set to null. | false |
OtherContactInformationClearFlag | Boolean | No | false | If set to true, the user's other contact information will be set to null. | false |
StartDateClearFlag | Boolean | No | false | If set to true, the user's start date will be set to null. Between start date or end date, only one or neither can be set for a user. Please clear the unused date. | false |
| TemporaryPasswordFlag | Boolean | No | false | If set to true, the temporary password will be emailed to the user. | false |
User | Yes | This structure contains the complete set of information about a user. | |||
| UserReferenceSystemIdClearFlag | Boolean | No | false | If set to true, the user's reference system ID will be set to null | false |
UserTimestamp | String | No | false | This is a Base64 encoded timestamp optionally utilized for user locking. | false |
| SuppressPasswordEmailsFlag | Boolean | No | false | If set to true, the email usually generated when a user is created or updated is suppressed. | false |
...
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 10010 | IllegalPassword | Error 10010 processing request. Please contact Projector technical support at 617-431-4111 x1 or support@projectorpsa.com. |
| 10116 | InvalidDateValueSpecified | The date specified in the field "StartDate" in the class "PwsUserDetail" is invalid or out of range. The time component of the specified date must be midnight UTC. |
| 50065 | MissingRequiredField | First Name is required. |
| 50262 | ValueAlreadyInUse | The Display Name "Daisy Mascot" is already in use. Please enter a different value. |
| 50070 | AccessPermissionDenied | Permission denied. |
| 57383 | MayNotSpecifyBothUserStartAndEndDate | User may not have both a start date and an end date - operation would result in both being set. |