Jump to

• Request
• Response

Retrieve List of Existing Activities

get

/activity-service/activity

This endpoint is used to retrieve the list of all existing activities.

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : activityCollection

Type: object

Collection of activities.

Show Source

• ActivityList(optional): array ActivityList

{
    "description":"Collection of activities.",
    "type":"object",
    "properties":{
        "ActivityList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/activityModel"
            }
        }
    }
}

Nested Schema : ActivityList

Type: array

Show Source

• Array of: object activityModel
  Activity model

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

Nested Schema : activityModel

Type: object

Activity model

Show Source

• accountId(optional): string
  Account ID of the activity.
• activityDesc(optional): string
  Activity Description of the activity.
• activityId(optional): string
  Activity ID of the activity.
• activityType(optional): string
  Activity Type of the activity.
• activityTypeId(optional): string
  Activity Type ID of the activity.
• createdBy(optional): string
  Created By of the activity.
• cretDttm(optional): string
  Created date and time of the activity.
• partyId(optional): string
  Party ID of the activity.

{
    "description":"Activity model",
    "type":"object",
    "properties":{
        "activityId":{
            "description":"Activity ID of the activity.",
            "type":"string"
        },
        "activityTypeId":{
            "description":"Activity Type ID of the activity.",
            "type":"string"
        },
        "accountId":{
            "description":"Account ID of the activity.",
            "type":"string"
        },
        "partyId":{
            "description":"Party ID of the activity.",
            "type":"string"
        },
        "activityType":{
            "description":"Activity Type of the activity.",
            "type":"string"
        },
        "activityDesc":{
            "description":"Activity Description of the activity.",
            "type":"string"
        },
        "createdBy":{
            "description":"Created By of the activity.",
            "type":"string"
        },
        "cretDttm":{
            "description":"Created date and time of the activity.",
            "type":"string"
        }
    }
}

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