| Info |
|---|
This web service will be temporary unavailable while we add support for permission overrides. This service is expected to return to service by Dec 28, 2018. |
Overview
This web service inserts or updates a single user based on a detailed user structure (PwsUserDetail). The service returns the identity (PwsUserRef) of the user that has been inserted or updated. The caller can optionally request that the full user detail (PwsUserElement) be included in the response.
...
| Panel | ||
|---|---|---|
| ||
|
Request Elements
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 |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsSaveUser>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AUIwZGmPFJMD0UEXT+1iSw==</req:SessionTicket>
<req:AdditionalUserTypesClearFlag>false</req:AdditionalUserTypesClearFlag>
<req:ClientClearFlag>false</req:ClientClearFlag>
<req:EndDateClearFlag>false</req:EndDateClearFlag>
<req:FullDetailFlag>true</req:FullDetailFlag>
<req:LoginNameClearFlag>false</req:LoginNameClearFlag>
<req:MiddleNameClearFlag>false</req:MiddleNameClearFlag>
<req:MobilePhoneClearFlag>false</req:MobilePhoneClearFlag>
<req:OfficePhoneClearFlag>false</req:OfficePhoneClearFlag>
<req:OtherContactInformationClearFlag>false</req:OtherContactInformationClearFlag>
<req:StartDateClearFlag>false</req:StartDateClearFlag>
<req:TemporaryPasswordFlag>true</req:TemporaryPasswordFlag>
<req:User>
<com:UserDisplayName>Jane Jones</com:UserDisplayName>
<com:UserReferenceSystemId>NU001</com:UserReferenceSystemId>
<com:EmailAddress>janejones@revcorp.bb</com:EmailAddress>
<com:FirstName>Jane</com:FirstName>
<com:LastName>Jones</com:LastName>
<com:PrimaryUserTypeCostCenter>
<com:CostCenterIdentity>
<com:CostCenterName>IT Team (USA)</com:CostCenterName>
<com:CostCenterNumber>IT Team (USA)</com:CostCenterNumber>
</com:CostCenterIdentity>
<com:UserTypeIdentity>
<com:UserTypeName>IT Specialist</com:UserTypeName>
</com:UserTypeIdentity>
</com:PrimaryUserTypeCostCenter>
<com:AdvancedAnalyticsPermissionSetting>N</com:AdvancedAnalyticsPermissionSetting>
<com:AllowBookOwnTimeFlag>false</com:AllowBookOwnTimeFlag>
<com:AllowRequestOwnTimeFlag>false</com:AllowRequestOwnTimeFlag>
<com:CultureIdentity>
<com:CultureName>en-US</com:CultureName>
</com:CultureIdentity>
<com:DefaultTabGroupIdentity>
<com:PublicTabGroupName>Project Manager</com:PublicTabGroupName>
</com:DefaultTabGroupIdentity>
<com:EnableManagementPortalFlag>true</com:EnableManagementPortalFlag>
<com:LimitedAccessFlag>false</com:LimitedAccessFlag>
<com:MobilePhone>555-555-1111</com:MobilePhone>
<com:OfficePhone>555-555-2222</com:OfficePhone>
<com:OtherContactInformation>janejones@revcorp.bbsupport</com:OtherContactInformation>
<com:OverrideAdvancedAnalyticsPermissionSettingFlag>false</com:OverrideAdvancedAnalyticsPermissionSettingFlag>
<com:OverrideAllowBookOwnTimeFlag>true</com:OverrideAllowBookOwnTimeFlag>
<com:OverrideAllowRequestOwnTimeFlag>true</com:OverrideAllowRequestOwnTimeFlag>
<com:OverrideDefaultPublicTabGroupFlag>true</com:OverrideDefaultPublicTabGroupFlag>
<com:OverrideEnableManagementPortalFlag>true</com:OverrideEnableManagementPortalFlag>
<com:OverrideLimitedAccessFlag>true</com:OverrideLimitedAccessFlag>
<com:OverrideProjectManagerFlag>true</com:OverrideProjectManagerFlag>
<com:OverrideRequestTimeOffPermissionSettingFlag>true</com:OverrideRequestTimeOffPermissionSettingFlag>
<com:OverrideSkillPermissionSettingFlag>true</com:OverrideSkillPermissionSettingFlag>
<com:OverrideSsoSettingFlag>false</com:OverrideSsoSettingFlag>
<com:OverrideTimeZoneFlag>true</com:OverrideTimeZoneFlag>
<com:OverrideUseDelegatedAuthenticationFlag>true</com:OverrideUseDelegatedAuthenticationFlag>
<com:ProjectManagerFlag>true</com:ProjectManagerFlag>
<com:RequestTimeOffPermissionSetting>N</com:RequestTimeOffPermissionSetting>
<com:SkillPermissionSetting>N</com:SkillPermissionSetting>
<com:SsoSetting>N</com:SsoSetting>
<com:StartDate>2018-12-01T00:00:00.000Z</com:StartDate>
<com:TimeZoneIdentity>
<com:TimeZoneIdentifier>Eastern Standard Time</com:TimeZoneIdentifier>
</com:TimeZoneIdentity>
<com:UseDelegatedAuthenticationFlag>false</com:UseDelegatedAuthenticationFlag>
</req:User>
<req:UserReferenceSystemIdClearFlag>false</req:UserReferenceSystemIdClearFlag>
</pws:serviceRequest>
</pws:PwsSaveUser>
</soapenv:Body>
</soapenv:Envelope> |
...
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. |