Skip to content

Commit ca7d02b

Browse files
[ILX 48044] make each endpoint response in api document consistent with api response (#26)
* Updated for EmissionCalculation endpoints. * Removed attribute name from the emission calculation request body and made changes in the doument as per Katy. * Added Emission factor end point for GET,POST,DELETE and QueryResults ned point for GET * modified reference.md to inlcude all the GET and POST endpoint reference * modified endpoint response to make it align with the API response by removing underscores in the response * set camelCase for request parameter for emission calculation * make each endpoint response in api document consistent with api response. --------- Co-authored-by: Sharath Upadhyaya <sharath.upadhyaya@intelex.com>
1 parent 2e5d30e commit ca7d02b

File tree

3 files changed

+301
-257
lines changed

3 files changed

+301
-257
lines changed

source/includes/acts/delete_api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,9 @@ IRestResponse response = client.Execute(request);
121121
122122
```json
123123
{
124-
"deletedRowCount": 1,
125-
"notFoundCount": 0,
126-
"failureCount": 0,
124+
"deletedRowCount": 1,
125+
"notFoundCount": 0,
126+
"failureCount": 0,
127127
"errorMessage" : []
128128
}
129129

source/includes/acts/get_api.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ IRestResponse response = client.Execute(request);
6969

7070
**API Endpoints**
7171

72-
`GET` /api/v1/AttributeType
72+
`GET` /api/v1/attributetype
7373

7474
**Query parameters**
7575

@@ -119,7 +119,7 @@ IRestResponse response = client.Execute(request);
119119
"data": [
120120
{
121121
"compoundId": "number",
122-
"compound": "string",
122+
"compoundName": "string",
123123
"compoundTypeId": "number",
124124
"compoundStatusId": "number",
125125
"activeDate": "2011-07-04T17:42:43",
@@ -179,7 +179,7 @@ compoundTypeIds | int | Compound Type Ids is the associated compound type and is
179179
compoundstatusIds | int | Compound Status Ids is associated with compound status
180180
compoundNames | string | Compound Names The name of the compound which is a string type data and is one among the parameter for filter option
181181
externalIdentifier | int | External Identifiers is a unique identifier for this record to an external data system
182-
CAS | string | CAS Number is a Chemical Abstract Service number for the compound
182+
cas | string | CAS Number is a Chemical Abstract Service number for the compound
183183

184184
### 3. Emission Category Table
185185

@@ -506,14 +506,14 @@ IRestResponse response = client.Execute(request);
506506
"hasNext": true,
507507
"data": [
508508
{
509-
"EquipmentAttributeId": "number",
510-
"EquipmentId": "number",
511-
"AttributeTypeId": "number",
512-
"EquipmentAttribute":"string",
513-
"DataLockTypeId": "number",
514-
"LastModifiedDate": "datetime",
515-
"ExternalIdentifier": "string",
516-
"Comments":"string"
509+
"equipmentAttributeId": "number",
510+
"equipmentId": "number",
511+
"attributeTypeId": "number",
512+
"equipmentAttribute":"string",
513+
"dataLockTypeId": "number",
514+
"lastModifiedDate": "datetime",
515+
"externalIdentifier": "string",
516+
"comments":"string"
517517
}
518518
]
519519
}
@@ -724,16 +724,16 @@ IRestResponse response = client.Execute(request);
724724
"hasPrevious": false,
725725
"hasNext": true,
726726
"data": [
727-
{
727+
{
728728
"facilityId": "number",
729729
"facilityName": "string",
730-
"emissionTypeId": "number",
731730
"areaId": "number",
732731
"facilityTypeId": "number",
733732
"facilityStatusId": "number",
734733
"sortOrder": "number",
735734
"facilityOwnershipId": "number",
736735
"facilityOwnerId": "number",
736+
"landOwnershipId": "number",
737737
"landOwnerId": "number",
738738
"operatorId": "number",
739739
"countryId": "number",
@@ -819,14 +819,14 @@ IRestResponse response = client.Execute(request);
819819
"hasNext": true,
820820
"data": [
821821
{
822-
"FacilityAttributeId": "number",
823-
"FacilityId": "number",
824-
"AttributeTypeId": "number",
825-
"FacilityAttribute":"string",
826-
"DataLockTypeId": "number",
827-
"LastModifiedDate": "2023-03-30T07:27:06.295Z",
828-
"ExternalIdentifier": "string",
829-
"Comments":"string"
822+
"facilityAttributeId": "number",
823+
"facilityId": "number",
824+
"attributeTypeId": "number",
825+
"facilityAttribute":"string",
826+
"dataLockTypeId": "number",
827+
"lastModifiedDate": "2023-03-30T07:27:06.295Z",
828+
"externalIdentifier": "string",
829+
"comments":"string"
830830
}
831831
]
832832
}
@@ -1413,8 +1413,7 @@ IRestResponse response = client.Execute(request);
14131413
"workflowQuestionId": "number",
14141414
"lastModifiedDate": "2017-02-13T22:15:30.203Z",
14151415
"externalIdentifier": "string",
1416-
"comments": "string",
1417-
"refId": "string"
1416+
"comments": "string"
14181417
}
14191418
]
14201419
}
@@ -1571,7 +1570,8 @@ IRestResponse response = client.Execute(request);
15711570
"sortOrder": "number",
15721571
"lastModifiedDate": "2017-02-13T22:15:30.203Z",
15731572
"externalIdentifier": "string",
1574-
"comments": "string"
1573+
"comments": "string",
1574+
"refId": "string"
15751575
}
15761576
]
15771577
}

0 commit comments

Comments
 (0)