Panel

title	PwsSaveUser Request

PwsSaveUser
- serviceRequest: PwsSaveUserRq
  - RequestId: Int32
  - SessionTicket: String
  - AdditionalUserTypesClearFlag: Boolean
  - ClientClearFlag: Boolean
  - CultureClearFlag: Boolean
  - EndDateClearFlag: Boolean
  - FullDetailFlag: Boolean
  - LoginNameClearFlag: Boolean
  - MiddleNameClearFlag: Boolean
  - MobilePhoneClearFlag: Boolean
  - NewTemporaryPassword: String (28)
  - NewUserDisplayName: String (90)
  - NewUserReferenceSystemId: String (20)
  - OfficePhoneClearFlag: Boolean
  - OtherContactInformationClearFlag: Boolean
  - StartDateClearFlag: Boolean
  - TimezoneClearFlag: Boolean
  - User: PwsUserDetail
  - UserReferenceSystemIdClearFlag: Boolean
  - UserTimestamp: String
  - SuppressPasswordEmailsFlag: Boolean

Request Elements

CultureClearFlag culture If set to true, the user's end date will be set to null, include full detailed user element in responseTimezoneClearFlag user's time zone set installation's time zone

Element	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32	No		Click here for more information.	1
SessionTicket	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 set to nullcleared.	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	false	EndDateClearFlag	Boolean	No	false	. 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	false", 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
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 the current datenull. 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	PwsUserDetail	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

language	xml
title	Example 01 - Creating a new user
collapse	true

<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:CostCenterIdentity>AllowRequestOwnTimeFlag>false</com:AllowRequestOwnTimeFlag>
                        <com:CostCenterName>ITCultureIdentity>
Team (USA)</com:CostCenterName>
                        <com:CostCenterNumber>IT Team (USA)<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:EnableManagementPortalFlag>true</com:PwsUserTypeCostCenter>EnableManagementPortalFlag>
               <<com:LimitedAccessFlag>false</com:AdditionalUserTypes>LimitedAccessFlag>
               <com:AdvancedAnalyticsPermissionSetting>N<MobilePhone>555-555-1111</com:AdvancedAnalyticsPermissionSetting>MobilePhone>
               <com:AllowBookOwnTimeFlag>false<OfficePhone>555-555-2222</com:AllowBookOwnTimeFlag>OfficePhone>
               <com:AllowRequestOwnTimeFlag>false<OtherContactInformation>janejones@revcorp.bbsupport</com:AllowRequestOwnTimeFlag>OtherContactInformation>
               <com:CultureIdentity>OverrideAdvancedAnalyticsPermissionSettingFlag>false</com:OverrideAdvancedAnalyticsPermissionSettingFlag>
                  <com:CultureName>en-US<OverrideAllowBookOwnTimeFlag>true</com:CultureName>OverrideAllowBookOwnTimeFlag>
               <<com:OverrideAllowRequestOwnTimeFlag>true</com:CultureIdentity>OverrideAllowRequestOwnTimeFlag>
               <com:DefaultTabGroupIdentity>
                  <com:PublicTabGroupName>Project Manager<OverrideDefaultPublicTabGroupFlag>true</com:PublicTabGroupName>OverrideDefaultPublicTabGroupFlag>
               <<com:OverrideEnableManagementPortalFlag>true</com:DefaultTabGroupIdentity>OverrideEnableManagementPortalFlag>
               <com:EnableManagementPortalFlag>true<OverrideLimitedAccessFlag>true</com:EnableManagementPortalFlag>OverrideLimitedAccessFlag>
               <com:LimitedAccessFlag>false<OverrideProjectManagerFlag>true</com:LimitedAccessFlag>OverrideProjectManagerFlag>
               <com:MobilePhone>555-555-1111<OverrideRequestTimeOffPermissionSettingFlag>true</com:MobilePhone>OverrideRequestTimeOffPermissionSettingFlag>
               <com:OfficePhone>555-555-2222<OverrideSkillPermissionSettingFlag>true</com:OfficePhone>OverrideSkillPermissionSettingFlag>
               <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

language	xml
title	Example 02 - Update an existing user
collapse	true

<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>
            <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>OverrideSsoSettingFlag>false</com:OverrideSsoSettingFlag>
               <req<com:MiddleNameClearFlag>false<OverrideTimeZoneFlag>true</req:MiddleNameClearFlag>com:OverrideTimeZoneFlag>
               <req<com:MobilePhoneClearFlag>false<OverrideUseDelegatedAuthenticationFlag>true</req:MobilePhoneClearFlag>com:OverrideUseDelegatedAuthenticationFlag>
               <req<com:NewPassword>password01<ProjectManagerFlag>true</req:NewPassword>com:ProjectManagerFlag>
               <req<com:NewUserDisplayName>Daisy Mascot<RequestTimeOffPermissionSetting>N</req:NewUserDisplayName>com:RequestTimeOffPermissionSetting>
               <req<com:NewUserReferenceSystemId>Mascot01<SkillPermissionSetting>N</req:NewUserReferenceSystemId>com:SkillPermissionSetting>
               <req<com:OfficePhoneClearFlag>false<SsoSetting>N</req:OfficePhoneClearFlag>com:SsoSetting>
               <req:OtherContactInformationClearFlag>false</req:OtherContactInformationClearFlag><com:StartDate>2018-12-01T00:00:00.000Z</com:StartDate>
            <req:StartDateClearFlag>false</req:StartDateClearFlag>   <com:TimeZoneIdentity>
         <req:TemporaryPasswordFlag>false</req:TemporaryPasswordFlag>         <com:TimeZoneIdentifier>Eastern    <req:User>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>

...

Element	Data Type	Description	Sample Data
Messages	PwsMessage[]	The web service response status and message. Click here for more information.
ResponseId	Int32	Click here for more information.	1
Status	RequestStatus	Click here for more information.	Ok
ServerTimestampUtc	DateTime	Click here for more information	2018-11-01T18:44:16.1165818Z
Timestamp	String	This is a Base64 encoded timestamp optionally utilized for user locking.	AAAAABCo/+U=
User	PwsUserElement	This structure contains a user detail structure PwsUserDetail. It is also where additional related information about the user, that is not directly an attribute of the user itself would be found. As of this time, there is no additional information returned about usersThis will only be included in the response if FullDetailFlag is set to true.
UserIdentity	PwsUserRef	This structure represents all of the unique identifying fields associated with a the user that was created or updated.

Response Usage Example(s)

...

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.

Versions Compared

Old Version 3

New Version Current

Key

Request Elements

Request Usage Example(s)

Response Usage Example(s)

Page Comparison

Versions Compared

Old Version 3

New Version Current

Key

Request Elements

Request Usage Example(s)

Response Usage Example(s)