Jump to

• Request
• Response

Get Existing Created Flag Details or Create/Update Flag Details for Particular Task

put

/api/1.0/taskSummary/flaggedTasks

This endpoint is used to get/create/update/delete flag Details by Account ID and Task ID.

Request

Supported Media Types

• application/json
• application/xml

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.
• entityId: string
  The entity ID
• userId: string
  The user ID of requesting user.

Body ()

Request Body contain data required for fetching task summary details for task tab.

Root Schema : DmFlaggedTaskDTO

Type: object

Data Transer Object for Flagged Tasks Details.

Show Source

• flag(optional): string
  Flag
• taskId(optional): string
  Task ID
• userId(optional): string
  User ID

{
    "description":"Data Transer Object for Flagged Tasks Details.",
    "type":"object",
    "properties":{
        "taskId":{
            "type":"string",
            "description":"Task ID"
        },
        "userId":{
            "type":"string",
            "description":"User ID"
        },
        "flag":{
            "type":"string",
            "description":"Flag"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Return Task Flag Status.

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.

405 Response

Invalid input.

500 Response

Internal error.

Back to Top