RemoveAssignments |
This method removes the existing user assignments and returns the ID of the removed assignment.
SOAP Request
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP:Body> <RemoveAssignments xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0"> <WorkspaceID>002481F0-8E9F-11E2-EE36-A5EED1105F38</WorkspaceID> <AssignmentRoot>[Assignment Root]</AssignmentRoot> <Assignments> <dataset> <tuple> <old> <Assignment xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0"> <ID>001CC438-906D-11E2-EECC-951E26303F4B</ID> <UserDN>cn=tester1,cn=organizational users,o=system,cn=cordys,o=orr.com</UserDN> <EffectiveDate>2013-02-13T00:00:00.0000</EffectiveDate> <FinishDate>2013-02-22T05:36:00.800</FinishDate> <IsPrincipalUnit>true</IsPrincipalUnit> <IsEffective>yes</IsEffective> <UnitID>001CC438-906D-11E2-EECC-49936ED1DF4B</UnitID> <QName>teams/college</QName> <Name>001CC438-906D-11E2-EECC-49936ED1DF4B</Name> <RoleDN>cn=professor,cn=organizational roles,o=system,cn=cordys,o=orr.com</RoleDN> <UnitRoleID>001CC438-906D-11E2-EECD-0D30315AFF4B</UnitRoleID> <IsLeadRole>false</IsLeadRole> <AssignmentRoot>[Assignment Root]</AssignmentRoot> </Assignment> </old> </tuple> </dataset> </Assignments> <DoPublish>true</DoPublish> </RemoveAssignments> </SOAP:Body> </SOAP:Envelope>
Request Parameters
Parameter |
Description |
Mandatory |
Accepted input values |
||
---|---|---|---|---|---|
WorkspaceID |
No |
GUID or null |
|||
AssignmentRoot |
Assignment root ID. GUID retrieved from InitializeAssignmentRoot must be used. |
Yes |
GUID |
||
Assignments |
Assignment that must be removed |
Yes |
This may be a full assignment, as returned by, for instance, GetAssignments. For processing only the child node ID is required, the others are ignored. |
||
ID |
ID of the assignment. It is used to identify the assignment to be updated. |
Yes |
The assignment ID is returned when an assignment is read, for example, from GetAssignments |
||
DoPublish |
|
Yes |
true or false |
SOAP Response
<RemoveAssignmentsResponse xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0"> <RemoveAssignments> <IDs> <ID>001CC438-906D-11E2-EECC-951E26303F4B</ID> </IDs> </RemoveAssignments> </RemoveAssignmentsResponse>
Response Parameters
Parameter |
Description |
---|---|
ID |
Returns the ID of the Assignment that was removed. |