Jump to

• Request
• Response

v1.0

get

/ec-site-svc/rest/v1.0/tenantsite/associations/{associationId}/addresses

Get addresses of tenant first entity for the passed association ID. However if passed ID belongs to INVESTIGATOR_INSTITUTION association, then it will return both tenant first entity and tenant second entity addresses.

Request

Path Parameters

• associationId(required): string
  Association identifier between tenant first entity and tenant second entity.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : ENTITY_ADDRESS_ASSOCIATION_RESPONSE_TITLE

Type: object

Title: ENTITY_ADDRESS_ASSOCIATION_RESPONSE_TITLE

ENTITY_ADDRESS_ASSOCIATION_RESPONSE_DESC

Show Source

• entityAddressAssociations: object EntityAddressAssociationDto
  Title: EntityAddressAssociationDto

  Represents an address linked to an entity.

{
    "title":"ENTITY_ADDRESS_ASSOCIATION_RESPONSE_TITLE",
    "type":"object",
    "properties":{
        "entityAddressAssociations":{
            "title":"EntityAddressAssociationDto",
            "required":[
                "addressPostalcode"
            ],
            "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":"Address Association ID",
                    "type":"string",
                    "description":"Unique identifier for the entity address association.",
                    "format":"uuid"
                },
                "versionStart":{
                    "type":"string",
                    "format":"date-time"
                },
                "entityId":{
                    "title":"Entity ID",
                    "type":"string",
                    "description":"Identifier of the entity owning the address.",
                    "format":"uuid"
                },
                "mainPrimary":{
                    "title":"Main Primary Flag",
                    "type":"boolean",
                    "description":"Indicates if this is the main primary address.",
                    "example":true
                },
                "entityType":{
                    "title":"Entity Type",
                    "maxLength":50,
                    "minLength":0,
                    "type":"string",
                    "description":"Type of entity for the address.",
                    "example":"Contact"
                },
                "addressType":{
                    "title":"Address Type",
                    "type":"string",
                    "description":"Identifier for the address type.",
                    "format":"uuid"
                },
                "addressTypeCodeValue":{
                    "title":"Address Type Code",
                    "maxLength":150,
                    "minLength":0,
                    "type":"string",
                    "description":"Display value for the address type.",
                    "example":"Primary"
                },
                "country":{
                    "title":"Country ID",
                    "type":"string",
                    "description":"Identifier for the country.",
                    "format":"uuid"
                },
                "countryCodeValue":{
                    "title":"Country Code",
                    "maxLength":150,
                    "minLength":0,
                    "type":"string",
                    "description":"Display value for the country code.",
                    "example":"USA"
                },
                "addressPostalcode":{
                    "title":"Postal Code",
                    "maxLength":20,
                    "minLength":0,
                    "type":"string",
                    "description":"Postal code for the address.",
                    "example":"80202"
                },
                "addressProperties":{
                    "title":"PROPERTY_DTO_TITLE",
                    "required":[
                        "propertyName",
                        "propertyValue"
                    ],
                    "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."
                        },
                        "entityId":{
                            "type":"string",
                            "description":"ENTITY_ID_DESC",
                            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                        },
                        "entityType":{
                            "title":"PROPERTY_DTO_ENTITY_TYPE_TITLE",
                            "maxLength":50,
                            "minLength":0,
                            "type":"string",
                            "description":"PROPERTY_DTO_ENTITY_TYPE_DESC",
                            "example":"INSTITUTION"
                        },
                        "propertyName":{
                            "title":"PROPERTY_DTO_NAME_TITLE",
                            "maxLength":100,
                            "minLength":0,
                            "type":"string",
                            "description":"PROPERTY_DTO_NAME_DESC",
                            "example":"LabId"
                        },
                        "propertyValue":{
                            "title":"PROPERTY_DTO_VALUE_TITLE",
                            "maxLength":500,
                            "minLength":0,
                            "type":"string",
                            "description":"PROPERTY_DTO_VALUE_DESC",
                            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                        }
                    },
                    "description":"PROPERTY_DTO_DESC"
                },
                "addressStreet1":{
                    "type":"string"
                },
                "addressStreet2":{
                    "type":"string"
                },
                "addressCity":{
                    "type":"string"
                },
                "addressStateOrProvOrCounty":{
                    "type":"string",
                    "format":"uuid"
                },
                "addressStateOrProvOrCountyCodeValue":{
                    "type":"string"
                }
            },
            "description":"Represents an address linked to an entity.",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ]
        }
    },
    "description":"ENTITY_ADDRESS_ASSOCIATION_RESPONSE_DESC"
}

Nested Schema : EntityAddressAssociationDto

Type: object

Title: EntityAddressAssociationDto

Represents an address linked to an entity.

Show Source

• addressCity: string
• addressPostalcode(required): string
  Title: Postal Code

  Minimum Length: 0

  Maximum Length: 20

  Postal code for the address.

  Example: 80202
• addressProperties: object PROPERTY_DTO_TITLE
  Title: PROPERTY_DTO_TITLE

  PROPERTY_DTO_DESC
• addressStateOrProvOrCounty: string (uuid)
• addressStateOrProvOrCountyCodeValue: string
• addressStreet1: string
• addressStreet2: string
• addressType: string (uuid)
  Title: Address Type

  Identifier for the address type.
• addressTypeCodeValue: string
  Title: Address Type Code

  Minimum Length: 0

  Maximum Length: 150

  Display value for the address type.

  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.
