Skip to content

[ILX - 50446] Reordering the endpoint lists in the API document #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Nov 19, 2024
58 changes: 29 additions & 29 deletions source/includes/acts/delete_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ In the current release, one DELETE API End point is provided to remove or delete

* Analysis
* Analysis Compound
* Equipment Analysis
* Emission Factor
* Equipment Analysis
* Operation

DELETE requests to these endpoints should be formatted in JSON.
Expand Down Expand Up @@ -130,25 +130,26 @@ IRestResponse response = client.Execute(request);

```

### 3. Equipment Analysis Table

This section guides you through the process of removing/deleting the existing records from the Equipment Analysis table using the designated API endpoint.
### 3. Emission Factor Table

**Equipment Analysis DELETE endpoint**
This section guides you through the process of removing/deleting the existing records from the Emission Factor table using the designated API endpoint.

`DELETE` /api/v1/equipmentanalysis
**Emission Factor DELETE endpoint**

`DELETE` /api/v1/emissionfactor

> Example Request & JSON Input Body

```javascript
var request = require("request");

var options = { method: 'DELETE',
url: 'https://[tenant].actsapi.intelex.com/v1/equipmentanalysis',
url: 'https://[tenant].actsapi.intelex.com/v1/emissionfactor',
headers: { 'content-type': 'application/json' },
body:
{
[equipmentanalysisId1, equipmentanalysisId2, equipmentanalysisId3....]
"emissionFactorId": "number"
},
json: true };

Expand All @@ -161,52 +162,53 @@ request(options, function (error, response, body) {

```csharp

var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/equipmentanalysis");
var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/emissionfactor");
var request = new RestRequest(Method.DELETE);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\r\n [equipmentanalysisId1, equipmentanalysisId2, equipmentanalysisId3....] \r\n}", ParameterType.RequestBody);
request.AddParameter("application/json", "{\r\n \"emissionFactorId\": \"number\"\r\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```
> Input JSON Body

```json

{
[equipmentanalysisId1, equipmentanalysisId2, equipmentanalysisId3....]
"emissionFactorId": "number"
}

```
> Example Response

```json
{
"deletedRowCount": 1,
"notFoundCount": 0,
"failureCount": 0,
"errorMessage" : []
"insertedRowCount" : 0 ,
"updatedRowCount" : 0 ,
"deletedRowCount" : 1 ,
"failureCount" : 0 ,
"errorMessage" : []
}

```

### 4. Emission Factor Table
### 4. Equipment Analysis Table

This section guides you through the process of removing/deleting the existing records from the Emission Factor table using the designated API endpoint.
This section guides you through the process of removing/deleting the existing records from the Equipment Analysis table using the designated API endpoint.

**Emission Factor DELETE endpoint**
**Equipment Analysis DELETE endpoint**

`DELETE` /api/v1/emissionfactor
`DELETE` /api/v1/equipmentanalysis

> Example Request & JSON Input Body

```javascript
var request = require("request");

var options = { method: 'DELETE',
url: 'https://[tenant].actsapi.intelex.com/v1/emissionfactor',
url: 'https://[tenant].actsapi.intelex.com/v1/equipmentanalysis',
headers: { 'content-type': 'application/json' },
body:
{
"emissionFactorId": "number"
[equipmentanalysisId1, equipmentanalysisId2, equipmentanalysisId3....]
},
json: true };

Expand All @@ -219,35 +221,33 @@ request(options, function (error, response, body) {

```csharp

var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/emissionfactor");
var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/equipmentanalysis");
var request = new RestRequest(Method.DELETE);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\r\n \"emissionFactorId\": \"number\"\r\n}", ParameterType.RequestBody);
request.AddParameter("application/json", "{\r\n [equipmentanalysisId1, equipmentanalysisId2, equipmentanalysisId3....] \r\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```
> Input JSON Body

```json

{
"emissionFactorId": "number"
[equipmentanalysisId1, equipmentanalysisId2, equipmentanalysisId3....]
}

```
> Example Response

```json
{
"insertedRowCount" : 0 ,
"updatedRowCount" : 0 ,
"deletedRowCount" : 1 ,
"failureCount" : 0 ,
"errorMessage" : []
"deletedRowCount": 1,
"notFoundCount": 0,
"failureCount": 0,
"errorMessage" : []
}

```


### 5. Operation Table

This section guides you through the process of removing/deleting the existing records from the Operation table using the designated API endpoint.
Expand Down
Loading
Loading