Get list of plans

get

/PASService/rest/services/plans

Gets a list of the latest 100 plans

Request

Query Parameters
Back to Top

Response

Supported Media Types

200 Response

successful operation
Body ()
Root Schema : schema
Type: object
Back to Top

Examples

This example describes how to get a list of the latest 100 plans.

Example cURL Command

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

curl -X GET -H "Accept: application/json" -u username:password "server:port/PASService/rest/services/plans"

Example Response Body

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

"{
    "count": 34,
    "offset": 0,
    "limit": 100,
    "plans": [
        {
            "links": [
                {
                    "href": "http://server:port/PASService/rest/services/plans/17CFE15E-0CDC-4CBA-A8BE-25BC0A0647D5",
                    "rel": "self",
                    "mediaType": "application/json",
                    "method": "GET"
                },
                {
                    "href": "http://server:port/PASService/rest/services/plans/17CFE15E-0CDC-4CBA-A8BE-25BC0A0647D5/planslices",
                    "rel": "planslices",
                    "mediaType": "application/json",
                    "method": "GET"
                },
                {
                    "href": "http://server:port/PASService/rest/services/codes?codeName=PlanAllocationMethod&codeValue=01",
                    "rel": "codes/planAllocationMethodCode",
                    "mediaType": "application/json",
                    "method": "GET"
                },
                {
                    "href": "http://server:port/PASService/rest/services/codes?codeName=PlanBusinessStatus&codeValue=Approved",
                    "rel": "codes/businessStatus",
                    "mediaType": "application/json",
                    "method": "GET"
                }
            ],
            "effectiveFrom": "2015-08-04T00:00:00Z",
            "effectiveTo": "2016-08-04T00:00:00Z",
            "planName": "plan 32",
            "systemCode": "01",
            "defaultCurrencyCode": "USD",
            "pointInTimeValuation": "Y",
            "mixedValuation": "N",
            "planAllocationMethodCode": "01",
            "updatedGmt": "2019-12-19T11:08:32Z",
            "activeGmt": "2019-12-19T11:08:02Z",
            "recordStatusCode": "ACTIVE",
            "updatedBy": "qatester3",
            "businessStatusCode": "Approved",
            "planSliceId": "56C8DF66-6266-44DF-8656-78EDA7576D47",
            "planId": "17CFE15E-0CDC-4CBA-A8BE-25BC0A0647D5",
            "companyId": "80798FC2-FEB9-4998-A575-513FF89698B1",
            "marketMakerId": "22FBC7C1-D8E0-4741-9D22-DF929A2890B5",
            "productId": "0689ACFC-F2B0-4BA9-8987-DE6C1AD83AC1"
        }
"
Back to Top