Regenerate order form
put
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/regenerate-order-form
Regenerates order form of a shipment by shimpment ID. Rights: BlindedKitOrderFormReportPost
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
shipmentId(required): string(uuid)
ID of the shipment.
-
studyId(required): string(uuid)
ID of the study
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Type:
Show Source
array
-
Array of:
object RegenerateOrderFormResponse
Contains details for regenerated order form
Nested Schema : RegenerateOrderFormResponse
Type:
object
Contains details for regenerated order form
Show Source
-
reportId: string
Report Id of the regenerated order formExample:
B1B8327AFAA6412287106192AB5984EF
400 Response
Invalid shipment status OR Invalid shipment type
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
404 Response
Invalid study ID OR Invalid shipment ID
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
500 Response
Internal server error
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object