Get a particular plan for a product

get

/PASService/rest/services/products/{productId}/plans/{planId}

Gets a plan associated with a product based on the specified product Id and plan Id

Request

Path Parameters
  • Pattern: \{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?
    Plan Id
  • Pattern: \{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?
    Product Id
Back to Top

Response

Supported Media Types

Default Response

successful operation
Back to Top

Examples

This example describes how to get a plan associated with a product based on the specified product Id and plan Id.

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/products/48C12B7F-BB92-47AE-8723-22085BF9FC91/plans/54792151-44B4-44CC-B6F9-2A1C50078323"

Example Response Body

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

"{
    "plan": {
        "links": [
            {
                "href": "http://server:port/PASService/rest/services/plans/54792151-44B4-44CC-B6F9-2A1C50078323",
                "rel": "self",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/plans/54792151-44B4-44CC-B6F9-2A1C50078323/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=Pending",
                "rel": "codes/businessStatus",
                "mediaType": "application/json",
                "method": "GET"
            }
        ],
        "codes": [
            {
                "codeName": "AsCodePlanAllocationMethod",
                "codeValue": "01",
                "longDescription": "Default",
                "shortDescription": "Default"
            },
            {
                "codeName": "AsCodePlanBusinessStatus",
                "codeValue": "Pending",
                "longDescription": "Pending",
                "shortDescription": "Pending"
            }
        ],
        "effectiveFrom": "2015-08-04T00:00:00Z",
        "effectiveTo": "2020-08-04T00:00:00Z",
        "planName": "hhi",
        "systemCode": "01",
        "defaultCurrencyCode": "USD",
        "pointInTimeValuation": "Y",
        "mixedValuation": "N",
        "planAllocationMethodCode": "01",
        "updatedGmt": "2019-10-11T05:06:58Z",
        "activeGmt": "2019-10-11T05:06:58Z",
        "recordStatusCode": "DRAFT",
        "updatedBy": "qatester3",
        "businessStatusCode": "Pending",
        "planSliceId": "018ED17C-F178-45D6-B0BD-AEB37EB40295",
        "planId": "54792151-44B4-44CC-B6F9-2A1C50078323",
        "companyId": "80798FC2-FEB9-4998-A575-513FF89698B1",
        "marketMakerId": "22FBC7C1-D8E0-4741-9D22-DF929A2890B5",
        "productId": "48C12B7F-BB92-47AE-8723-22085BF9FC91"
    }
}
"
Back to Top