POST BI/GetCompSales
Request Information
URI Parameters
None.
Body Parameters
IConnect.Domain.Reports.CommonReport.BusinessIntelligence.ReportViewModelName | Description | Type | Additional information |
---|---|---|---|
SelectedCompanies | Collection of integer |
None. |
|
TopOrSlow | boolean |
None. |
|
Start | date |
None. |
|
End | date |
None. |
|
StartDateObjectString | string |
None. |
|
EndDateObjectString | string |
None. |
|
SkipTimeZoneConvertion | boolean |
None. |
|
ForceImmediateExport | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "SelectedCompanies": [ 1, 2 ], "TopOrSlow": true, "Start": "2025-04-03T22:12:23.7537864-04:00", "End": "2025-04-03T22:12:23.7537864-04:00", "StartDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":12,\"seconds\":23,\"miliseconds\":753}", "EndDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":12,\"seconds\":23,\"miliseconds\":753}", "SkipTimeZoneConvertion": true, "ForceImmediateExport": true }
application/xml, text/xml
Sample:
<ReportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.CommonReport.BusinessIntelligence"> <_x003C_End_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2025-04-03T22:12:23.7537864-04:00</_x003C_End_x003E_k__BackingField> <_x003C_ForceImmediateExport_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">true</_x003C_ForceImmediateExport_x003E_k__BackingField> <_x003C_SkipTimeZoneConvertion_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">true</_x003C_SkipTimeZoneConvertion_x003E_k__BackingField> <_x003C_Start_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2025-04-03T22:12:23.7537864-04:00</_x003C_Start_x003E_k__BackingField> <_x003C_SelectedCompanies_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </_x003C_SelectedCompanies_x003E_k__BackingField> <_x003C_TopOrSlow_x003E_k__BackingField>true</_x003C_TopOrSlow_x003E_k__BackingField> </ReportViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IConnect.ReportingApi.Core.ApiResponseOfSystem.ObjectName | Description | Type | Additional information |
---|---|---|---|
StatusCode | IConnect.ReportingApi.Core.ApiStatusCode |
None. |
|
Message | string |
None. |
|
Data | Object |
None. |
|
IsSuccess | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "StatusCode": 0, "Message": "sample string 1", "Data": {}, "IsSuccess": true }
application/xml, text/xml
Sample:
<ApiResponseOfanyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.ReportingApi.Core"> <Data /> <Message>sample string 1</Message> <StatusCode>Success</StatusCode> </ApiResponseOfanyType>