PlanResourceListGet_API

Syntax

ListResult BM::PlanResourceListGet_API(

  Int PlanID;

  Int ResourceCategoryID;

  Int StatusList;

  Int SortNo.

)

returns

  Int ResourceID - resource ID;

  Str(250) ResourceName - resource name;

  Str(1024) Description - resource rate description;

  Double SetupFee - resource rate setup fee;

  Double RecurringFee - resource rate recurring fee;

  Double CostForAdditional resource rate overuse fee;

  Int IncludedValue - resource included units;

  Int MaxValue - resource upper limit;

  Int MinValue - resource lower limit;

  Int IsMain - signifies if resource rate is shown in store ("1") or not("0");

  Int IsSFperUnit - signifies if setup fee is changed per unit ("1") or not ("0");

  Int IsVisible - signifies if resource rate is shown in CP ("1") or not("0");

  Str(30) MeasureUnit - resource unit of measure;

  Int ResourceCategoryID - resource category ID;

  Int SortOrder - sort order of resource in store.

Special Notes

• Int PlanID - service plan ID;
• Int ResourceCategoryID - resource category ID;
• Int StatusList - truncates result depending on resource rate Included Unit value:
  • StatusList == 0. Method returns resources, which have positive Included Unit value in resource rate (Caution! Resource rate != resource in service template)
  • StatusList == 1. Method returns resources, which have zero Included Unit value in resource rate (Caution! Resource rate != resource in service template)
  • StatusList empty. Method returns all resources of plan resource rates, which belong to specified resource category.
• Int SortNo - defines how output data is sorted: 1 - the output is sorted by first column in ascending order, 1 - the output is sorted by second column in ascending order, etc. Negative value makes output sorted in descending order, for example: -1 - the output is sorted by first column (Resource ID) in descending order.

Please send us your feedback on this help page