Develop > Application Programming Interface > Legacy APIs > User API > Cancel multiple service requests

Cancel Multiple Service Requests

Details

URI /user/multipleRequest/cancel
Method POST
Parameters

userIdentifier=<user_id>
    Required; the user ID you want to use as credentials for this API call. See Get userIdentifier for the steps required to get the userIdentifier value.

Returns 200 - Ok (Indicates the REST call executed without error. See XML return content for whether all specified requests were canceled.) 
401 - Not authorized
404 - Object not found
500 - Server exception

A request can only be canceled if its state is PENDING.

Note

  • When a pending subscription modification request is canceled, only the modification is canceled; the subscription is not changed.
  • Once a subscription request has been approved, the request can no longer be canceled. The subscription, though, can be canceled.

Example

Use the following URL:

https://<host>:<port>/csa/rest/user/multipleRequest/cancel ?userIdentifier=90d965c0379fd06601379fd192b30ee6

The following XML was sent in the request:


<ServiceRequestList>
    <ServiceRequest>
        <id>90e72e283b05aff1013b0b2c015103a4</id>
        <catalogItem>
            <catalog>
                <id>90d965c0379fd06601379fd1936a0f05</id>
            </catalog>
        </catalogItem>
    </ServiceRequest>
    <ServiceRequest>
        <id>90e72e283b05aff1013b0b2b43fc0356</id>
        <catalogItem>
            <catalog>
                <id>90d965c0379fd06601379fd1936a0f05</id>
            </catalog>
        </catalogItem>
    </ServiceRequest>
</ServiceRequestList>

The following XML was returned in the response. The count value indicates the number of service requests successfully canceled. A ServiceRequest element is included for each canceled service request


<ServiceRequestList>
    <count>2</count>
    <limit>0</limit>
    <ServiceRequest>
        <id>90e72e283b05aff1013b0b2c015103a4</id>
  ...
    </ServiceRequest>
    <ServiceRequest>
        <id>90e72e283b05aff1013b0b2b43fc0356</id>
  ...
    </ServiceRequest>
</ServiceRequestList>