Get a specific plan for a product by product Id and plan Id
get
/PASService/rest/services/v1/products/{productId}/plans/{planId}
Gets a plan associated with a product based on the specified product Id and plan Id.
Request
Path Parameters
-
planId(required): string
Plan Id
-
productId(required): string(guid)
Product Id
There's no request body for this operation.
Back to TopResponse
200 Response
This operation fetches a specific plan for a product by product Id and plan Id successfully.
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 "Content-Type: application/json" \
-u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-L "http://server:port/PASService/rest/services/v1/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/v1/plans/78EB7DD1-329F-4143-9EFE-E42496103B0A",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/plans/78EB7DD1-329F-4143-9EFE-E42496103B0A/planslices",
"rel": "planslices",
"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"
}
],
"codes": [
{
"codeName": "AsCodePlanAllocationMethod",
"codeValue": "01",
"longDescription": "Default",
"shortDescription": "Default"
}
],
"effectiveFrom": "2014-12-23T00:00:00Z",
"effectiveTo": "2015-12-23T00:00:00Z",
"planName": "RegPlan5",
"systemCode": "00",
"defaultCurrencyCode": "USD",
"pointInTimeValuation": "Y",
"mixedValuation": null,
"planAllocationMethodCode": "01",
"updatedGmt": "2014-12-24T04:38:32Z",
"activeGmt": "2014-12-24T04:38:32Z",
"recordStatusCode": "ACTIVE",
"updatedBy": "install",
"businessStatusCode": null,
"planSliceId": "4281AE71-639B-4526-A488-2A814BE3DA33",
"planId": "78EB7DD1-329F-4143-9EFE-E42496103B0A",
"companyId": "80798FC2-FEB9-4998-A575-513FF89698B1",
"marketMakerId": "22FBC7C1-D8E0-4741-9D22-DF929A2890B5",
"productId": "06B2036D-6CBD-45C6-9997-58D6E17D395C"
}
}