Jump to

• Request
• Response

v1.0

put

/ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/kitSettings/{sdfId}

Creates, updates or removes the kit settings for the given SDF ID.

Request

Path Parameters

• mode(required): string
  Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).

  Example:

  test

• sdfId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) for a site, depot, or lab (SDF).

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• sdfType(required): string
  SDF type filter. Allowed values: site/SITE (site records), depot/DEPOT (depot records), lab/LAB (lab records), all/ALL (all supported SDF types).

  Example:

  site

• studyId(required): string(uuid)
  Study identifier as a 32-character uppercase hexadecimal UUID string.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• sdfKitSettings: array sdfKitSettings

{
    "type":"object",
    "properties":{
        "sdfKitSettings":{
            "type":"array",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/SDFKitSettingDto"
            }
        }
    }
}

Nested Schema : sdfKitSettings

Type: array

Show Source

• Array of: object SDFKitSettingDto

{
    "type":"array",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/SDFKitSettingDto"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : SDFKitSettingDto

Type: object

Show Source

• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• id: string (uuid)
• kitTypeId(required): string (uuid)
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• sdfId: string (uuid)
• settingName(required): string
  Example: PRIMARY_COUNTRY
• settingOperationType: string
• settingValue(required): string
  Example: sample
• versionStart: string (date-time)
  Example: 2026-01-15T10:30:00Z

{
    "required":[
        "kitTypeId",
        "settingName",
        "settingValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time",
            "example":"2026-01-15T10:30:00Z"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "kitTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "settingName":{
            "type":"string",
            "example":"PRIMARY_COUNTRY"
        },
        "settingValue":{
            "type":"string",
            "example":"sample"
        },
        "settingOperationType":{
            "type":"string",
            "writeOnly":true
        }
    },
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ]
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Examples

Select an example Request Example

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : SDFKitSettingsResponse

Type: object

Show Source

• sdfKitSettings: array sdfKitSettings

{
    "type":"object",
    "properties":{
        "sdfKitSettings":{
            "type":"array",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/SDFKitSettingDto"
            }
        }
    }
}

Nested Schema : sdfKitSettings

Type: array

Show Source

• Array of: object SDFKitSettingDto

{
    "type":"array",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/SDFKitSettingDto"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : SDFKitSettingDto

Type: object

Show Source

• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• id: string (uuid)
• kitTypeId(required): string (uuid)
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• sdfId: string (uuid)
• settingName(required): string
  Example: PRIMARY_COUNTRY
• settingOperationType: string
• settingValue(required): string
  Example: sample
• versionStart: string (date-time)
  Example: 2026-01-15T10:30:00Z

{
    "required":[
        "kitTypeId",
        "settingName",
        "settingValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time",
            "example":"2026-01-15T10:30:00Z"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "kitTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "settingName":{
            "type":"string",
            "example":"PRIMARY_COUNTRY"
        },
        "settingValue":{
            "type":"string",
            "example":"sample"
        },
        "settingOperationType":{
            "type":"string",
            "writeOnly":true
        }
    },
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ]
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Examples

Select an example Success Response

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.

Body ()

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

• errorData: object ErrorResponseData
• result: object result
  The result object for successful requests. Type depends on the API operation.
• status: string
  Status of the response, either 'success' or an error indication.

  Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

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

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : details

Type: object

Examples

Select an example Bad Request Response

Back to Top