1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Sites and Depots
  4. Contact
  5. Create contact

v1.0

post

/ec-site-svc/rest/v1.0/contacts

Creates a contact record using the provided demographic, role, and association details.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : ContactModelDto
Type: object
Title: ContactModelDto
Payload describing a contact with addresses, properties, and modes.
Show Source
Nested Schema : ContactDto
Type: object
Title: ContactDto
Represents the contact entity details.
Show Source
Example:
{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "firstName":"John",
    "lastName":"Doe"
}
Nested Schema : EntityAddressAssociationDto
Type: object
Title: EntityAddressAssociationDto
Represents an address linked to an entity.
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : ModeDto
Type: object
Title: ModeDto
Represents a mode assignment for an entity.
Show Source
Example:
[
    "test"
]
Nested Schema : PROPERTY_DTO_TITLE
Type: object
Title: PROPERTY_DTO_TITLE
PROPERTY_DTO_DESC
Show Source
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • ENTITY_ID_DESC
    Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
  • Title: PROPERTY_DTO_ENTITY_TYPE_TITLE
    Minimum Length: 0
    Maximum Length: 50
    PROPERTY_DTO_ENTITY_TYPE_DESC
    Example: INSTITUTION
  • Title: PROPERTY_DTO_NAME_TITLE
    Minimum Length: 0
    Maximum Length: 100
    PROPERTY_DTO_NAME_DESC
    Example: LabId
  • Title: PROPERTY_DTO_VALUE_TITLE
    Minimum Length: 0
    Maximum Length: 500
    PROPERTY_DTO_VALUE_DESC
    Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : PROPERTY_DTO_TITLE
Type: object
Title: PROPERTY_DTO_TITLE
PROPERTY_DTO_DESC
Show Source
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • ENTITY_ID_DESC
    Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
  • Title: PROPERTY_DTO_ENTITY_TYPE_TITLE
    Minimum Length: 0
    Maximum Length: 50
    PROPERTY_DTO_ENTITY_TYPE_DESC
    Example: INSTITUTION
  • Title: PROPERTY_DTO_NAME_TITLE
    Minimum Length: 0
    Maximum Length: 100
    PROPERTY_DTO_NAME_DESC
    Example: LabId
  • Title: PROPERTY_DTO_VALUE_TITLE
    Minimum Length: 0
    Maximum Length: 500
    PROPERTY_DTO_VALUE_DESC
    Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
Examples

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : Contacts
Type: object
Show Source
Examples

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
Nested Schema : ErrorResponseData
Type: object
Show Source
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

Back to Top