POST Requirements/Calculate

Requirements calculator for determing exam requirements

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
carrierId	The carrier id that products are being requested for.	integer	None.
productCode	The product code used for the specified carrier id.	string	None.
dob	The applicant birth date.	string	None.
faceAmount	The policy face amount.	string	None.
stateAbbr	The applicant state abbreviation. Example "CA" for California.	string	None.
genderType	The applicant gender type. Accepted integer types: 0 = Unknown, 1 = Male, 2 = Female, 3 = Unisex	integer	None.
smokerStatusType	The applicant smoker status type. Accepted integer types: 0 = Unknown, 1 = Never Used, 3 = Current User	integer	None.
doctorVisitType	The applicant doctor visit type. Accepted integer types: 0 = None, 1 = Doctor Visit Within 12 Months, 2 = Doctor Visit Within 24 Months	integer	None.
isFaceToFace	Select whether or not the applicant was seen face to face by the agent.	boolean	None.
physicalInLastYear	Select whether or not the applicant had a physical in the last year.	boolean	None.
healthCareWorker	Select whether or not the applicant must be seen by someone who performs invasive procedures or handles bodily fluids	boolean	None.
agentIsApplicant	Select whether the agent is the applicant on the case.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "carrierId": 1,
  "productCode": "sample string 1",
  "dob": "sample string 2",
  "faceAmount": "sample string 3",
  "stateAbbr": "sample string 4",
  "genderType": 1,
  "smokerStatusType": 1,
  "doctorVisitType": 1,
  "isFaceToFace": true,
  "physicalInLastYear": true,
  "healthCareWorker": true,
  "agentIsApplicant": true
}

application/xml, text/xml

Sample:

<RequirementsRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <carrierId>1</carrierId>
  <productCode>sample string 1</productCode>
  <dob>sample string 2</dob>
  <faceAmount>sample string 3</faceAmount>
  <stateAbbr>sample string 4</stateAbbr>
  <genderType>1</genderType>
  <smokerStatusType>1</smokerStatusType>
  <doctorVisitType>1</doctorVisitType>
  <isFaceToFace>true</isFaceToFace>
  <physicalInLastYear>true</physicalInLastYear>
  <healthCareWorker>true</healthCareWorker>
  <agentIsApplicant>true</agentIsApplicant>
</RequirementsRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RequirementsRequest'.

Response Information

Resource Description

Returns the exam requirement description and SMM billing requirement code.

CalculatorResult

Name	Type	Additional information
Requirements	string	None.
BillingReqCode	string	None.
Result	TransactionStatus	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Requirements": "sample string 1",
  "BillingReqCode": "sample string 2",
  "Result": 0,
  "Message": "sample string 3"
}

application/xml, text/xml

Sample:

<CalculatorResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Requirements>sample string 1</Requirements>
  <BillingReqCode>sample string 2</BillingReqCode>
  <Result>Not Yet Run</Result>
  <Message>sample string 3</Message>
</CalculatorResult>