Jump to

• Request
• Response

Retrieve List of Segments Associated with List of Account IDs

post

/api/1.0/segmentBatch/getSegmentCdAndAcctIdMapping

This endpoint is used to retrieve list of Segments associated with an list of Account IDs.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• limit(optional): integer
  Limit is maximum number of records to be fetched.
• offset(optional): integer
  Offset is starting number of records 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.
• userId: string
  The user ID of requesting user.

Body ()

Request Body that contains AccountIds List.

Root Schema : DmAccountIdsAndSegmentCodesCollection

Type: object

Collection of list of Account IDs and List of Segment Codes.

Show Source

• accountId(optional): array accountId
  List of Account IDs
• segmentCode(optional): array segmentCode
  List of Segment Codes

{
    "type":"object",
    "description":"Collection of list of Account IDs and List of Segment Codes.",
    "properties":{
        "accountId":{
            "type":"array",
            "description":"List of Account IDs",
            "items":{
                "type":"string"
            }
        },
        "segmentCode":{
            "type":"array",
            "description":"List of Segment Codes",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : accountId

Type: array

List of Account IDs

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of Account IDs",
    "items":{
        "type":"string"
    }
}

Nested Schema : segmentCode

Type: array

List of Segment Codes

Show Source

• Array of: string

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns map of accounts and Segment Code

Body ()

Root Schema : DmAccountSegmentCodeMap

Type: object

Collection of Map of Segment Code and Account.

Show Source

• segmentCdAccountMap(optional): array segmentCdAccountMap
  List of Map of Segment Code and Account.

{
    "description":"Collection of Map of Segment Code and Account.",
    "type":"object",
    "properties":{
        "segmentCdAccountMap":{
            "type":"array",
            "description":"List of Map of Segment Code and Account.",
            "items":{
                "$ref":"#/definitions/DmAccountSegmentCodePair"
            }
        }
    }
}

Nested Schema : segmentCdAccountMap

Type: array

List of Map of Segment Code and Account.

Show Source

• Array of: object DmAccountSegmentCodePair
  Map of Segment Code and Account ID.

{
    "type":"array",
    "description":"List of Map of Segment Code and Account.",
    "items":{
        "$ref":"#/definitions/DmAccountSegmentCodePair"
    }
}

Nested Schema : DmAccountSegmentCodePair

Type: object

Map of Segment Code and Account ID.

Show Source

• accountId(optional): string
  Account ID
• segmentCode(optional): array segmentCode
  Segment Code

{
    "description":"Map of Segment Code and Account ID.",
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "description":"Account ID"
        },
        "segmentCode":{
            "type":"array",
            "description":"Segment Code",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : segmentCode

Type: array

Segment Code

Show Source

• Array of: string

{
    "type":"array",
    "description":"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