Skip to content

submitSampleOrders ​

Submits sample orders to SAM

Request ​

http
POST /rest/sample

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

An array of SampleOrderJSON objects each containing a 1 or more SampleOrderLineJSON i.e.

json
[
  {
    "userId": 3,
    "sampleOrderClientUUID": "SampleClientUUID11407926497144",
    "sampleOrderSubmitted": 1407926497144,
    "contactClientUUID": "SampleContact1-UUIDGARBAGE",
    "contactFirstname": "First1",
    "contactLastname": "Last1",
    "contactEmail": "contact1@whatever.com",
    "contactSignature": "ContactSignature1",
    "userSignature": "UserSignature1",
    "sampleOrderLines": [
      {
        "sampleId": 1,
        "sampleBatchNumber": "Batch#1",
        "sampleQuantity": 24,
        "sampleOrderId": null,
        "sampleOrderCreated": null,
        "sampleOrderCreatedBy": null,
        "sampleName": null,
        "sampleOrderLineId": null,
        "isScheduled": null
      },
      {
        "sampleId": 2,
        "sampleBatchNumber": "Batch#2",
        "sampleQuantity": 12,
        "sampleOrderId": null,
        "sampleOrderCreated": null,
        "sampleOrderCreatedBy": null,
        "sampleName": null,
        "sampleOrderLineId": null,
        "isScheduled": null
      }
    ]
  },
  {
    "userId": 3,
    "sampleOrderClientUUID": "SampleClientUUID21407926497145",
    "sampleOrderSubmitted": 1407926497145,
    "contactClientUUID": "SampleContact1-UUIDGARBAGE",
    "contactFirstname": "First1",
    "contactLastname": "Last1",
    "contactEmail": "contact1@whatever.com",
    "userSignature": "UserSignature2",
    "sampleOrderPosted": "Y",
    "sampleOrderPostageDate": 1407926497145,
    "sampleOrderLines": [
      {
        "sampleId": 1,
        "sampleBatchNumber": "Batch#12",
        "sampleQuantity": 36,
        "sampleOrderId": null,
        "sampleOrderCreated": null,
        "sampleOrderCreatedBy": null,
        "sampleName": null,
        "sampleOrderLineId": null,
        "isScheduled": null
      },
      {
        "sampleId": 2,
        "sampleBatchNumber": "Batch#22",
        "sampleQuantity": 8,
        "sampleOrderId": null,
        "sampleOrderCreated": null,
        "sampleOrderCreatedBy": null,
        "sampleName": null,
        "sampleOrderLineId": null,
        "isScheduled": null
      }
    ]
  }
]

Response ​

200 OK ​

Returns an array of strings representing the successfully saved sampleOrderClientUUIDs sent by the client

json
[ 
  "SampleClientUUID2-5y773002-2-3-92-0392-",
  "SampleClientUUID1-7423579863289875423689"
]

Errors ​

ExceptionDescription
WSInvalidParameterExceptionSee Error Definitions
WSInvalidAuthTokenExceptionSee Error Definitions
WSDuplicateSampleSubmittedExceptionSee Error Definitions
WSInvalidSampleDataExceptionSee Error Definitions
WSSampleServiceExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions