Persons Category

LIST: GET /api/personsfm/list

Returns collection persons category in JSON format. Company ID must be provided as URL param.

Resource URL 

/api/personsfm/list?companyId={companyId} or
                        /api/personsfm/list?categoryId={categoryId} or
                        /api/personsfm/list?companyId={companyId}&start={start}&limit={limit}

Resource Properties

PROPERTY DESCRIPTION
Method GET
Response formats JSON
Requires authentication? Yes

URL Params

Always specify companyId param

PARAM TYPE REQUIRED/OPTIONAL DESCRIPTION
companyId number required The ID of the company for which to return persons
categoryId number required The ID of the person category for which to return persons
start number optional Specify beginning of paging
limit number optional Specify end of paging

Example <base_url>/api/personsfm/list?companyId=2132

Response

{
    "count": 3,
    "list": [
        {
            "name": "ATTICUS FINCH",
            "phoneNo": "070000000",
            "email": "Atticus.Finch@fakeemail.com",
            "userId": null,
            "employeeId": null,
            "categoryId": 15442580,
            "categoryName": "TECHNICIAN",
            "companyId": 6621,
            "id": 15444380
        },
        {
            "name": "KUNTA KINTE",
            "phoneNo": "0700000000",
            "email": "kunta.kinte@gmail.com",
            "userId": null,
            "employeeId": null,
            "categoryId": 15441481,
            "categoryName": "PLUMBER",
            "companyId": 6621,
            "id": 15443380
        },
        {
            "name": "NORMAN GORDON",
            "phoneNo": "0720000000",
            "email": "Norman.Gordon@norman.com",
            "userId": null,
            "employeeId": null,
            "categoryId": 15441481,
            "categoryName": "PLUMBER",
            "companyId": 6621,
            "id": 15444381
        }
    ]
}