Jump to

• Request
• Response

Get All Valid Segments

get

/api/1.0/segment

This endpoint is used to get all valid Segment Maintenance Records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• authStat(optional): string
  Authorization Status that needs to be fetched.
• groupingBasis(optional): string
  Grouping Basis that needs to be fetched.
• ignoreGroupBasisFlag(optional): string
  Ignore Group Basis Flag that needs to be fetched.
• includecloseandunauth(optional): boolean
  Include close and unauthorized value need to be provided to fetch summary record, default value is false.
• limit(optional): integer
  Limit is maximum number of records to be fetched.
• offset(optional): integer
  Offset is starting number of records to be fetched.
• productProcessorCd(optional): string
  Product Processor Code that needs to be fetched.
• recordStat(optional): string
  Record Status that needs to be fetched.
• segmentCd(optional): string
  Segment Code that needs to be fetched.
• segmentDescription(optional): string
  Segment Description that needs 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.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string
  URL of newly created Segment

Body ()

Root Schema : DmTmSegmentCollection

Type: object

Collection of Segment

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of Segment",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmSegmentDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object DmTmSegmentDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer
  Total number of results available.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Total number of results available."
        }
    }
}

Nested Schema : DmTmSegmentDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object DmTmSegmentDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "segmentDescription":{
                    "description":"Segment Description",
                    "type":"string"
                },
                "productProcessorCd":{
                    "description":"Product Processor Code",
                    "type":"string"
                },
                "groupingBasis":{
                    "description":"Grouping Basis",
                    "type":"string"
                },
                "ignoreGroupBasisFlag":{
                    "description":"Ignore Group Basis Flag",
                    "type":"boolean"
                },
                "segmentCd":{
                    "description":"Segment Code",
                    "type":"string"
                },
                "effectiveDt":{
                    "description":"Effective Date",
                    "type":"string"
                },
                "expiryDt":{
                    "description":"Expiry Date",
                    "type":"string"
                },
                "DmTmStrategyDTO":{
                    "type":"array",
                    "description":"List of Strategy",
                    "items":{
                        "$ref":"#/definitions/DmTmStrategyDTO"
                    }
                },
                "DmTmSelectionCriteriaDTO":{
                    "type":"array",
                    "description":"List of Rule",
                    "items":{
                        "$ref":"#/definitions/DmTmSelectionCriteriaDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : DmTmSegmentDTO-allOf[1]

Type: object

Show Source

• DmTmSelectionCriteriaDTO(optional): array DmTmSelectionCriteriaDTO
  List of Rule
• DmTmStrategyDTO(optional): array DmTmStrategyDTO
  List of Strategy
• effectiveDt(optional): string
  Effective Date
• expiryDt(optional): string
  Expiry Date
• groupingBasis(optional): string
  Grouping Basis
• ignoreGroupBasisFlag(optional): boolean
  Ignore Group Basis Flag
• productProcessorCd(optional): string
  Product Processor Code
• segmentCd(optional): string
  Segment Code
• segmentDescription(optional): string
  Segment Description

{
    "type":"object",
    "properties":{
        "segmentDescription":{
            "description":"Segment Description",
            "type":"string"
        },
        "productProcessorCd":{
            "description":"Product Processor Code",
            "type":"string"
        },
        "groupingBasis":{
            "description":"Grouping Basis",
            "type":"string"
        },
        "ignoreGroupBasisFlag":{
            "description":"Ignore Group Basis Flag",
            "type":"boolean"
        },
        "segmentCd":{
            "description":"Segment Code",
            "type":"string"
        },
        "effectiveDt":{
            "description":"Effective Date",
            "type":"string"
        },
        "expiryDt":{
            "description":"Expiry Date",
            "type":"string"
        },
        "DmTmStrategyDTO":{
            "type":"array",
            "description":"List of Strategy",
            "items":{
                "$ref":"#/definitions/DmTmStrategyDTO"
            }
        },
        "DmTmSelectionCriteriaDTO":{
            "type":"array",
            "description":"List of Rule",
            "items":{
                "$ref":"#/definitions/DmTmSelectionCriteriaDTO"
            }
        }
    }
}

Nested Schema : DmTmSelectionCriteriaDTO

Type: array

List of Rule

Show Source

• Array of: object DmTmSelectionCriteriaDTO

{
    "type":"array",
    "description":"List of Rule",
    "items":{
        "$ref":"#/definitions/DmTmSelectionCriteriaDTO"
    }
}

Nested Schema : DmTmStrategyDTO

Type: array

List of Strategy

Show Source

• Array of: object DmTmStrategyDTO

{
    "type":"array",
    "description":"List of Strategy",
    "items":{
        "$ref":"#/definitions/DmTmStrategyDTO"
    }
}

Nested Schema : DmTmSelectionCriteriaDTO

Type: object

Show Source

• id(optional): string
  ID
• ruleCode(optional): string
  Rule Code
• segmentMasterId(optional): string
  Segment Master ID

{
    "type":"object",
    "properties":{
        "ruleCode":{
            "description":"Rule Code",
            "type":"string"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "segmentMasterId":{
            "type":"string",
            "description":"Segment Master ID"
        }
    }
}

Nested Schema : DmTmStrategyDTO

Type: object

Show Source

• callDetails(optional): string
  Call Details
• enabledFlag(optional): boolean
  Enabled Flag
• id(optional): string
  ID
• segmentMasterId(optional): string
  Segment Master ID
• seqNo(optional): integer
  Minimum Value: 0

  Maximum Value: 999

  Seq Number
• strategyCode(optional): string
  Strategy Code
• userAssignmentCode(optional): string
  User Assignment Code

{
    "type":"object",
    "properties":{
        "seqNo":{
            "description":"Seq Number",
            "type":"integer",
            "minimum":0,
            "maximum":999
        },
        "strategyCode":{
            "description":"Strategy Code",
            "type":"string"
        },
        "userAssignmentCode":{
            "description":"User Assignment Code",
            "type":"string"
        },
        "callDetails":{
            "description":"Call Details",
            "type":"string"
        },
        "enabledFlag":{
            "description":"Enabled Flag",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "segmentMasterId":{
            "type":"string",
            "description":"Segment Master ID"
        }
    }
}

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