GET api/BillingService/ListPromotions?pageIndex={pageIndex}&pageSize={pageSize}&showAll={showAll}

Documentation for 'ListPromotions'.

Request Information

Parameters

Name	Description	Additional information
pageIndex	Documentation for 'pageIndex'.	Define this parameter in the request URI.
pageSize	Documentation for 'pageSize'.	Define this parameter in the request URI.
showAll	Documentation for 'showAll'.	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "promotions": [
    {
      "promotion_name": "sample string 1",
      "state": 0,
      "promotion_type": 0,
      "promotion_code": "sample string 2",
      "scope": 0,
      "discount_type": 0,
      "discount_value": 3.0,
      "description": "sample string 4",
      "terms_and_conditions": "sample string 5",
      "available_from_utc_time": "sample string 6",
      "expired_utc_time": "sample string 7",
      "creation_utc_time": "sample string 8",
      "duration": 9,
      "is_user_used": true,
      "is_success": true,
      "error_message": "sample string 12",
      "exception_name": "sample string 13",
      "error_code": 14
    },
    {
      "promotion_name": "sample string 1",
      "state": 0,
      "promotion_type": 0,
      "promotion_code": "sample string 2",
      "scope": 0,
      "discount_type": 0,
      "discount_value": 3.0,
      "description": "sample string 4",
      "terms_and_conditions": "sample string 5",
      "available_from_utc_time": "sample string 6",
      "expired_utc_time": "sample string 7",
      "creation_utc_time": "sample string 8",
      "duration": 9,
      "is_user_used": true,
      "is_success": true,
      "error_message": "sample string 12",
      "exception_name": "sample string 13",
      "error_code": 14
    },
    {
      "promotion_name": "sample string 1",
      "state": 0,
      "promotion_type": 0,
      "promotion_code": "sample string 2",
      "scope": 0,
      "discount_type": 0,
      "discount_value": 3.0,
      "description": "sample string 4",
      "terms_and_conditions": "sample string 5",
      "available_from_utc_time": "sample string 6",
      "expired_utc_time": "sample string 7",
      "creation_utc_time": "sample string 8",
      "duration": 9,
      "is_user_used": true,
      "is_success": true,
      "error_message": "sample string 12",
      "exception_name": "sample string 13",
      "error_code": 14
    }
  ],
  "total_count": 1,
  "page_index": 2,
  "page_size": 3,
  "is_success": true,
  "error_message": "sample string 5",
  "exception_name": "sample string 6",
  "error_code": 7
}

application/xml, text/xml

Sample:

<ListPromotionsResponse 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">7</error_code>
  <error_message xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 5</error_message>
  <exception_name xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 6</exception_name>
  <is_success xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">true</is_success>
  <page_index xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi.Entities">2</page_index>
  <page_size xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi.Entities">3</page_size>
  <total_count xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi.Entities">1</total_count>
  <promotions>
    <PromotionResponse>
      <error_code xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">14</error_code>
      <error_message xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 12</error_message>
      <exception_name xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 13</exception_name>
      <is_success xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">true</is_success>
      <available_from_utc_time>sample string 6</available_from_utc_time>
      <creation_utc_time>sample string 8</creation_utc_time>
      <description>sample string 4</description>
      <discount_type>None</discount_type>
      <discount_value>3</discount_value>
      <duration>9</duration>
      <expired_utc_time>sample string 7</expired_utc_time>
      <is_user_used>true</is_user_used>
      <promotion_code>sample string 2</promotion_code>
      <promotion_name>sample string 1</promotion_name>
      <promotion_type>None</promotion_type>
      <scope>All</scope>
      <state>None</state>
      <terms_and_conditions>sample string 5</terms_and_conditions>
    </PromotionResponse>
    <PromotionResponse>
      <error_code xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">14</error_code>
      <error_message xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 12</error_message>
      <exception_name xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 13</exception_name>
      <is_success xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">true</is_success>
      <available_from_utc_time>sample string 6</available_from_utc_time>
      <creation_utc_time>sample string 8</creation_utc_time>
      <description>sample string 4</description>
      <discount_type>None</discount_type>
      <discount_value>3</discount_value>
      <duration>9</duration>
      <expired_utc_time>sample string 7</expired_utc_time>
      <is_user_used>true</is_user_used>
      <promotion_code>sample string 2</promotion_code>
      <promotion_name>sample string 1</promotion_name>
      <promotion_type>None</promotion_type>
      <scope>All</scope>
      <state>None</state>
      <terms_and_conditions>sample string 5</terms_and_conditions>
    </PromotionResponse>
    <PromotionResponse>
      <error_code xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">14</error_code>
      <error_message xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 12</error_message>
      <exception_name xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 13</exception_name>
      <is_success xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">true</is_success>
      <available_from_utc_time>sample string 6</available_from_utc_time>
      <creation_utc_time>sample string 8</creation_utc_time>
      <description>sample string 4</description>
      <discount_type>None</discount_type>
      <discount_value>3</discount_value>
      <duration>9</duration>
      <expired_utc_time>sample string 7</expired_utc_time>
      <is_user_used>true</is_user_used>
      <promotion_code>sample string 2</promotion_code>
      <promotion_name>sample string 1</promotion_name>
      <promotion_type>None</promotion_type>
      <scope>All</scope>
      <state>None</state>
      <terms_and_conditions>sample string 5</terms_and_conditions>
    </PromotionResponse>
  </promotions>
</ListPromotionsResponse>