GET api/Report/GetPremiumAmount?scope={scope}&startUtcTime={startUtcTime}&endUtcTime={endUtcTime}

Documentation for 'GetPremiumAmount'.

Request Information

Parameters

Name	Description	Additional information
scope	Documentation for 'scope'.	Define this parameter in the request URI.
startUtcTime	Documentation for 'startUtcTime'.	Define this parameter in the request URI.
endUtcTime	Documentation for 'endUtcTime'.	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "totals": [
    {
      "total_amount": 1,
      "type": "sample string 2"
    },
    {
      "total_amount": 1,
      "type": "sample string 2"
    },
    {
      "total_amount": 1,
      "type": "sample string 2"
    }
  ],
  "details": [
    {
      "provider": "sample string 1",
      "provider_details": [
        {
          "total_amount": 1,
          "type": "sample string 2"
        },
        {
          "total_amount": 1,
          "type": "sample string 2"
        },
        {
          "total_amount": 1,
          "type": "sample string 2"
        }
      ]
    },
    {
      "provider": "sample string 1",
      "provider_details": [
        {
          "total_amount": 1,
          "type": "sample string 2"
        },
        {
          "total_amount": 1,
          "type": "sample string 2"
        },
        {
          "total_amount": 1,
          "type": "sample string 2"
        }
      ]
    },
    {
      "provider": "sample string 1",
      "provider_details": [
        {
          "total_amount": 1,
          "type": "sample string 2"
        },
        {
          "total_amount": 1,
          "type": "sample string 2"
        },
        {
          "total_amount": 1,
          "type": "sample string 2"
        }
      ]
    }
  ],
  "is_success": true,
  "error_message": "sample string 2",
  "exception_name": "sample string 3",
  "error_code": 4
}

application/xml, text/xml

Sample:

<GetPremiumAmountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ContentApi.Client.Rest.Report.Entities">
  <error_code xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">4</error_code>
  <error_message xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 2</error_message>
  <exception_name xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 3</exception_name>
  <is_success xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">true</is_success>
  <details>
    <PremiumAmountItemByProvider>
      <provider>sample string 1</provider>
      <provider_details>
        <PremiumTotalAmountItem>
          <total_amount>1</total_amount>
          <type>sample string 2</type>
        </PremiumTotalAmountItem>
        <PremiumTotalAmountItem>
          <total_amount>1</total_amount>
          <type>sample string 2</type>
        </PremiumTotalAmountItem>
        <PremiumTotalAmountItem>
          <total_amount>1</total_amount>
          <type>sample string 2</type>
        </PremiumTotalAmountItem>
      </provider_details>
    </PremiumAmountItemByProvider>
    <PremiumAmountItemByProvider>
      <provider>sample string 1</provider>
      <provider_details>
        <PremiumTotalAmountItem>
          <total_amount>1</total_amount>
          <type>sample string 2</type>
        </PremiumTotalAmountItem>
        <PremiumTotalAmountItem>
          <total_amount>1</total_amount>
          <type>sample string 2</type>
        </PremiumTotalAmountItem>
        <PremiumTotalAmountItem>
          <total_amount>1</total_amount>
          <type>sample string 2</type>
        </PremiumTotalAmountItem>
      </provider_details>
    </PremiumAmountItemByProvider>
    <PremiumAmountItemByProvider>
      <provider>sample string 1</provider>
      <provider_details>
        <PremiumTotalAmountItem>
          <total_amount>1</total_amount>
          <type>sample string 2</type>
        </PremiumTotalAmountItem>
        <PremiumTotalAmountItem>
          <total_amount>1</total_amount>
          <type>sample string 2</type>
        </PremiumTotalAmountItem>
        <PremiumTotalAmountItem>
          <total_amount>1</total_amount>
          <type>sample string 2</type>
        </PremiumTotalAmountItem>
      </provider_details>
    </PremiumAmountItemByProvider>
  </details>
  <totals>
    <PremiumTotalAmountItem>
      <total_amount>1</total_amount>
      <type>sample string 2</type>
    </PremiumTotalAmountItem>
    <PremiumTotalAmountItem>
      <total_amount>1</total_amount>
      <type>sample string 2</type>
    </PremiumTotalAmountItem>
    <PremiumTotalAmountItem>
      <total_amount>1</total_amount>
      <type>sample string 2</type>
    </PremiumTotalAmountItem>
  </totals>
</GetPremiumAmountResponse>