order_list Navigate to XML API

This REST API is used get order list.

End Point https://www.vcareapi.com:8080/handover
Field (Short Description) Value/Tag Name Format Field Example Type Notes Validation rules
action string order_list Required This needs to be passed as order_list order_list
current_page Numeric 1 Optional
record_limit Numeric 10 Optional
enrollment_id String ABC123 Optional
start_date String 2019-02-21 Optional (YYYY-MM-DD) (YYYY-MM-DD)
end_date String 2019-02-21 Optional (YYYY-MM-DD) (YYYY-MM-DD)
order_type String 2019-02-21 Optional Completed, Rejected, Pending, Pending for Handover (YYYY-MM-DD)
source string API Optional Source of the order/application/API call Expected Value:API, TABLET, WEBSITE
agent_id string John Doe Required This is the Telgoo5 user id for the Agent/Employee who is sending the API request.
agent_password string JohnDoe Conditional 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.
Sample Request REST
{  
   "record_limit":10,
   "current_page":1,
   "start_date":"2019-05-19",
   "end_date":"2019-06-19",
   "order_type":"all",
   "action":"order_list",
   "agent_id":"emplajay",
   "source":"ENROLLMENT_PORTAL"
}
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
{  
   "msg":"Success",
   "msg_code":"RESTAPI000",
   "data":{  
      "total_count":"11",
      "records":[  
         {  
            "serial_no":1,
            "is_rejected":"N",
            "order_completed":"Y",
            "description":"",
            "approve_date":"2019-06-18 11:20:04",
            "esn_number":None,
            "fax_id":"138974",
            "f_name":"D`A"            R-R`E`L L",
            "m_name":"D`A"            R-R`E`L L",
            "l_name":"P`A"            U L-EYDGF",
            "ssn_number":"9876",
            "serv_add1":"1707 CARLISLE RD",
            "serv_add2":None,
            "city":"COUSHATTA",
            "state":"LA",
            "zip":"71019",
            "created_by":"emplajay",
            "created_datetime":"2019-06-18 11:17:28",
            "enrollment_id":"EPTX145694",
            "source":"ENROLLMENT_PORTAL",
            "lock_by":"emplajay",
            "rejected_by":None,
            "nlad_resolution_id":"279045-RMMJ9B",
            "nlad_resolution_status":"Processing",
            "cust_status":"New",
            "status":"N",
            "shipment_method":None,
            "nlad_verify_skip":"Y",
            "nlad_proof_tpiv_verified":"Y",
            "shipment":"T_Open"
         },
         {  
            "serial_no":2,
            "is_rejected":"Y",
            "order_completed":"N",
            "description":"Order has been rejected due to Test Application",
            "approve_date":None,
            "esn_number":None,
            "fax_id":"138973",
            "f_name":"D`A"            R-R`E`L L`R",
            "m_name":"D`A"            R-R.`E`L L`R",
            "l_name":"BARKUS",
            "ssn_number":"9864",
            "serv_add1":"1707 CARLISLE RD",
            "serv_add2":None,
            "city":"COUSHATTA",
            "state":"LA",
            "zip":"71019",
            "created_by":"ENROLLMENT_PORTAL",
            "created_datetime":"2019-06-18 11:05:53",
            "enrollment_id":"EPTX145693",
            "source":"ENROLLMENT_PORTAL",
            "lock_by":"emplajay",
            "rejected_by":"emplajay",
            "nlad_resolution_id":"",
            "nlad_resolution_status":None,
            "cust_status":"Rejected",
            "status":"N",
            "shipment_method":None,
            "nlad_verify_skip":"Y",
            "nlad_proof_tpiv_verified":"Y",
            "shipment":None
         },
         {  
            "serial_no":3,
            "is_rejected":"Y",
            "order_completed":"N",
            "description":"Order has been rejected due to Test Application",
            "approve_date":None,
            "esn_number":None,
            "fax_id":"138972",
            "f_name":"D`A"            R-R`E`L L`G",
            "m_name":"D`A"            R-R`E`L.L`G",
            "l_name":"P`A"            U L-E-Y-J",
            "ssn_number":"9879",
            "serv_add1":"1707 CARLISLE RD",
            "serv_add2":None,
            "city":"COUSHATTA",
            "state":"LA",
            "zip":"71019",
            "created_by":"ENROLLMENT_PORTAL",
            "created_datetime":"2019-06-18 11:00:42",
            "enrollment_id":"EPTX145692",
            "source":"ENROLLMENT_PORTAL",
            "lock_by":"emplajay",
            "rejected_by":"emplajay",
            "nlad_resolution_id":"",
            "nlad_resolution_status":None,
            "cust_status":"Rejected",
            "status":"N",
            "shipment_method":None,
            "nlad_verify_skip":"Y",
            "nlad_proof_tpiv_verified":"Y",
            "shipment":None
         },
         {  
            "serial_no":4,
            "is_rejected":"Y",
            "order_completed":"N",
            "description":"Order has been rejected due to Test Application",
            "approve_date":None,
            "esn_number":None,
            "fax_id":"138970",
            "f_name":"D`A"            R-R`E`L L`G",
            "m_name":"D`A"            R.-R`E`L L`G",
            "l_name":"P`A"            U L-EY`D-GF",
            "ssn_number":"9876",
            "serv_add1":"1707 CARLISLE RD",
            "serv_add2":None,
            "city":"COUSHATTA",
            "state":"LA",
            "zip":"71019",
            "created_by":"ENROLLMENT_PORTAL",
            "created_datetime":"2019-06-18 06:36:07",
            "enrollment_id":"EPTX145682",
            "source":"ENROLLMENT_PORTAL",
            "lock_by":"emplajay",
            "rejected_by":"emplajay",
            "nlad_resolution_id":"",
            "nlad_resolution_status":None,
            "cust_status":"Rejected",
            "status":"N",
            "shipment_method":None,
            "nlad_verify_skip":"Y",
            "nlad_proof_tpiv_verified":"Y",
            "shipment":None
         },
         {  
            "serial_no":5,
            "is_rejected":"N",
            "order_completed":"N",
            "description":"",
            "approve_date":None,
            "esn_number":None,
            "fax_id":"138967",
            "f_name":"MYRA",
            "m_name":"MYRA",
            "l_name":"TEST",
            "ssn_number":"9879",
            "serv_add1":"123 MAPLE ST",
            "serv_add2":None,
            "city":"COUSHATTA",
            "state":"LA",
            "zip":"71019",
            "created_by":"ENROLLMENT_PORTAL",
            "created_datetime":"2019-06-17 09:43:53",
            "enrollment_id":"EPTX145641",
            "source":"ENROLLMENT_PORTAL",
            "lock_by":None,
            "rejected_by":None,
            "nlad_resolution_id":"",
            "nlad_resolution_status":None,
            "cust_status":"New",
            "status":"N",
            "shipment_method":None,
            "nlad_verify_skip":"Y",
            "nlad_proof_tpiv_verified":"N",
            "shipment":None
         },
         {  
            "serial_no":6,
            "is_rejected":"N",
            "order_completed":"Y",
            "description":"",
            "approve_date":"2019-05-27 09:15:41",
            "esn_number":"256691532801087560",
            "fax_id":"138753",
            "f_name":"ROBIN",
            "m_name":None,
            "l_name":"JACKSON",
            "ssn_number":"3179",
            "serv_add1":"186 E 10TH ST",
            "serv_add2":None,
            "city":"RESERVE",
            "state":"LA",
            "zip":"70084",
            "created_by":"emplajay",
            "created_datetime":"2019-05-27 09:14:54",
            "enrollment_id":"ATX144862",
            "source":"ENROLLMENT_PORTAL",
            "lock_by":"emplajay",
            "rejected_by":None,
            "nlad_resolution_id":"",
            "nlad_resolution_status":None,
            "cust_status":"Activated",
            "status":"D",
            "shipment_method":"AgentProgram",
            "nlad_verify_skip":"N",
            "nlad_proof_tpiv_verified":"N",
            "shipment":"Cancel"
         },
         {  
            "serial_no":7,
            "is_rejected":"N",
            "order_completed":"N",
            "description":"",
            "approve_date":None,
            "esn_number":None,
            "fax_id":"138751",
            "f_name":"ROBIN",
            "m_name":None,
            "l_name":"JACKSON",
            "ssn_number":"3179",
            "serv_add1":"2181 S ALBERT ST",
            "serv_add2":None,
            "city":"LUTCHER",
            "state":"LA",
            "zip":"70071",
            "created_by":"ENROLLMENT_PORTAL",
            "created_datetime":"2019-05-27 07:20:34",
            "enrollment_id":"ATX144839",
            "source":"ENROLLMENT_PORTAL",
            "lock_by":"emplajay",
            "rejected_by":"emplajay",
            "nlad_resolution_id":"",
            "nlad_resolution_status":None,
            "cust_status":"New",
            "status":"N",
            "shipment_method":None,
            "nlad_verify_skip":"N",
            "nlad_proof_tpiv_verified":"N",
            "shipment":None
         },
         {  
            "serial_no":8,
            "is_rejected":"N",
            "order_completed":"N",
            "description":"",
            "approve_date":None,
            "esn_number":None,
            "fax_id":"138719",
            "f_name":"TESTER",
            "m_name":"NEME",
            "l_name":"DEMO",
            "ssn_number":"1000",
            "serv_add1":"13632 EXPLORERS AVE",
            "serv_add2":None,
            "city":"NEW ORLEANS",
            "state":"LA",
            "zip":"70129",
            "created_by":"ENROLLMENT_PORTAL",
            "created_datetime":"2019-05-22 11:28:31",
            "enrollment_id":"ATX144231",
            "source":"ENROLLMENT_PORTAL",
            "lock_by":None,
            "rejected_by":None,
            "nlad_resolution_id":"",
            "nlad_resolution_status":None,
            "cust_status":"New",
            "status":"N",
            "shipment_method":None,
            "nlad_verify_skip":"Y",
            "nlad_proof_tpiv_verified":"N",
            "shipment":None
         },
         {  
            "serial_no":9,
            "is_rejected":"N",
            "order_completed":"N",
            "description":"",
            "approve_date":None,
            "esn_number":None,
            "fax_id":"138712",
            "f_name":"TEST",
            "m_name":None,
            "l_name":"DEMO",
            "ssn_number":"9876",
            "serv_add1":"13632 EXPLORERS AVE",
            "serv_add2":None,
            "city":"NEW ORLEANS",
            "state":"LA",
            "zip":"70129",
            "created_by":"ENROLLMENT_PORTAL",
            "created_datetime":"2019-05-22 07:56:03",
            "enrollment_id":"ATX144203",
            "source":"ENROLLMENT_PORTAL",
            "lock_by":None,
            "rejected_by":None,
            "nlad_resolution_id":"",
            "nlad_resolution_status":None,
            "cust_status":"New",
            "status":"N",
            "shipment_method":None,
            "nlad_verify_skip":"Y",
            "nlad_proof_tpiv_verified":"N",
            "shipment":None
         },
         {  
            "serial_no":10,
            "is_rejected":"N",
            "order_completed":"Y",
            "description":"",
            "approve_date":"2019-05-21 13:26:15",
            "esn_number":None,
            "fax_id":"138701",
            "f_name":"JONATHAN",
            "m_name":None,
            "l_name":"SOUTHALL",
            "ssn_number":"9785",
            "serv_add1":"317 DARALYN DR",
            "serv_add2":None,
            "city":"HOUMA",
            "state":"LA",
            "zip":"70363",
            "created_by":"Devteam",
            "created_datetime":"2019-05-20 15:41:08",
            "enrollment_id":"ATX143947",
            "source":"ENROLLMENT_PORTAL",
            "lock_by":"Devteam",
            "rejected_by":"Devteam",
            "nlad_resolution_id":"",
            "nlad_resolution_status":None,
            "cust_status":"Activated",
            "status":"N",
            "shipment_method":"Shipment",
            "nlad_verify_skip":"N",
            "nlad_proof_tpiv_verified":"N",
            "shipment":"Shipped"
         }
      ]
   },
   "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.OTM0fQ.bG15ow1TqsA8-8yvk4blibP1XvIhUKAw1BJDOlNXEc0"
}
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.