Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Overview


This web service sets the global and cost center-based permissions and global and cost center-based notifications for a single user based on a user identity (PwsUserRef). The service returns the identity (PwsUserRef) of the user that has been updated. 

Request Format


Panel
titlePwsSaveUser Request

...

Element

Data Type

Required?

Description

Sample Data

RequestId

Int32

No

Click here for more information.

1

SessionTicket

String

Yes 

Click here for more information.

AebU24OSeu9cgUOSfIwEmg==
CostCenterNotificationSettingsPwsCostCenterNotificationSettingDetailNoThis structure contains the complete set of information about a user's A collection of cost center-based notification settings to apply for the user.
CostCenterPermissionSettingsPwsCostCenterPermissionSettingDetailNoThis structure contains the complete set of information about a A collection of cost center permission setting-based permission settings to apply for the user.
GlobalNotificationSettingsPwsGlobalNotificationSettingDetailNoThis structure contains a user's setting (on or off) for a specific global notificationA collection of global notification settings to apply for the user.
GlobalPermissionSettingsPwsGlobalPermissionSettingDetailNoThis structure contains a users setting (None, View or Update) for a global permission. A collection of global permission settings to apply for the user.
UserIdentityPwsUserRefYesThis structure represents all of the unique identifying fields associated with a userThe user to apply the new permission and notification settings to.
UserTimestampStringNoTimestamp optionally used for user locking.


Request Usage Example(s)

...

Code Block
languagexml
titleExample 01
collapsetrue
<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:PwsSetUserPermissionsNotifications>
         <pws:serviceRequest>
            <req:RequestId>1<RequestId>1	</req:RequestId>
            <req:SessionTicket>AebU24OSeu9cgUOSfIwEmgSessionTicket>AbBxknXELlyF3kCHn5Fivg==</req:SessionTicket>
            <req:CostCenterNotificationSettings>
               <com:PwsCostCenterNotificationSettingDetail>
                  <com:CostCenterNotificationIdentity>
                     <com:CostCenterNotificationTag>ProjectStageChange</com:CostCenterNotificationTag>
                  </com:CostCenterNotificationIdentity>
                  <com:CostCenterNotificationSetting>true</com:CostCenterNotificationSetting>
                     <com:CostCenters>
                        <com:PwsCostCenterRef>
                           <com:CostCenterName>ExecutiveCostCenterName>IT Team (USA)</com:CostCenterName>
                           <com:CostCenterNumber>ExecutiveCostCenterNumber>IT Team (USA)</com:CostCenterNumber>
                        </com:PwsCostCenterRef>
                     </com:CostCenters>
                     <com:EntireOrganizationFlag>false</com:EntireOrganizationFlag>
                  </com:CostCenterNotificationSetting>
                  <com:OverrideCostCenterNotificationSettingFlag>true</com:OverrideCostCenterNotificationSettingFlag>
               </com:PwsCostCenterNotificationSettingDetail>
            </req:CostCenterNotificationSettings>
            <req:CostCenterPermissionSettings>
               <com:PwsCostCenterPermissionSettingDetail>
                  <com:CostCenterPermissionIdentity>
                     <com:CostCenterPermissionTag>maintainProjectsAndEngagements</com:CostCenterPermissionTag>
                  </com:CostCenterPermissionIdentity>
                  <com:CostCenterPermissionSetting>true</com:CostCenterPermissionSetting>
                     <com:CostCenters>
                        <com:PwsCostCenterRef>
                           <com:CostCenterName>Executive Team (USA)</com:CostCenterName>
                           <com:CostCenterNumber>Executive Team (USA)</com:CostCenterNumber>
                        </com:PwsCostCenterRef>
                     </com:CostCenters>
                     <com:EntireOrganizationFlag>false</com:EntireOrganizationFlag>
                  </com:CostCenterPermissionSetting>
                  <com:OverrideCostCenterPermissionSettingFlag>true</com:OverrideCostCenterPermissionSettingFlag>
               </com:PwsCostCenterPermissionSettingDetail>
            </req:CostCenterPermissionSettings>
            <req:GlobalNotificationSettings>
               <com:PwsGlobalNotificationSettingDetail>
                  <com:GlobalNotificationIdentity>
                     <com:GlobalNotificationTag>DowntimeNotification</com:GlobalNotificationTag>
                  </com:GlobalNotificationIdentity>
                  <com:GlobalNotificationSetting>true</com:GlobalNotificationSetting>
                  <com:OverrideGlobalNotificationSettingFlag>true</com:OverrideGlobalNotificationSettingFlag>
               </com:PwsGlobalNotificationSettingDetail>
            </req:GlobalNotificationSettings>
            <req:GlobalPermissionSettings>
               <com:PwsGlobalPermissionSettingDetail>
                  <com:GlobalPermissionIdentity>
                     <com:GlobalPermissionTag>maintainSystemSettings</com:GlobalPermissionTag>
                  </com:GlobalPermissionIdentity>
                  <com:GlobalPermissionSetting>U</com:GlobalPermissionSetting>
                <  <com:OverrideGlobalPermissionSettingFlag>true</com:PwsGlobalPermissionSettingDetail>OverrideGlobalPermissionSettingFlag>
               </reqcom:GlobalPermissionSettings>PwsGlobalPermissionSettingDetail>
            <req</req:UserIdentity>GlobalPermissionSettings>
               <com:UserDisplayName>IT Manager</com:UserDisplayName><req:UserIdentity>
               <com:UserReferenceSystemId>IT Manager<UserReferenceSystemId>NU001</com:UserReferenceSystemId>
            </req:UserIdentity>
         </pws:serviceRequest>
      </pws:PwsSetUserPermissionsNotifications>
   </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-09T21:44:05.0179178Z

Timestamp

String

This is a Base64 encoded timestamp optionally utilized for user locking.

AAAAABCzYug=

UserIdentity

PwsUserRef

This structure represents all of the unique identifying fields associated with the user that was created or updated. 


Response Usage Example(s)

...

Code Block
languagexml
titleExample 01
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSetUserPermissionsNotificationsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSetUserPermissionsNotificationsResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>       
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-1112-09T2121T16:4457:0538.0179178Z<8647068Z</ServerTimestampUtc>
            <a:Timestamp>AAAAABCzYugTimestamp>AAAAABGHvDY=</a:Timestamp>
            <a:UserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:UserDisplayName>ITUserDisplayName>Jane Manager<Jones</b:UserDisplayName>
               <b:UserId i:nil="true"/>
               <b:UserReferenceSystemId>IT Manager<UserReferenceSystemId>NU001</b:UserReferenceSystemId>
               <b:UserUid>1152921504607134339<UserUid>1152921504607135993</b:UserUid>
            </a:UserIdentity>
         </PwsSetUserPermissionsNotificationsResult>
      </PwsSetUserPermissionsNotificationsResponse>
   </s:Body>
</s:Envelope>

...

PwsSetUserPermissionsNotifications - Common Errors and Warnings

...