Sample Limits Validation (POST)

Validate the samples requested during a visit against the sample limits for that account, product, and sample limit template.

Resource

1/connect/life-sciences/commercial/sample-limits-validation

Available version

65.0

HTTP methods

POST

Request body for POST

JSON example

1{
2  "sampleLimitsValidationRequest": {
3    "data": {
4      "providerVisitsData": {
5        "providerVisitData": {
6          "territory": "<ProviderVisit.Visit.Territory>",
7          "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000",
8          "productDisbursements": [
9            {
10              "productId": "2_childProduct1",
11              "productBatchItemId": "",
12              "accountId": "001XXXXXXXXXXXXAAG",
13              "quantity": 1
14            },
15            {
16              "productBatchItemId": "",
17              "productId": "2_childProduct2",
18              "quantity": 6,
19              "accountId": "001XXXXXXXXXXXXAAG"
20            }
21          ],
22          "providerVisitSampleLimitTransactions": {
23            "001XXXXXXXXXXXXAAG": [
24              {
25                "providerVisitId": "a2TXXXXXXXXXXXXEAI",
26                "limitProductId": "2_childProduct1",
27                "productId": "2_childProduct1",
28                "providerSampleLimitTemplateName": "PerYearTemplate",
29                "providerVisitRequestedSampleId": "callSample1",
30                "ProviderSampleLimitId": "sampleLimit1",
31                "quantity": "1",
32                "account": "001XXXXXXXXXXXXAAG",
33                "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000"
34              },
35              {
36                "limitProductId": "2_parentProduct1",
37                "quantity": "6",
38                "productId": "2_childProduct2",
39                "ProductDisbursementId": "callSample2",
40                "ProviderVisitId": "a2TXXXXXXXXXXXXEAI",
41                "providerSampleLimitTemplateName": "parent_template1",
42                "ProviderSampleLimitId": "defaultSampleLimit1",
43                "account": "001XXXXXXXXXXXXAAG",
44                "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000"
45              }
46            ]
47          }
48        },
49        "childProviderVisitsData": {
50          "productDisbursements": [
51            {
52              "accountId": "001XXXXXXXXXXXXAAG",
53              "productId": "2_childProduct1",
54              "productBatchItemId": "",
55              "quantity": 1
56            },
57            {
58              "accountId": "001XXXXXXXXXXXXAAG",
59              "productId": "2_childProduct1",
60              "productBatchItemId": "",
61              "quantity": 1
62            },
63            {
64              "accountId": "001XXXXXXXXXXXXAAG",
65              "productId": "2_childProduct2",
66              "productBatchItemId": "",
67              "quantity": 1
68            }
69          ],
70          "providerVisitSampleLimitTransactions": {
71            "0010p000013CLb1AAG": [
72              {
73                "providerVisitId": "a2TXXXXXXXXXXXXEAI",
74                "limitProductId": "2_childProduct1",
75                "productId": "2_childProduct1",
76                "ProductDisbursementId": "",
77                "providerVisitRequestedSampleId": "callSample3",
78                "providerSampleLimitTemplateName": "PerYearTemplate",
79                "ProviderSampleLimitId": "sampleLimit1",
80                "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000",
81                "account": "001XXXXXXXXXXXXAAG",
82                "quantity": "1"
83              },
84              {
85                "ProviderVisitId": "a2TXXXXXXXXXXXXEAI",
86                "limitProductId": "2_parentProduct1",
87                "productId": "2_childProduct2",
88                "ProductDisbursementId": "callSample4",
89                "providerVisitRequestedSampleId": "",
90                "providerSampleLimitTemplateName": "parent_template1",
91                "ProviderSampleLimitId": "defaultSampleLimit1",
92                "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000",
93                "account": "001XXXXXXXXXXXXAAG",
94                "quantity": "6"
95              }
96            ]
97          }
98        }
99      },
100      "pendingSyncData": {
101        "providerVisitSampleLimitTransactions": {
102          "001XXXXXXXXXXXXAAG": [
103            {
104              "providerVisitId": "lscpr1__call__c-639XXXXX-XXXX-XXXX-XXXX-XXXXXXXXXAEB",
105              "providerVisitRequestedSampleId": "lscpr1__callsampleorder__c-988XXXXX-XXXX-XXXX-XXXX-XXXXXXXXX1BF",
106              "ProductDisbursementId": "",
107              "limitProductId": "a5AXXXXXXXXXXXXEAU",
108              "productId": "a5AXXXXXXXXXXXXEAU",
109              "quantity": "1",
110              "visitPlannedStartTime": "2024-12-11T18:28:31.404+0000",
111              "ProviderSampleLimitId": "a5cXXXXXXXXXXXXAAE",
112              "account": "001XXXXXXXXXXXXAAG",
113              "providerSampleLimitTemplateName": "PerYearTemplate"
114            }
115          ]
116        },
117        "productDisbursements": [
118          {}
119        ]
120      }
121    },
122    "action": "validate"
123  }
124}

Properties

Name	Type	Description	Required or Optional	Available Version
`sampleLimitsValidationRequest`	SampleLimitsRequestDataInput	The payload that contains the sample limit validations to perform in JSON format.	Required	65.0

Response body for POST

Sample Limits Validation Response Output

Life Sciences Cloud Developer Guide

Sample Limits Validation (POST)