Jump to

• Request
• Response
• Examples

Update segments for a policy

put

/PASService/rest/services/policies/{id}/segments/{segmentId}

Updates a segment based on the specified policy Id and segment Id

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Pattern: \{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?

  Policy Id
• segmentId: string
  Pattern: \{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?

  Segment Id

Body ()

Root Schema : schema

Type: string

Back to Top

Response

Supported Media Types

• application/json

Default Response

successful operation

Back to Top

Examples

This example describes how to update a segment based on the specified policy Id and segment Id.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -X PUT -H "Accept: application/json" -u username:password "server:port/PASService/rest/services/policies/B580F658-F2AC-4A73-8B0B-3BBF8BB2BC4C/segments/59AEF076-0301-414C-9808-CBACB94E4816"

Example Request Body

The following shows an example of the request body in JSON format:

"{
  "segment": {
    "multiFields": {
      
    },
    "effectiveDate": "2020-01-06T00:00:00Z",
    "roles": [
      
    ],
    "segmentId": "59AEF076-0301-414C-9808-CBACB94E4816",
    "parentSegmentId": "3857770D-1A4D-4404-A9C3-9FF4FE6E128F",
    "policyId": "B580F658-F2AC-4A73-8B0B-3BBF8BB2BC4C",
    "segmentNameId": "4B9BEB90-8B17-4FD9-B53A-3B315647A275",
    "status": "24",
    "planSegmentNameId": "A7E5E058-2455-46E9-85AB-F614EEEC0EEB",
    "segmentName": {
      "multiFields": {
        
      },
      "segmentName": "Deferred Annuity",
      "activeFromDate": "2020-01-06T00:00:00Z",
      "activeToDate": "2070-01-06T00:00:00Z",
      "planSegmentName": "Deferred  Plan",
      "segmentNameId": "4B9BEB90-8B17-4FD9-B53A-3B315647A275",
      "planId": "51673985-8606-4ABF-9EEE-85328BE03DA5",
      "productId": "5108BB0B-C075-4807-AE60-F4C14B26C4AA",
      "type": "05",
      "status": "01"
    },
    "RebalanceFrequency": {
      "textValue": "01",
      "optionText": "Annual"
    },
    "SWPEndDate": {
      
    },
    "SystematicWithdrawalProgram": {
      "textValue": "00",
      "optionText": "No"
    },
    "RebalanceProgram": {
      "textValue": "00",
      "optionText": "No"
    },
    "APPFrequency": {
      "textValue": "01",
      "optionText": "Annual"
    },
    "StartDate": "2010-01-01T00:00:00Z",
    "JointLifeSurvivorBenefit": {
      "textValue": "00",
      "optionText": "N/A"
    },
    "OwnerAge": 18,
    "SWPPaymentType": {
      "textValue": "01",
      "optionText": "Check"
    },
    "SegmentDate59Half": "2051-07-01T00:00:00Z",
    "SWPFrequency": {
      "textValue": "01",
      "optionText": "Annual"
    }
  }
}"

Back to Top