Jump to

• Request
• Response

v1.0

put

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

Update Ship To Address of a kit Type for all sites based on list of locally sourced countries matching site's primary country.

Request

Path Parameters

• kitTypeId(required): string
  Kit type identifier as a 32-character uppercase hexadecimal UUID string.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

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

  Example:

  test

• 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

• countries: array countries

{
    "type":"object",
    "properties":{
        "countries":{
            "type":"array",
            "example":"[\\\"B1B8327AFAA6412287106192AB5984EF\\\"]",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : countries

Type: array

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "example":"[\\\"B1B8327AFAA6412287106192AB5984EF\\\"]",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

[\"B1B8327AFAA6412287106192AB5984EF\"]

Examples

Select an example Request Example

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : SDFPrimaryCountryResponse

Type: object

Show Source

• countries: array countries

{
    "type":"object",
    "properties":{
        "countries":{
            "type":"array",
            "example":"[\\\"B1B8327AFAA6412287106192AB5984EF\\\"]",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : countries

Type: array

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "example":"[\\\"B1B8327AFAA6412287106192AB5984EF\\\"]",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

[\"B1B8327AFAA6412287106192AB5984EF\"]

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