Jump to

• Request
• Response

Retrieve Segment Based on Account ID

get

/api/1.0/segmentBatch/getSegmentCdByAcctId

This endpoint is used to retrieve the Segment based on Account ID.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• acctId: string
  The account ID used to fetch the Segment.

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

201 Response

Returns message of success or failure

Body ()

Root Schema : DmSegmentCodeList

Type: object

Collection list of Segment Codes

Show Source

• segmentCds(optional): array segmentCds
  List of Segment Code

{
    "description":"Collection list of Segment Codes",
    "type":"object",
    "properties":{
        "segmentCds":{
            "type":"array",
            "description":"List of Segment Code",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : segmentCds

Type: array

List of Segment Code

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of Segment Code",
    "items":{
        "type":"string"
    }
}

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