PCA API Documentation

each function has the api call url, parameters (all are query parameters) all functions are get functions status responses are included as well { "name" "validate employee", "method" "get", "url" "https pcuganda com/api/data/validate/\[employeenumber]", "description" "function to validate employee using employee number", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{ \n \\"employeedetails\\" \n {\n \\"employeenumber\\" \\"000000000123456\\",\n \\"fullname\\" \\"richard akzo\\",\n \\"dateofbirth\\" \\"1979 01 10\\",\n \\"gender\\" \\"m\\",\n \\"votecode\\" \\"563\\",\n \\"votedescription\\" \\"koboko district\\",\n \\"employeetitle\\" \\"entomological assistant\\",\n \\"terms\\" \\"permanent employee\\",\n \\"lastupdated\\" \\"2018 2\\",\n \\"tel\\" \\"0712999999\\",\n \\"deductions\\" {\n \\"reservationnumber\\" \\"1485652415\\",\n \\"referencecode\\" \\"866178\\",\n \\"installmentamount\\" \\"50000\\",\n \\"loanamount\\" \\"200000\\",\n \\"startdate\\" \\"2017 02 01\\",\n \\"enddate\\" \\"2019 03 01\\",\n \\"deductiontype\\" \\"458\\",\n \\"companyname\\" \\"jopeg financial services\\",\n \\"status\\" \\"reserved\\",\n }\n \\"recurring allowances\\" {\n \\"code\\" \\"1510\\",\n \\"amount\\" \\"50000\\",\n \\"payrolldate\\" \\"2018 02 01\\",\n \\"description\\" \\"lunch allowance\\"\n }\n \\"statutory deductions\\" {\n \\"code\\" \\"249\\",\n \\"deductionamount\\" \\"63351\\",\n \\"payrolldate\\" \\"2018 02 01\\",\n \\"description\\" \\"paye\\"\n }\n \\"maximum affordability\\" \\"189432 76\\",\n \\"alt affordability\\" null,\n \\"last deduction date\\" null,\n \\"last payment amount\\" null,\n \\"totalpaid\\" null\n }\n}" }, { "id" "spaihfge34yu2ok7ibo i", "language" "404", "customlabel" "", "code" "{\n \\"status\\" \\"false\\",\n \\"message\\" \\"employee could not be found\\"\n}" } ], "selectedlanguageid" "1kxdjw1bsqybhvvcgort1" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "employee number", "kind" "required", "type" "string", "description" "15 digit string with leading zeros", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "make reservation", "method" "get", "url" "https pcuganda com/api/data/reservation/ \[employeenumber]/ \[referencecode]/ \[installmentamount]/ \[loanamount]/ \[telephone]", "description" "function to make a reservation on an employee", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{\n reservation details {\n \\"employeenumber\\" \\"000000000123456\\",\n \\"referencecode\\" \\"jp001\\",\n \\"installmentamount\\" \\"50000\\",\n \\"loanamount\\" \\"600000\\",\n \\"deductiontype\\" \\"458\\",\n \\"reservationnumber\\" \\"25412415231\\" \n }\n}" }, { "id" "spaihfge34yu2ok7ibo i", "language" "404", "customlabel" "", "code" "{\n \\"status\\" \\"false\\",\n \\"message\\" \\"please enter all parameters\\"\n}\nor\n{\n \\"status\\" \\"false\\",\n \\"message\\" \\"reservation/deduction already exists\\"\n}\nor\n{\n \\"status\\" \\"false\\",\n \\"message\\" \\"the employee has no affordability\\"\n}" } ], "selectedlanguageid" "1kxdjw1bsqybhvvcgort1" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "employeenumber", "kind" "required", "type" "string", "description" "15 digit employee number with leading zeros", "children" \[] }, { "name" "referencecode", "kind" "required", "type" "string", "description" "loan unique identifier", "children" \[] }, { "name" "installmentamount", "kind" "required", "type" "integer", "description" "", "children" \[] }, { "name" "loanamount", "kind" "required", "type" "string", "description" "", "children" \[] }, { "name" "telephone", "kind" "optional", "type" "string", "description" "employee's telephone number", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "get reservations pending approval", "method" "get", "url" "https pcuganda com/api/data/reservations pending approval", "description" "function to show all reservations pending approval", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{\n \\"pending approval\\" \[\n {\n \\"employeenumber\\" \\"000000000123456\\",\n \\"id\\" \\"7754\\",\n \\"reservationnumber\\" \\"45215642\\",\n \\"referencecode\\" \\"jp001\\",\n \\"installmentamount\\" \\"50000\\",\n \\"loanamout\\" \\"600000\\",\n \\"startdate\\" \\"2017 02 01\\",\n \\"enddate\\" \\"2019 03 01\\",\n \\"deductiontype\\" \\"458\\"\n },\n \n ]\n}" } ], "selectedlanguageid" "1kxdjw1bsqybhvvcgort1" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "form parameter", "value" "formdataparameters" } } { "name" "submit reservation for approval", "method" "get", "url" "https pcuganda com/api/data/submit for approval/ \[deductionid]", "description" "function to submit individual reservation for approval\nuse this function call after getting results from the “get reservations pending approval” function", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{\n \\"status\\" \\"true\\",\n \\"message\\" \\"reservation submitted for approval\\"\n}" }, { "id" "spaihfge34yu2ok7ibo i", "language" "404", "customlabel" "", "code" "{\n \\"status\\" \\"false\\",\n \\"message\\" \\"no reservation selected\\"\n}" } ], "selectedlanguageid" "spaihfge34yu2ok7ibo i" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "deductionid", "kind" "required", "type" "string", "description" "id for the reservation as retrieved from get reservations pending approval function", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "find reservation", "method" "get", "url" "https pcuganda com/api/data/find reservation / \[employeenumber]", "description" "function to get details of institution reservation", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{\n \\"employeenumber\\" \\"000000000324516\\",\n \\"reservations\\" {\n \\"id\\" \\"7754\\",\n \\"reservationnumber\\" \\"45215642\\",\n \\"referencecode\\" \\"jp001\\",\n \\"installmentamount\\" \\"50000\\",\n \\"loanamout\\" \\"600000\\",\n \\"startdate\\" \\"2017 02 01\\",\n \\"enddate\\" \\"2019 03 01\\",\n \\"deductiontype\\" \\"458\\"\n }\n}" }, { "id" "spaihfge34yu2ok7ibo i", "language" "404", "customlabel" "", "code" "{\n \\"status\\" \\"false\\",\n \\"message\\" \\"invalid employee number\\"\n}\nor\n{\n \\"status\\" \\"false\\",\n \\"message\\" \\"no reservations found\\"\n}" } ], "selectedlanguageid" "1kxdjw1bsqybhvvcgort1" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "employeenumber", "kind" "required", "type" "string", "description" "", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "cancel reservation", "method" "get", "url" "https pcuganda com/api/data/cancel reservation / \[employeenumber]", "description" "function to get cancel running reservation", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{\n \\"status\\" \\"true\\",\n \\"message\\" \\"reservation cancelled\\"\n}" }, { "id" "spaihfge34yu2ok7ibo i", "language" "404", "customlabel" "", "code" "{\n \\"status\\" \\"false\\",\n \\"message\\" \\"invalid employee number\\"\n}\nor\n{\n \\"status\\" \\"false\\",\n \\"message\\" \\"no reservations found\\"\n}" } ], "selectedlanguageid" "1kxdjw1bsqybhvvcgort1" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "employeenumber", "kind" "required", "type" "string", "description" "15 digit string with trailing zeros eg 000000000123456", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "reports", "method" "get", "url" "https pcuganda com/api/data/report /\[startdate]/\[enddate]/\[status]", "description" "function to retrieve different reports on the pdms", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{\n \\"deductions\\" {\n \\"reservationnumber\\" \\"45215642\\",\n \\"referencecode\\" \\"jp001\\",\n \\"installmentamount\\" \\"50000\\",\n \\"loanamout\\" \\"600000\\", \n \\"deductionstart\\" \\"2017 02 01\\", \n \\"deductionend\\" \\"2019 03 01\\", \n \\"status\\" \\"reserved\\",\n \\"firstname\\" \\"moses ariho\\", \n \\"employeenumber\\" \\"000000000635467\\",\n \\"votedesc\\" \\"state house\\"\n }\n}" } ], "selectedlanguageid" "1kxdjw1bsqybhvvcgort1" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "startdate", "kind" "required", "type" "string", "description" "date format is yyyy mm dd eg 2017 12 01", "children" \[] }, { "name" "enddate", "kind" "required", "type" "string", "description" "date format is yyyy mm dd eg 2017 12 01", "children" \[] }, { "name" "status", "kind" "required", "type" "string", "description" "status codes reserved, takenup, cancelled, stopped, rejected, topups rejected, expired, pending, topup pending, approve, approved topups", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "find deduction", "method" "get", "url" "https pcuganda com/api/data/find deduction/\[employeenumber]", "description" "function to find deduction details", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{\n \\"employeenumber\\" \\"000000000324516\\",\n \\"fullname\\" \\"moses ariho\\",\n \\"department\\" \\"local government\\",\n \\"deduction\\" {\n \\"id\\" \\"7754\\",\n \\"reservationnumber\\" \\"45215642\\",\n \\"referencecode\\" \\"jp001\\",\n \\"installmentamount\\" \\"50000\\",\n \\"loanamout\\" \\"600000\\",\n \\"borrowedamount\\" \\"600000\\",\n \\"startdate\\" \\"2017 02 01\\",\n \\"enddate\\" \\"2019 03 01\\",\n \\"status\\" \\"takenup\\",\n \\"deductiontype\\" \\"458\\"\n }\n}" }, { "id" "pdtrkr wepjm7vow3smtg", "language" "404", "code" "{\n \\"status\\" \\"false\\",\n \\"message\\" \\"employee number not found\\"\n}\nor\n{\n \\"status\\" \\"false\\",\n \\"message\\" \\"no deduction found\\"\n}", "customlabel" "" } ], "selectedlanguageid" "1kxdjw1bsqybhvvcgort1" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "employeenumber", "kind" "required", "type" "string", "description" "", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "stop deduction", "method" "get", "url" "https pcuganda com/api/data/stop deduction / \[employeenumber]", "description" "function to stop active deduction", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{\n \\"status\\" \\"true\\",\n \\"message\\" \\"deduction stopped\\"\n}" }, { "id" "pdtrkr wepjm7vow3smtg", "language" "404", "code" "{\n \\"status\\" \\"false\\",\n \\"message\\" \\"employee number not found\\"\n}\nor\n{\n \\"status\\" \\"false\\",\n \\"message\\" \\"no deduction found\\"\n}", "customlabel" "" } ], "selectedlanguageid" "1kxdjw1bsqybhvvcgort1" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "employeenumber", "kind" "required", "type" "string", "description" "", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "replace deduction / do topup", "method" "get", "url" "https pcuganda com/api/data/replace deduction /\[employeenumber]/\[installmentamount]/\[loanamount]", "description" "function to top up active deduction", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{\n \\"status\\" \\"true\\",\n \\"message\\" \\"topup reservation done\\"\n}" }, { "id" "pdtrkr wepjm7vow3smtg", "language" "404", "code" "{\n \\"status\\" \\"false\\",\n \\"message\\" \\"employee number not found\\"\n}\nor\n{\n \\"status\\" \\"false\\",\n \\"message\\" \\"no deduction found\\"\n}\nor\n{\n \\"status\\" \\"false\\",\n \\"message\\" \\"reservation not affordable\\"\n}", "customlabel" "" } ], "selectedlanguageid" "1kxdjw1bsqybhvvcgort1" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "employeenumber", "kind" "required", "type" "string", "description" "", "children" \[] }, { "name" "installmentamount", "kind" "required", "type" "string", "description" "", "children" \[] }, { "name" "loanamount", "kind" "required", "type" "string", "description" "", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "find topup reservation", "method" "get", "url" "https pcuganda com/api/data/find topup reservation /\[employeenumber]", "description" "function to retrieve topup reservation details", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{\n \\"reservation list\\" \[\n {\n \\"id\\" \\"7754\\",\n \\"reservationnumber\\" \\"45215642\\",\n \\"referencecode\\" \\"jp001\\",\n \\"installmentamount\\" \\"50000\\",\n \\"loanamout\\" \\"600000\\",\n \\"deductionstart\\" \\"2017 02 01\\",\n \\"deductionend\\" \\"2019 03 01\\",\n \\"status\\" \\"topup reserved\\",\n \\"firstname\\" \\"moses ariho\\",\n \\"employeenumber\\" \\"000000000783645\\",\n \\"votedesc\\" \\"koboko district\\",\n },\n ]\n}" }, { "id" "pdtrkr wepjm7vow3smtg", "language" "404", "code" "{\n \\"status\\" \\"false\\",\n \\"message\\" \\"no topup reservation found\\"\n}", "customlabel" "" } ], "selectedlanguageid" "pdtrkr wepjm7vow3smtg" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "employeenumber", "kind" "required", "type" "string", "description" "", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "cancel topup reservation", "method" "get", "url" "https pcuganda com/api/data/cancel topup reservation/ \[employeenumber]", "description" "function to cancel active topup reservation", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{\n \\"status\\" \\"true\\",\n \\"message\\" \\"topup reservation cancelled\\"\n}" }, { "id" "pdtrkr wepjm7vow3smtg", "language" "404", "code" "{\n \\"status\\" \\"false\\",\n \\"message\\" \\"no topup reservation found\\"\n}", "customlabel" "" } ], "selectedlanguageid" "1kxdjw1bsqybhvvcgort1" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "employeenumber", "kind" "required", "type" "string", "description" "", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "get topup reservations pending approval", "method" "get", "url" "https pcuganda com/api/data/topup reservations pending approval", "description" "function to show records of topup reservations pending approval", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{\n \\"pending approval\\" \[\n {\n \\"employeenumber\\" \\"000000000123456\\",\n \\"firstname\\" \\"moses ariho\\",\n \\"deductionid\\" \\"7754\\",\n \\"reservationnumber\\" \\"45215642\\",\n \\"referencecode\\" \\"jp001\\",\n \\"installmentamount\\" \\"50000\\",\n \\"loanamout\\" \\"600000\\",\n \\"startdate\\" \\"2017 02 01\\",\n \\"enddate\\" \\"2019 03 01\\",\n \\"deductiontype\\" \\"458\\"\n }\n ]\n}" } ], "selectedlanguageid" "1kxdjw1bsqybhvvcgort1" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "submit topup reservation for approval", "method" "get", "url" "https pcuganda com/api/data/submit topup for approval/ \[deductionid]", "description" "function to submit topup reservations for approval", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{\n \\"status\\" \\"true\\",\n \\"message\\" \\"topup reservation submitted for approval\\"\n}" }, { "id" "xks08blgebuwjsvunelgb", "language" "404", "code" "{\n \\"status\\" \\"false\\",\n \\"message\\" \\"no reservation selected\\"\n}", "customlabel" "" } ], "selectedlanguageid" "1kxdjw1bsqybhvvcgort1" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "deductionid", "kind" "required", "type" "string", "description" "id for the deduction got from get topup reservations pending approval function", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "update deduction balance", "method" "get", "url" "https pcuganda com/api/data/update balance/ \[employeenumber]/\[loanamount]", "description" "function to update loan balance", "tab" "examples", "examples" { "languages" \[ { "id" "6v94gpsrxi1ehiyaut9yo", "language" "curl", "code" "", "customlabel" "responses" } ], "selectedlanguageid" "6v94gpsrxi1ehiyaut9yo" }, "results" { "languages" \[ { "id" "1kxdjw1bsqybhvvcgort1", "language" "200", "customlabel" "", "code" "{\n \\"status\\" \\"true\\",\n \\"message\\" \\"deduction balance updated\\"\n}" }, { "id" "xks08blgebuwjsvunelgb", "language" "404", "code" "{\n \\"status\\" \\"false\\",\n \\"message\\" \\"employee number not found\\"\n}\nor\n{\n \\"status\\" \\"false\\",\n \\"message\\" \\"no deduction found\\"\n}", "customlabel" "" } ], "selectedlanguageid" "xks08blgebuwjsvunelgb" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "employeenumber", "kind" "required", "type" "string", "description" "", "children" \[] }, { "name" "loanamount", "kind" "required", "type" "string", "description" "new balance to update", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } please note the quota for the api calls is 1 call per second connection to the api use the example below to connect to the pca api the example was written in php \<?php $curl header = array(); $key = ' '; //api key provided by pca $dedtype = ' '; //institution deduction code provided by pca $companycode = ' '; //company code provided by pca $username = ' '; //username credentials for api user configured by pca $password = ' '; //password for api user configured by pca $curl header = \[ 'apikey ' $key, 'dedtype ' $dedtype, 'companycode ' $companycode, 'username ' $username, 'password ' $password ]; //change the url depending on the api to call and add the required values $url = "https //sandbox pcuganda com/api/data/validate/000000000123456"; $ch = curl init(); curl setopt($ch, curlopt ssl verifypeer, false); curl setopt($ch, curlopt ssl verifyhost, 2); curl setopt($ch, curlopt url, $url); curl setopt($ch, curlopt httpheader, $curl header); $result = curl exec($ch); if($result === false){ echo "curl error " $curl error($ch); } curl close($ch); ?>