Jump to

• Request
• Response

[Deprecated]: v1.0

put

/ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/address/{addressId}

Deprecated in v1: use the latest SDF API version.

Request

Path Parameters

• addressId(required): string
  Required path parameter. Address identifier to delete from the specified SDF. Accepted length: 32 to 36 characters.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

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

  Example:

  test

• sdfId(required): string
  Required path parameter. SDF identifier to update. Accepted length: 32 to 36 characters.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• 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 : SDFAddressRequest v1.0

Type: object

Title: SDFAddressRequest v1.0

Request payload that wraps an SDF address.

Show Source

• sdfAddress(required): object SDFAddressDto v1.0
  Title: SDFAddressDto v1.0

  Address metadata returned for a site or depot.

{
    "title":"SDFAddressRequest v1.0",
    "required":[
        "sdfAddress"
    ],
    "type":"object",
    "properties":{
        "sdfAddress":{
            "$ref":"#/components/schemas/SDFAddressDto"
        }
    },
    "description":"Request payload that wraps an SDF address."
}

Nested Schema : SDFAddressDto v1.0

Type: object

Title: SDFAddressDto v1.0

Address metadata returned for a site or depot.

Show Source

• addressCity(required): string
  Title: City

  Minimum Length: 0

  Maximum Length: 100

  City for the address.

  Example: Metropolis
• addressCountry(required): string
  Title: Country

  Minimum Length: 0

  Maximum Length: 100

  Country for the address.

  Example: US
• addressPostalcode(required): string
  Title: Postal Code

  Minimum Length: 0

  Maximum Length: 20

  Postal or ZIP code for the address.

  Example: 94105
• addressStateOrProvOrCounty: string
  Title: State or Province or County

  Minimum Length: 0

  Maximum Length: 100

  State, province, or county for the address.

  Example: CA
• addressStreet1(required): string
  Title: Address Street 1

  Minimum Length: 0

  Maximum Length: 150

  Pattern: .*[A-z].*|.*\p{L}+.*

  Primary street address.

  Example: 123 Primary St
• addressStreet2: string
  Title: Address Street 2

  Minimum Length: 0

  Maximum Length: 150

  Secondary street address (optional).

  Example: Suite 500
• addressType(required): string
  Title: Address Type

  Minimum Length: 0

  Maximum Length: 100

  Label describing the address type such as Primary or Shipping.

  Example: PRIMARY
• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• email: string (email)
  Title: Email

  Minimum Length: 0

  Maximum Length: 255

  Email address for the site or depot.

  Example: [e-mail]
• fax: string
  Title: Fax

  Minimum Length: 0

  Maximum Length: 50

  Fax number for the address contact.

  Example: [phone]
• id: string (uuid)
  Title: SDF Address ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the address.
• phone: string
  Title: Phone

  Minimum Length: 0

  Maximum Length: 50

  Phone number for the address contact.

  Example: [phone]
• 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)
  Title: SDF ID

  Identifier of the SDF associated with the address.
• versionStart: string (date-time)

{
    "title":"SDFAddressDto v1.0",
    "required":[
        "addressCity",
        "addressCountry",
        "addressPostalcode",
        "addressStreet1",
        "addressType"
    ],
    "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":{
            "title":"SDF Address ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the address.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "title":"SDF ID",
            "type":"string",
            "description":"Identifier of the SDF associated with the address.",
            "format":"uuid"
        },
        "addressType":{
            "title":"Address Type",
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Label describing the address type such as Primary or Shipping.",
            "example":"PRIMARY"
        },
        "addressStreet1":{
            "title":"Address Street 1",
            "maxLength":150,
            "minLength":0,
            "pattern":".*[A-z].*|.*\\p{L}+.*",
            "type":"string",
            "description":"Primary street address.",
            "example":"123 Primary St"
        },
        "addressStreet2":{
            "title":"Address Street 2",
            "maxLength":150,
            "minLength":0,
            "type":"string",
            "description":"Secondary street address (optional).",
            "example":"Suite 500"
        },
        "addressCity":{
            "title":"City",
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"City for the address.",
            "example":"Metropolis"
        },
        "addressStateOrProvOrCounty":{
            "title":"State or Province or County",
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"State, province, or county for the address.",
            "example":"CA"
        },
        "addressPostalcode":{
            "title":"Postal Code",
            "maxLength":20,
            "minLength":0,
            "type":"string",
            "description":"Postal or ZIP code for the address.",
            "example":"94105"
        },
        "addressCountry":{
            "title":"Country",
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Country for the address.",
            "example":"US"
        },
        "fax":{
            "title":"Fax",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Fax number for the address contact.",
            "example":"[phone]"
        },
        "email":{
            "title":"Email",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Email address for the site or depot.",
            "format":"email",
            "example":"[e-mail]"
        },
        "phone":{
            "title":"Phone",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Phone number for the address contact.",
            "example":"[phone]"
        }
    },
    "description":"Address metadata returned for a site or depot.",
    "example":[
        {
            "addressStreet1":"123 Primary St",
            "addressCity":"Metropolis",
            "addressCountry":"US"
        }
    ]
}

Example:

[
    {
        "addressStreet1":"123 Primary St",
        "addressCity":"Metropolis",
        "addressCountry":"US"
    }
]

Examples

Select an example Update SDF Address Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

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 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