Jump to

• Request
• Response

Get Order Summary report

post

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

Retrieves the Order Summary report

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training
• studyId(required): string(uuid)
  ID of the study

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Request body passing search specs like limit, offset and list of fields

Show Source

• fieldSpecsList: array fieldSpecsList
• limit: integer (int32)
  Minimum Value: 1

  Maximum Value: 5000

  Maximum number of records to display per page.

  Example: 50
• offset: integer (int32)
  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

{
    "type":"object",
    "properties":{
        "limit":{
            "maximum":"5000",
            "minimum":"1",
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int32",
            "example":"50"
        },
        "offset":{
            "maximum":"2147483647",
            "minimum":"0",
            "type":"integer",
            "description":"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",
            "format":"int32",
            "example":"5"
        },
        "fieldSpecsList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Field"
            }
        }
    },
    "description":"Request body passing search specs like limit, offset and list of fields"
}

Nested Schema : fieldSpecsList

Type: array

Show Source

• Array of: object Field
  Contains field details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Field"
    }
}

Nested Schema : Field

Type: object

Contains field details.

Show Source

• fieldName(required): string
  Minimum Length: 0

  Maximum Length: 255

  Field name

  Example: siteIds
• fieldSequence: integer (int32)
  Minimum Value: 0

  Field sequence

  Example: 1
• fieldType(required): string
  Minimum Length: 0

  Maximum Length: 50

  Field type

  Example: list
• fieldValueList(required): array fieldValueList

{
    "required":[
        "fieldName",
        "fieldType",
        "fieldValueList"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"Field name",
            "example":"siteIds"
        },
        "fieldType":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string",
            "description":"Field type",
            "example":"list"
        },
        "fieldSequence":{
            "minimum":"0",
            "type":"integer",
            "description":"Field sequence",
            "format":"int32",
            "example":"1"
        },
        "fieldValueList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Contains field details."
}

Nested Schema : fieldValueList

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

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

• errorData: string
  Detail of error
• result: object PaginatedResponseDto
  Paginated Response Object for report APIs.
• status: string
  Status of request

  Example: Success

{
    "title":"ReportBaseResponse",
    "type":"object",
    "properties":{
        "result":{
            "$ref":"#/components/schemas/PaginatedResponseDto"
        },
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "errorData":{
            "type":"string",
            "description":"Detail of error"
        }
    },
    "description":"Response Object for different report APIs."
}

Nested Schema : PaginatedResponseDto

Type: object

Paginated Response Object for report APIs.

Show Source

• columns: array columns
• count: integer (int32)
  Total count of result
• data: array data
• hasMore: string
  Attribute describes if result set has more records

  Example: true
• limit: integer (int32)
  Maximum number of records to display per page.
• offset: integer (int32)
  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: 400
• totalResults: integer (int32)
  Total number of entities in response

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"string",
            "description":"Attribute describes if result set has more records",
            "example":"true"
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of entities in response",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "description":"Total count of result",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "description":"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",
            "format":"int32",
            "example":"400"
        },
        "columns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "data":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    },
    "description":"Paginated Response Object for report APIs."
}

Nested Schema : columns

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: array items

{
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Invalid search criteria

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

404 Response

Study not found

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Back to Top