Jump to

• Request
• Response

Create kit settings by sdfId

post

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

Creates the kit settings for the given sdfId.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts active, test, or training.
• sdfId(required): string
  Unique Id to identify Site, Lab or Depot (SDF)
• sdfType(required): string
  Type of SDF : Sites or Depots.
• studyId(required): string(uuid)
  The ID of the study.

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",
            "items":{
                "$ref":"#/components/schemas/SDFKitSettingDto"
            }
        }
    }
}

Nested Schema : sdfKitSettings

Type: array

Show Source

• Array of: object SDFKitSettingDto

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

Nested Schema : SDFKitSettingDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• kitTypeId(required): string (uuid)
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfId: string (uuid)
• settingName(required): string
• settingOperationType: string
• settingValue(required): string
• versionStart: string (date-time)

{
    "required":[
        "kitTypeId",
        "settingName",
        "settingValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "kitTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "settingName":{
            "type":"string"
        },
        "settingValue":{
            "type":"string"
        },
        "settingOperationType":{
            "type":"string",
            "writeOnly":true
        }
    }
}

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",
            "items":{
                "$ref":"#/components/schemas/SDFKitSettingDto"
            }
        }
    }
}

Nested Schema : sdfKitSettings

Type: array

Show Source

• Array of: object SDFKitSettingDto

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

Nested Schema : SDFKitSettingDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• kitTypeId(required): string (uuid)
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfId: string (uuid)
• settingName(required): string
• settingOperationType: string
• settingValue(required): string
• versionStart: string (date-time)

{
    "required":[
        "kitTypeId",
        "settingName",
        "settingValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "kitTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "settingName":{
            "type":"string"
        },
        "settingValue":{
            "type":"string"
        },
        "settingOperationType":{
            "type":"string",
            "writeOnly":true
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : SDFResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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

Nested Schema : details

Type: object

Back to Top