{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"867323f4-8f41-4ad9-95a8-42e6411e5146","name":"Peoplestrong APIs","description":"PeopleStrong in its pursuit of being the most Open & Connected HR Tech platform has built and made available this API Directory. These APIs provide programmatic access to PeopleStrong's suite of products through REST API endpoints. Our APIs are accessible to privileged customers and access would be provided on a request-only basis.\n\nWe publish enhancements to our APIs on a monthly basis. Please reach out to us at [Integrations@peoplestrong.com](mailto:Integrations@peoplestrong.com) for any queries you must have.\n\n---\n\n# API Types\n\nWe expose three types of APIs i.e. Inbound API, Outbound API, and Transactional API\n\n**Inbound API:** Inbound API are those API which we consumedata from our clients. In this API, our client’s application makes call to People Strong's API to put data in our database\n\n**Outbound API:** Outbound API are those API where we make call to send data to other application of our client’s platform.\n\n**Transactional API:** Transactional API are those API where handles API request on real time basis.\n\n---\n\n# Error Codes\n\nError Handling will be descriptive, and we have provided Error Codes upfront to help consumers understand the reason for error. There won’t be any limit on error. Error handling is hardcoded at the backend with error code, and it won’t be configurable. Exhaustive list of errors are shown below:\n\n- EC 2XXX Series: Successful\n    - EC 2000: Processed Successfully\n- EC 4XXX Series: Request contains bad syntax or cannot be fulfilled\n    - EC4001, Content-Type must be provided.\n    - EC4002, Integration name is not provided in the request.\n    - EC4003, Authorization header must be provided.\n    - EC4004, Access token not in proper format.\n    - EC4005, Invalid Dynamic Filter provided in the request body.\n    - EC4006, Invalid StartDate Filter.\n    - EC4007, Invalid EndDate Filter.\n    - EC4009, Range between start Date and end Date is greater than the startEndRange\n    - EC4010, Invalid filters sent in the request.\n- EC 5xxx: Server error. It will give the message as “API unable to fetch data” at user end.\n    - EC5000, INTERNAL_SERVER_ERROR\n    - EC5001, OUTBOUND_JOIN_COLUMN_ATTRIBUTE_NULL\n    - EC5002, NO_MARKER_FOR_REQUEST\n    - EC5003, PRIMARY_KEY_NULL\n    - EC 5004, SYNTAX_ERROR_IN_QUERY\n    - EC 5005, ERROR_IN_DYNAMIC_QUERY_CREATION\n    - EC 5006, MARKER_INSERTION_IN_DB_FAILURE\n    - EC 5007, REDIS_MARKER_DELETION_FAILURE\n    - EC 5008, MARKER_NULL_OR_INVALID\n    - EC 5009, ERROR_IN_DYNAMIC_QUERY_SYNTAX_OR_FROM_DATALAKE\n    - EC 5010, UNIQUE_IDENTIFIER_COLUMN_NAME_NULL\n    - EC5011, ONE_TO_ONE_TABLE_OR_PRIMARY_KEY_NULL\n    - EC5012, COLUMNWISE_TABLE_OR_PRIMARY_KEY_NULL\n    - EC 5013, MUTLIPLE_1M_TABLES_FOR_MASTER\n    - EC5014, MUTLIPLE_COLUMN_WISE_TABLES_FOR_MASTER\n    - EC5015, ERROR_FROM_CLIENT_CONFIG_API\n- 6xxx Custom: Client Side Config Error\n    - EC6001, API does not exist or is inactive for this organization.\n    - EC6002, Multiple APIs configured for this organization/entity.\n    - EC6003, Dataflowtype is null or empty.\n    - EC6004, Configured DataFlowType doesn't exist.\n    - EC6005, API Response Format is set as null.\n    - EC6006, Pagination Limit is configured as null. Please provide a valid value before proceeding.\n    - EC6007, Config not found for the given api\n    - EC6008, Invalid number of master types found for the outbound API.\n    - EC6009, No visible fields are configured in hierarchy for tree format.\n\n---\n\n# Rate Limiting\n\nAPI access rate limit applied on Size and Number of invocations. Number of invocation will be based on 'API request per hour', 'API request per day', and 'API request per month'. Our system will also show the status of your consumption.\n\n- Consumed API request details\n- Remaining API request details\n    \n\nIf the rate limit of API will exceed number of invocations, it will throw error, “API rate limit exceeded \" with status code 429. If API records exceeded the size, it will throw error, \"API size limit exceeded \" with status code 413.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"25536221","team":6054668,"collectionId":"867323f4-8f41-4ad9-95a8-42e6411e5146","publishedId":"2s935oMj6o","public":true,"publicUrl":"https://documenter-api.postman.tech/view/25536221/2s935oMj6o","privateUrl":"https://go.postman.co/documentation/25536221-867323f4-8f41-4ad9-95a8-42e6411e5146","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2023-02-06T07:10:22.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/087362e44b775d1a442eea399f289c95745cab57291a2aee61c79a44b12655ee","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s935oMj6o"}