Delete Cash Flow - Summary Curves

DELETE /ws/rest/service/v1/cashflow/summary/{project_number}

Version: 19.7

PUT /ws/rest/service/v1/cashflow/delete/curve/{project_number}

Version: 22.11

Purpose

Delete summary cash flow.

Request Format

All parameters should be URL encoded.

Both input & output in JSON format in the body.

Request Parameter

project_number(Required): Specify the project/shell number to delete the summary cash flows of project

Response Format

A JSON object is returned in the following format.

{

"data": [],

"message": [],

"status": <REST status code value>

}

A successful response displays a status code 200.

A failed response displays a message with a status code.

Sample Request

To delete summary curves for a cash flow, send an API request in the following format:

{

"data": {

"names": ["Summary Cash Flow 1","Cash Flow Summary Curve"]

}

Sample Response

A partial success / failure response is returned with a status code 3000 to the above request, wherein:

Summary Cash Flow 1 was deleted successfully.
Summary Cash Flow 2 is not deleted, and displays a status code of 1306.

{

"data": [],

"message": [

{

"status": 200,

"message": "success",

"name": "Summary Cash Flow 1"

},

{

"status": 1306,

"message": "System-defined Summary Cash Flow Curve cannot be deleted",

"name": "Cash Flow Summary Curve"

}

],

"status": 3000

}