POST api/Report/ProfitabilityReport

Request Information

URI Parameters

None.

Body Parameters

ProfitabilityReportViewModel
NameDescriptionTypeAdditional information
BySalesRep

boolean

None.

ByMarketSegment

boolean

None.

ByState

boolean

None.

ByManufacturer

boolean

None.

ByOrderAmount

boolean

None.

SalesAssociate

SalesAssociate

None.

MarketSegment

PrimaryIndustry

None.

State

StateViewModel

None.

Manufacturer

ManufacturerViewModel

None.

OrderAmount

OrderAmountModel

None.

StartDate

date

None.

EndDate

date

None.

Request Formats

application/json, text/json

Sample:
{
  "bySalesRep": true,
  "byMarketSegment": true,
  "byState": true,
  "byManufacturer": true,
  "byOrderAmount": true,
  "salesAssociate": {
    "salesAssociateID": 1,
    "salesAssociateName": "sample string 2"
  },
  "marketSegment": {
    "primaryIndustryID": 1,
    "primaryIndustryName": "sample string 2",
    "primaryIndustryIcon": "sample string 3"
  },
  "state": {
    "stateID": 1,
    "stateName": "sample string 2",
    "stateAbvr": "sample string 3",
    "countryID": 4
  },
  "manufacturer": {
    "manufacturerID": 1,
    "manufacturerName": "sample string 2",
    "isGameTime": true,
    "usePricingStructure": true
  },
  "orderAmount": {
    "min": 1,
    "max": 2,
    "name": "sample string 3"
  },
  "startDate": "2025-12-09T23:05:45.6039784-05:00",
  "endDate": "2025-12-09T23:05:45.6039784-05:00"
}

application/xml, text/xml

Sample:
<ProfitabilityReportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GameTimeBAL.ViewModels">
  <EndDate>2025-12-09T23:05:45.6039784-05:00</EndDate>
  <StartDate>2025-12-09T23:05:45.6039784-05:00</StartDate>
  <ByManufacturer>true</ByManufacturer>
  <ByMarketSegment>true</ByMarketSegment>
  <ByOrderAmount>true</ByOrderAmount>
  <BySalesRep>true</BySalesRep>
  <ByState>true</ByState>
  <Manufacturer>
    <IsGameTime>true</IsGameTime>
    <ManufacturerID>1</ManufacturerID>
    <ManufacturerName>sample string 2</ManufacturerName>
    <UsePricingStructure>true</UsePricingStructure>
  </Manufacturer>
  <MarketSegment>
    <PrimaryIndustryID>1</PrimaryIndustryID>
    <PrimaryIndustryIcon>sample string 3</PrimaryIndustryIcon>
    <PrimaryIndustryName>sample string 2</PrimaryIndustryName>
  </MarketSegment>
  <OrderAmount xmlns:d2p1="http://schemas.datacontract.org/2004/07/GameTimeDAL.AdditionalModel">
    <d2p1:Max>2</d2p1:Max>
    <d2p1:Min>1</d2p1:Min>
    <d2p1:Name>sample string 3</d2p1:Name>
  </OrderAmount>
  <SalesAssociate>
    <SalesAssociateID>1</SalesAssociateID>
    <SalesAssociateName>sample string 2</SalesAssociateName>
  </SalesAssociate>
  <State>
    <CountryID>4</CountryID>
    <StateAbvr>sample string 3</StateAbvr>
    <StateID>1</StateID>
    <StateName>sample string 2</StateName>
  </State>
</ProfitabilityReportViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.