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

Show Source

• data(optional): array data

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

Nested Schema : data

Type: array

Show Source

• Array of: object DmTmSegmentDTO

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

Nested Schema : DmTmSegmentDTO

Type: object

Show Source

• DmTmStrategyDTO(optional): array DmTmStrategyDTO
• segmentCode(optional): string

{
    "type":"object",
    "properties":{
        "segmentCode":{
            "description":"",
            "type":"string"
        },
        "DmTmStrategyDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmStrategyDTO"
            }
        }
    }
}

Nested Schema : DmTmStrategyDTO

Type: array

Show Source

• Array of: object DmTmStrategyDTO

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

Nested Schema : DmTmStrategyDTO

Type: object

Show Source

• callDetails(optional): string
  Call Details
• enabledFlag(optional): string
  Enabled Flag
• strategyCode(optional): string
  Strategy Code
• userAssignmentCode(optional): string
  User Assignment Code

{
    "type":"object",
    "properties":{
        "strategyCode":{
            "description":"Strategy Code",
            "type":"string"
        },
        "userAssignmentCode":{
            "description":"User Assignment Code",
            "type":"string"
        },
        "callDetails":{
            "description":"Call Details",
            "type":"string"
        },
        "enabledFlag":{
            "description":"Enabled Flag",
            "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