POST MultiBrand/GetTopStates

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.MultiBrand.MultiBrandReportViewModel
NameDescriptionTypeAdditional information
LocationId

integer

None.
IsCurrentYear

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: 
{
  "LocationId": 1,
  "IsCurrentYear": true,
  "Start": "2024-10-18T04:39:56.3395962-04:00",
  "End": "2024-10-18T04:39:56.3395962-04:00",
  "StartDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":39,\"seconds\":56,\"miliseconds\":339}",
  "EndDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":39,\"seconds\":56,\"miliseconds\":339}",
  "SkipTimeZoneConvertion": true,
  "ForceImmediateExport": true
}

application/xml, text/xml

Sample: 
<MultiBrandReportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.MultiBrand">
  <_x003C_End_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2024-10-18T04:39:56.3395962-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">2024-10-18T04:39:56.3395962-04:00</_x003C_Start_x003E_k__BackingField>
  <_x003C_IsCurrentYear_x003E_k__BackingField>true</_x003C_IsCurrentYear_x003E_k__BackingField>
  <_x003C_LocationId_x003E_k__BackingField>1</_x003C_LocationId_x003E_k__BackingField>
</MultiBrandReportViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IConnect.ReportingApi.Core.ApiResponseOfSystem.Collections.Generic.ListOfIConnect.Domain.MultiBrand.MultiBrandViewModel+StatesInfo
NameDescriptionTypeAdditional information
StatusCode

IConnect.ReportingApi.Core.ApiStatusCode

None.
Message

string

None.
Data

Collection of IConnect.Domain.MultiBrand.MultiBrandViewModel+StatesInfo

None.
IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "StatusCode": 0,
  "Message": "sample string 1",
  "Data": [
    {
      "StateName": "sample string 1",
      "SalesRevenue": 2.0,
      "FormattedSalesRevenue": "$2.00"
    },
    {
      "StateName": "sample string 1",
      "SalesRevenue": 2.0,
      "FormattedSalesRevenue": "$2.00"
    }
  ],
  "IsSuccess": true
}

application/xml, text/xml

Sample: 
<ApiResponseOfArrayOfMultiBrandViewModel.StatesInfo2TF5CiQF xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.ReportingApi.Core">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.MultiBrand">
    <d2p1:MultiBrandViewModel.StatesInfo>
      <d2p1:SalesRevenue>2</d2p1:SalesRevenue>
      <d2p1:StateName>sample string 1</d2p1:StateName>
    </d2p1:MultiBrandViewModel.StatesInfo>
    <d2p1:MultiBrandViewModel.StatesInfo>
      <d2p1:SalesRevenue>2</d2p1:SalesRevenue>
      <d2p1:StateName>sample string 1</d2p1:StateName>
    </d2p1:MultiBrandViewModel.StatesInfo>
  </Data>
  <Message>sample string 1</Message>
  <StatusCode>Success</StatusCode>
</ApiResponseOfArrayOfMultiBrandViewModel.StatesInfo2TF5CiQF>