getSampleProductsForUser

Returns sample products for a given NI users

Request

GET /rest/sample

Headers

Header	Required	Description
x-nextinteract-authtoken	Yes	Auth token returned from loginUser

Response

200 OK

Returns an array of SampleJSON objects:

[
  {
    "productId": 3,
    "productName": "Alphagan",
    "sampleId": 1,
    "sampleName": "ALPHAGAN P® 5mL",
    "formula": "Alphagan P",
    "sampleCategory": "Glaucoma",
    "isScheduled": true,
    "quantityLimit": 25,
    "dosage": "5ml"
  },
  {
    "productId": 4,
    "productName": "Combigan",
    "sampleId": 2,
    "sampleName": "COMBIGAN® 5mL",
    "formula": "Combigan",
    "sampleCategory": "Glaucoma",
    "isScheduled": true,
    "quantityLimit": 25,
    "dosage": "5ml"
  },
  {
    "productId": 5,
    "productName": "Ganfort",
    "sampleId": 4,
    "sampleName": "GANFORT PF® 0.3/5 12x3mL",
    "formula": "Ganfort 0.3/5 PF",
    "sampleCategory": "Glaucoma",
    "isScheduled": true,
    "quantityLimit": 25,
    "dosage": "12 x 3ml"
  },
  {
    "productId": 5,
    "productName": "Ganfort",
    "sampleId": 3,
    "sampleName": "GANFORT® 0.3/5 3mL",
    "formula": "Ganfort 0.3/5",
    "sampleCategory": "Glaucoma",
    "isScheduled": true,
    "quantityLimit": 25,
    "dosage": "3ml"
  },
  {
    "productId": 6,
    "productName": "Lumigan",
    "sampleId": 5,
    "sampleName": "LUMIGAN® 3mL",
    "formula": "Lumigan",
    "sampleCategory": "Glaucoma",
    "isScheduled": true,
    "quantityLimit": 25,
    "dosage": "3ml"
  },
  {
    "productId": 6,
    "productName": "Lumigan",
    "sampleId": 6,
    "sampleName": "LUMIGAN® PF 12x3mL",
    "formula": "Lumigan PF",
    "sampleCategory": "Glaucoma",
    "isScheduled": true,
    "quantityLimit": 25,
    "dosage": "12 x 3ml"
  },
  {
    "productId": 7,
    "productName": "Optive",
    "sampleId": 8,
    "sampleName": "OPTIVE ADVANCED® 3mL",
    "formula": "Optive Advanced",
    "sampleCategory": "Dry Eye",
    "isScheduled": false,
    "quantityLimit": null,
    "dosage": "3ml"
  },
  {
    "productId": 7,
    "productName": "Optive",
    "sampleId": 7,
    "sampleName": "OPTIVE® 3mL",
    "formula": "Optive",
    "sampleCategory": "Dry Eye",
    "isScheduled": false,
    "quantityLimit": null,
    "dosage": "3ml"
  },
  {
    "productId": 7,
    "productName": "Optive",
    "sampleId": 9,
    "sampleName": "OPTIVE® SENSITIVE™ 5x0.4mL",
    "formula": "Optive Sensitive",
    "sampleCategory": "Dry Eye",
    "isScheduled": false,
    "quantityLimit": null,
    "dosage": "5 x 0.4ml"
  },
  {
    "productId": 8,
    "productName": "Refresh",
    "sampleId": 10,
    "sampleName": "REFRESH LIQUIGEL® 12x3mL",
    "formula": "Refresh Liquigel",
    "sampleCategory": "Dry Eye",
    "isScheduled": false,
    "quantityLimit": null,
    "dosage": "12 x 3ml"
  },
  {
    "productId": 8,
    "productName": "Refresh",
    "sampleId": 11,
    "sampleName": "REFRESH TEARS PLUS® 12x3mL",
    "formula": "Refresh Tears Plus",
    "sampleCategory": "Dry Eye",
    "isScheduled": false,
    "quantityLimit": null,
    "dosage": "12 x 3ml"
  }
]

Errors

Exception	Description
WSInvalidParameterException	See Error Definitions
WSInvalidAuthTokenException	See Error Definitions
WSSampleServiceException	See Error Definitions
WSCacheServiceException	See Error Definitions