getSampleOrderHistory

Returns sample order history for a given NI user and contact HCP. Can optionally return a SINGLE order

Request

GET /rest/sample/history

Headers

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

Parameters

Parameter	Type	Required	Description
contactId	-	No	contactId of a contact in SAM. Either contactId or contactUUID must be provided.
contactUUID	-	No	The UUID of a contact created locally on client that is NOT in SAM. Either contactId or contactUUID must be provided.
sampleOrderId	-	No	Sample order id of a specific order
maxOrders	-	No	The maximum number of last order dates to return. Defaults to 100 if no value sent.

Response

200 OK

Returns an array of SampleOrderJSON objects:

[
  {
    "companyId": 1,
    "userId": 3,
    "contactFirstname": "First1",
    "contactLastname": "Last1",
    "sampleOrderSubmitted": 1407114348446,
    "contactSignature": "ContactSignature2",
    "userSignature": "UserSignature2",
    "sampleOrderLines": [
      {
        "sampleId": 1,
        "sampleBatchNumber": "Batch#12",
        "sampleName": "ALPHAGAN P® 5mL",
        "sampleOrderId": 2,
        "sampleOrderLineId": 4,
        "isScheduled": true,
        "sampleQuantity": 36,
        "sampleOrderCreated": 1407114348743,
        "sampleOrderCreatedBy": "3"
      },
      {
        "sampleId": 2,
        "sampleBatchNumber": "Batch#22",
        "sampleName": "COMBIGAN® 5mL",
        "sampleOrderId": 2,
        "sampleOrderLineId": 3,
        "isScheduled": true,
        "sampleQuantity": 8,
        "sampleOrderCreated": 1407114348743,
        "sampleOrderCreatedBy": "3"
      }
    ],
    "sampleOrderId": 2,
    "contactEmail": "contact1@whatever.com",
    "sampleOrderCreated": 1407114348743,
    "sampleOrderCreatedBy": "3",
    "sampleOrderClientUUID": "SampleClientUUID21407114348446",
    "contactClientUUID": "SampleContact1-UUIDGARBAGE"
  },
  {
    "companyId": 1,
    "userId": 3,
    "contactFirstname": "First1",
    "contactLastname": "Last1",
    "sampleOrderSubmitted": 1407114348445,
    "contactSignature": "ContactSignature1",
    "userSignature": "UserSignature1",
    "sampleOrderLines": [
      {
        "sampleId": 1,
        "sampleBatchNumber": "Batch#1",
        "sampleName": "ALPHAGAN P® 5mL",
        "sampleOrderId": 1,
        "sampleOrderLineId": 2,
        "isScheduled": true,
        "sampleQuantity": 24,
        "sampleOrderCreated": 1407114348611,
        "sampleOrderCreatedBy": "3"
      },
      {
        "sampleId": 2,
        "sampleBatchNumber": "Batch#2",
        "sampleName": "COMBIGAN® 5mL",
        "sampleOrderId": 1,
        "sampleOrderLineId": 1,
        "isScheduled": true,
        "sampleQuantity": 12,
        "sampleOrderCreated": 1407114348611,
        "sampleOrderCreatedBy": "3"
      }
    ],
    "sampleOrderId": 1,
    "contactEmail": "contact1@whatever.com",
    "sampleOrderCreated": 1407114348611,
    "sampleOrderCreatedBy": "3",
    "sampleOrderClientUUID": "SampleClientUUID11407114348445",
    "contactClientUUID": "SampleContact1-UUIDGARBAGE"
  }
]

Errors

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