...
| 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 | CultureClearFlag|||||||
| EndDateClearFlag | Boolean | No | false | If set to true, the user's | cultureend date 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 | , include full detailed user element", the complete resource detail will be included in response. | false | ||||||
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 | |||||||
NewTemporaryPassword 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 | Nofalse | 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 | user's time zonetemporary password will be | setemailed to the | installation's time zoneuser. | 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>AX6DNTSsd7jKIwQw0/RKxwSessionTicket>AUIwZGmPFJMD0UEXT+1iSw==</req:SessionTicket>
<req:AdditionalUserTypesClearFlag>false</req:AdditionalUserTypesClearFlag>
<req:ClientClearFlag>false</req:ClientClearFlag>
<req:DefaultPublicTabGroupClearFlag>false</req:DefaultPublicTabGroupClearFlag>
<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>false<TemporaryPasswordFlag>true</req:TemporaryPasswordFlag>
<req:User>
<com:UserDisplayName>DaisyUserDisplayName>Jane A<Jones</com:UserDisplayName>
<com:UserReferenceSystemId>daisydog-a<UserReferenceSystemId>NU001</com:UserReferenceSystemId>
<com:EmailAddress>daisy-a@revcorpEmailAddress>janejones@revcorp.bb</com:EmailAddress>
<com:FirstName>Daisy<FirstName>Jane</com:FirstName>
<com:LastName>A<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>Resource<UserTypeName>IT Specialist</com:UserTypeName>
</com:UserTypeIdentity>
</com:PrimaryUserTypeCostCenter>
<com:AdditionalUserTypes>
AdvancedAnalyticsPermissionSetting>N</com:AdvancedAnalyticsPermissionSetting>
<com:PwsUserTypeCostCenter>
AllowBookOwnTimeFlag>false</com:AllowBookOwnTimeFlag>
<com:AllowRequestOwnTimeFlag>false</com:CostCenterIdentity>AllowRequestOwnTimeFlag>
<com:CostCenterName>ITCultureIdentity>
Team (USA)</com:CostCenterName> <com:CostCenterNumber>IT Team (USA)<<com:CultureName>en-US</com:CostCenterNumber>
CultureName>
</com:CostCenterIdentity>CultureIdentity>
<com:UserTypeIdentity>
DefaultTabGroupIdentity>
<com:UserTypeName>ITPublicTabGroupName>Project Specialist<Manager</com:UserTypeName>
PublicTabGroupName>
</com:UserTypeIdentity>DefaultTabGroupIdentity>
</com:PwsUserTypeCostCenter>
<<com:EnableManagementPortalFlag>true</com:AdditionalUserTypes>EnableManagementPortalFlag>
<com:AdvancedAnalyticsPermissionSetting>N<LimitedAccessFlag>false</com:AdvancedAnalyticsPermissionSetting>LimitedAccessFlag>
<com:AllowBookOwnTimeFlag>false<MobilePhone>555-555-1111</com:AllowBookOwnTimeFlag>MobilePhone>
<com:AllowRequestOwnTimeFlag>false<OfficePhone>555-555-2222</com:AllowRequestOwnTimeFlag>OfficePhone>
<com:CultureIdentity>
<com:CultureName>en-US<OtherContactInformation>janejones@revcorp.bbsupport</com:CultureName>OtherContactInformation>
<<com:OverrideAdvancedAnalyticsPermissionSettingFlag>false</com:CultureIdentity>OverrideAdvancedAnalyticsPermissionSettingFlag>
<com:DefaultTabGroupIdentity>
<com:PublicTabGroupName>Project Manager<OverrideAllowBookOwnTimeFlag>true</com:PublicTabGroupName>OverrideAllowBookOwnTimeFlag>
<<com:OverrideAllowRequestOwnTimeFlag>true</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>daisy-a@gmail.com</com:OtherContactInformation>
<com:ProjectManagerFlag>true</com:ProjectManagerFlag>
<com:RequestTimeOffPermissionSetting>N</com:RequestTimeOffPermissionSetting>
<com:SkillPermissionSetting>N</com:SkillPermissionSetting>
<com:SsoSetting>N</com:SsoSetting>
<com:StartDate>2018-10-24T00: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> | ||||||
| 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>AX6DNTSsd7jKIwQw0/RKxw==</req:SessionTicket>OverrideAllowRequestOwnTimeFlag> <req<com:AdditionalUserTypesClearFlag>false<OverrideDefaultPublicTabGroupFlag>true</req:AdditionalUserTypesClearFlag>com:OverrideDefaultPublicTabGroupFlag> <req<com:ClientClearFlag>false<OverrideEnableManagementPortalFlag>true</req:ClientClearFlag>com:OverrideEnableManagementPortalFlag> <req<com:DefaultPublicTabGroupClearFlag>false<OverrideLimitedAccessFlag>true</req:DefaultPublicTabGroupClearFlag>com:OverrideLimitedAccessFlag> <req<com:EndDateClearFlag>false<OverrideProjectManagerFlag>true</req:EndDateClearFlag>com:OverrideProjectManagerFlag> <req<com:FullDetailFlag>true<OverrideRequestTimeOffPermissionSettingFlag>true</req:FullDetailFlag>com:OverrideRequestTimeOffPermissionSettingFlag> <req<com:LoginNameClearFlag>false<OverrideSkillPermissionSettingFlag>true</req:LoginNameClearFlag>com:OverrideSkillPermissionSettingFlag> <req<com:MiddleNameClearFlag>false<OverrideSsoSettingFlag>false</req:MiddleNameClearFlag>com:OverrideSsoSettingFlag> <req<com:MobilePhoneClearFlag>false<OverrideTimeZoneFlag>true</req:MobilePhoneClearFlag>com:OverrideTimeZoneFlag> <req<com:NewPassword>password01<OverrideUseDelegatedAuthenticationFlag>true</req:NewPassword>com:OverrideUseDelegatedAuthenticationFlag> <req<com:NewUserDisplayName>Daisy Mascot<ProjectManagerFlag>true</req:NewUserDisplayName>com:ProjectManagerFlag> <req<com:NewUserReferenceSystemId>Mascot01<RequestTimeOffPermissionSetting>N</req:NewUserReferenceSystemId>com:RequestTimeOffPermissionSetting> <req<com:OfficePhoneClearFlag>false<SkillPermissionSetting>N</req:OfficePhoneClearFlag>com:SkillPermissionSetting> <req<com:OtherContactInformationClearFlag>false<SsoSetting>N</req:OtherContactInformationClearFlag>com:SsoSetting> <req:StartDateClearFlag>false</req:StartDateClearFlag><com:StartDate>2018-12-01T00:00:00.000Z</com:StartDate> <req:TemporaryPasswordFlag>false</req:TemporaryPasswordFlag><com:TimeZoneIdentity> <req<com:User>TimeZoneIdentifier>Eastern Standard Time</com:TimeZoneIdentifier> <com:UserDisplayName>Daisy A<</com:UserDisplayName>TimeZoneIdentity> <com:UserReferenceSystemId>daisydog-a<UseDelegatedAuthenticationFlag>false</com:UserReferenceSystemId>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. |