REST API for Clinical One Platform

~~[Deprecated]: Update site address by site and address ID~~

put

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

Deprecated: Updates a site's address for the given SDF ID and address ID.

Request

Path Parameters

addressId(required): string

address id to update SDF address
mode(required): string

Mode of the study. Accepts active, test, or training.
sdfId(required): string

sdf id to update SDF address
studyId(required): string(uuid)

The ID of the study.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

sdfAddress: object SDFAddressDto

{
    "type":"object",
    "properties":{
        "sdfAddress":{
            "$ref":"#/components/schemas/SDFAddressDto"
        }
    }
}

Nested Schema : SDFAddressDto

Type: object

Show Source

addressCity(required): string

Minimum Length: 0

Maximum Length: 100
addressCountry(required): string

Minimum Length: 0

Maximum Length: 100
addressPostalcode(required): string

Minimum Length: 0

Maximum Length: 20
addressStateOrProvOrCounty: string

Minimum Length: 0

Maximum Length: 100
addressStreet1(required): string

Minimum Length: 0

Maximum Length: 150

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

Minimum Length: 0

Maximum Length: 150
addressType(required): string

Minimum Length: 0

Maximum Length: 100
comment: string

Minimum Length: 0

Maximum Length: 2048
email: string

Minimum Length: 0

Maximum Length: 255
fax: string

Minimum Length: 0

Maximum Length: 50
id: string (uuid)
phone: string

Minimum Length: 0

Maximum Length: 50
reason: string

Minimum Length: 0

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

{
    "required":[
        "addressCity",
        "addressCountry",
        "addressPostalcode",
        "addressStreet1",
        "addressType"
    ],
    "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"
        },
        "addressType":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "addressStreet1":{
            "maxLength":150,
            "minLength":0,
            "pattern":".*[A-z].*|.*\\p{L}+.*",
            "type":"string"
        },
        "addressStreet2":{
            "maxLength":150,
            "minLength":0,
            "type":"string"
        },
        "addressCity":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "addressStateOrProvOrCounty":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "addressPostalcode":{
            "maxLength":20,
            "minLength":0,
            "type":"string"
        },
        "addressCountry":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "fax":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        },
        "email":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "phone":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : shippingAddress

Type: object

Title: shippingAddress

Contains site/depot address.

Show Source

address: string
addressCity: string

Address city
addressCountry: string

Address country
addressCounty: string

Address county
addressPostalcode: string

Address postal code
addressStateOrProvOrCounty: string

Address state/province/county
addressStreet1: string

Address Street1 detail
addressStreet2: string

Address Street2 detail
addressType: string

Type of address name

Example: Primary/Shipping
email: string

Email Address
fax: string

Fax number
id: string (uuid)

Unique id for site/depot address
phone: string

Phone number
sdfId: string (uuid)

Unique id for site/depot
versionStart: string (date-time)

Version Start

{
    "title":"shippingAddress",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique id for site/depot address",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "description":"Unique id for site/depot",
            "format":"uuid"
        },
        "addressType":{
            "type":"string",
            "description":"Type of address name",
            "example":"Primary/Shipping"
        },
        "addressStreet1":{
            "type":"string",
            "description":"Address Street1 detail"
        },
        "addressStreet2":{
            "type":"string",
            "description":"Address Street2 detail"
        },
        "addressCity":{
            "type":"string",
            "description":"Address city"
        },
        "addressCounty":{
            "type":"string",
            "description":"Address county"
        },
        "addressStateOrProvOrCounty":{
            "type":"string",
            "description":"Address state/province/county"
        },
        "addressPostalcode":{
            "type":"string",
            "description":"Address postal code"
        },
        "addressCountry":{
            "type":"string",
            "description":"Address country"
        },
        "email":{
            "type":"string",
            "description":"Email Address"
        },
        "fax":{
            "type":"string",
            "description":"Fax number"
        },
        "phone":{
            "type":"string",
            "description":"Phone number"
        },
        "address":{
            "type":"string"
        }
    },
    "description":"Contains site/depot address."
}

400 Response

Bad request.

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