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
Root Schema : schema
Type:
Show Source
object-
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
Nested Schema : ContactDto
Type:
Show Source
object-
comment: string
Minimum Length:
0Maximum Length:2048 -
contactId: string
Minimum Length:
0Maximum Length:50 -
contactType: string
(uuid)
-
degree: string
Minimum Length:
0Maximum Length:200 -
disbarmentEnd: string
(date-time)
-
disbarmentStart: string
(date-time)
-
firstName(required): string
Minimum Length:
0Maximum Length:100 -
id: string
(uuid)
-
lastName(required): string
Minimum Length:
0Maximum Length:100 -
middleName: string
Minimum Length:
0Maximum Length:100 -
objectVersionNumber: number
-
prefix: string
(uuid)
-
prefixCodeValue: string
Minimum Length:
0Maximum Length:200 -
primarySpecialityId: string
(uuid)
-
reason: string
Minimum Length:
0Maximum Length:255 -
status: string
(uuid)
-
statusCodeValue: string
Minimum Length:
0Maximum Length:200 -
suffix: string
(uuid)
-
suffixCodeValue: string
Minimum Length:
0Maximum Length:200 -
taxId: string
Minimum Length:
0Maximum Length:50 -
timezone: string
-
versionStart: string
(date-time)
Nested Schema : EntityAddressAssociationDto
Type:
Show Source
object-
addressCity: string
-
addressPostalcode(required): string
Minimum Length:
0Maximum 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:
0Maximum Length:150 -
comment: string
Minimum Length:
0Maximum Length:2048 -
country: string
(uuid)
-
countryCodeValue: string
Minimum Length:
0Maximum Length:150 -
entityId: string
(uuid)
-
entityType: string
Minimum Length:
0Maximum Length:50 -
id: string
(uuid)
-
mainPrimary: boolean
-
objectVersionNumber: number
-
reason: string
Minimum Length:
0Maximum Length:255 -
versionStart: string
(date-time)
Nested Schema : PropertyDto
Type:
Show Source
object-
comment: string
-
id: string
(uuid)
-
objectVersionNumber: number
-
operationType: string
-
propertyAttr: string
-
propertyKey: string
-
propertyStatus: string
-
propertyType: string
-
propertyValue: string
-
reason: string
-
softwareVersionNumber: number
-
userId: string
(uuid)
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
Nested Schema : ModeDto
Type:
Show Source
object-
comment: string
Minimum Length:
0Maximum Length:2048 -
entityId: string
(uuid)
-
entityType: string
Minimum Length:
0Maximum Length:50 -
id: string
(uuid)
-
mode: string
(uuid)
-
modeCodeValue: string
Minimum Length:
0Maximum Length:50 -
objectVersionNumber: number
-
reason: string
Minimum Length:
0Maximum Length:255 -
versionStart: string
(date-time)
Response
Supported Media Types
- application/json
200 Response
Successful operation.
400 Response
Bad request.
Nested Schema : result
Type:
objectNested Schema : details
Type:
object