Get list of plan slices by plan Id

get

/PASService/rest/services/v1/plans/{planId}/planslices

Gets plan slices based on the specified plan Id.

Request

Path Parameters
Query Parameters
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY.

There's no request body for this operation.

Back to Top

Response

200 Response

This operation fetches list of plan slices by plan Id successfully.
Back to Top

Examples

This example describes how to get a plan slices based on the specified plan Id.

Example cURL Command

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

curl \
    -X GET \
    -H "Content-Type: application/json" \
    -u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \ 
    -L "http://server:port/PASService/rest/services/v1/plans/B4806475-95D4-4007-83A9-2D3F41D97D99/planslices"

Example Response Body

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

{
    "count": 1,
    "offset": 0,
    "limit": 100,
    "plans": [
        {
            "links": [
                {
                    "href": "http://server:port/PASService/rest/services/v1/plans/9F5507A5-B7EC-4637-BD86-5168A1864408/planslices/75483CD4-743B-4588-A4F0-E6AA6F90AEA1",
                    "rel": "self",
                    "mediaType": "application/json",
                    "method": "GET"
                },
                {
                    "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PlanAllocationMethod&codeValue=01",
                    "rel": "codes/planAllocationMethodCode",
                    "mediaType": "application/json",
                    "method": "GET"
                },
                {
                    "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PlanBusinessStatus&codeValue=Approved",
                    "rel": "codes/businessStatus",
                    "mediaType": "application/json",
                    "method": "GET"
                }
            ],
            "effectiveFrom": "2020-06-15T00:00:00Z",
            "effectiveTo": null,
            "planName": "MainPlanWithSegment123",
            "systemCode": "01",
            "defaultCurrencyCode": "USD",
            "pointInTimeValuation": "Y",
            "mixedValuation": "N",
            "planAllocationMethodCode": "01",
            "updatedGmt": "2023-02-01T07:09:17Z",
            "activeGmt": "2023-02-01T07:09:07Z",
            "recordStatusCode": "ACTIVE",
            "updatedBy": "qatester3",
            "businessStatusCode": "Approved",
            "planSliceId": "75483CD4-743B-4588-A4F0-E6AA6F90AEA1",
            "planId": "9F5507A5-B7EC-4637-BD86-5168A1864408",
            "companyId": "80798FC2-FEB9-4998-A575-513FF89698B1",
            "marketMakerId": "22FBC7C1-D8E0-4741-9D22-DF929A2890B5",
            "productId": "0689ACFC-F2B0-4BA9-8987-DE6C1AD83AC1",
            "MaximumFaceAmount": {
                "value": null,
                "currency": "USD"
            }
        }
    ]
}
Back to Top