check_service_availability Navigate to XML API

This REST API determines whether a location is serviceable or not. This REST API also generates the enrollment id for the new order.

End Point https://www.vcareapi.com:8080/enrollment
Field (Short Description) Value/Tag Name Format Field Example Type Notes Validation rules
action String check_service_availability Required This needs to be passed as check_service_availability check_service_availability
enrollment_type String LIFELINE Required If you are creating an order for prepaid or postpaid services than you should pass NON_LIFELINE else pass LIFELINE. Expected values : LIFELINE or NON_LIFELINE
zip_code String 08104 Required This is the Zip Code for the service address of the customer Should not allow letters and special characters, only numbers.Should be exactly 5 digits.
is_enrollment String Y Optional If you only wants to check the availability of the services than you pass N but if you want to create the enrollment id also than pass Y. Expected values : Y OR N
source String API Required Source of the order/application Expected Value : API , WEBSITE
agent_id String John Doe Required This is the Telgoo5 user id for the Agent/Employee who is sending the API request. This is the user login id which will be created in Telgoo5 for the API user.
agent_password String ****** Optional This is the password for the Agent Id mentioned above. This is configuration level field. If you have set the permissions for the Agent Id for the requirement of the password in API transactions then you will need to pass the Agent Password in all the REST API transaction, else if you have set the permissions to password not required then you don’t need to pass the Agent Password in the REST API.
validate_agent_location String Y / N Optional If we want to validate agent location, then we have to pass Y otherwise N. Expected values : Y or N
coordinate['latitude'] String Optional latitude of agent if validate_agent_location is equal to Y.
coordinate['longitude'] String Optional longitude of agent if validate_agent_location is equal to Y.
is_web_partner String Y Optional If Y then add Web partner API prefix in Enroll id Expected values : Y / N
login_log_otp String Optional To validate enroll agent location
is_check_coverage String Y Optional to get list of available carrier Expected values : Y / N
Sample Request REST
{
    "zip_code": "21215",
    "enrollment_type": "LIFELINE",
    "is_enrollment": "Y",
    "action": "check_service_availability",
    "agent_id": "Devteam",
    "source": "ENROLLMENT_PORTAL",
    "request_name": "enrollment",
    "vendor_id": "Demo-Telgoo5demo"
}
List of status code, description and resolution.
Status Code Description How to Resolve?
RESTAPI000 SUCCESS SUCCESS
RESTAPI001 FAIL Multiple errors like Invalid Token, Token already used, Token expire & Invalid Access!!
RESTAPI101 FAIL Module required.
RESTAPI102 FAIL Action required.
RESTAPI103 FAIL Source Not Allowed.
RESTAPI104 FAIL Invalid Agent ID or Password.
RESTAPI105 FAIL Module does not exist.
RESTAPI106 FAIL Action does not exist.
RESTAPI107 FAIL Invalid company.
RESTAPI108 FAIL Invalid method.
RESTAPI109 FAIL Unauthorized Access.
RESTAPI010 FAIL Multiple errors come in an array.
Sample Response
{
    "data": {
        "acp_transfer_exception_config": "N",
        "allow_acp_transfer_exception": "Y",
        "allow_business_address_mailing_address": "N",
        "allow_business_address_service_address": "N",
        "allow_enrollment_in_case_of_unconfirmed_address": "Y",
        "allowed_enrollment_type": "ACP",
        "available_carrier_list": [],
        "beneficiary_required_ssn_digits": "4",
        "bqp_information_not_required": "N",
        "city": "Baltimore",
        "combo_enroll_with_acp_parent_lifeline_child": "",
        "ebb_nlad_call_type": "NV",
        "ebb_state_through_national_verifier": "GA,KY,MI,PA,WI,AL,AK,AZ,AR,CA,CO,CT,DE,FL,HI,ID,IL,IN,IA,KS,LA,ME,MD,MA,MN,MS,MO,MT,NE,NV,NH,NJ,NM,NY,NC,ND,OH,OK,OR,RI,SC,SD,TN,UT,VT,VA,WA,WV,WY,VI,TX,PR,DC,DC,GU,AS,CM",
        "enable_address_validate_from_usps": "Y",
        "enrollment_id": "EANG430",
        "enrollment_type_default_value": "ACP",
        "is_combo": 0,
        "is_driving_license_required": "Y",
        "is_ebb": "1",
        "is_lifeline": "0",
        "is_national_verifier_state": "Y",
        "is_tribal": "N",
        "lifeline_alternate_phone_required": "Y",
        "lifeline_email_required": "Y",
        "nlad_address_override_rural": "Y",
        "nlad_verification_override": "Y",
        "nv_ga_proof_required": "N",
        "nv_id_proof_required": "N",
        "permission_to_show_sim_option_during_enrollment": "N",
        "priority_wise_carrier_list_for_csa": "",
        "proof_required_for_nv": "NOT REQUIRED",
        "required_ssn_digits": "4",
        "show_alert_for_multiple_carrier": "N",
        "show_enrollment_type_list": "NO",
        "state": "MD",
        "validate_tribal_from_address": "N",
        "zip_code": "21215"
    },
    "msg": "Success",
    "msg_code": "RESTAPI000",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGVtby1BbmdlbE1vYmlsZVVzZXIiLCJwYXNzd29yZCI6IkRlbW8tQW5nZWxNb2JteDlzcjV6cjg0NzUiLCJwaW4iOiJEZW1vLTg5MjM2OTI3Nzk3NyIsInZlbmRvcl9pZCI6IkRlbW8tQW5nZWxNb2JpbGUiLCJsb2dfaWQiOjcwMjQ2MiwidXJsIjoiaHR0cHM6Ly9kZW1vLWFuZ2VsLnRlbGdvbzUuY29tL3ZjYXJlT3NzQXBpLyJ9LCJleHAiOjE3MDE5ODg5ODB9.4UtFvA2WhttxQ2HUjMwNYt6wfoC0dsy0XJlo1tPgNGs"
}
SUCCESS
Sample Fail Response: 1
{
    
    "msg": "Invalid Token",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Invalid Token
How to Resolve?: Provide valid token in header
Sample Fail Response: 2
{
    
    "msg": "Invalid Access!!",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Invalid Access!!
How to Resolve?: Request method will be POST
Sample Fail Response: 3
{
    "errors":["Source Not Allowed"]
    "msg": "Source Not Allowed",
    "msg_code": "RESTAPI103",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Source Not Allowed
How to Resolve?: Provide valid Source
Sample Fail Response: 4
{
    "errors":["Agent Id should not be blank"]
    "msg": "Agent Id should not be blank",
    "msg_code": "RESTAPI104",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Agent Id should not be blank
How to Resolve?: Provide valid Agent Id
Sample Fail Response: 5
{
    "errors":["Invalid Agent Id"]
    "msg": "Invalid Agent Id",
    "msg_code": "RESTAPI104",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Invalid Agent Id
How to Resolve?: Provide valid Agent Id
Sample Fail Response: 6
{
    
    "msg": "Token already used",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Token already used
How to Resolve?: You can use token once per request
Sample Fail Response: 7
{
    
    "msg": "Token expire",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Token expire
How to Resolve?: Create token again
Sample Fail Response: 8
{
    "errors":["Please enter Enrollment Id"]
    "msg": "Error occurred",
    "msg_code": "RESTAPI110",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Error occurred
How to Resolve?: Provide Enrollment Id

All the status codes are listed under the status code sections. Please click here to go to the status code.