Overview

This web service deletes a specified role type. The service will return the identity of the deleted role type.

Request Format

PwsDeleteRoleType Request

PwsDeleteRoleType
- serviceRequest: PwsDeleteRoleTypeRq
  - RequestId: Int32
  - SessionTicket: String
  - InactivateIfInUseFlag: Boolean
  - RoleTypeIdentity: PwsRoleTypeRef

Request Elements

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.	AS/RAku1pN9F58A3WQh3aw==
InactivateIfInUseFlag	Boolean	No	false	If set to 'true', the role type will be set to inactive in the event it cannot e delete	true
RoleTypeIdentity	PwsRoleTypeRef	Yes		This is the identity of the role type to be deleted. Click here for more information.

Request Usage Example(s)

Request

<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:PwsDeleteRoleType>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AS/RAku1pN9F58A3WQh3aw==</req:SessionTicket>
            <req:InactivateIfInUseFlag>true</req:InactivateIfInUseFlag>
            <req:RoleTypeIdentity>
               <com:RoleTypeName>Product Owner</com:RoleTypeName>
            </req:RoleTypeIdentity>
         </pws:serviceRequest>
      </pws:PwsDeleteRoleType>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsDeleteRoleType Response

PwsDeleteRoleTypeResponse
- PwsDeleteRoleTypeResult: PwsDeleteRoleTypeRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - RoleTypeIdentity: PwsRoleTypeRef

Response Elements

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.	2022-10-21T19:41:52.6505682Z
RoleTypeIdentity	PwsRoleTypeRef	The identity of the deleted role type.

Response Usage Example(s)

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDeleteRoleTypeResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteRoleTypeResult 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/">
               <b:PwsMessage>
                  <b:AdditionalErrorText>Message 136: This request was executed against the Staging [appst.projectorpsa.com] environment.</b:AdditionalErrorText>
                  <b:ErrorCode>NonProductionEnvironment</b:ErrorCode>
                  <b:ErrorNumber>136</b:ErrorNumber>
                  <b:ErrorText>This web service request was executed against a non-production instance of Projector.</b:ErrorText>
                  <b:Type>Information</b:Type>
                  <b:ReferenceId1 i:nil="true"/>
                  <b:ReferenceId2 i:nil="true"/>
               </b:PwsMessage>
            </Messages>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2022-10-21T19:41:52.6505682Z</ServerTimestampUtc>
            <a:RoleTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:RoleTypeId i:nil="true"/>
               <b:RoleTypeName>Product Owner</b:RoleTypeName>
               <b:RoleTypeUid>1152921504606848579</b:RoleTypeUid>
            </a:RoleTypeIdentity>
         </PwsDeleteRoleTypeResult>
      </PwsDeleteRoleTypeResponse>
   </s:Body>
</s:Envelope>

PwsDeleteRoleType - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
50024	EntityNotFound	Role Type was not found. Another user may have deleted it.