Jump to

• Request
• Response

Create contact

post

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

Creates a contact.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• contact(required): object ContactDto
• contactAddressesDetails(required): array contactAddressesDetails
  Unique Items Required: true
• modes: array modes
  Unique Items Required: true
• properties: array properties
  Unique Items Required: true

{
    "required":[
        "contact",
        "contactAddressesDetails"
    ],
    "type":"object",
    "properties":{
        "contact":{
            "$ref":"#/components/schemas/ContactDto"
        },
        "properties":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PropertyDto"
            }
        },
        "contactAddressesDetails":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EntityAddressAssociationDto"
            }
        },
        "modes":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ModeDto"
            }
        }
    }
}

Nested Schema : ContactDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• contactId: string
  Minimum Length: 0

  Maximum Length: 50
• contactType: string (uuid)
• degree: string
  Minimum Length: 0

  Maximum Length: 200
• disbarmentEnd: string (date-time)
• disbarmentStart: string (date-time)
• firstName(required): string
  Minimum Length: 0

  Maximum Length: 100
• id: string (uuid)
• lastName(required): string
  Minimum Length: 0

  Maximum Length: 100
• middleName: string
  Minimum Length: 0

  Maximum Length: 100
• prefix: string (uuid)
• prefixCodeValue: string
  Minimum Length: 0

  Maximum Length: 200
• primarySpecialityId: string (uuid)
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• status: string (uuid)
• statusCodeValue: string
  Minimum Length: 0

  Maximum Length: 200
• suffix: string (uuid)
• suffixCodeValue: string
  Minimum Length: 0

  Maximum Length: 200
• taxId: string
  Minimum Length: 0

  Maximum Length: 50
• timezone: string
• versionStart: string (date-time)

{
    "required":[
        "firstName",
        "lastName"
    ],
    "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"
        },
        "firstName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "lastName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "middleName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "suffix":{
            "type":"string",
            "format":"uuid"
        },
        "suffixCodeValue":{
            "maxLength":200,
            "minLength":0,
            "type":"string"
        },
        "prefix":{
            "type":"string",
            "format":"uuid"
        },
        "prefixCodeValue":{
            "maxLength":200,
            "minLength":0,
            "type":"string"
        },
        "status":{
            "type":"string",
            "format":"uuid"
        },
        "statusCodeValue":{
            "maxLength":200,
            "minLength":0,
            "type":"string"
        },
        "degree":{
            "maxLength":200,
            "minLength":0,
            "type":"string"
        },
        "contactId":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        },
        "timezone":{
            "type":"string"
        },
        "taxId":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        },
        "primarySpecialityId":{
            "type":"string",
            "format":"uuid"
        },
        "disbarmentStart":{
            "type":"string",
            "format":"date-time"
        },
        "disbarmentEnd":{
            "type":"string",
            "format":"date-time"
        },
        "contactType":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : contactAddressesDetails

Type: array

Unique Items Required: true

Show Source

• Array of: object EntityAddressAssociationDto

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EntityAddressAssociationDto"
    }
}

Nested Schema : modes

Type: array

Unique Items Required: true

Show Source

• Array of: object ModeDto

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ModeDto"
    }
}

Nested Schema : properties

Type: array

Unique Items Required: true

Show Source

• Array of: object PropertyDto
  CTMS Property DTO

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PropertyDto"
    }
}

Nested Schema : EntityAddressAssociationDto

Type: object

Show Source

• addressCity: string
• addressPostalcode(required): string
  Minimum Length: 0

  Maximum Length: 20
• addressProperties: array addressProperties
  Unique Items Required: true
• addressStateOrProvOrCounty: string (uuid)
• addressStateOrProvOrCountyCodeValue: string
• addressStreet1: string
• addressStreet2: string
• addressType: string (uuid)
• addressTypeCodeValue: string
  Minimum Length: 0

  Maximum Length: 150
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• country: string (uuid)
• countryCodeValue: string
  Minimum Length: 0

  Maximum Length: 150
• entityId: string (uuid)
• entityType: string
  Minimum Length: 0

  Maximum Length: 50
• id: string (uuid)
• mainPrimary: boolean
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• versionStart: string (date-time)

{
    "required":[
        "addressPostalcode"
    ],
    "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"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "mainPrimary":{
            "type":"boolean"
        },
        "entityType":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        },
        "addressType":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeCodeValue":{
            "maxLength":150,
            "minLength":0,
            "type":"string"
        },
        "country":{
            "type":"string",
            "format":"uuid"
        },
        "countryCodeValue":{
            "maxLength":150,
            "minLength":0,
            "type":"string"
        },
        "addressPostalcode":{
            "maxLength":20,
            "minLength":0,
            "type":"string"
        },
        "addressProperties":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PropertyDto"
            }
        },
        "addressStreet1":{
            "type":"string"
        },
        "addressStreet2":{
            "type":"string"
        },
        "addressCity":{
            "type":"string"
        },
        "addressStateOrProvOrCounty":{
            "type":"string",
            "format":"uuid"
        },
        "addressStateOrProvOrCountyCodeValue":{
            "type":"string"
        }
    }
}

Nested Schema : addressProperties

Type: array

Unique Items Required: true

Show Source

• Array of: object PropertyDto
  CTMS Property DTO

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PropertyDto"
    }
}

Nested Schema : PropertyDto

Type: object

CTMS Property DTO

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• entityType: string
  Minimum Length: 0

  Maximum Length: 50

  Type of the entity for which the property applies. Type can have value Organization,Contact,Facility,Institution,Investigator,Lab or Depot
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100

  Unique key name of the property.

  Example: LabId
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 500

  Value of the property.

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• reason: string
  Minimum Length: 0

  Maximum Length: 255

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "entityId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        },
        "entityType":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Type of the entity for which the property applies. Type can have value Organization,Contact,Facility,Institution,Investigator,Lab or Depot"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Unique key name of the property.",
            "example":"LabId"
        },
        "propertyValue":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":" Value of the property.",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        }
    },
    "description":"CTMS Property DTO"
}

Nested Schema : ModeDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityId: string (uuid)
• entityType: string
  Minimum Length: 0

  Maximum Length: 50
• id: string (uuid)
• mode: string (uuid)
• modeCodeValue: string
  Minimum Length: 0

  Maximum Length: 50
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• versionStart: string (date-time)

{
    "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"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "entityType":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        },
        "mode":{
            "type":"string",
            "format":"uuid"
        },
        "modeCodeValue":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

400 Response

Bad request.

Body ()

Root Schema : SDFResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top