Jump to

• Request
• Response

Delete User Group Identified by Given ID

delete

/api/1.0/usergroup/{id}

This endpoint is used to delete the User Group identified by given ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  Key of the User Group maintenance

Header Parameters

• appId: string
  The application ID of host service.
• branchCode: string
  The branch code of requesting branch.
• contentType(optional): string
  The content type of request or response body.
• userId: string
  The user ID of requesting user.

Body ()

Request body contain User Group and Modification number of User Group maintenance which need to be deleted

Root Schema : ModListKeyDto

Type: object

Show Source

• modNos(optional): array modNos
  Array of modification numbers.
• remarks(optional): string
  Remarks

{
    "type":"object",
    "properties":{
        "modNos":{
            "type":"array",
            "description":"Array of modification numbers.",
            "items":{
                "type":"integer"
            }
        },
        "remarks":{
            "type":"string",
            "description":"Remarks"
        }
    }
}

Nested Schema : modNos

Type: array

Array of modification numbers.

Show Source

• Array of: integer

{
    "type":"array",
    "description":"Array of modification numbers.",
    "items":{
        "type":"integer"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Deleted the User Group Identified by given ID successfully.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top