Skip to content

Commit bf2b50d

Browse files
[ILX - 50446] Reordering the endpoint lists in the API document (#36)
* Update API Document with Analysis, Analysis Compound and Equipment Analysis endpoint for insert/update/delete operation * correcting post and delete endpoint for analysis, analysis compound and equipement analyis table * Removed Lastmodifieddate from equipment analysis request body * Remove lastmodifiedDate field from all the post endpoints for all tables. * Reordering the endpoint list in post and delete api file
1 parent b7d9980 commit bf2b50d

File tree

2 files changed

+178
-178
lines changed

2 files changed

+178
-178
lines changed

source/includes/acts/delete_api.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ In the current release, one DELETE API End point is provided to remove or delete
88

99
* Analysis
1010
* Analysis Compound
11-
* Equipment Analysis
1211
* Emission Factor
12+
* Equipment Analysis
1313
* Operation
1414

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

131131
```
132132

133-
### 3. Equipment Analysis Table
134133

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

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

139-
`DELETE` /api/v1/equipmentanalysis
138+
**Emission Factor DELETE endpoint**
139+
140+
`DELETE` /api/v1/emissionfactor
140141

141142
> Example Request & JSON Input Body
142143
143144
```javascript
144145
var request = require("request");
145146

146147
var options = { method: 'DELETE',
147-
url: 'https://[tenant].actsapi.intelex.com/v1/equipmentanalysis',
148+
url: 'https://[tenant].actsapi.intelex.com/v1/emissionfactor',
148149
headers: { 'content-type': 'application/json' },
149150
body:
150151
{
151-
[equipmentanalysisId1, equipmentanalysisId2, equipmentanalysisId3....]
152+
"emissionFactorId": "number"
152153
},
153154
json: true };
154155

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

162163
```csharp
163164

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

174175
{
175-
[equipmentanalysisId1, equipmentanalysisId2, equipmentanalysisId3....]
176+
"emissionFactorId": "number"
176177
}
177178

178179
```
179180
> Example Response
180181
181182
```json
182183
{
183-
"deletedRowCount": 1,
184-
"notFoundCount": 0,
185-
"failureCount": 0,
186-
"errorMessage" : []
184+
"insertedRowCount" : 0 ,
185+
"updatedRowCount" : 0 ,
186+
"deletedRowCount" : 1 ,
187+
"failureCount" : 0 ,
188+
"errorMessage" : []
187189
}
188190

189191
```
190192

191-
### 4. Emission Factor Table
193+
### 4. Equipment Analysis Table
192194

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

195-
**Emission Factor DELETE endpoint**
197+
**Equipment Analysis DELETE endpoint**
196198

197-
`DELETE` /api/v1/emissionfactor
199+
`DELETE` /api/v1/equipmentanalysis
198200

199201
> Example Request & JSON Input Body
200202
201203
```javascript
202204
var request = require("request");
203205

204206
var options = { method: 'DELETE',
205-
url: 'https://[tenant].actsapi.intelex.com/v1/emissionfactor',
207+
url: 'https://[tenant].actsapi.intelex.com/v1/equipmentanalysis',
206208
headers: { 'content-type': 'application/json' },
207209
body:
208210
{
209-
"emissionFactorId": "number"
211+
[equipmentanalysisId1, equipmentanalysisId2, equipmentanalysisId3....]
210212
},
211213
json: true };
212214

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

220222
```csharp
221223

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

232234
{
233-
"emissionFactorId": "number"
235+
[equipmentanalysisId1, equipmentanalysisId2, equipmentanalysisId3....]
234236
}
235237

236238
```
237239
> Example Response
238240
239241
```json
240242
{
241-
"insertedRowCount" : 0 ,
242-
"updatedRowCount" : 0 ,
243-
"deletedRowCount" : 1 ,
244-
"failureCount" : 0 ,
245-
"errorMessage" : []
243+
"deletedRowCount": 1,
244+
"notFoundCount": 0,
245+
"failureCount": 0,
246+
"errorMessage" : []
246247
}
247248

248249
```
249250

250-
251251
### 5. Operation Table
252252

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

0 commit comments

Comments
 (0)