Jump to

• Request
• Response

Update sdf status for the given study id, mode id and sdf type

put

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

Updates sdf (site/depot) status for a particular study id and mode id.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts active, test, or training.
• 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

• sdfStatuses: array sdfStatuses

{
    "type":"object",
    "properties":{
        "sdfStatuses":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFUpdateStatusDto"
            }
        }
    }
}

Nested Schema : sdfStatuses

Type: array

Show Source

• Array of: object SDFUpdateStatusDto

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

Nested Schema : SDFUpdateStatusDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfId(required): string (uuid)
• statusId(required): string (uuid)
• versionStart: string (date-time)

{
    "required":[
        "sdfId",
        "statusId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "statusId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : SDFUpdateStatusResponse

Type: object

Show Source

• sdfstatuses: array sdfstatuses

{
    "type":"object",
    "properties":{
        "sdfstatuses":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFUpdateStatusDto"
            }
        }
    }
}

Nested Schema : sdfstatuses

Type: array

Show Source

• Array of: object SDFUpdateStatusDto

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

Nested Schema : SDFUpdateStatusDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfId(required): string (uuid)
• statusId(required): string (uuid)
• versionStart: string (date-time)

{
    "required":[
        "sdfId",
        "statusId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "statusId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        }
    }
}

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