GET api/Protocol?page={page}&records={records}

Get Protocol list

Request Information

URI Parameters

NameDescriptionTypeAdditional information
page

integer

Default value is 0

records

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of ProtocolVM
NameDescriptionTypeAdditional information
id

Id is the formula id generated by system

integer

None.

name

Formula name

string

Required

dose

It is a formula dose

string

None.

price

It is formula cost

decimal number

None.

notes

It is a notes field.

string

None.

meta

Formula meeta

string

None.

type

Formula type

integer

None.

supply

Supply quantity

integer

Required

Range: inclusive between 1 and 2147483647

filleridnumber

It is filler id number

string

None.

exactserving

It is exact serving size

string

None.

numberofdoses

It is number of does

string

None.

totalvolume

It is total valume

string

None.

totalweight

It is total weight

string

None.

supplyweight

It is supply weight

string

None.

totalservings

It is total serving.

string

None.

Contents

It is formula contents list.

Collection of ContentVM

None.

locked

It is lock property to check formula locked or unlocked

boolean

None.

uniqueformulaname

Unique formula name If it value is false then unique condition will not work means user will able to create duplicate formula

boolean

None.

isOrderable

It's indicate formula is orderable or not

boolean

None.

ValidateErrorMessage

Validation error message

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 2,
    "name": "sample string 3",
    "dose": "sample string 4",
    "price": 5.0,
    "notes": "sample string 6",
    "type": 1,
    "supply": 8,
    "filleridnumber": "sample string 9",
    "exactserving": "sample string 10",
    "numberofdoses": "sample string 11",
    "totalvolume": "sample string 12",
    "totalweight": "sample string 13",
    "totalservings": "sample string 15",
    "contents": [
      {
        "weight": 3.0,
        "name": "sample string 4",
        "activecomponent": "sample string 7",
        "idnumber": "sample string 8",
        "ingredientPrice": 9.0,
        "unit": "sample string 19"
      },
      {
        "weight": 3.0,
        "name": "sample string 4",
        "activecomponent": "sample string 7",
        "idnumber": "sample string 8",
        "ingredientPrice": 9.0,
        "unit": "sample string 19"
      }
    ],
    "locked": true,
    "isOrderable": true,
    "validateErrorMessage": "sample string 20"
  },
  {
    "id": 2,
    "name": "sample string 3",
    "dose": "sample string 4",
    "price": 5.0,
    "notes": "sample string 6",
    "type": 1,
    "supply": 8,
    "filleridnumber": "sample string 9",
    "exactserving": "sample string 10",
    "numberofdoses": "sample string 11",
    "totalvolume": "sample string 12",
    "totalweight": "sample string 13",
    "totalservings": "sample string 15",
    "contents": [
      {
        "weight": 3.0,
        "name": "sample string 4",
        "activecomponent": "sample string 7",
        "idnumber": "sample string 8",
        "ingredientPrice": 9.0,
        "unit": "sample string 19"
      },
      {
        "weight": 3.0,
        "name": "sample string 4",
        "activecomponent": "sample string 7",
        "idnumber": "sample string 8",
        "ingredientPrice": 9.0,
        "unit": "sample string 19"
      }
    ],
    "locked": true,
    "isOrderable": true,
    "validateErrorMessage": "sample string 20"
  }
]