...
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 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 |
CultureClearFlag | Boolean | No | false | If set to true, the user's culture 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 |
FullDetailFlag | Boolean | No | false | If set to true, include full detailed user element 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 (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 | false | 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. | false |
TimezoneClearFlag | Boolean | No | false | If set to true, the user's time zone will be set to the installation's time zone. | false |
User | Yes | This structure contains the complete set of information about a user. | |||
UserTimestamp | String | No | false | This is a Base64 encoded timestamp optionally utilized for user locking. |
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/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>
<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</req:TemporaryPasswordFlag>
<req:User>
<com:UserDisplayName>Daisy A</com:UserDisplayName>
<com:UserReferenceSystemId>daisydog-a</com:UserReferenceSystemId>
<com:EmailAddress>daisy-a@revcorp.bb</com:EmailAddress>
<com:FirstName>Daisy</com:FirstName>
<com:LastName>A</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</com:UserTypeName>
</com:UserTypeIdentity>
</com:PrimaryUserTypeCostCenter>
<com:AdditionalUserTypes>
<com:PwsUserTypeCostCenter>
<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:PwsUserTypeCostCenter>
</com:AdditionalUserTypes>
<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>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> |
...
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
Int32 | Click here for more information. | 1 | |
Status | Click here for more information. | Ok | |
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 | 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 | This structure represents all of the unique identifying fields associated with a the user that was created or updated. |
Response Usage Example(s)
...