Get withholding for a specific policy by withholding Id
get
/PASService/rest/services/v1/policies/{policyId}/withholdings/{withholdingId}
Gets withholding for a policy based on the specified withholding Id
Request
Path Parameters
-
policyId(required): string(guid)
Policy Id
-
withholdingId(required): string(guid)
Withholding Id
Query Parameters
-
expand: string
codes, all
-
q: string
Search parameter
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
successful operation
Examples
This example describes how to get a withholding for a policy based on the specified policy Id and withholding 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/policies/5F53C523-F201-4CEF-A376-DBA24BC7DC1A/withholdings/E721D943-8DA7-4FC1-86B1-9D219A8896B9" Example Response Body
The following shows an example of the response body in JSON format:
{
"withholding": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/policies/5F53C523-F201-4CEF-A376-DBA24BC7DC1A/withholdings/E721D943-8DA7-4FC1-86B1-9D219A8896B9",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://localhost:8081/PASService/rest/services/codes?codeName=typeCode&codeValue=03",
"rel": "codes/withholdingType",
"mediaType": "application/json",
"method": "GET"
}
],
"withholdingId": "E721D943-8DA7-4FC1-86B1-9D219A8896B9",
"typeCode": "03",
"policyId": "007C2C66-6E6D-4504-857E-001D0DA509AE",
"StateForm": {
"textValue": "01",
"optionText": "Yes"
},
"ComboField": {
"textValue": "01",
"optionText": "Savings"
},
"TaxIDSource": {
"textValue": "01",
"optionText": "Application"
},
"letterSendDate": "2001-01-01T00:00:00Z",
"federalPercent": "10",
"federalAmount": "1000",
"stateAmount": "1000",
"currencyCode":"USD",
"statePercent": "10"
}
]
}