4.1.16 Plan manager

Plan manager

URL: /pl.ashx

Authorization

The method requires authorization using basic authentication. Please use your SIP account login and password.

Description

The list of methods:

• getPlan - reading information about the plan, tariff names, plan value
• buyPlan - buy a plan
• cancelPlan - cancellation of the period plan
• getPlans - a list of available plans, along with a selection of the client's active plans.

Service parameters:

• m - method name
• pm - method parameters (JSON obiect)

Method description:

Pobranie listy planów

To download the plans, call the /pl.ashx method with the following parameters:

{"co": string}

Return value

Return value

• If successful, we will receive a JSON object

  Response

  [
   {
    "id" :integer,
    "ds" :string,
    "n"  :string,
    "pr" :bool,
    "pt" :integer,
    "pn" :integer,
    "pc" :decimal,
    "sc" :decimal,
    "a"  :bool,
    "av" :bool,
    "ex" :string,
    "dl" :integer,
    "da" :bool,
    "ss" :string
     }
  ]

  where:

• • id - plan id
  • ds - description 
  • n - plan name
  • pt - period type: 1 - month, 2 - week, 4 - day, 5 - year, 6 - quarter, example: Fri = 1 and Mon = 2 means that the plan is for two months.
  • pr - whether the plan is periodic
  • pn - period length
  • pc - period cost
  • sc - startup cost
  • a -if true - the plan purchased by the customer
  • av - if true - plan available, you can buy it
  • ex - Expiration date - in case of periodic plan it means the next payment date, in case of single plan it means the end date of the plan. Date format "yyyy-MM-dd"
  • dl - Days left - this is the expiration date given in days
  • da - if true - select the DID number when purchasing the plan
  • ss - means whether the plan is paid for by Apple App Store or Google Play subscriptions. Possible values:
    • a - active subscription, has been purchased,
    • i - subscription inactive, subscriptions can be purchased,
    • empty value - not applicable, subscriptions cannot be associated with the plan

Download details of plans

To download the plans, call the /pl.ashx method (GET) with the following parameters:

{"id": integer}

Return value

• • id - plan id
  • tp - tariff plan table
  • tp.id - tariff plan id
  • tp.v - value - tariff plan value
  • tp.n - name -name of the plan's tariff prefix
  • tp.as - account state - current status of the customer's account, the value -1 means that the tariff plan is not assigned to the customer
  • tp.ut - unit - tariff plan unit - currently may contain the following values: mm - minutes or ss - seconds. This unit is set on the server side in the AppSettings.config file using the key
    <add key="tariff_plan_ID_value_unit" value="unit"/>, example  <add key="tariff_plan_33_value_unit" value="ss"/> which means that tariff plan with id = 33 is defined in seconds

  • tp.ft  - format - format in which we want to show the tariff plan value, currently it may contain the following values: mm - minutes or ss - seconds. This unit is set on the server side in the AppSettings.config file using the key <add key="tariff_plan_ID_value_format" value="unit"/>, example  <add key="tariff_plan_33_value_format" value="mm"/> which means that for tariff plan with id = 33, the value should be shown in minutes. Note: when displaying the tariff plan values, they should be grouped by the id field, because several or a dozen prefixes (name field) may be defined for one tariff plan.

    Below is an example in which for a plan with id = 2 we have 3 "prefixes" - name but only 2 different tariff plans

    Name (prefix)	Value	Value - formatted	Account state	Account state - formatted
    Poland - ORANGE	3600	60 minutes	3480	58 minutes.
    Poland - PLAY
    Poland	3600	60 minutes	3600	60 minutes.

    Response

    {
      "id": 2,
      "tp":
        [
          {
            "id": 10,
            "v" : 3600,
            "n" : Poland - ORANGE, 
            "as": 3480,
            "ut": "ss",
            "ft": "mm"
          },
          {
            "id": 10,
            "v" : 3600,
            "n" : Poland - PLAY, 
            "as": 3480,
            "ut": "ss",
            "ft": "mm"
          },
          {
            "id": 11,
            "v" : 3600,
            "n" : Poland, 
            "as": 3600,
            "ut": "ss",
            "ft": "mm"
          },
       ]
    }

Purchasing a plan

To buy the selected plans, call the /pl.ashx method(POST) with the following parameters:

{"id": integer}

Return value

• If successful, we will receive a JSON object

  Response

  {
    "id" :1,
    "ds" :"Europa in your hands",
    "n"  :"PlanEuropa",
    "pr" :true,
    "pn" :3,
    "pc" :25.0000,
    "sc" :15.0000,
    "a"  :true,
    "av" :false,
    "ex" :string,
    "dl" :string
    "ss" :string
  }

  where:

• • id - plan id
  • ds - description
  • n - plan name
  • pr - whether the plan is periodic
  • pn - Period number
  • pc - Period cost
  • sc - Startup cost
  • a - Active - plan purchased by the customer
  • av - Available - Can the plan be purchased.
  • ex - Expiration date - in the case of a periodic plan, it means the date of the next payment, in the case of a one-off plan, it means the end date of the plan. Date format "yyyy-MM-dd"
  • dl - Days left - this is the expiration date given in days
  • ss - indicates whether the plan is paid for by Apple App Store or Google Play subscriptions. Possible values: 
    • a - active subscription, has been purchased,
    • i - subscription inactive, subscriptions can be purchased,
    • empty value - not applicable, subscriptions cannot be associated with the plan
      
      

• If an error occurs on the server or any of the parameters contain an incorrect value, the method will return the appropriate 3-digit error code shown below:

  Code	Description
  400	Incorrect parameters - one of the parameters was not provided
  447	Plan cannot be canceled.
  500	Internal server error

Canceling a periodic plan

To cancel the selected periodic plans, call the /pl.ashx method with the parameters:

{"id": integer}

Return value

• If successful, we will receive a JSON object

  Response

  {
    "id" :1,
    "ds" :"Europa in your hands",
    "n"  :"PlanEuropa",
    "pr" :true,
    "pn" :3,
    "pc" :25.0000,
    "sc" :15.0000,
    "a"  :true,
    "av" :false,
    "ex" :"2013-06-22",
    "dl: :20
  }

  where:

  • id - plan id
  • ds - description 
  • n - plan name
  • pr - whether the plan is periodic
  • pn - Period number
  • pc - Period cost
  • sc - Startup cost
  • a - Active - plan purchased by the customer
  • av - Available - Can the plan be purchased.
  • ex - Expiration date - in the case of a periodic plan, it means the date of the next payment, in the case of a one-off plan, it means the end date of the plan
  • dl - Days left - this is the expiration date in days
    
    

• If an error occurs on the server or any of the parameters contain an incorrect value, the method will return the appropriate 3-digit error code shown below:

  Code	Description
  400	Incorrect parameters - one of the parameters was not provided
  447	Plan cannot be canceled.
  500	Internal server error