Did You Know?

Updated on October 22, 2024

Staff

This domain serves for requests related to retrive staff details.

Get Assigned Staff

POSTRetrieves staff details based on the provided Quote Number.

Request Paramters
stringdomain Value should be staff Required
stringaction Value should be get_assigned_staff Required
objectdata Contains input parameters. Required
stringquote_no Relevent quote number. Required
Sample Request Body
            
            {
                "domain":"staff",
                "action": "get_assigned_staff",
                "data":{
                    "quote_no":"Q07240092"
                }
            }
Response Paramters
stringstatus This indicate the status of the response. success is the expected value.
stringmessage This explains the reson for status.
objectdata This contain result data object of the API call.
Sample Response
            
            {
                "status": "success",
                "data": {
                    "status": "success",
                    "message": "Assigned Staff Read",
                    "data": null
                }
            }

Get All Staff

POSTRetrieves details of all staff members associated with the current account.

Request Paramters
stringdomain Value should be staff Required
stringaction Value should be get_all_staff Required
objectdata Empty object. Required
Sample Request Body
            
            {
                "domain":"staff",
                "action": "get_all_staff",
                "data":{}
            }
Response Paramters
stringstatus This indicate the status of the response. success is the expected value.
stringmessage This explains the reson for status.
objectdata This contain list of result data objects of the API call.
stringid The ID of the staff member.
stringfirst_name The first name of the staff member.
stringlast_name The last name of the staff member.
Sample Response
            
            {
                "status": "success",
                "data": {
                    "status": "success",
                    "message": "All Staff Read",
                    "data": [
                        {
                            "id": "982",
                            "first_name": "Jhon",
                            "last_name": "Doe"
                        },
                        {
                            "id": "8704",
                            "first_name": "Jane",
                            "last_name": "Doe"
                        },
                    ]
                }
            }
Print
API END POINTS