Edit collected sample details

POST

/projects/{projectId}/samples/{sampleId}/edit-details

Authorizations

• bearer

Parameters

Path Parameters

projectId

required

string

Project UUID

sampleId

required

string

Sample UUID

Request Body ^required

object

barcode

Visible sample identifier / barcode

string

collectedBy

User UUID of the collector

string format: uuid

collectionTime

Sample collection date/time

string

Responses

201

object

success

required

boolean

message

required

string

data

required

object

replicates

string

Allowed values: available not collected

sampleStatus

required

string

Allowed values: pending picked-up received pre-processed virus-isolation extracted tested rejected test-report-generated

barcode

required

string

id

required

string

sampleCode

string

nullable

collectedAt

required

string format: date-time

quantity

number

nullable

unit

string

nullable

habitat

string

nullable

conc

string

nullable

collectionTime

required

string format: date-time

photos

required

Array<string>

comment

string

nullable

rejectReason

string

nullable

receivedAt

string format: date-time

nullable

receivedVolumeValue

string

nullable

receivedVolumeUnit

string

nullable

receivedLabStorageDetails

string

nullable

extractionDateTime

string format: date-time

nullable

extractionSampleUsedValue

string

nullable

extractionSampleUsedUnit

string

nullable

extractionSampleRemainingValue

string

nullable

extractionSampleRemainingUnit

string

nullable

extractionComments

string

nullable

receivedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

extractedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

collectedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

reportGeneratedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

project

object

id

required

string

name

required

string

code

required

string

site

object

collectionDayOfWeek

Array<string>

nullable

Allowed values: Sunday Monday Tuesday Wednesday Thursday Friday Saturday

collectionStartDate

The date when collection visits should start

string format: date-time

nullable

Example

2026-01-16

farmType

Type of farm/site based on the disease (e.g. Poultry Farm, Wetland, Cattle Farm)

string

nullable

Example

poultry_farm

siteSubType

Sub-type of the farm/site (e.g. Broiler, Breeder, Layer, Backyard)

string

nullable

Example

broiler

siteType

string

Allowed values: private government corporate

id

required

string

name

required

string

siteCode

string

nullable

collectionConsent

string

nullable

collectionFrequencyInterval

number

nullable

collectionFrequency

number

nullable

collectionTime

string

nullable

collectionLastScheduleDate

string format: date-time

nullable

collectionDuration

number

nullable

collectionExpiryDate

string format: date-time

photos

Array<string>

nullable

siteOwnerName

string

nullable

siteOwnerNumber

string

nullable

workerNumber

number

nullable

address

string

nullable

pinCode

number

nullable

comment

string

nullable

createdAt

required

string format: date-time

diseases

required

Array<object>

object

id

required

string

code

required

string

name

required

string

shortName

required

string

index

required

number

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

status

string

nullable

Allowed values: active inactive deleted

collectionCollector

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

createdBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

team

object

id

required

string

teamName

string

nullable

address

string

nullable

logo

string

nullable

location

object

id

required

string

coordinates

object

coordinates

required

Array<number>

type

required

string

region

object

id

required

string

regionType

required

string

Allowed values: country state district subdistrict city

lgdCode

string

nullable

localName

required

string

name

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

parentRegion

object

id

required

string

regionType

required

string

Allowed values: country state district subdistrict city

lgdCode

string

nullable

localName

required

string

name

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

diseases

Array<object>

object

id

required

string

code

required

string

name

required

string

shortName

required

string

index

required

number

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

status

string

nullable

Allowed values: active inactive deleted

team

object

id

required

string

teamName

string

nullable

address

string

nullable

logo

string

nullable

location

object

id

required

string

coordinates

object

coordinates

required

Array<number>

type

required

string

region

object

id

required

string

regionType

required

string

Allowed values: country state district subdistrict city

lgdCode

string

nullable

localName

required

string

name

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

parentRegion

object

id

required

string

regionType

required

string

Allowed values: country state district subdistrict city

lgdCode

string

nullable

localName

required

string

name

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

visit

object

visitStartedAt

Timestamp when the collector opened the page

string format: date-time

nullable

visitStatus

required

string

Allowed values: upcoming overdue skipped completed

id

required

string

visitedAt

string format: date-time

nullable

visitScheduledAt

required

string format: date-time

comment

string

isCompleted

required

boolean

rescheduledFrom

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

visitedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

collector

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

labTests

Array<object>

object

testResult

string

Allowed values: pending positive negative unclear

id

required

string

ctValue

string

nullable

variant

string

nullable

viralLoad

string

nullable

kitOrProtocol

string

nullable

labComment

string

nullable

resultDate

string format: date-time

nullable

resultComment

string

nullable

testResultReport

string

nullable

testedAt

string format: date-time

nullable

project

object

id

required

string

name

required

string

code

required

string

sample

object

replicates

string

Allowed values: available not collected

sampleStatus

required

string

Allowed values: pending picked-up received pre-processed virus-isolation extracted tested rejected test-report-generated

barcode

required

string

id

required

string

sampleCode

string

nullable

collectedAt

required

string format: date-time

quantity

number

nullable

unit

string

nullable

habitat

string

nullable

conc

string

nullable

collectionTime

required

string format: date-time

photos

required

Array<string>

comment

string

nullable

rejectReason

string

nullable

receivedAt

string format: date-time

nullable

receivedVolumeValue

string

nullable

receivedVolumeUnit

string

nullable

receivedLabStorageDetails

string

nullable

extractionDateTime

string format: date-time

nullable

extractionSampleUsedValue

string

nullable

extractionSampleUsedUnit

string

nullable

extractionSampleRemainingValue

string

nullable

extractionSampleRemainingUnit

string

nullable

extractionComments

string

nullable

receivedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

extractedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

collectedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

reportGeneratedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

originalSampleId

string

nullable

disease

object

id

required

string

code

required

string

name

required

string

shortName

required

string

index

required

number

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

status

string

nullable

Allowed values: active inactive deleted

testedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

hasAI

boolean

originalSampleId

string

nullable