POST api/Customers/GetUserReports
user login
Request Information
URI Parameters
None.
Body Parameters
UserReportsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Email": "sample string 1"
}
application/xml, text/xml
Sample:
<UserReportsRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Email>sample string 1</Email> </UserReportsRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
returns login object
UserReportsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ReportsValidKey | Collection of ReportItem |
None. |
|
| Success |
Indicate if the operation was success |
boolean |
None. |
| Message |
Return of errors or indicated return message/data |
string |
None. |
| Extra1 |
Additional info 1 to return |
string |
None. |
| Extra2 |
Additional info 2 to return |
string |
None. |
| Extra3 |
Additional info 3 to return |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ReportsValidKey": [
{
"ApiKey": "sample string 1",
"Name": "sample string 2"
},
{
"ApiKey": "sample string 1",
"Name": "sample string 2"
}
],
"Success": true,
"Message": "sample string 2",
"Extra1": "sample string 3",
"Extra2": "sample string 4",
"Extra3": "sample string 5"
}
application/xml, text/xml
Sample:
<UserReportsResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success>true</Success>
<Message>sample string 2</Message>
<Extra1>sample string 3</Extra1>
<Extra2>sample string 4</Extra2>
<Extra3>sample string 5</Extra3>
<ReportsValidKey>
<ReportItem>
<ApiKey>sample string 1</ApiKey>
<Name>sample string 2</Name>
</ReportItem>
<ReportItem>
<ApiKey>sample string 1</ApiKey>
<Name>sample string 2</Name>
</ReportItem>
</ReportsValidKey>
</UserReportsResponse>