• country: string (uuid)
  Title: Country ID

  Identifier for the country.
• countryCodeValue: string
  Title: Country Code

  Minimum Length: 0

  Maximum Length: 150

  Display value for the country code.

  Example: USA
• entityId: string (uuid)
  Title: Entity ID

  Identifier of the entity owning the address.
• entityType: string
  Title: Entity Type

  Minimum Length: 0

  Maximum Length: 50

  Type of entity for the address.

  Example: Contact
• id: string (uuid)
  Title: Address Association ID

  Unique identifier for the entity address association.
• mainPrimary: boolean
  Title: Main Primary Flag

  Indicates if this is the main primary address.

  Example: true
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• versionStart: string (date-time)

{
    "title":"EntityAddressAssociationDto",
    "required":[
        "addressPostalcode"
    ],
    "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":"Address Association ID",
            "type":"string",
            "description":"Unique identifier for the entity address association.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "entityId":{
            "title":"Entity ID",
            "type":"string",
            "description":"Identifier of the entity owning the address.",
            "format":"uuid"
        },
        "mainPrimary":{
            "title":"Main Primary Flag",
            "type":"boolean",
            "description":"Indicates if this is the main primary address.",
            "example":true
        },
        "entityType":{
            "title":"Entity Type",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Type of entity for the address.",
            "example":"Contact"
        },
        "addressType":{
            "title":"Address Type",
            "type":"string",
            "description":"Identifier for the address type.",
            "format":"uuid"
        },
        "addressTypeCodeValue":{
            "title":"Address Type Code",
            "maxLength":150,
            "minLength":0,
            "type":"string",
            "description":"Display value for the address type.",
            "example":"Primary"
        },
        "country":{
            "title":"Country ID",
            "type":"string",
            "description":"Identifier for the country.",
            "format":"uuid"
        },
        "countryCodeValue":{
            "title":"Country Code",
            "maxLength":150,
            "minLength":0,
            "type":"string",
            "description":"Display value for the country code.",
            "example":"USA"
        },
        "addressPostalcode":{
            "title":"Postal Code",
            "maxLength":20,
            "minLength":0,
            "type":"string",
            "description":"Postal code for the address.",
            "example":"80202"
        },
        "addressProperties":{
            "title":"PROPERTY_DTO_TITLE",
            "required":[
                "propertyName",
                "propertyValue"
            ],
            "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."
                },
                "entityId":{
                    "type":"string",
                    "description":"ENTITY_ID_DESC",
                    "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                },
                "entityType":{
                    "title":"PROPERTY_DTO_ENTITY_TYPE_TITLE",
                    "maxLength":50,
                    "minLength":0,
                    "type":"string",
                    "description":"PROPERTY_DTO_ENTITY_TYPE_DESC",
                    "example":"INSTITUTION"
                },
                "propertyName":{
                    "title":"PROPERTY_DTO_NAME_TITLE",
                    "maxLength":100,
                    "minLength":0,
                    "type":"string",
                    "description":"PROPERTY_DTO_NAME_DESC",
                    "example":"LabId"
                },
                "propertyValue":{
                    "title":"PROPERTY_DTO_VALUE_TITLE",
                    "maxLength":500,
                    "minLength":0,
                    "type":"string",
                    "description":"PROPERTY_DTO_VALUE_DESC",
                    "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                }
            },
            "description":"PROPERTY_DTO_DESC"
        },
        "addressStreet1":{
            "type":"string"
        },
        "addressStreet2":{
            "type":"string"
        },
        "addressCity":{
            "type":"string"
        },
        "addressStateOrProvOrCounty":{
            "type":"string",
            "format":"uuid"
        },
        "addressStateOrProvOrCountyCodeValue":{
            "type":"string"
        }
    },
    "description":"Represents an address linked to an entity.",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ]
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : PROPERTY_DTO_TITLE

Type: object

Title: PROPERTY_DTO_TITLE

PROPERTY_DTO_DESC

Show Source

• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• entityId: string
  ENTITY_ID_DESC

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• entityType: string
  Title: PROPERTY_DTO_ENTITY_TYPE_TITLE

  Minimum Length: 0

  Maximum Length: 50

  PROPERTY_DTO_ENTITY_TYPE_DESC

  Example: INSTITUTION
• propertyName(required): string
  Title: PROPERTY_DTO_NAME_TITLE

  Minimum Length: 0

  Maximum Length: 100

  PROPERTY_DTO_NAME_DESC

  Example: LabId
• propertyValue(required): string
  Title: PROPERTY_DTO_VALUE_TITLE

  Minimum Length: 0

  Maximum Length: 500

  PROPERTY_DTO_VALUE_DESC

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.

{
    "title":"PROPERTY_DTO_TITLE",
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "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."
        },
        "entityId":{
            "type":"string",
            "description":"ENTITY_ID_DESC",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        },
        "entityType":{
            "title":"PROPERTY_DTO_ENTITY_TYPE_TITLE",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"PROPERTY_DTO_ENTITY_TYPE_DESC",
            "example":"INSTITUTION"
        },
        "propertyName":{
            "title":"PROPERTY_DTO_NAME_TITLE",
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"PROPERTY_DTO_NAME_DESC",
            "example":"LabId"
        },
        "propertyValue":{
            "title":"PROPERTY_DTO_VALUE_TITLE",
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"PROPERTY_DTO_VALUE_DESC",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        }
    },
    "description":"PROPERTY_DTO_DESC"
}

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