Get a specific policy by policy Id
get
/PASService/rest/services/v1/policies/{policyId}
Gets a policy based on the specified policy Id and all policy details such as Policy, PolicyField, MVFields, Roles, RoleField, Segment, and Segment field.
Request
Path Parameters
-
policyId(required): string(guid)
Policy Id
There's no request body for this operation.
Back to TopResponse
200 Response
This operation fetches a specific policy by policy Id successfully.
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 "Content-Type: application/json" \
-u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-L "http://server:port/PASService/rest/services/v1/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/v1/policies/08739DA7-D305-450F-975A-44B269B159CD",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/policies/08739DA7-D305-450F-975A-44B269B159CD/segments",
"rel": "segments",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/policies/08739DA7-D305-450F-975A-44B269B159CD/roles",
"rel": "roles",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/policies/08739DA7-D305-450F-975A-44B269B159CD/requirements",
"rel": "requirements",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/codes?codeName=State&codeValue=55",
"rel": "codes/issueStateCode",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/codes?codeName=System&codeValue=02",
"rel": "codes/systemCode",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/codes?codeName=Status&codeValue=08",
"rel": "codes/status",
"mediaType": "application/json",
"method": "GET"
}
],
"multiFields": {},
"codes": [
{
"codeName": "AsCodeState",
"codeValue": "55",
"longDescription": "Armed Forces",
"shortDescription": "AE"
},
{
"codeName": "AsCodeSystem",
"codeValue": "02",
"longDescription": "NBU",
"shortDescription": "NBU"
},
{
"codeName": "AsCodeStatus",
"codeValue": "08",
"longDescription": "Policy is Pending",
"shortDescription": "Pending"
}
],
"policyName": "adededd",
"policyNumber": "adedd",
"planDate": "2020-06-15T00:00:00Z",
"issueStateCode": "55",
"systemCode": "02",
"segments": null,
"roles": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/policies/08739DA7-D305-450F-975A-44B269B159CD/roles/FCDE474F-B328-47C0-AC40-2888A0A6E0BF",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/codes?codeName=Role&codeValue=11",
"rel": "codes/role",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/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": null,
"rolePercent": null,
"stateCode": null,
"roleId": "FCDE474F-B328-47C0-AC40-2888A0A6E0BF",
"clientId": "23D8108C-A278-4A8C-89FC-C64EB37EF1A1",
"externalclientId": null,
"companyId": null,
"percentDollar": null,
"policyId": "08739DA7-D305-450F-975A-44B269B159CD",
"role": "11",
"segmentId": null,
"status": "01"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/policies/08739DA7-D305-450F-975A-44B269B159CD/roles/825AA2DD-B353-4E3B-881C-528D53F6F61B",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/codes?codeName=Role&codeValue=37",
"rel": "codes/role",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/codes?codeName=RoleStatus&codeValue=01",
"rel": "codes/status",
"mediaType": "application/json",
"method": "GET"
}
],
"multiFields": {
"MultiFieldRoleScreen": [
{
"index": 0,
"RoleMultiField": null
}
]
},
"codes": [
{
"codeName": "AsCodeRole",
"codeValue": "37",
"longDescription": "Insured",
"shortDescription": "Insured"
},
{
"codeName": "AsCodeRoleStatus",
"codeValue": "01",
"longDescription": "Active",
"shortDescription": "Active"
}
],
"roleAmount": null,
"rolePercent": 100.0,
"stateCode": null,
"roleId": "825AA2DD-B353-4E3B-881C-528D53F6F61B",
"clientId": "7A51150D-EA45-4271-B64D-8ADC849F5751",
"externalclientId": null,
"companyId": null,
"percentDollar": null,
"policyId": "08739DA7-D305-450F-975A-44B269B159CD",
"role": "37",
"segmentId": null,
"status": "01",
"BillingSelectAddress": {
"textValue": "01",
"optionText": "Electronic Funds Transfer"
},
"DeliveryAgent": null,
"Billing": {
"textValue": "01",
"optionText": "Yes"
},
"DepartmentName": null,
"TransactionField": null,
"TestCollection": null,
"TestField": null,
"DeliveryType": null,
"GraceLapseNotices": {
"textValue": "01",
"optionText": "Yes"
}
}
],
"policyId": "08739DA7-D305-450F-975A-44B269B159CD",
"creationDate": "2021-09-23T00:00:00Z",
"updatedDate": "2023-02-07T06:40:03Z",
"companyId": "05711222-7DB3-4EBD-A821-57A30A699B88",
"planId": "C5EE0DA4-3003-42C1-9468-D91DA546B79F",
"status": "08",
"PolicyCurrencySupportTest": {
"value": 0.0,
"currency": "USD"
},
"InterestBonusQual": {
"textValue": "Yes",
"optionText": "Yes"
},
"RiderWithClientAssignmentII": "UNCHECKED",
"GMIRLookupDate": null,
"TransactionField": null,
"SurrenderCharges": null,
"ContractDate": "2020-06-15T00:00:00Z",
"TestField": null,
"EffectiveDate": "2020-06-15T00:00:00Z"
}
}