1. REST API for Clinical One Platform
  2. Tasks
  3. Randomization and Supplies
  4. Report APIs
  5. v4.0

Get Order Summary report

post

/ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/order-summary

Retrieves the Order Summary report

Request

Path Parameters
Supported Media Types
Request Body - */* ()
Root Schema : SearchSpecs
Type: object
Title: SearchSpecs
Request body passing search specs like limit, offset and list of fields
Show Source
  • fieldSpecsList
  • Minimum Value: 1
    Maximum Value: 5000
    Maximum number of records to display per page.
    Example: 50
  • Minimum Value: 0
    Maximum Value: 2147483647
    An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter
    Example: 5
Nested Schema : fieldSpecsList
Type: array
Show Source
Nested Schema : Field
Type: object
Contains field details.
Show Source
Back to Top

Response

Supported Media Types

200 Response

The result contains following attributes 1. Shipped By SDF UUID of the site/depot which shipped the shipment. E.g. '41300000900000000000000000000001' 2. Received By SDF UUID of the site/depot which received the shipment. E.g. '41300000900000000000000000000001' 3. Received By SDF ID of Country UUID of the country of the site/depot which received the shipment. E.g. '41300000900000000000000000000001' 4. Shipment ID Name of shipment. E.g. 'Hyd125' 5. Shipment Type Type of shipment. E.g. 'Resupply' 6. Shipment Status Current status of the shipment. E.g. '4' 7. Date Requested Date on which the shipment was raised. E.g. '2020-01-20' 8. Date Received Date on which the shipment was received. null if the shipment is still not received 9. Days Outstanding No. of days till the shipment was received. If the shipment is still not received, this would be equal to no. of days since the shipment was requested (current date - date requested). 10. Date Cancelled/Marked Lost Date on which the shipment was canceled. null if not available (shipment not canceled) 11. Kit Count No. of kits in the shipment. 12. Kit Numbers in Shipment Kit numbers separated by `\u7F`. E.g. "300\u7F400" Use Character.toString ((char) 0x7F) as delimiter while concatenating multiple kits 13. Tracking Number Tracking number which is assigned to the shipment 14. Received By User UUID of the user which received the shipment. E.g. '41300000900000000000000000000001' Reponse Payload : { "result": { "hasMore": "true", "totalResults": 221, "count": 1, "limit": 1, "offset": 0, "columns": [ "Shipped By SDF", "Received By SDF", "Received By SDF ID for Country", "Shipment ID", "Shipment Type", "Shipment Status", "Date Requested", "Date Received", "Days Outstanding", "Date Cancelled/Marked Lost", "Kit Count", "Kit Numbers in Shipment", "Tracking Number", "Temperature Monitor Status" "Received By User" ], "data": [ [ "09CA38D0A01145A285B2086729B4453C", "EB0F5FE4B75E4652800B90BE21521733", "EB0F5FE4B75E4652800B90BE21521733", "depo161", "Manual", "Received", "04-Jan-2022", "04-Jan-2022", "0", "", "4", "100324704780", "", "Yes" "0000000000000000000000000000000B", ] ] }, "status": "success", "errorData": null }
Body ()
Root Schema : ReportBaseResponse
Type: object
Title: ReportBaseResponse
Response Object for different report APIs.
Show Source
Nested Schema : PaginatedResponseDto
Type: object
Title: PaginatedResponseDto
Paginated Response Object for report APIs.
Show Source
Nested Schema : columns
Type: array
Names of report columns in the result set.
Show Source
  • Names of report columns in the result set.
    Example: ["UserName","UserId","SiteName","Role"]
Example:
[
    "UserName",
    "UserId",
    "SiteName",
    "Role"
]
Nested Schema : data
Type: array
Tabular data where each item is a row (array of string values in report column order).
Show Source
  • items
    Tabular data where each item is a row (array of string values in report column order).
Example:
[
    [
        "fiona.cobb@example.com",
        "8571341A98694B82B8EB3EB901C88ACD",
        "US-East",
        "Rule Designer"
    ],
    [
        "lucas.james@example.com",
        "225B79C982104415886DE02BC73C1E1E",
        "US-West",
        "Site User"
    ]
]
Nested Schema : items
Type: array
Tabular data where each item is a row (array of string values in report column order).
Show Source
  • Tabular data where each item is a row (array of string values in report column order).
    Example: [["fiona.cobb@example.com","8571341A98694B82B8EB3EB901C88ACD","US-East","Rule Designer"],["lucas.james@example.com","225B79C982104415886DE02BC73C1E1E","US-West","Site User"]]
Example:
[
    [
        "fiona.cobb@example.com",
        "8571341A98694B82B8EB3EB901C88ACD",
        "US-East",
        "Rule Designer"
    ],
    [
        "lucas.james@example.com",
        "225B79C982104415886DE02BC73C1E1E",
        "US-West",
        "Site User"
    ]
]

400 Response

Invalid search criteria
Body ()
Root Schema : ORSResponse
Type: object
Common response object.
Show Source
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
    Example: User role is missing required permission REPORTING_VIEW. Field: userId
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Result Object

404 Response

Study not found
Body ()
Root Schema : ORSResponse
Type: object
Common response object.
Show Source
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
    Example: User role is missing required permission REPORTING_VIEW. Field: userId
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Result Object

500 Response

Internal server error
Body ()
Root Schema : ORSResponse
Type: object
Common response object.
Show Source
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
    Example: User role is missing required permission REPORTING_VIEW. Field: userId
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Result Object
Back to Top