Get policy by Id
get
/PASService/rest/services/policies/{id}
Gets a policy based on the specified policy Id
Request
Path Parameters
-
id: string
Pattern:
\{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?Policy Id
Response
Supported Media Types
- application/json
Default Response
successful operation
Examples
This example describes how to get a policy based on the specified policy 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/policies/22E39E64-7876-4A61-B5FE-9E45A291C54D"
Example Response Body
The following shows an example of the response body in JSON format:
"{
"policy": {
"links": [
{
"href": "http://server:port/PASService/rest/services/policies/22E39E64-7876-4A61-B5FE-9E45A291C54D",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/policies/22E39E64-7876-4A61-B5FE-9E45A291C54D/segments",
"rel": "segments",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/policies/22E39E64-7876-4A61-B5FE-9E45A291C54D/roles",
"rel": "roles",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/policies/22E39E64-7876-4A61-B5FE-9E45A291C54D/requirements",
"rel": "requirements",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=State&codeValue=55",
"rel": "codes/issueStateCode",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=System&codeValue=01",
"rel": "codes/systemCode",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=Status&codeValue=08",
"rel": "codes/status",
"mediaType": "application/json",
"method": "GET"
}
],
"multiFields": {
"ComboTestMF": [
{
"index": 0,
"ComboTest1": {
"textValue": "00",
"optionText": "No"
},
"ComboTest2": {
"textValue": "00",
"optionText": "No"
},
"ComboTest3": {
"textValue": "00",
"optionText": "No"
},
"ComboTest4": {
"textValue": "00",
"optionText": "No"
},
"ComboTest5": {
"textValue": "00",
"optionText": "No"
},
"ComboTest6": {
"textValue": "00",
"optionText": "No"
}
}
],
"TextTestMF": [
{
"index": 0,
"TextTest1": "Test"
}
],
"RadioTestMF": [
{
"index": 0,
"RadioTest2": {
"textValue": "00",
"optionText": "No"
},
"RadioTest1": {
"textValue": "00",
"optionText": "No"
},
"RadioTest4": {
"textValue": "00",
"optionText": "No"
},
"RadioTest3": {
"textValue": "00",
"optionText": "No"
}
}
],
"CheckTestMF": [
{
"index": 0,
"CheckboxTest2": "UNCHECKED",
"CheckboxTest1": "UNCHECKED",
"CheckboxTest4": "UNCHECKED",
"CheckboxTest3": "UNCHECKED"
}
]
},
"codes": [
{
"codeName": "AsCodeState",
"codeValue": "55",
"longDescription": "Armed Forces",
"shortDescription": "AE"
},
{
"codeName": "AsCodeSystem",
"codeValue": "01",
"longDescription": "OIPA",
"shortDescription": "OIPA"
},
{
"codeName": "AsCodeStatus",
"codeValue": "08",
"longDescription": "Policy is Pending",
"shortDescription": "Pending"
}
],
"policyName": "Payal",
"policyNumber": "Payal",
"planDate": "2015-08-04T00:00:00Z",
"issueStateCode": "55",
"systemCode": "01",
"segments": {},
"roles": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/policies/22E39E64-7876-4A61-B5FE-9E45A291C54D/roles/0DE0006A-983F-4210-B3A5-54DD41955774",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=Role&codeValue=11",
"rel": "codes/role",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=RoleStatus&codeValue=01",
"rel": "codes/status",
"mediaType": "application/json",
"method": "GET"
}
],
"multiFields": {},
"codes": [
{
"codeName": "AsCodeRole",
"codeValue": "11",
"longDescription": "Customer Service Representative",
"shortDescription": "CSR"
},
{
"codeName": "AsCodeRoleStatus",
"codeValue": "01",
"longDescription": "Active",
"shortDescription": "Active"
}
],
"roleAmount": 23,
"rolePercent": 25,
"stateCode": "CA",
"roleId": "0DE0006A-983F-4210-B3A5-54DD41955774",
"clientId": "5149CC4C-1D1C-45BF-910B-D0DA1B3A785B",
"externalclientId": "2149CC4C-1D1C-45BF-910B-D0DA1B3A785B",
"companyId": "3149CC2C-1D1C-45BF-910B-D0DA1B3A785B",
"percentDollar": null,
"policyId": "22E39E64-7876-4A61-B5FE-9E45A291C54D",
"role": "11",
"segmentId": "11E39E64-7876-4A61-B5FE-9E45A291C54D",
"status": "01"
}
],
"policyId": "22E39E64-7876-4A61-B5FE-9E45A291C54D",
"creationDate": "2020-01-20T00:00:00Z",
"updatedDate": "2020-01-20T14:34:31Z",
"companyId": "05711222-7DB3-4EBD-A821-57A30A699B88",
"planId": "C5EE0DA4-3003-42C1-9468-D91DA546B79F",
"status": "08",
"MVAStartDate": "2020-01-20T00:00:00Z",
"VersionIndicator": "Y",
"PolicyCurrencySupportTest": {
"value": 0,
"currency": "USD"
},
"MVAEndDate": "2022-01-20T00:00:00Z",
"InterestBonusQual": {
"textValue": "Yes",
"optionText": "Yes"
},
"MVAWithdrawFlag": "N",
"RiderWithClientAssignmentII": "CHECKED",
"EffectiveDate": "2020-01-20T00:00:00Z"
}
}
"