POST api/BillingService/QueryBillingReport

Documentation for 'QueryBillingReport'.

Request Information

Parameters

Name	Description	Additional information
request	Documentation for 'request'.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "environment": "sample string 1",
  "action_type": "sample string 2",
  "action_name": "sample string 3",
  "page_index": 4,
  "page_size": 5,
  "parameters": [
    {
      "name": "sample string 1",
      "data_type": "sample string 2",
      "value": "sample string 3",
      "min_value": 1.0,
      "max_value": 1.0,
      "min_length": 1.0,
      "max_length": 1.0,
      "string_enum": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "number_enum": [
        1.0,
        2.0,
        3.0
      ]
    },
    {
      "name": "sample string 1",
      "data_type": "sample string 2",
      "value": "sample string 3",
      "min_value": 1.0,
      "max_value": 1.0,
      "min_length": 1.0,
      "max_length": 1.0,
      "string_enum": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "number_enum": [
        1.0,
        2.0,
        3.0
      ]
    },
    {
      "name": "sample string 1",
      "data_type": "sample string 2",
      "value": "sample string 3",
      "min_value": 1.0,
      "max_value": 1.0,
      "min_length": 1.0,
      "max_length": 1.0,
      "string_enum": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "number_enum": [
        1.0,
        2.0,
        3.0
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<QueryBillingReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MMS.RestApi.Entities.Billing">
  <action_name>sample string 3</action_name>
  <action_type>sample string 2</action_type>
  <environment>sample string 1</environment>
  <page_index>4</page_index>
  <page_size>5</page_size>
  <parameters>
    <BillingReportQueryActionParameter>
      <data_type>sample string 2</data_type>
      <max_length>1</max_length>
      <max_value>1</max_value>
      <min_length>1</min_length>
      <min_value>1</min_value>
      <name>sample string 1</name>
      <number_enum xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
        <d4p1:decimal>3</d4p1:decimal>
      </number_enum>
      <string_enum xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </string_enum>
      <value>sample string 3</value>
    </BillingReportQueryActionParameter>
    <BillingReportQueryActionParameter>
      <data_type>sample string 2</data_type>
      <max_length>1</max_length>
      <max_value>1</max_value>
      <min_length>1</min_length>
      <min_value>1</min_value>
      <name>sample string 1</name>
      <number_enum xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
        <d4p1:decimal>3</d4p1:decimal>
      </number_enum>
      <string_enum xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </string_enum>
      <value>sample string 3</value>
    </BillingReportQueryActionParameter>
    <BillingReportQueryActionParameter>
      <data_type>sample string 2</data_type>
      <max_length>1</max_length>
      <max_value>1</max_value>
      <min_length>1</min_length>
      <min_value>1</min_value>
      <name>sample string 1</name>
      <number_enum xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
        <d4p1:decimal>3</d4p1:decimal>
      </number_enum>
      <string_enum xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </string_enum>
      <value>sample string 3</value>
    </BillingReportQueryActionParameter>
  </parameters>
</QueryBillingReportRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "is_paginated": true,
  "page_index": 2,
  "page_size": 3,
  "total_count": 4,
  "columns": [
    {
      "name": "sample string 1",
      "data_type": "sample string 2",
      "value": "sample string 3",
      "min_value": 1.0,
      "max_value": 1.0,
      "min_length": 1.0,
      "max_length": 1.0,
      "string_enum": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "number_enum": [
        1.0,
        2.0,
        3.0
      ]
    },
    {
      "name": "sample string 1",
      "data_type": "sample string 2",
      "value": "sample string 3",
      "min_value": 1.0,
      "max_value": 1.0,
      "min_length": 1.0,
      "max_length": 1.0,
      "string_enum": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "number_enum": [
        1.0,
        2.0,
        3.0
      ]
    },
    {
      "name": "sample string 1",
      "data_type": "sample string 2",
      "value": "sample string 3",
      "min_value": 1.0,
      "max_value": 1.0,
      "min_length": 1.0,
      "max_length": 1.0,
      "string_enum": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "number_enum": [
        1.0,
        2.0,
        3.0
      ]
    }
  ],
  "query_result": [
    [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ],
    [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ],
    [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ]
  ],
  "is_success": true,
  "error_message": "sample string 6",
  "exception_name": "sample string 7",
  "error_code": 8
}

application/xml, text/xml

Sample:

<QueryBillingReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MMS.RestApi.Entities.Billing">
  <error_code xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">8</error_code>
  <error_message xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 6</error_message>
  <exception_name xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 7</exception_name>
  <is_success xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">true</is_success>
  <columns>
    <BillingReportQueryActionParameter>
      <data_type>sample string 2</data_type>
      <max_length>1</max_length>
      <max_value>1</max_value>
      <min_length>1</min_length>
      <min_value>1</min_value>
      <name>sample string 1</name>
      <number_enum xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
        <d4p1:decimal>3</d4p1:decimal>
      </number_enum>
      <string_enum xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </string_enum>
      <value>sample string 3</value>
    </BillingReportQueryActionParameter>
    <BillingReportQueryActionParameter>
      <data_type>sample string 2</data_type>
      <max_length>1</max_length>
      <max_value>1</max_value>
      <min_length>1</min_length>
      <min_value>1</min_value>
      <name>sample string 1</name>
      <number_enum xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
        <d4p1:decimal>3</d4p1:decimal>
      </number_enum>
      <string_enum xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </string_enum>
      <value>sample string 3</value>
    </BillingReportQueryActionParameter>
    <BillingReportQueryActionParameter>
      <data_type>sample string 2</data_type>
      <max_length>1</max_length>
      <max_value>1</max_value>
      <min_length>1</min_length>
      <min_value>1</min_value>
      <name>sample string 1</name>
      <number_enum xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
        <d4p1:decimal>3</d4p1:decimal>
      </number_enum>
      <string_enum xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </string_enum>
      <value>sample string 3</value>
    </BillingReportQueryActionParameter>
  </columns>
  <is_paginated>true</is_paginated>
  <page_index>2</page_index>
  <page_size>3</page_size>
  <query_result xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfstring>
      <d2p1:string>sample string 1</d2p1:string>
      <d2p1:string>sample string 2</d2p1:string>
      <d2p1:string>sample string 3</d2p1:string>
    </d2p1:ArrayOfstring>
    <d2p1:ArrayOfstring>
      <d2p1:string>sample string 1</d2p1:string>
      <d2p1:string>sample string 2</d2p1:string>
      <d2p1:string>sample string 3</d2p1:string>
    </d2p1:ArrayOfstring>
    <d2p1:ArrayOfstring>
      <d2p1:string>sample string 1</d2p1:string>
      <d2p1:string>sample string 2</d2p1:string>
      <d2p1:string>sample string 3</d2p1:string>
    </d2p1:ArrayOfstring>
  </query_result>
  <total_count>4</total_count>
</QueryBillingReportResponse>