Create organization
post
/ec-site-svc/rest/v1.0/organizations
Creates organization
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
modes(required): array
modes
Unique Items Required:
true
-
orgAddressesDetails(required): array
orgAddressesDetails
Unique Items Required:
true
-
organization(required): object
OrganizationDto
-
properties: array
properties
Unique Items Required:
true
Nested Schema : OrganizationDto
Type:
Show Source
object
-
categoryType: string
(uuid)
-
categoryTypeCodeValue: string
Minimum Length:
0
Maximum Length:50
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
id: string
(uuid)
-
msa: string
Minimum Length:
0
Maximum Length:1
-
msaEnd: string
(date-time)
-
msaStart: string
(date-time)
-
name(required): string
Minimum Length:
0
Maximum Length:500
-
objectVersionNumber: number
-
orgId: string
Minimum Length:
0
Maximum Length:50
-
orgType: string
(uuid)
-
orgTypeCodeValue: string
Minimum Length:
0
Maximum Length:50
-
reason: string
Minimum Length:
0
Maximum Length:255
-
status: string
(uuid)
-
statusCodeValue: string
Minimum Length:
0
Maximum Length:50
-
subType: string
(uuid)
-
subTypeCodeValue: string
Minimum Length:
0
Maximum Length:50
-
taxId: string
Minimum Length:
0
Maximum Length:50
-
timezone: string
-
vatId: string
Minimum Length:
0
Maximum Length:50
-
versionStart: string
(date-time)
-
webUrl: string
Minimum Length:
0
Maximum Length:255
Pattern:[(http(s)?):\/\/(www\.)?a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&//=]*)
Nested Schema : ModeDto
Type:
Show Source
object
-
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
-
objectVersionNumber: number
-
reason: string
Minimum Length:
0
Maximum Length:255
-
versionStart: string
(date-time)
Nested Schema : EntityAddressAssociationDto
Type:
Show Source
object
-
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
-
objectVersionNumber: number
-
reason: string
Minimum Length:
0
Maximum Length:255
-
versionStart: string
(date-time)
Nested Schema : PropertyDto
Type:
Show Source
object
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
entityId: string
(uuid)
-
entityType: string
Minimum Length:
0
Maximum Length:50
-
id: string
(uuid)
-
objectVersionNumber: number
-
propertyName(required): string
Minimum Length:
0
Maximum Length:100
-
propertyValue(required): string
Minimum Length:
0
Maximum Length:500
-
reason: string
Minimum Length:
0
Maximum Length:255
-
versionStart: string
(date-time)
Response
Supported Media Types
- application/json
200 Response
Successful operation.
400 Response
Bad request.
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object