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.
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of success or failure
Headers
-
Location: string
URL of newly created Segment
Nested Schema : DmTmStrategyDTO
Type:
Show Source
object
-
callDetails(optional):
string
Call Details
-
enabledFlag(optional):
string
Enabled Flag
-
strategyCode(optional):
string
Strategy Code
-
userAssignmentCode(optional):
string
User Assignment Code
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