Jump to

• Request
• Response

Delete organization by ID with reason

put

/ec-site-svc/rest/v2.0/organizations/deleteOrganization/{id}

Deletes an organization by organization ID with a delete reason 'other'.

Request

Path Parameters

• id(required): string

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• commentForOther: string
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• reasonForDelete: string

{
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "reasonForDelete":{
            "type":"string"
        },
        "commentForOther":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

204 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