Jump to

• Request
• Response

Retrieve Existing Collection Status Based on Account ID

get

/api/1.0/callActionTransactional/getExistingCollectionStatus

This endpoint is used to retrieve the existing collection status based on an account ID.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• accountId(optional): string
  The Account ID for which existing collection status to be fetched.

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure.

Headers

• Location: string
  Returns the Collection Status based on account ID.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DmAccountCollectionStatusDTO

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

Nested Schema : DmAccountCollectionStatusDTO

Type: object

Match All

Show Source

• object DmAccountCollectionStatusDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "accountID":{
                    "description":"Account ID",
                    "type":"string"
                },
                "startDate":{
                    "description":"Start Date",
                    "type":"string"
                },
                "collectionStatus":{
                    "description":"Collection Status",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : DmAccountCollectionStatusDTO-allOf[0]

Type: object

Show Source

• accountID(optional): string
  Account ID
• collectionStatus(optional): string
  Collection Status
• startDate(optional): string
  Start Date

{
    "type":"object",
    "properties":{
        "accountID":{
            "description":"Account ID",
            "type":"string"
        },
        "startDate":{
            "description":"Start Date",
            "type":"string"
        },
        "collectionStatus":{
            "description":"Collection Status",
            "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