Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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

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

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 : orgAddressesDetails

Type: array

Unique Items Required: true

Show Source

• Array of: object EntityAddressAssociationDto

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

Nested Schema : OrganizationDto

Type: object

Show Source

• 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@:%_\+.~#?&//=]*)

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "name":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string"
        },
        "status":{
            "type":"string",
            "format":"uuid"
        },
        "statusCodeValue":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "timezone":{
            "type":"string"
        },
        "msaStart":{
            "type":"string",
            "format":"date-time"
        },
        "msaEnd":{
            "type":"string",
            "format":"date-time"
        },
        "orgType":{
            "type":"string",
            "format":"uuid"
        },
        "orgTypeCodeValue":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "categoryType":{
            "type":"string",
            "format":"uuid"
        },
        "categoryTypeCodeValue":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "orgId":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "subType":{
            "type":"string",
            "format":"uuid"
        },
        "subTypeCodeValue":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "msa":{
            "maxLength":"1",
            "minLength":"0",
            "type":"string"
        },
        "taxId":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "vatId":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "webUrl":{
            "maxLength":"255",
            "minLength":"0",
            "pattern":"[(http(s)?):\\/\\/(www\\.)?a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&//=]*)",
            "type":"string"
        }
    }
}

Nested Schema : properties

Type: array

Unique Items Required: true

Show Source

• Array of: object PropertyDto

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

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
• objectVersionNumber: number
• 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"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "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"
        }
    }
}

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
• objectVersionNumber: number
• 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"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "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"
            }
        },
        "addressStateOrProvOrCountyCodeValue":{
            "type":"string"
        },
        "addressStateOrProvOrCounty":{
            "type":"string",
            "format":"uuid"
        },
        "addressCity":{
            "type":"string"
        },
        "addressStreet1":{
            "type":"string"
        },
        "addressStreet2":{
            "type":"string"
        }
    }
}

Nested Schema : addressProperties

Type: array

Unique Items Required: true

Show Source

• Array of: object PropertyDto

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

Nested Schema : PropertyDto

Type: object

Show Source

• 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)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "propertyType":{
            "type":"string"
        },
        "propertyKey":{
            "type":"string"
        },
        "propertyValue":{
            "type":"string"
        },
        "propertyAttr":{
            "type":"string"
        },
        "propertyStatus":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        }
    }
}

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
• result: object result
• status: string

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

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

Nested Schema : details

Type: object

Back to Top