GET api/CustomerReview?ItemType={ItemType}&ItemID={ItemID}&APIToken={APIToken}
Get Customer Review
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
ItemType | integer |
Required |
|
ItemID | integer |
Required |
|
APIToken | string |
Required |
Body Parameters
None.
Response Information
Resource Description
CustomerReviewResponseDataModelName | Description | Type | Additional information |
---|---|---|---|
AvarageRating | decimal number |
None. |
|
FiveStarConut | integer |
None. |
|
FivecntPercentage | integer |
None. |
|
FourStarCount | integer |
None. |
|
FourcntPercentage | integer |
None. |
|
ThreeStarCount | integer |
None. |
|
ThreecntPercentage | integer |
None. |
|
TwoStarCount | integer |
None. |
|
TwocntPercentage | integer |
None. |
|
OneStarCount | integer |
None. |
|
OnecntPercentage | integer |
None. |
|
CustomerReview | Collection of CustomerReviewDataModel |
None. |
|
ReturnID | integer |
Required |
|
Message | string |
Required |
|
Successful | boolean |
Required |
|
Code | integer |
None. |
|
TotalRecord | integer |
None. |
Response Formats
application/json, text/json, text/plain, text/html
Sample:
{ "avarageRating": 1.0, "fiveStarConut": 2, "fivecntPercentage": 3, "fourStarCount": 4, "fourcntPercentage": 5, "threeStarCount": 6, "threecntPercentage": 7, "twoStarCount": 8, "twocntPercentage": 9, "oneStarCount": 10, "onecntPercentage": 11, "customerReview": [ { "customerReviewID": 1, "itemType": 2, "itemID": 3, "customerName": "sample string 4", "customerEmail": "sample string 5", "customerPhoneNo": "sample string 6", "customerRating": 7.0, "customerReview": "sample string 8", "customerReviewDate": "2025-07-17T05:31:43.7404919+00:00" }, { "customerReviewID": 1, "itemType": 2, "itemID": 3, "customerName": "sample string 4", "customerEmail": "sample string 5", "customerPhoneNo": "sample string 6", "customerRating": 7.0, "customerReview": "sample string 8", "customerReviewDate": "2025-07-17T05:31:43.7404919+00:00" } ], "returnID": 12, "message": "sample string 13", "successful": true, "code": 15, "totalRecord": 16 }
application/xml, text/xml
Sample:
<CustomerReviewResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel"> <Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">15</Code> <Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 13</Message> <ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">12</ReturnID> <Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful> <TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">16</TotalRecord> <AvarageRating>1</AvarageRating> <CustomerReview> <CustomerReviewDataModel> <CustomerEmail>sample string 5</CustomerEmail> <CustomerName>sample string 4</CustomerName> <CustomerPhoneNo>sample string 6</CustomerPhoneNo> <CustomerRating>7</CustomerRating> <CustomerReview>sample string 8</CustomerReview> <CustomerReviewDate>2025-07-17T05:31:43.7404919+00:00</CustomerReviewDate> <CustomerReviewID>1</CustomerReviewID> <ItemID>3</ItemID> <ItemType>2</ItemType> </CustomerReviewDataModel> <CustomerReviewDataModel> <CustomerEmail>sample string 5</CustomerEmail> <CustomerName>sample string 4</CustomerName> <CustomerPhoneNo>sample string 6</CustomerPhoneNo> <CustomerRating>7</CustomerRating> <CustomerReview>sample string 8</CustomerReview> <CustomerReviewDate>2025-07-17T05:31:43.7404919+00:00</CustomerReviewDate> <CustomerReviewID>1</CustomerReviewID> <ItemID>3</ItemID> <ItemType>2</ItemType> </CustomerReviewDataModel> </CustomerReview> <FiveStarConut>2</FiveStarConut> <FivecntPercentage>3</FivecntPercentage> <FourStarCount>4</FourStarCount> <FourcntPercentage>5</FourcntPercentage> <OneStarCount>10</OneStarCount> <OnecntPercentage>11</OnecntPercentage> <ThreeStarCount>6</ThreeStarCount> <ThreecntPercentage>7</ThreecntPercentage> <TwoStarCount>8</TwoStarCount> <TwocntPercentage>9</TwocntPercentage> </CustomerReviewResponseDataModel>
multipart/form-data
Sample:
<CustomerReviewResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel"><Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">15</Code><Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 13</Message><ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">12</ReturnID><Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful><TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">16</TotalRecord><AvarageRating>1</AvarageRating><CustomerReview><CustomerReviewDataModel><CustomerEmail>sample string 5</CustomerEmail><CustomerName>sample string 4</CustomerName><CustomerPhoneNo>sample string 6</CustomerPhoneNo><CustomerRating>7</CustomerRating><CustomerReview>sample string 8</CustomerReview><CustomerReviewDate>2025-07-17T05:31:43.7404919+00:00</CustomerReviewDate><CustomerReviewID>1</CustomerReviewID><ItemID>3</ItemID><ItemType>2</ItemType></CustomerReviewDataModel><CustomerReviewDataModel><CustomerEmail>sample string 5</CustomerEmail><CustomerName>sample string 4</CustomerName><CustomerPhoneNo>sample string 6</CustomerPhoneNo><CustomerRating>7</CustomerRating><CustomerReview>sample string 8</CustomerReview><CustomerReviewDate>2025-07-17T05:31:43.7404919+00:00</CustomerReviewDate><CustomerReviewID>1</CustomerReviewID><ItemID>3</ItemID><ItemType>2</ItemType></CustomerReviewDataModel></CustomerReview><FiveStarConut>2</FiveStarConut><FivecntPercentage>3</FivecntPercentage><FourStarCount>4</FourStarCount><FourcntPercentage>5</FourcntPercentage><OneStarCount>10</OneStarCount><OnecntPercentage>11</OnecntPercentage><ThreeStarCount>6</ThreeStarCount><ThreecntPercentage>7</ThreecntPercentage><TwoStarCount>8</TwoStarCount><TwocntPercentage>9</TwocntPercentage></CustomerReviewResponseDataModel>