![\"\"](\"https://api.corehr.com/resources/WebServiceCredentials.png\")
\n\n![\"\"](\"https://api.corehr.com/resources/UnmaskWebServiceCredentials2.png\")
\n\n![\"\"](\"https://api.corehr.com/resources/GrantWebServicePrivs.png\")
\n\nBatch Load Clocks into the XD system. We suggest sending no more then 10k clocks per batch or else the connection may time out. Esitmated 3 minutes for a 10k batch load.
\nAny errors in data parse will be returned immeditly with 400 error and a reponse giving specific detail as to what caused the rejection.
\n- \n
The JSON body uses standard data validation
\n- \n
- clockData. - JSON Array \n
person
\n- \n
- Max lenght 10. \n
- Mandatory if badgeno is empty. \n
badgeno\n * Max length 18.\n * Mandatory if person is empty.
\nmovement\n * Max length 1.\n * Valid values A I O and Empty.
\nclock\n * String date in format \"YYYY-MM-DD HH24:MI:SS TZH:TZM\"\n * Strictly Typed all parts of the date are required.
\ndeviceid\n * Max lenght 30.
\nExample Json Array.\n [{\n \"person\": \"T123456\",\n \"badgeno\":\"123434567\",\n \"movement\": \"I\",\n \"clock\": \"2021-11-01 09:00:15 +01:00\",\n \"deviceid\": \"1234567\"\n }, {\n \"person\": \"T123456\",\n \"badgeno\":\"123434567\",\n \"movement\": \"O\",\n \"clock\": \"2021-11-01 17:30:30 +01:00\",\n \"deviceid\": \"1234567\"\n }]\n- \n
- externalBatchId.
- \n
- Digits Only. \n
- Mandatory. \n
- Max length 30. \n
\n
\nThis endpoint is protected using oAuth2, it requires a valid Bearer Token to be sent in the Authorization header. Please refer to the Authorization guidelines outlined in the introduction.
\n \n
This endpoint will return a list of valid badges for third party clocking services.
\n- \n
- \n
- \n
- diff. \n Alphabetic Chars Only.\n Pass in 'Y' to return only differences since last time this api was called. \n Pass in 'N' to return a full list of valid badges clearing all out tracked changes. \n
\n The JSON Response
\n- \n
- badge
- \n
- String. Badge Number. \n
\n - person
- \n
- String. Personnel Number. \n
\n - name
- \n
- String. Persons Name. \n
\n - distroGroups
- \n
- Comma delimited Array of Distribution Groups. \n
\n - languageCode
- \n
- String. Prefered Language. \n
\n - status
- \n
- String. ACTIVE or DELETE. \n
\n
\n- badge
This endpoint is protected using oAuth2, it requires a valid Bearer Token to be sent in the Authorization header. Please refer to the Authorization guidelines outlined in the introduction.
\n \n
This endpoint will return a list of Distribution groups.
\n- \n
The JSON Response
\n- \n
- code
- \n
- String. Code for distribution groups. \n
\n - description
- \n
- String. Distribution group description \n
\n
\n- code
This endpoint is protected using oAuth2, it requires a valid Bearer Token to be sent in the Authorization header. Please refer to the Authorization guidelines outlined in the introduction.
\n \n
This Web Service provides a means of reporting the data that has been sent to the Clocking web service and the status of that clocking data in terms of it being interfaced into CoreTime.
\nParameters
\n- \n
id
\nType : Numeric Optional
\nThe ws_id unique id of the web service clocking. When a clocking is POSTed to the /clocking/user/ web service it returns this unique ws_id relating to the data just added.
\n \nperson
\nType : Alphanumeric Optional
\nThe personnel number in CoreHR of the person for whom the web service related clockings will be retrieved for.
\n \nbadge_no
\nType : Numeric Optional
\nThe badge number in CoreHR of the person for whom web service related clockings will be retrieved for.
\n \nappointment_id
\nType : Alphanumeric Optional
\nThe appointment id in CoreHR for which web service related clockings will be retrieved.
\n \ndevice_id
\nType : Alphanumeric Optional
\nThe device ID from which the clocking originated for which web service related clockings will be retrieved.
\n \nmoved_to_coretime
\nType : Alpha Optional
\nThe status of the clocking records being queried. Options include:
\n- \n
Y- Clockings that have been successfully interfaced into CoreTime \nN- Clockings that have not yet been interfaced into CoreTime. These will be actioned the next time the Clocking Interface to CoreTime is invoked. \nE- Clockings that have been attempted to be interfaced into CoreTime but have not been successfully inserted into coretime. Further details of the Error are included in the errMsg results returned. \n
\nstart_date_range
\nType : Date Optional
\nThe start of the date range from which Web Service Clocking will be retrieved. Required to use the standard ISO 8601 / CoreHR Standard YYYY-MM-DD format.
\n \nend_date_range
\nType : Date Optional
\nThe end of the date range from which Web Service Clocking will be retrieved. Required to use the standard ISO 8601 / CoreHR Sandard YYYY-MM-DD format.
\n \nThe JSON Response
\n- \n
WSID
\n- \n
- The unique id of the web service clocking record. \n
\nPERSON
\n- \n
- The CoreHR personnel number of the person the clocking record is for. Note that this will be automatically populated based on the badge number of the record if that was used to insert the clocking - provided that the badge number is associated with a valid CoreHR employee. \n
\nAPPOINTMENTID
\n- \n
- The Appointment ID of the clocking being queried. Only populated on sites where CoreTime is configured to run as multi-appointment. \n
\nBADGENO
\n- \n
- The CoreTime Badge Number of the clocking record. Only populated where the clocking was inserted using a badge number. \n
\nCLOCKDATETIME
\n- \n
- The Clock Date Time in the standard
YYYY-MM-DD HH24:MI TZH:TZMformat. This is the format the clocking record came in as. e.g.2018-09-04 00:16 +01:00\n Note that CoreHR will convert the data into the server system time before interfacing to CoreTime. \n
\n- The Clock Date Time in the standard
INSERTDATETIME
\n- \n
- The date (without time) that the clocking record was inserted. \n
\nRECORDTYPE
\n- \n
- The transactional event type that the clocking record is. \n
\nFUNCTIONCODE
\n- \n
- The optional function code related to the clocking record. \n
\nFUNCTIONVALUE
\n- \n
- The function value related to the function code above. e.g. if the FUNCTIONCODE was
COSTand the FUNCTIONVALUE was1then the clocking would relate to Cost Centre 1. \n
\n- The function value related to the function code above. e.g. if the FUNCTIONCODE was
DEVICEID
\n- \n
- Text field to report on the device that the clocking originated from. \n
\nCLOCKDATESYSTEMTZ
\n- \n
- The Clock Date converted to the System Time Zone for the clocking record. e.g. a clocking for
2018-09-20 00:46 +02:00would be2018-09-19when converted to system date presuming server resides in +01:00 time zone (i.e UTC+1 for daylight savings). \n
\n- The Clock Date converted to the System Time Zone for the clocking record. e.g. a clocking for
CLOCKTIMESYSTEMTZ
\n- \n
- The Clock time converted to the System Time Zone for the clocking record. e.g. a clocking for
2018-09-20 00:46 +02:00would be23:46when converted to system date presuming server resides in +01:00 time zone (i.e UTC+1 for daylight savings). \n
\n- The Clock time converted to the System Time Zone for the clocking record. e.g. a clocking for
CORETIMECLOCKDATE
\n- \n
- The CoreTime Date. This is because CoreTime may need to perform some adjustments to the clocking once it is inserted into CoreTime based on the pattern the person is working and if it relates to an overnight. \n
\nCORETIMECLOCKTIME
\n- \n
- The CoreTime Time. This is because CoreTime may need to perform some adjustments to the clocking once it is inserted into CoreTime based on the pattern the person is working and if it relates to an overnight. \n
\nCORETIMEACTUALCLOCKDATE
\n- \n
- The CoreTime actual date of clocking for reporting purposes. \n
\nMOVEDTOCORETIME
\n- \n
- Indicates what the status of this clocking record is in terms of its having been transferred to CoreTime. Options are:\n
Ywhere the record has been successfully transferred into CoreTime.\nNwhere the record has not yet been attempted to be transferred into CoreTime.\nEwhere an attempt was made to move the record into CoreTime but an error occurred when doing so. \n
\n- Indicates what the status of this clocking record is in terms of its having been transferred to CoreTime. Options are:\n
ERRIND
\n- \n
- Indicates if an error occurred when transferring the clocking for the web service into CoreTime. Can be either
YorN. \n
\n- Indicates if an error occurred when transferring the clocking for the web service into CoreTime. Can be either
ERRLOGID
\n- \n
- The unique id of the error record on the system. Only ever populated when there was an error transferring the clocking to CoreTime. i.e. only populated when ERRIND above is
Y. \n
\n- The unique id of the error record on the system. Only ever populated when there was an error transferring the clocking to CoreTime. i.e. only populated when ERRIND above is
ERRMSG
\n- \n
- A message explaining the error that occurred when transferring the record into CoreTime. \n
\n
\n
Create a clocking record in the clocking module for subsequent transfer into CoreTime. On successful completion, users will have submitted a new clocking record which subject to subsequent CoreTime validation will be transferred into CoreTime the next time the interface runs.
\nJSON Request Body Explained
\nperson
\nIs an CoreHR employee id also known as personnel number although it is alphanumeric.
badge_no
\nIs the badge number that the CoreHR employee uses. Badge must be valid and linked to a valid CoreHR employee for the clocking to interface into CoreTime.
\nclock_date_time
\nThe Date and Time that this particular clocking is for. Required to be in YYYY-MM-DD HH24:MI TZH:TZM format. Mandatory.
\nrecord_type
\nThe Transactional event associated with the clocking. Optional but if specified must be one of:
\n- \n
B0Undefined. \nB1In. \nB2Out. \nB3Business Absence. \n
function_code
\nOptional function code but if specified must be one of:
\n- \n
CALLIN\nUNSBRK\nSTD\nTNAIN\nCALLOT\nTNAOUT\nOVERTM\nCOST\n
function_value
\nOptional function_value relating to the above code. When using the function_code COST then the Cost Centre provided in the function_value is validated against the CoreHR Cost Centres.
device_id
\nOptional free text to describe the Device ID where the clocking was recorded e.g. Main Entrance Device.
\nappointment_id
\nCoreHR Appointment ID of person clocking in. Note: if using this field then person must also be used. i.e. this field cannot be used in conjunction with the badge_no field. Also note: this cannot be used at all if the CoreTime site is not Multi-Appointment. If the site is Multi-Appointment then the field is optional unless the ClockingWebservices Appointment Mandatory for Clockings option in the CoreTime Global Parameters screen is selected.
Mandatory
\n- \n
- Either
personorbadge_no\n clock_date_time\nappointment_idfor Multi-Appointment sites where the Webservices Appointment Mandatory for Clockings option in the CoreTime Global Parameters screen is selected. \n
The clocking module provides ability to insert CoreTime clocking records for a PeopleXD employee.
\nConstraints, Limitations, Mandatory and Validation
\nThe clocking module is designed to handle clockings for CoreTime. Clocking by person or badge_no is possible. It is also as of Version 27 possible to perform clocking by appointment for CoreTime Multi-Appointment sites. When using clock by appointment both the appointment_id and the person must be provided. i.e. badge_no cannot be used together with appointment_id. Appointments for the clocking web service can only be used as long as CoreTime is configured in Multi-Appointment mode (ct_global_param.multi_appointment). Provided CoreTime is running as a Mutli- Appointment site it is possible to make appointments mandatory for the clocking web service using the Appointment Mandatory For Clockings option (ct_global_param.ws_clocking_appt_mandatory) in the CoreTime Global Params screen.
In Version 27 (V27) of PeopleXD the Clocking webservice completes the following validation:
\n* Person is a valid PeopleXD employee.\n* Badge is a valid PeopleXD Badge for a valid PeopleXD employee. If both badge and person are populated badge take precedence.\n* Record Type is valid.\n* Function Code is valid. When using COST then it validates that the Function Value is a valid Cost Centre.\n* Appointment ID is valid on the specified clocking date - if the site is Multi-Appointment based. Also validates that the field is populated if it is mandatory.\n* Duplicate Clocking - defined as where a clocking already exists in CoreTime for this person at the same date/time. Clockings are converted to system time for this comparison i.e. 09:00 +00:00 is the same as 08:00 +01:00.
Prior to V27 much of the above validation was performed later at the point of interface into CoreTime.
Fields are as in the table below:
\nNote: Clock Date Time is mandatory and either Person or Badge No must also be provided.
\nNote2: Appointment ID is an optional parameter for use if the site is configured as CoreTime Multi-Appointment. This can be made mandatory by also activating the Appointment Mandatory for Clockings option in CoreTime.
\nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n* 400 / 001 Both badge and person fields are not populated. One must be populated.\n* 400 / 002 clock_date_time field is not populated.\n* 400 / 003 clock_date_time field is not in the correct format.\n* 404 / 004 Non standard database exception inserting this clocking.\n* 404 / 005 record_type is invalid. Must be either empty, B0, B1, B2 or B3.\n* 400 / 006 function_code is invalid. Must be either empty, CALLIN, UNSBRK, STD, TNAIN, CALLOT, TNAOUT, OVERTM or COST.\n* 400 / 007 CoreTime is not configured to run using appoinments but an appointment has been provided as part of this request.\n* 400 / 008 badge_no and appointment_id cannot be used together. If you want to clock by appointment, then only personnel_no and appointment_id must be provided but badge_no must be blank.\n* 400 / 009 appointment_id is configured to be a required field but none has been provided.\n* 400 / 010 The appointment_id provided for this person is not valid - check that the appointment id is valid on the system and that it is valid on the clocking date provided.\n* 400 / 011 The badge_no provided is not a valid badge on the system.\n* 400 / 012 The person provided is not a valid person on the system.\n* 400 / 013 The Cost Centre provided in the function_value for is not a valid Cost Centre on the system.\n* 400 / 014 This is a duplicate Clocking. Clocking with this detail has already been interfaced to Core Time.\n* 400 / 015 Clocking with this detail is already in the queue to be interfaced to Core Time.\n* 400 / 016 When specifying a date range to use the start date range must be before the end date range.\n* 400 / 017 When using the id parameter only numeric values are valid.\n* 400 / 999 Basic sanitization error. Where a filed is not the correct data type or length or the data is deemed to be unsafe for recording within the system. Details of the fields failing sanitization are returned in the sanatizeError object in the Response.
\n","event":[{"listen":"prerequest","script":{"id":"0ce39f37-cfae-42d6-8c3c-e368d00156bc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"91d2bb1b-cbc9-45e6-a232-44afb8ac61d0","type":"text/javascript","exec":[""]}}],"_postman_id":"8d5869dd-2524-4fa5-bbd5-0da86a2f8860"},{"name":"Contact","item":[{"name":"/contact/","id":"3a36457f-3c97-43ed-858b-7638ceb8106a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer p7Zy3YYr3Yck6yOVXUYPaQ.."}],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/","description":"Get a list of registered / whitelisted contacts. Tenant has an ability to define contacts available for creating / updating. A tenant may not allow all contacts to be updated or created, this base URI provides the list of valid contact types. In cases where server returns validation errors, refer to this list.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"73c1c930-0f3c-4897-9bd9-e72bc78cda29","name":"200 - Response OK","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:00:52 GMT","name":"Date","description":""},{"key":"ETag","value":"\"uwlnRwLu1teq90JMcLw3B68+EOyVApqwZ0O87dUiP4G6rHtTNS14dRJz0YaKyE8k7RmWTnrUodwqt3OwuAMICA==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"EMAIL\", \"length\": 80, \"dataType\" : \"EMAIL\"}\n,\n{\"type\":\"MOBILE\", \"length\": 20, \"dataType\" : \"MOB\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 2,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/contact/\"\n }\n ]\n}\n"}],"_postman_id":"3a36457f-3c97-43ed-858b-7638ceb8106a"},{"name":"/contact/:type/","id":"2a6a16b8-846a-4bea-afeb-e4d97236ac06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/EMAIL/","description":"Get a list of all users for a particular contact type. Typically used to get a list of all users email addresses.
This service will only return whitelisted contact types. A tenant may decide to only whitelist a subset of all contacts e.g. EMAIL is whitelisted while MOBILE is not. Only accounts where the contact type is populated are returned. To find accounts with missing contact information use the web service /contact/missing/:type
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","EMAIL",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"831c218f-2afd-4122-904e-6edc627a12da","name":"404 - Invalid Contact type","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/MOB/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 15 Nov 2016 19:51:28 GMT","name":"Date","description":""},{"key":"ETag","value":"\"WIZPZbpKwxRRgssW8lwH34floeFnPJzhb0Pc1fxiiWRv2Gqy41LgVu19up1qzvTBBMK6i635jWpyDaAsi5TVnQ==-gzip\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"002\",\"errorMessage\" :\"Validation failed. Contact type does not exist\" }}\n"},{"id":"94661f24-f169-452c-87cc-6fe7ce6df0da","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/EMAIL/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 15 Nov 2016 19:46:57 GMT","name":"Date","description":""},{"key":"ETag","value":"\"6iQZlpyFhjCcA3IiwUAR9L8mLF0w4tdo6M6kmFN3AV+v32sX/fFbqqgk/bMg7pMmUv2y1+9/cnGbLcj57836dw==-gzip\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"coreHRId\":\"003676\", \"value\": \"webservices003676@corehr.com\"}\n,\n{\"coreHRId\":\"003674\", \"value\": \"webservices003674@corehr.com\"}\n,\n{\"coreHRId\":\"003332\", \"value\": \"webservices003332@corehr.com\"}\n,\n{\"coreHRId\":\"003333\", \"value\": \"webservices003333@corehr.com\"}\n,\n{\"coreHRId\":\"INT009\", \"value\": \"webservicesINT009@corehr.com\"}\n,\n{\"coreHRId\":\"INT010\", \"value\": \"webservicesINT010@corehr.com\"}\n,\n{\"coreHRId\":\"600100\", \"value\": \"webservices600100@corehr.com\"}\n,\n{\"coreHRId\":\"600101\", \"value\": \"webservices600101@corehr.com\"}\n,\n{\"coreHRId\":\"600102\", \"value\": \"webservices600102@corehr.com\"}\n,\n{\"coreHRId\":\"7777\", \"value\": \"webservices7777@corehr.com\"}\n,\n{\"coreHRId\":\"C876876\", \"value\": \"webservicesC876876@corehr.com\"}\n,\n{\"coreHRId\":\"003193\", \"value\": \"webservices003193@corehr.com\"}\n,\n{\"coreHRId\":\"003528\", \"value\": \"webservices003528@corehr.com\"}\n,\n{\"coreHRId\":\"gh1234\", \"value\": \"webservicesgh1234@corehr.com\"}\n,\n{\"coreHRId\":\"JG1234\", \"value\": \"webservicesJG1234@corehr.com\"}\n,\n{\"coreHRId\":\"002145\", \"value\": \"webservices002145@corehr.com\"}\n,\n{\"coreHRId\":\"002144\", \"value\": \"webservices002144@corehr.com\"}\n,\n{\"coreHRId\":\"002146\", \"value\": \"webservices002146@corehr.com\"}\n,\n{\"coreHRId\":\"000660\", \"value\": \"webservices000660@corehr.com\"}\n,\n{\"coreHRId\":\"002626\", \"value\": \"webservices002626@corehr.com\"}\n,\n{\"coreHRId\":\"000740\", \"value\": \"webservices000740@corehr.com\"}\n,\n{\"coreHRId\":\"000936\", \"value\": \"webservices000936@corehr.com\"}\n,\n{\"coreHRId\":\"000830\", \"value\": \"webservices000830@corehr.com\"}\n,\n{\"coreHRId\":\"000831\", \"value\": \"webservices000831@corehr.com\"}\n,\n{\"coreHRId\":\"000880\", \"value\": \"webservices000880@corehr.com\"}\n,\n{\"coreHRId\":\"1000491\", \"value\": \"webservices1000491@corehr.com\"}\n,\n{\"coreHRId\":\"000014\", \"value\": \"webservices000014@corehr.com\"}\n,\n{\"coreHRId\":\"000115\", \"value\": \"webservices000115@corehr.com\"}\n,\n{\"coreHRId\":\"000012\", \"value\": \"webservices000012@corehr.com\"}\n,\n{\"coreHRId\":\"000015\", \"value\": \"webservices000015@corehr.com\"}\n,\n{\"coreHRId\":\"000296\", \"value\": \"webservices000296@corehr.com\"}\n,\n{\"coreHRId\":\"000297\", \"value\": \"webservices000297@corehr.com\"}\n,\n{\"coreHRId\":\"000328\", \"value\": \"webservices000328@corehr.com\"}\n,\n{\"coreHRId\":\"000590\", \"value\": \"webservices000590@corehr.com\"}\n,\n{\"coreHRId\":\"000227\", \"value\": \"webservices000227@corehr.com\"}\n,\n{\"coreHRId\":\"001873\", \"value\": \"webservices001873@corehr.com\"}\n,\n{\"coreHRId\":\"000275\", \"value\": \"webservices000275@corehr.com\"}\n,\n{\"coreHRId\":\"CUT-001\", \"value\": \"webservicesCUT-001@corehr.com\"}\n,\n{\"coreHRId\":\"END-001\", \"value\": \"webservicesEND-001@corehr.com\"}\n,\n{\"coreHRId\":\"000286\", \"value\": \"webservices000286@corehr.com\"}\n,\n{\"coreHRId\":\"001987\", \"value\": \"webservices001987@corehr.com\"}\n,\n{\"coreHRId\":\"000180\", \"value\": \"webservices000180@corehr.com\"}\n,\n{\"coreHRId\":\"001993\", \"value\": \"webservices001993@corehr.com\"}\n,\n{\"coreHRId\":\"000598\", \"value\": \"webservices000598@corehr.com\"}\n,\n{\"coreHRId\":\"000601\", \"value\": \"webservices000601@corehr.com\"}\n,\n{\"coreHRId\":\"002037\", \"value\": \"webservices002037@corehr.com\"}\n,\n{\"coreHRId\":\"GH992\", \"value\": \"webservicesGH992@corehr.com\"}\n,\n{\"coreHRId\":\"000119\", \"value\": \"webservices000119@corehr.com\"}\n,\n{\"coreHRId\":\"000124\", \"value\": \"webservices000124@corehr.com\"}\n,\n{\"coreHRId\":\"000587\", \"value\": \"webservices000587@corehr.com\"}\n,\n{\"coreHRId\":\"000588\", \"value\": \"webservices000588@corehr.com\"}\n,\n{\"coreHRId\":\"000592\", \"value\": \"webservices000592@corehr.com\"}\n,\n{\"coreHRId\":\"000594\", \"value\": \"webservices000594@corehr.com\"}\n,\n{\"coreHRId\":\"002315\", \"value\": \"webservices002315@corehr.com\"}\n,\n{\"coreHRId\":\"000904\", \"value\": \"webservices000904@corehr.com\"}\n,\n{\"coreHRId\":\"002261\", \"value\": \"webservices002261@corehr.com\"}\n,\n{\"coreHRId\":\"002262\", \"value\": \"webservices002262@corehr.com\"}\n,\n{\"coreHRId\":\"CUT-012\", \"value\": \"webservicesCUT-012@corehr.com\"}\n,\n{\"coreHRId\":\"002248\", \"value\": \"webservices002248@corehr.com\"}\n,\n{\"coreHRId\":\"002249\", \"value\": \"webservices002249@corehr.com\"}\n,\n{\"coreHRId\":\"002250\", \"value\": \"webservices002250@corehr.com\"}\n,\n{\"coreHRId\":\"002367\", \"value\": \"webservices002367@corehr.com\"}\n,\n{\"coreHRId\":\"002368\", \"value\": \"webservices002368@corehr.com\"}\n,\n{\"coreHRId\":\"002369\", \"value\": \"webservices002369@corehr.com\"}\n,\n{\"coreHRId\":\"000826\", \"value\": \"webservices000826@corehr.com\"}\n,\n{\"coreHRId\":\"000897\", \"value\": \"webservices000897@corehr.com\"}\n,\n{\"coreHRId\":\"001128\", \"value\": \"webservices001128@corehr.com\"}\n,\n{\"coreHRId\":\"002629\", \"value\": \"webservices002629@corehr.com\"}\n,\n{\"coreHRId\":\"002697\", \"value\": \"webservices002697@corehr.com\"}\n,\n{\"coreHRId\":\"000934\", \"value\": \"webservices000934@corehr.com\"}\n,\n{\"coreHRId\":\"002624\", \"value\": \"webservices002624@corehr.com\"}\n,\n{\"coreHRId\":\"000290\", \"value\": \"webservices000290@corehr.com\"}\n,\n{\"coreHRId\":\"000837\", \"value\": \"webservices000837@corehr.com\"}\n,\n{\"coreHRId\":\"002444\", \"value\": \"webservices002444@corehr.com\"}\n,\n{\"coreHRId\":\"002685\", \"value\": \"webservices002685@corehr.com\"}\n,\n{\"coreHRId\":\"002227\", \"value\": \"webservices002227@corehr.com\"}\n,\n{\"coreHRId\":\"002169\", \"value\": \"webservices002169@corehr.com\"}\n,\n{\"coreHRId\":\"000849\", \"value\": \"webservices000849@corehr.com\"}\n,\n{\"coreHRId\":\"000808\", \"value\": \"webservices000808@corehr.com\"}\n,\n{\"coreHRId\":\"002091\", \"value\": \"webservices002091@corehr.com\"}\n,\n{\"coreHRId\":\"1010101010\", \"value\": \"webservices1010101010@corehr.com\"}\n,\n{\"coreHRId\":\"20202020\", \"value\": \"webservices20202020@corehr.com\"}\n,\n{\"coreHRId\":\"GM967\", \"value\": \"webservicesGM967@corehr.com\"}\n,\n{\"coreHRId\":\"GM969\", \"value\": \"webservicesGM969@corehr.com\"}\n,\n{\"coreHRId\":\"DB678\", \"value\": \"webservicesDB678@corehr.com\"}\n,\n{\"coreHRId\":\"002651\", \"value\": \"webservices002651@corehr.com\"}\n,\n{\"coreHRId\":\"gh23\", \"value\": \"webservicesgh23@corehr.com\"}\n,\n{\"coreHRId\":\"6633228\", \"value\": \"webservices6633228@corehr.com\"}\n,\n{\"coreHRId\":\"250\", \"value\": \"webservices250@corehr.com\"}\n,\n{\"coreHRId\":\"260\", \"value\": \"webservices260@corehr.com\"}\n,\n{\"coreHRId\":\"002705\", \"value\": \"webservices002705@corehr.com\"}\n,\n{\"coreHRId\":\"002103\", \"value\": \"webservices002103@corehr.com\"}\n,\n{\"coreHRId\":\"000950\", \"value\": \"webservices000950@corehr.com\"}\n,\n{\"coreHRId\":\"002756\", \"value\": \"webservices002756@corehr.com\"}\n,\n{\"coreHRId\":\"002652\", \"value\": \"webservices002652@corehr.com\"}\n,\n{\"coreHRId\":\"jg1234\", \"value\": \"webservicesjg1234@corehr.com\"}\n,\n{\"coreHRId\":\"DF5609\", \"value\": \"webservicesDF5609@corehr.com\"}\n,\n{\"coreHRId\":\"002289\", \"value\": \"webservices002289@corehr.com\"}\n,\n{\"coreHRId\":\"002727\", \"value\": \"webservices002727@corehr.com\"}\n,\n{\"coreHRId\":\"000179\", \"value\": \"webservices000179@corehr.com\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 100,\"hasMore\":true\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://localhost/ws/tenant/corehr/v1/contact/EMAIL/\"\n },\n {\n \"rel\": \"next\",\n \"href\": \"https://localhost/ws/tenant/corehr/v1/contact/EMAIL/?offsetby=100\"\n }\n ]\n}\n"}],"_postman_id":"2a6a16b8-846a-4bea-afeb-e4d97236ac06"},{"name":"/contact/user/:person/","id":"c91a75ef-4ea7-4bfd-985a-843665e014c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/","description":"This web service returns all contacts for the person.
This web service returns a specific contact for an associated person and type. Refer to /contact/ for a complete list of contacts available.
This web service provides ability to create a new contact type for a user. The contact type should not already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available.
\nThe value of the contact type must be provided in the request body as JSON e.g.
\n\n\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"13607f96-1ee2-467c-9100-f2e0b65e17cb","name":"400 - Bad Request - Error Code 006","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:41:20 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"006\",\"errorMessage\" :\"Validation failed. Existing contact for user, use PATCH to update\" }}\n"},{"id":"344e78a1-7889-4858-90f2-2e1272289d38","name":"400 - Bad Request - Error Code 001","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:42:45 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"001\",\"errorMessage\" :\"Mandatory fields are missing\" }}\n"},{"id":"37d6cabc-0143-4977-a50e-c3ac3f4517a4","name":"201 - Success - Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:40:49 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"},{"id":"7f229075-2fe4-464c-9047-08443856c1e5","name":"404 - Not Found - Error Code 003","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/7788/EMAIL"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:43:31 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"003\",\"errorMessage\" :\"Validation failed. User account does not exist\" }}\n"},{"id":"dfee6d8d-9c16-43b8-866d-33345774102e","name":"400 - Bad Request - Error Code 005","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/PHONE"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:44:28 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"005\",\"errorMessage\" :\"Validation failed. Ensure contact type is allowed and has correct format\" }}\n"}],"_postman_id":"136efeb9-f7c5-415e-a31f-0e3791da6049"},{"name":"/contact/user/:person/:type","id":"b792d56e-e89d-42fc-a0d5-ebb903d05551","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"value\" :\"darragh.james.duffy@corehr.com\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL","description":"{\"value\" :\"darragh.james.duffy@corehr.com\"}
\n
This web service provides ability to patch / update a contact type for a user. The contact type must already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available.
\nThe value of the contact type must be provided in the request body as JSON e.g.
\n\n\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"31faaeb0-8355-4b56-af0a-6f2e5d4d8032","name":"404 - Not Found - Error Code 003","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/7788/EMAIL"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:47:30 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"003\",\"errorMessage\" :\"Validation failed. User account does not exist\" }}\n"},{"id":"4e5d4c60-bea4-4476-b714-8a026eee0ae3","name":"400 - Bad Request - Error Code 001","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:46:55 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"001\",\"errorMessage\" :\"Mandatory fields are missing\" }}\n"},{"id":"b6545e7d-bb7b-4fc3-9f61-669ac0d834c4","name":"404 - Not Found - Error Code 002","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/Phone"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:48:16 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"002\",\"errorMessage\" :\"Validation failed. Contact does not exist\" }}\n"},{"id":"d10b8742-89f8-49e3-81b1-1b3307c26bfe","name":"201- Success - Created","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:45:19 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"b792d56e-e89d-42fc-a0d5-ebb903d05551"},{"name":"/contact/user/:person/:type","id":"f2f05d0b-c47e-4057-a7d6-92debd1b23c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL","description":"{\"value\" :\"darragh.james.duffy@corehr.com\"}
\n
This web service provides ability to delete a contact from a users / employees profile. The contact type should already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available. All contact types are case sensitive.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"83b58572-c6cb-47ce-a9e0-e127d2b8ab4d","name":"200 - Response OK","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 11 Nov 2016 14:46:13 GMT","name":"Date","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"f2f05d0b-c47e-4057-a7d6-92debd1b23c1"},{"name":"/contact/missing/:type","id":"bb201adb-6317-4656-8bf1-eb0010687568","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/missing/EMAIL","description":"This web service provides ability to list user accounts with missing contact types. For example find all users with a missing EMAIL contact.
This examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Contact module provides ability to interact with contact information associated with an account in PeopleXD. Different contact types exist and can be defined by a tenant e.g EMAIL, MOBILE etc. Not all tenants have the same list of contacts i.e. each tenant can define a whitelist of contacts exposed to web services.
\nContraints, Limitations & Mandatory
\nThe contact module is case senstive, no process converts the contact type provided to upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned. Within PeopleXD contact types are typically uppercase.
\nPerson is mandatory, person represents users unique PeopleXD ID, this is often referenced as personnel number
Optionally
\nProvide the type of contact e.g. EMAIL to get users associated email address.
In cases where type is not specified all contact details are returned associated with employee.
In Summary contact provides ability to
\n* Enumerate users contact information\n* Obtain a specific contact type\n* Update / Patch an existing contact type\n* Assign a new contact type to a user
\nError Codes
\nNote type is case senstive, no process converts the type provided into upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned.
Convention is HTTP Status Code / Verbose Code
\n* 400 / 001 Mandatory fields are missing\n* 404 / 002 Validation failed. Contact does not exist\n* 404 / 003 Validation failed. User account does not exist\n* 400 / 005 Validation failed. Ensure contact type is allowed and has correct format\n* 400 / 006 Validation failed. Existing contact for user, use PATCH to update\n* 404 / 007 Contact type does not exist for user, consider using POST to create
\nNote
\nWhere a contact exists within PeopleXD , this does not mean an account in PeopleXD has this contact assigned, e.g. not every account would have a mobile / cell number. Keep this in mind if you attempt to PATCH a contact type and server responds with a validation error.
\n","_postman_id":"0e5bd16c-a50b-4673-acb1-201a90a98277"},{"name":"Image","item":[{"name":"/image/user/","id":"343731cf-6d46-4277-98f7-75f0df4df427","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"Bearer MZun_JVHkiiNm9SXgadz4A.."}],"url":"{{url}}/ws/{{schema}}/{{version}}/image/user/0890126","description":"This Web Service is used to retrieve (GET) the image profile for a CoreHR user on the system. Returns a binary image file.
\nExample cURL:
\n$ curl -o ./local_copy_of_profile.jpeg -k --request GET --url https://devapi.corehr.com/ws/frame/corehr/v1/image/user/0890126 \\\n --header 'authorization: Bearer MZun_JVHkiiNm9SXgadz4A..'\nThis command will save the binary image of CoreHR User 0890126 into the file local_copy_of_profile.jpeg. If alternatively the person did not have an image on the system then the web service would return an http code 404 with and verbose errorCode of 1008.
Example cURL:
\n$ curl --request POST --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/png' \\\n --header 'authorization: Bearer E63-fevVwKH-CV4E_TScUA..' \\\n --data-binary \"@./original_profile.png\" \nThe above cURL will insert the file original_profile.png as the binary image profile photo for the CoreHR User 0890126 where they do not have an profile image already configured on the system.
Web Service used to update the profile image for a CoreHR user on the system. This overwrites their current profile image with this new image. The image is provided as binary data in the body of the request.
\nExample cURL:
\n$ curl --request PATCH --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/jpeg' \\\n --header 'authorization: Bearer Fbbanqy44exS0Nat7Ep3oQ..' \\\n --data-binary \"@./new_profile.jpg\" \nThe above cURL will insert the file new_profile.jpg as the binary image profile photo for the CoreHR User 0890126 where they already have a profile image in CoreHR. This will over-write the existing profile image.
This Web Service is used to retrieve (GET) the image profile for a CoreHR user on the system. Returns a binary image file.
\nExample cURL:
\n$ curl -o ./local_copy_of_profile.jpeg -k --request GET --url https://devapi.corehr.com/ws/frame/corehr/v1/image/user/0890126 \\\n --header 'authorization: Bearer MZun_JVHkiiNm9SXgadz4A..'\nThis command will save the binary image of CoreHR User 0890126 into the file local_copy_of_profile.jpeg. If alternatively the person did not have an image on the system then the web service would return an http code 404 with and verbose errorCode of 1008.
Web Service used to update the profile image for a CoreHR user on the system. This overwrites their current profile image with this new image. The image is provided as binary data in the body of the request.
\nExample cURL:
\n$ curl --request PATCH --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/jpeg' \\\n --header 'authorization: Bearer Fbbanqy44exS0Nat7Ep3oQ..' \\\n --data-binary \"@./new_profile.jpg\" \nThe above cURL will insert the file new_profile.jpg as the binary image profile photo for the CoreHR User 0890126 where they already have a profile image in CoreHR. This will over-write the existing profile image.
This Web Service is used to insert a profile image for a CoreHR user on the system where none exists. The image is provided as binary data in the body of the request.
\nExample cURL:
\n$ curl --request POST --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/png' \\\n --header 'authorization: Bearer E63-fevVwKH-CV4E_TScUA..' \\\n --data-binary \"@./original_profile.png\" \nThe above cURL will insert the file original_profile.png as the binary image profile photo for the CoreHR User 0890126 where they do not have an profile image already configured on the system.
The image web service provides a means for uploading and viewing a PeopleXD user's profile picture.
\nConstraints, Limitations, Mandatory and Validation
\nImages uploaded can be a maximum of 500KB in size and must be provided in one of the following file formats:
\n* gif\n* png\n* jpeg\n* tiff
\nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n* 415 / 1001 Invalid content type, only image/gif, image/png, image/jpeg or image/tiff allowed\n* 415 / 1002 n image file (gif, png, jpeg or tiff) of size greater than zero must be attached to this request.\n* 415 / 1003 There was an issue with the supplied image being recognized as a supported image (gif, png, jpeg or tiff) please save as another supported format and re-try.\n* 415 / 1004 The attached image exceeded the maximum allowed file size for an image.\n* 400 / 1005 The person supplied is not currently a valid person on the system. Please check the personnel details.\n* 400 / 1006 This person does not have an image on the system to update please change this request to POST to insert the image.\n* 400 / 1007 This person already has an image on the system to insert please change this request to PATCH to update the image.\n* 404 / 1008 This person does not currently have an image on the system to retrieve.
\n","_postman_id":"2ed72dd2-1cd6-4746-b27d-e039e6b6da1a"},{"name":"Provision","item":[{"name":"native","item":[{"name":"auth","item":[{"name":"/provision/native/auth/uuid/","id":"1075210e-62c0-4f22-9c0d-12382df38fb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Use this service if you want to remove UUID's. The service can facility bulk UUID removal/purge and individual employee UUID.
\nThis is useful in cases where you have a need
\n- \n
- to remove an individuals UUID e.g. as part of a leaver process. \n
- to implement a policy requiring users to re-register, this would be similar to a password policy \n
Constraints and Limitations
\n- \n
typemust be one of the following: \n
ALL
\n- \n
id\n
must now be a valid type i.e. a valid Email address. In cases where ALL is used for type, the id should be left blank.
\nIf invalid ID provided nothing is deleted, i.e. if an invalid email address provided a status of 404 is returned. For valid email address a 200 is returned, indicating a success.
\nParameters
\n- \n
typethis must be email, username, employeeNumber or all. \"ALL\" is reserved for bulk removal, this will remove all the registered UUID's, therefore use with caution \nidthis must be a valid email address \n
CoreHR's native mobile application facilitates users registering once and then using biometric (e.g. touchID, FaceID) or PIN to unlock the application i.e. the user does not require a username / password each time they login. However a user is required to unlock the app via biometric or PIN.
\nA tenant may have a requirement to implement a different policy e.g. a user must authenticate via username / password at least once a day, week or month i.e. similar to password policies. CoreHR makes no assumptions for password policies, instead tenants can implement their own policies.
\nIn order to faciliate these requirments web services can be used. A tenant can generate a new app grant priviliges to this module and end point.
\n","_postman_id":"415d2e84-12e7-4d19-b7a6-47034bbc23ae"}],"id":"8069402f-cc56-41a0-bd0b-e34b818e07f0","description":"The native module manages authentication and tokens for the CoreHR native application. These services cater for both SAML and non-SAML customers. All request will be handled via TLS.
\nThis service provides:
\n- \n
- Ability to remove / purge / reset Uses UUID's \n
Find all non provisioned accounts. This endpoint will return all users not yet provisioned.
\nThis examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Optionally provide number of days, this service is used to offset users start date. Provides ability to determine accounts not yet provisioned in CoreHR for Core|Portal self service access. This service will include employees due to start in the future.
\nAllowing the following scenario.
\n- \n
obtain user accounts to be provisioned within the last X number of days, i.e. a start date occurring in the past.
\n \nobtain user accounts to be provisioned with a future start date, i.e. users starting in the future.
\n \n
This examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Provisions a new CorePortal account; on successful completion, users will have ability to access CoreHR's self service features via CorePortal. As noted in the introduction to the provisioning module, where an IDM or third party application understands CorePortal privileges this module will accept these privileges. Example provided below includes Users Privilege.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- authType \n
This is the authentication type for the employee, the value here should be either inApplicationPassword or LDAP. For all single sign on authenticated accounts use LDAP. For non single sign on account set this value to inApplicationPassword this then requires the password attribute to be set. Leaving this parameter null indicates to CoreHR that the user account should pick up the system default authentication type, this parameter can be found in CoreHR as 'authtype'.
- \n
- password \n
This attribute is required when authType is inApplicationPassword. The value here will be validated against the password policy in CoreHR.
- \n
- privileges \n
An array, each array object contains a privilege.
\nMandatory
\n- \n
- corehrid \n
- loginid \n
- password (only when authType is inApplicationPassword) \n
Provides ability to patch (amend) an existing account. Account must have previously been provisioned, this means corehrID must previously have been generated via POST. In general this service supports Single Sign On style accounts.
It is possible to use this service with non SSO accounts, in such cases all parameters are mandatory including password and explcitly setting authType to inApplicationPassword. In cases where authType is not provided the account is assumed to be Single Sign On.
The use cases for this web service includes
\n- \n
- loginId changing \n
Where a user changes their loginId e.g. their name changes because of marriage, this web service faciliates this change of ID.
\n- \n
- privilege changing \n
executing this web service will remove all current privileges and replace with the privileges array. It is therefore possible to use this web service to revoke all privileges for a user by sending a blank array of privileges.
\nExample provided below changes both Login ID and privileges.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- authType \n
This is the authentication type for the employee, the value here should be either inApplicationPassword or LDAP. For all single sign on authenticated accounts use LDAP. For non single sign on account set this value to inApplicationPassword this then requires the password attribute to be set. In cases where this attribute is null, assumpetion is Single Sign On.
- \n
- password \n
This attribute is required when authType is inApplicationPassword. The value here will be validated against the password policy in CoreHR.
- \n
- privileges \n
An array, each array object contains a privilege. If this is blank all privs are revoked.
\nMandatory
\n- \n
- corehrid \n
- loginid \n
- password (only when authType is inApplicationPassword) \n
For Non SSO Accounts all parameters are mandatory.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","provision","user"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ad614ee9-63d9-4c85-b2bb-dc726637e5b5","name":"201 - Created - Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\n \"corehrid\" : \"002875\",\n \"loginid\" : \"jones.donovan@corehr.com\",\n \"privileges\" : [\n {\"privilege\" : \"developmentTeam\"},\n {\"privilege\" : \"VPNGroup\"}\n ]\n}\n"},"url":"{{url}}/ws/{{schema}}/{{version}}//provision/user"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 05 Oct 2016 16:42:46 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"81ab924d-52b1-4c92-9e29-8209ddfb2bc1"},{"name":"/provision/user/status/:id","id":"6788199b-72fa-416e-a1a4-249482969277","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100","description":"Obtain user account status indicator; determining if an account is active or not. The parameter id can be users coreHRID or account username.
Obtain user authentication type. Response indicates either LDAP or inApplicationPassword.
The parameter id can be users coreHRID or loginID.
Provides an ability to activate or deactivate an account. Setting an account to be deactive results in a user not being allowed sign into CoreHR self Service module CorePortal. This does not apply to SAML authentication. Credentials and access needs to be checked by the SAML IDP.
\nWhen an account is created via POST /provision/user the account is assumed to be active. You do not need to execute this web services to activate an account once it has been created. However if you execute this web services and set active to N then you must execute this web services again to re-activate the account by setting active to Y.
The id parameter can be either coreHRID or the username associated with the account. The Active parameter must be N or Y
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","provision","user","status","100"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"24945d7b-046d-4dab-ac65-01c00785d1fa","name":"400 - Validation Failed","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\"active\" : \"N\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/1001"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 19:02:41 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"007\",\"errorMessage\" :\"Validation failed. Either user account does not exist or request data is invalid.\" }}\n"},{"id":"5ef85864-ca15-439f-b815-c64b7612cda1","name":"200 - Account Active","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 18:04:52 GMT","name":"Date","description":""},{"key":"ETag","value":"\"L/idwKxNGWvlkQGQ4j3vC0+brkecdYNqpY2o9nJxaN5RiPktu/5d3OJrX6yJIWMlOB0ocscXHR0OVsUrx7Decw==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"{\"items\":[{\"isaccountactive\":\"Yes\"}],\"hasMore\":false,\"limit\":100,\"offset\":0,\"count\":1,\"links\":[{\"rel\":\"self\",\"href\":\"http://localhost:8585/ws/corehr/v1/provision/user/status/100\"},{\"rel\":\"describedby\",\"href\":\"http://localhost:8585/ws/corehr/metadata-catalog/v1/provision/user/status/item\"},{\"rel\":\"first\",\"href\":\"http://localhost:8585/ws/corehr/v1/provision/user/status/100\"}]}"},{"id":"8ec89643-257f-47cc-9f92-1efda2ad03c0","name":"201 - Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\"active\" : \"N\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 19:02:16 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"6e650f08-b6d2-4cdf-b0f0-c4afedb1230c"},{"name":"/provision/user/privilege","id":"987b187d-f470-4dfa-a705-17e47ff971c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"loginid\" : \"jones.donovan@corehr.com\",\n \"privilege\" : \"hrAdmin\"\n }\n"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/privilege","description":"Provisions a new privilege for a user. This service allows one new privilege to be assigned to the user account. In addition this service assumes an account has already been provisioned. Validation is performed on the account confirming existence.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- privilege \n
a new privilege for the user.
\nSpecial Usage Note
\nuse one of the following combinations, do not use all three fields. If you do an error will be returned.
\n- \n
- corehrid and a privilege \n
or
\n- \n
- loginid and a privilege \n
CoreHR v25.0.7 required
\nThis service will list all currently granted privileges associated with a user.
\nParameter
\nid can be either the users loginid or the users corehrid (personnelNumber).
CoreHR v25.0.7 required
\nProvides an ability to revoke all user privileges associated with the user account.
\nA privilege here relates to all granted menu security items i.e. feature access and not access to a specific user, while access to the user is not revoked the privilege to use the feature is revoked.
\nNB this revokes all.
\nOther attributes associated with the user Account are not affected e.g. account will still exist, authentication type will remain as is, and password for non SSO accounts remain in place etc.
\nThis service assumes an account has already been provisioned. Validation is performed on the account confirming existence. This is a simple purge request, in cases where the user has no privileges, this service will not respond with an error, instead a successful response is returned.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by using the new filter services.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\nSpecial Usage Note
\nuse one of the following combinations, do not use both fields. If you do an error will be returned.
\n- \n
- corehrid \n
or
\n- \n
- loginid \n
Provisioning facility allowing Portal accounts to be provisioned. Portal is the self service module within PeopleXD . A employee may have a record in PeopleXD , this does not automatically suggest same employee has access to self service features via Portal. In order to access Portal a self service account is required. This module provides a web service mechanism to provision an employee.
\nIn Summary provisioning provides ability to
\n* Determine accounts yet to be provisioned\n* Determine accounts yet to be provisioned within X number of days (including future start dates)\n* Provision a new account\n* Provision a new account with privileges\n* Update existing accounts privileges\n* Add additional privilege to an account\n* Set authentication Type in cases where a mix of Single Sign On, SAML and inApplicationPasswords exist
\nContraints, Limitations & Mandatory
\nAccounts to be provisioned simply indicates accounts (employees) not yet provisioned. These accounts must satisfy following criteria
\n* Active Employee Record
\nindicates employees record must not have a date left.
\nDo not assume logic applies indicating certain categories of employees are allowed access and others are not allowed. No other conditions are applied. Additional attributes are possible to add to the response to help an IDM provider make this decision, PeopleXD will work with an IDM provider to best determine.
\nPortal privileges can be assigned by the IDM using the privileges array (example below). Where an IDM can not determine privileges, this provisioning web service module integrates with the PeopleXD user profile matrix, and in cases where this matrix is not configured the fall back is all users are granted a default access profile typically \"coreportal_employee\".
\nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n* 400 / 001 Mandatory fields are missing\n* 400 / 002 Validation failed. If attempting to update use PATCH method\n* 400 / 003 Unexpected error, unable to provision account\n* 404 / 004 Validation failed. User account does not exist\n* 404 / 005 Validation failed. Account must first be provisioned, use POST method\n* 400 / 006 Validation failed. Invalid fields used\n* 400 / 007 Validation failed. Either user account does not exist or request data is invalid.\n* 400 / 008 Validation failed. Authtype must be either LDAP or inApplicationPassword. If choosing inApplicationPassword a password is required\n* 400 / 009 Validation failed. Supplied password has not passed password
\n","_postman_id":"136eb6ed-8acf-4f93-82ed-e907790c2738"},{"name":"Reference","item":[{"name":"/reference/","id":"23ef6767-6b6c-423e-92bc-43d9fed25afd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/reference/","description":"Get a list of registered / whitelisted referene types. Tenant has an ability to define reference types available for creating / updating. A tenant may not allow all references to be updated or created, this base URI provides the list of valid reference types. In cases where server returns validation errors, refer to this list to confirm the reference type is whitelisted.
\nThis examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Returns a list of codes and descriptions for a reference type, a reference type could be COST, DEPT etc. Reference Types are typically upper case. As already noted reference types can be whitelisted by a tenant.
For a full list of available reference types use /reference/
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","{{version}}","reference","type","DEPT",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"35492378-7820-412b-a790-2a6d31288529","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/COST/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:35:18 GMT","name":"Date","description":""},{"key":"ETag","value":"\"ZInz0RdXlDlkFr0RxOWVt0Xe8DrUJnBC2+V/aZmUKdeVao7Vnt+tTjTY7a88qxAW/95HgOuX3zxv4wgdqSdatg==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"COST\", \"code\": \"1\", \"description\": \"Cost Centre Web Services 1\"}\n,\n{\"type\":\"COST\", \"code\": \"10\", \"description\": \"Cost Centre Web Services 10\"}\n,\n{\"type\":\"COST\", \"code\": \"100A\", \"description\": \"Cost Centre Web Services 100A\"}\n,\n{\"type\":\"COST\", \"code\": \"111\", \"description\": \"Cost Centre Web Services 111\"}\n,\n{\"type\":\"COST\", \"code\": \"123456789\", \"description\": \"Cost Centre Web Services 123456789\"}\n,\n{\"type\":\"COST\", \"code\": \"149\", \"description\": \"Cost Centre Web Services 149\"}\n,\n{\"type\":\"COST\", \"code\": \"159\", \"description\": \"Cost Centre Web Services 159\"}\n,\n{\"type\":\"COST\", \"code\": \"20\", \"description\": \"Cost Centre Web Services 20\"}\n,\n{\"type\":\"COST\", \"code\": \"200A\", \"description\": \"Cost Centre Web Services 200A\"}\n,\n{\"type\":\"COST\", \"code\": \"21\", \"description\": \"Cost Centre Web Services 21\"}\n,\n{\"type\":\"COST\", \"code\": \"22\", \"description\": \"Cost Centre Web Services 22\"}\n,\n{\"type\":\"COST\", \"code\": \"222\", \"description\": \"Cost Centre Web Services 222\"}\n,\n{\"type\":\"COST\", \"code\": \"23\", \"description\": \"Cost Centre Web Services 23\"}\n,\n{\"type\":\"COST\", \"code\": \"24\", \"description\": \"Cost Centre Web Services 24\"}\n,\n{\"type\":\"COST\", \"code\": \"25\", \"description\": \"Cost Centre Web Services 25\"}\n,\n{\"type\":\"COST\", \"code\": \"26\", \"description\": \"Cost Centre Web Services 26\"}\n,\n{\"type\":\"COST\", \"code\": \"27\", \"description\": \"Cost Centre Web Services 27\"}\n,\n{\"type\":\"COST\", \"code\": \"28\", \"description\": \"Cost Centre Web Services 28\"}\n,\n{\"type\":\"COST\", \"code\": \"29\", \"description\": \"Cost Centre Web Services 29\"}\n,\n{\"type\":\"COST\", \"code\": \"2908100\", \"description\": \"Cost Centre Web Services 2908100\"}\n,\n{\"type\":\"COST\", \"code\": \"30\", \"description\": \"Cost Centre Web Services 30\"}\n,\n{\"type\":\"COST\", \"code\": \"300A\", \"description\": \"Cost Centre Web Services 300A\"}\n,\n{\"type\":\"COST\", \"code\": \"356\", \"description\": \"Cost Centre Web Services 356\"}\n,\n{\"type\":\"COST\", \"code\": \"39\", \"description\": \"Cost Centre Web Services 39\"}\n,\n{\"type\":\"COST\", \"code\": \"40\", \"description\": \"Cost Centre Web Services 40\"}\n,\n{\"type\":\"COST\", \"code\": \"451\", \"description\": \"Cost Centre Web Services 451\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC\", \"description\": \"Cost Centre Web Services ABC\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC001\", \"description\": \"Cost Centre Web Services ABC001\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC0010\", \"description\": \"Cost Centre Web Services ABC0010\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC003\", \"description\": \"Cost Centre Web Services ABC003\"}\n,\n{\"type\":\"COST\", \"code\": \"J12345\", \"description\": \"Cost Centre Web Services J12345\"}\n,\n{\"type\":\"COST\", \"code\": \"JKL333\", \"description\": \"Cost Centre Web Services JKL333\"}\n,\n{\"type\":\"COST\", \"code\": \"PROD\", \"description\": \"Cost Centre Web Services PROD\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 33,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/reference/type/COST/\"\n }\n ]\n}\n"}],"_postman_id":"1b2ce441-a481-49db-bfdc-66869b8a3232"},{"name":"/reference/type/:atype/:code?","id":"1613fdac-7091-402a-95be-884ac4a438ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/reference/type/DEPT/7001","description":"Returns an individual reference description associated with a reference type and code. A reference type could be COST, DEPT etc. Reference Types are typically upper case. As already noted reference types can be whitelisted by a tenant.
For a full list of available reference types use /reference/
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","{{version}}","reference","type","DEPT","7001"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"8d891e38-604f-4c4a-be6f-0591a0862561","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/COST/10"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:35:39 GMT","name":"Date","description":""},{"key":"ETag","value":"\"Q3jVQU2iTQ/v0g70PelGZKl9U6wG1LV/Ns7vRxFBtB7MUyXAAgUcC+nxdBtW/mQMcQPoQhSS1jjRtrAA4a7uzQ==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"COST\", \"code\": \"10\", \"description\": \"Cost Centre Web Services 10\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/reference/type/COST/10\"\n }\n ]\n}\n"}],"_postman_id":"1613fdac-7091-402a-95be-884ac4a438ce"},{"name":"/reference/type/:atype","id":"ff4db3d6-ed19-4d18-875d-787e81dfee86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"value\" : \"1\",\n\"description\" : \"Department One\"\n}"},"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/reference/type/DEPT/","description":"Add reference data based on the reference type, code and description. The reference type is expected in the URL, while the request body should include code and description
Ability to update a description associated with an existing reference code / type combination. The reference type is expected in the URL, while the request body should include code and description
It is possible to also provide an active parameter, this parameter can also be provided via the request body must be either Y or N.
Delete reference data based on the reference type, code. The reference type is expected in the URL, while the request body should include code.
Reference module provides ability to view, add and update reference related items for PeopleXD e.g. Cost Centre, Department, Projects etc.
\nContraints, Limitations & Mandatory
\nThe reference module is case senstive, no process converts the type provided into upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned. Within PeopleXD reference types are typically uppercase.
\nIn most cases a type is mandatory. Following are some examples, for more detail review each URI and method below.
\nFor endpoint /reference/type/aType/ aType is mandatory e.g. /reference/type/COST/. Another example /reference/type/COST/1 will return Reference Type COST where the cost centre code is 1. For /reference/types/ no type is required.
Further information per method below.
\nLimitations
\nDescription max length - 40 Characters
\nCode max length - 13 Characters
\nWRKGRP only GETS are supported, POST, PATCH and DELETE are not supported.
Error Codes
\nConvention is HTTP Status Code / Verbose Code
\n* 400 / 001 Mandatory fields are missing\n* 400 / 002 Validation failed. If attempting to update use PATCH method\n* 404 / 003 Validation failed. Reference type does not exist\n* 400 / 004 Validation failed. Sanitization of data failed, ensure field lengths are correct\n* 400 / 005 Validation failed. Reference code does not exist. If attempting to add use POST method.\n* 400 / 006 Validation failed. Validation failed. Reference type and code do not exist.\n* 400 / 007 Validation failed. Validation failed. Active Indicator can only be Y or N.
\nDefined below are the endpoints, sample requests and responses.
\n","event":[{"listen":"prerequest","script":{"id":"24a38dcd-3a5c-4007-af8b-870fd7787a74","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4f2616ab-5e01-4a38-a242-11ddd9b933e5","type":"text/javascript","exec":[""]}}],"_postman_id":"f88629c1-368a-46d0-8df7-035db27157e9"},{"name":"User Defined Fields","item":[{"name":"/udf/user/:udf_type","id":"96a407cc-b3dd-476f-9ff8-e445c614d39e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 9m1zDcUnJrxvkqTfEsTOfQ.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20","description":"Creating a new UDF Type Record for a user
\nAdding a new User record for a UDF Type requires the following fields. UDF Type code is mandatory and specified as part of the URL.
\nThe rest of the fields are provided as JSON in the request body. Un-used/empty fields should be left blank. Successful inserts results in a JSON Response object with success value of true. Also included in the JSON Response is the ws_id which is the unique Web Service ID that can be used to identify this specific record.
\nFields are sent in the JSON are as in the table below:
\n¹ Either personnel_no OR appointment_id are mandatory.
² Date1 and Date2 are input in the format DD-MON-RRRR.
\n³ Text1 to Text12 must ALWAYS be provided. If the field is not being used for the UDF Type use a blank value string e.g. \"\".
\n¬ Text1 to Text12 field requirements are defined by the UDF Type configuration in CoreHR. Text fields can be marked as mandatory/optional and of specific data types including:
\n- \n
- Text - to a maximum of 4000 characters long. \n
- Number - number values only \n
- Date required to be in the format DD-MON-YYYY. \n
- List - Based on the allowed list for the UDF Type as configured in CoreHR. \n
Response Object\nSample responses are shown to the right under different conditions.
\nA response objects is always provided and within success will either be true. In which case as ws_id (unique web service identifier that allows us to refer back to this record).
Alternatively, the success value can be false if this is the cause an errorCode and errorMessage are provided. Additional error details - if the error pertains to a specific value in the body - is provided in the validationError object. This will contain one or more JSON objects relating to each specific error. The param_name will contain the field the validation error relates to the field_name is the label of the field used in CoreHR and the message will contain a detailed explanation of what validation is failing.
Error Codes
\nConvention is HTTP Status Code / Verbose Code. These are shared by all these UDF endpoints and explained in the Error Codes section at the start of the UDF documentation.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","udf","user","AB20"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3c4aab90-bb34-4477-9511-27d09b0c8683","name":"1. Successful date fields example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer _QsnRadImZrbh8w9_4B6UA.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"1409000\",\n \"appointment_id\": \"\",\n \"text1\": \"27-JAN-2017\",\n \"text2\": \"24-FEB-2017\",\n \"text3\": \"31-MAR-2017\",\n \"text4\": \"28-APR-2017\",\n \"text5\": \"27-MAY-2017\",\n \"text6\": \"30-JUN-2017\",\n \"text7\": \"28-JUL-2017\",\n \"text8\": \"25-AUG-2017\",\n \"text9\": \"29-SEP-2017\",\n \"text10\": \"28-OCT-2017\",\n \"text11\": \"24-NOV-2017\",\n \"text12\": \"29-DEC-2017\",\n \"date1\": \"\",\n \"date2\": \"\",\n \"user_code\": \"\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Fri, 11 Aug 2017 16:05:48 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"41431680-ec3d-4690-8100-5e5ec94a3c78-00002f6a","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true, \"ws_id\":\"2017081171563091\"}}\n"},{"id":"6ef19f31-00b0-469a-8cc3-41d2ade461ac","name":"3. Sanatization Fail Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer _QsnRadImZrbh8w9_4B6UA.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"1409000\",\n \"appointment_id\": \"\",\n \"text1\": \"27\",\n \"text2\": \"24\",\n \"text3\": \"31\",\n \"text4\": \"28\",\n \"text5\": \"27\",\n \"text6\": \"30\",\n \"text7\": \"28\",\n \"text8\": \"25\",\n \"text9\": \"29\",\n \"text10\": \"28\",\n \"text11\": \"24\",\n \"text12\": \"29\",\n \"date1\": \"\",\n \"date2\": \"\",\n \"user_code\": \"\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"close","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Fri, 11 Aug 2017 16:16:01 GMT","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"41431680-ec3d-4690-8100-5e5ec94a3c78-00002f6f","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[],"responseTime":null,"body":"\n\n { \"Response\": {\n \"success\" : false,\n \"errorCode\" : \"998\",\n \"errorMessage\" : \"UDF Type validation errors. Review validationError object for more details of data errors for this UDF type.\",\n \"validationError\" : [\n\n {\n \"param_name\" : \"text1\",\n \"field_name\" : \"COREHR 7600\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text2\",\n \"field_name\" : \"text2\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text3\",\n \"field_name\" : \"text3\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text4\",\n \"field_name\" : \"text4\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text5\",\n \"field_name\" : \"text5\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text6\",\n \"field_name\" : \"text6\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text7\",\n \"field_name\" : \"text7\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text8\",\n \"field_name\" : \"text8\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text9\",\n \"field_name\" : \"text9\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text10\",\n \"field_name\" : \"text10\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text11\",\n \"field_name\" : \"text11\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text12\",\n \"field_name\" : \"text12\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n]\n }\n }\n"},{"id":"bbb6a402-2c8e-46da-9429-f1c8ec81baca","name":"2. Validation Fail","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer _QsnRadImZrbh8w9_4B6UA.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"1409000\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"27-JAN-2017\",\n \"text2\": \"24-FEB-2017\",\n \"text3\": \"31-MAR-2017\",\n \"text4\": \"28-APR-2017\",\n \"text5\": \"27-MAY-2017\",\n \"text6\": \"30-JUN-2017\",\n \"text7\": \"28-JUL-2017\",\n \"text8\": \"25-AUG-2017\",\n \"text9\": \"29-SEP-2017\",\n \"text10\": \"28-OCT-2017\",\n \"text11\": \"24-NOV-2017\",\n \"text12\": \"29-DEC-2017\",\n \"date1\": \"\",\n \"date2\": \"\",\n \"user_code\": \"\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Fri, 11 Aug 2017 16:14:20 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"41431680-ec3d-4690-8100-5e5ec94a3c78-00002f6d","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"002\",\"errorMessage\" :\"Validation failed. Provide either a personnel number or an Appointment ID. It is not possible to use both.\" }}\n"},{"id":"e833f078-38e5-4a20-b46c-bfd9465415b9","name":"4. User Code example to use pre-defined data in all text fields","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 9m1zDcUnJrxvkqTfEsTOfQ.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Mon, 14 Aug 2017 12:10:39 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"f38c5093-1095-4e7e-be35-0074f4d4eb81-0000002c","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true, \"ws_id\":\"2017081471563097\"}}\n"}],"_postman_id":"96a407cc-b3dd-476f-9ff8-e445c614d39e"},{"name":"/udf/user/:udf_type","id":"9f98ed76-18d6-4fed-91e6-e5cea715e4e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer 9m1zDcUnJrxvkqTfEsTOfQ.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20","description":"Updating existing UDF Type Record for a user
\nUpdating a user record for a UDF Type uses the personnel_no/appoinment_id, date1, date2 and the udf_type to determine if the record is an update. i.e. If there is an existing record(s) with the same person/appointment and date1 and date2 then it is an update and the existing record(s) will be patched (updated) to the new values provided in the JSON code. UDF Type is of course mandatory and specified as part of the URL.
\nThe rest of the fields are provided as JSON in the request body. Un-used/empty fields should be left blank. Successful updates result in a JSON Response object with success value of true.
\nFields are sent in the JSON are as in the table below:
\n¹ Either personnel_no OR appointment_id are mandatory.
² Date1 and Date2 are input in the format DD-MON-RRRR.
\n³ Text1 to Text12 must ALWAYS be provided. If the field is not being used for the UDF Type use a blank value string e.g. \"\".
\n¬ Text1 to Text12 field requirements are defined by the UDF Type configuration in CoreHR. Text fields can be marked as mandatory/optional and of specific data types including:
\n- \n
- Text - to a maximum of 4000 characters long. \n
- Number - number values only \n
- Date required to be in the format DD-MON-YYYY. \n
- List - Based on the allowed list for the UDF Type as configured in CoreHR. \n
Response Object\nSample responses are shown to the right under different conditions.
\nA response objects is always provided and within success will either be true. In which case as ws_id (unique web service identifier that allows us to refer back to this record).
Alternatively, the success value can be false if this is the cause an errorCode and errorMessage are provided. Additional error details - if the error pertains to a specific value in the body - is provided in the validationError object. This will contain one or more JSON objects relating to each specific error. The param_name will contain the field the validation error relates to the field_name is the label of the field used in CoreHR and the message will contain a detailed explanation of what validation is failing.
Error Codes
\nConvention is HTTP Status Code / Verbose Code. These are shared by all these UDF endpoints and explained in the Error Codes section at the start of the UDF documentation.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","udf","user","AB20"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"09b29ee8-b9a1-434a-8914-db219b968224","name":"Successful update using User Code","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Bearer 0nsn4KtX5QlKF4_4q0gNcw.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Thu, 17 Aug 2017 15:13:29 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"e491ed87-4cb1-4174-9763-76bbe5667c2b-0000009c","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"9f98ed76-18d6-4fed-91e6-e5cea715e4e2"},{"name":"/udf/user/","id":"566825e5-5581-484d-9aa5-12563cac555a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Web service to get the list of User Defined Field (UDF) records for a particular UDF Type. Mandatory search criteria include:
\n- \n
- udf_type - The UDF code. \n
- person - The CoreHR Personnel Number for whom records are to be retrieved.\nOptional criteria include: \n
- appointment_id - To search for details relating to a specific appointment. \n
- date1 - Commonly used as the Date From field. \n
- date2 - Commonly used as the Date To field. \n
A get request can return many records depending on the criteria poveded and consequently the ws_id value pair is the unique identifier that can be used with other web services to update this specific record.
Error Codes are documented at the start of the UDF documentation.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","udf","user",""],"host":["{{url}}"],"query":[{"key":"udf_type","value":"USER"},{"key":"person","value":"7202000006"}],"variable":[]}},"response":[{"id":"6cee0780-db43-4536-b016-66f5da3064ad","name":"Missing Person parameter","originalRequest":{"method":"GET","header":[{"key":"Authorization","name":"Authorization","value":"Bearer _E4Pl9nxSkcJFbic2dxD8w.."}],"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"name":"connection","key":"connection","value":"close","description":"Options that are desired for the connection"},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":"Custom header"},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"name":"date","key":"date","value":"Thu, 17 Aug 2017 11:54:53 GMT","description":"The date and time that the message was sent"},{"name":"etag","key":"etag","value":"\"hu/EykO6P9EsmiOfI5hQk+9yi5r2AxYFcmeD8ppL8ujowI4GmtSfFHQi+xgzudcWmF0pxNbJHLHEWwepH2J8/A==\"","description":"An identifier for a specific version of a resource, often a message digest"},{"name":"server","key":"server","value":"Apache","description":"A name for the server"},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"e491ed87-4cb1-4174-9763-76bbe5667c2b-00000044","description":"Custom header"},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":"Custom header"},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":"Cross-site scripting (XSS) filter"}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"013\",\"errorMessage\" :\"Person is a mandatory field.\" }}\n"},{"id":"6f50e776-e067-4f03-b70e-e40dd03c653f","name":"Search using all citeria","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Bearer 8N7tv3Kwt2W5_i-B72dWew.."}],"url":{"raw":"{{url}}/ws/{{schema}}/{{version}}/udf/user/?udf_type=AB20&person=1409000&appointment_id=TS0011-2594&date1=01-JAN-2017&date2=31-DEC-2017","host":["{{url}}"],"path":["ws","{{schema}}","{{version}}","udf","user",""],"query":[{"key":"udf_type","value":"AB20"},{"key":"person","value":"1409000"},{"key":"appointment_id","value":"TS0011-2594"},{"key":"date1","value":"01-JAN-2017"},{"key":"date2","value":"31-DEC-2017"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"name":"connection","key":"connection","value":"Keep-Alive","description":"Options that are desired for the connection"},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":"Custom header"},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"name":"date","key":"date","value":"Thu, 17 Aug 2017 14:27:44 GMT","description":"The date and time that the message was sent"},{"name":"etag","key":"etag","value":"\"MQgB6VKjaT8lHDgADQKxxd0zqZ1ssI3lKuh3MursJBsVKHrOsHcxUeOJWWw6Lq7KQJ4hi5sQMuu9orqF0glhNg==\"","description":"An identifier for a specific version of a resource, often a message digest"},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":"Custom header"},{"name":"server","key":"server","value":"Apache","description":"A name for the server"},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"e491ed87-4cb1-4174-9763-76bbe5667c2b-0000008c","description":"Custom header"},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":"Custom header"},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":"Cross-site scripting (XSS) filter"}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{ \"items\" : [\n{\"udf_type\":\"AB20\",\"person\": \"1409000\",\"appointment_id\": \"TS0011-2594\",\"ws_id\": \"2017081171563091\",\"user_code\": \"AB20\",\"date1\": \"01-JAN-2017\",\"date2\": \"31-DEC-2017\",\"text1\": \"27-JAN-2017\",\"text2\": \"24-FEB-2017\",\"text3\": \"31-MAR-2017\",\"text4\": \"28-APR-2017\",\"text5\": \"27-MAY-2017\",\"text6\": \"30-JUN-2017\",\"text7\": \"28-JUL-2017\",\"text8\": \"25-AUG-2017\",\"text9\": \"29-SEP-2017\",\"text10\": \"28-OCT-2017\",\"text11\": \"24-NOV-2017\",\"text12\": \"29-DEC-2017\",\"last_update\": \"17-AUG-2017 12:46:49\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/frame/corehr/v1/udf/user/\"\n }\n ]\n}\n"}],"_postman_id":"566825e5-5581-484d-9aa5-12563cac555a"}],"id":"41431d64-849a-49f9-8a47-f2e7a8545436","description":"The User Defined Fields (UDF) module provides ability to insert/update and view the UDF records for a PeopleXD employee.
\nThe list of UDF Types available is as configured in Core Personnel in the User Defined Fields under the Employee option i.e. those UDF types that related to a specific employee/user.
\nThese UDF Types must also be white listed using the Security option in Portal to allow them to be called via this Web Service.
\nConstraints, Limitations and Validation
\nFor all calls (insert/update/get) the personnel no. and the UDF Type code must be specified at a minimum. As previously mentioned the UDF Type must have been added to the whitelist to be accessed in any way.
\nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n* 404 / 000 The UDF Type does not exist in Core as a valid UDF Type for an Employee/User.\n* 400 / 001 A Personnel Number or an Appointment ID must be provided.\n* 404 / 002 Provide either a personnel number or an Appointment ID. It is not possible to use both.\n* 404 / 003 There is no PeopleXD personnel/user account associated with the personnel number provided.\n* 404 / 004 The Appointment ID is invalid.\n* 404 / 006 UDF Type with these details does not exist for user, consider using POST to create.\n* 404 / 007 This UDF Type is not whitelisted for web services.\n* 400 / 008 When using User Reference Data - by specifying a user_code - then do not provide values in parameters text1 to text12 i.e. pass in empty values in text1..text12.\n* 404 / 009 This User Reference Data - as specified by the user_code - is not a a valid User Code for this UDF Type.\n* 404 / 010 There is no UDF record of this type for this person with these details to update. Use POST if you want to insert a record.\n* 400 / 011 Date1 field when used must be provided in the date format DD-MON-YYY.\n* 400 / 012 Date2 field when used must be provided in the date format DD-MON-YYY.\n* 400 / 013 Person is a mandatory field in this context.\n* 400 / 014 UDF Type is a mandatory field in this context.
\n","_postman_id":"41431d64-849a-49f9-8a47-f2e7a8545436"},{"name":"Position","item":[{"name":"Profile","item":[{"name":"All","item":[{"name":"/position/profile/all","id":"d5df6b8f-5480-45c6-9b85-b7e99232a36d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/position/profile/all","description":"This service returns all position profiles, and is ordered by post number
\nParameters
\nNone
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- postNumber \n
A unique identifier associated with the position profile.
\n- \n
- postType \n
Provides information about the type of post e.g. permanent, part time, trainee, contractor etc. For associated descriptions use the Reference Module with the reference type EMPS. This attribute is available from CoreHR 26.0.6 and is not available in older versions.
- \n
- category \n
Categorises the position / post based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The date this position / post profile is effective from
\n- \n
- endDate \n
The date this position / post profile is no longer effective
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
- payScale \n
This is the \"scale\" related to salary information which is associated with the appointment. This attribute is also referred to as 'PositionCode' and 'Grade'. Note: if the requirement is to determine an individuals exact Grade use the /person/salary/ web service instead.
\n- \n
- postTileCode \n
A code that represents the description of the position / post profile. For associated descriptions use the Reference Module with the reference type POSTTL.
- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
This service returns only active position profiles, and is ordered by post number. An active position profile is based on the start and end dates of the position profile. Leaving the date parameter blank will return the current active appointments as of 'today'. Provide a date if the requirement is to determine active position profiles as of a specific date. An appointment with a start date >= today and a dormant date <= today is considered active. When the dormant date is not set for an appointment then it is active if the start date is >= today.
\nParameters
\ndate : format YYYYMMDD
\nMandatory : No
\nWhen blank, the service returns active appointments as of 'today'.
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- postNumber \n
A unique identifier associated with the position profile.
\n- \n
- postType \n
Provides information about the type of post e.g. permanent, part time, trainee, contractor etc. For associated descriptions use the Reference Module with the reference type EMPS. This attribute is available from CoreHR 26.0.6 and is not available in older versions.
- \n
- category \n
Categorises the position / post based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The date this position / post profile is effective from
\n- \n
- endDate \n
The date this position / post profile is no longer effective
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
- payScale \n
This is the \"scale\" related to salary information which is associated with the appointment. This attribute is also referred to as 'PositionCode' and 'Grade'. Note: if the requirement is to determine an individuals exact Grade use the /person/salary/ web service instead.
\n- \n
- postTileCode \n
A code that represents the description of the position / post profile. For associated descriptions use the Reference Module with the reference type POSTTL.
- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
This service returns only future position profiles, and is ordered by post number. A future position profile is based on the start of the position profile, and the start must be greater than 'today'.
\nParameters
\nNone
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- postNumber \n
A unique identifier associated with the position profile.
\n- \n
- postType \n
Provides information about the type of post e.g. permanent, part time, trainee, contractor etc. For associated descriptions use the Reference Module with the reference type EMPS. This attribute is available from CoreHR 26.0.6 and is not available in older versions.
- \n
- category \n
Categorises the position / post based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The date this position / post profile is effective from
\n- \n
- endDate \n
The date this position / post profile is no longer effective
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
- payScale \n
This is the \"scale\" related to salary information which is associated with the appointment. This attribute is also referred to as 'PositionCode' and 'Grade'. Note: if the requirement is to determine an individuals exact Grade use the /person/salary/ web service instead.
\n- \n
- postTileCode \n
A code that represents the description of the position / post profile. For associated descriptions use the Reference Module with the reference type POSTTL.
- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
A post number can be obtained by using the /person/appointment/:personnelNo web service.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- postNumber \n
A unique identifier associated with the position profile.
\n- \n
- postType \n
Provides information about the type of post e.g. permanent, part time, trainee, contractor etc. For associated descriptions use the Reference Module with the reference type EMPS. This attribute is available from CoreHR 26.0.6 and is not available in older versions.
- \n
- category \n
Categorises the position / post based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The date this position / post profile is effective from
\n- \n
- endDate \n
The date this position / post profile is no longer effective
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
- payScale \n
This is the \"scale\" related to salary information which is associated with the appointment. This attribute is also referred to as 'PositionCode' and 'Grade'. Note: if the requirement is to determine an individuals exact Grade use the /person/salary/ web service instead.
\n- \n
- postTileCode \n
A code that represents the description of the position / post profile. For associated descriptions use the Reference Module with the reference type POSTTL.
- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
Position Module
\nThe position module will retrieve position (aka post) profile information. This profile information is generally best described as a blueprint providing default information for appointments e.g. sets the cost centre, department, category information etc.
\nSeveral options exist for this module:
\n- \n
/position/profile/:postNumber
\n \n/position/profile/active
\n \n/position/profile/inactive
\n \n/position/profile/all
\n \n
Get all active employees, this will include employees who have a future leaving dates.
\nBy default only 100 active employees will be returned. In cases where you have a large employee base, set the pagesize filter via the URL. The max pagesize is 10,000 i.e it is possible to obtain an employee result set up to 10,000 employees. Setting the pagesize above this max threshold will result in only the default result set.
\n- \n
- Date\nan optional parameter, leaving this parameter blank, will simply return active employees as of 'today'. While providing a value for date (formated as YYYYMMDD) will return employees active for that specific date. Typically used to find employees active based on a specific historical date. It is therefore possible to obtain employees who have ceased employment. \n
This module relates to active employees, and will always only deal with active employees. The objective is to return an employee result set matching certain use cases, common use cases:
\n- \n
- Determine active employees \n
- Active employees on a particular date \n
Use this service to query employees leaving within the next X number of days, use the parameter :days to set the X value. These employees are currently active, however, they are set to leave within X number of days. The parameter must be positive.
The service will assume today when supplied with no value for :days or a value of 0, this returns employees leaving today.
Use this service to query employees leaving within the next X number of days.
\n","event":[{"listen":"prerequest","script":{"id":"6ab750ec-a3e5-49b0-9a55-efcc0c5bd908","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7a78e469-5d58-4d2b-8e04-24c635f04e18","type":"text/javascript","exec":[""]}}],"_postman_id":"093cab68-76f1-413b-a473-5a1b550f880a"},{"name":"Date","item":[{"name":"/filter/jml/leaver/date/:date?","id":"9e84881b-1942-425f-bbbe-8bb7789adf4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/leaver/date/20190101","description":"Use this service to query employees leaving based on a supplied date. By providing a future date the service will check employees who are due to leave between \"now\" and the future date. These employees are currently active, but are set to leave by the date provided.
\nDate format is YYYYMMDD and the date should be in the future, and the service treats date inclusive.
\nIf no date is supplied, by default the service will assume today as the date, i.e. find employees leaving today.
\nProviding a date less than \"today\" will always return 0 returns, no error will be provided, simply a response of 0 employees i.e. you must provide a future date.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","filter","jml","leaver","date","20190101"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"bca1532a-1bfa-45d0-803d-ba055d0dae64","name":"Leavers by 10th July 2017","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/leaver/date/20180710"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 12 Mar 2018 21:20:49 GMT","name":"Date","description":""},{"key":"ETag","value":"\"n64ZqihwRTaSnvtuJO8evqgaU7E41l1sQh6dvCZ2iJaA88DDSmbv8C/ph/M5S3l9M+IJJjYZ/KhVZTpDuEtdXQ==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"0927066f-15b4-4ceb-ab46-10c24ebde76e-00095dc9","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"employees\" : [\n\"1265972\"\n,\n\"1266093\"\n,\n\"1266320\"\n,\n\"1266812\"\n,\n\"1267013\"\n,\n\"1267172\"\n,\n\"1267412\"\n,\n\"1409000\"\n,\n\"1410828\"\n,\n\"1416471\"\n,\n\"1419656\"\n,\n\"1421133\"\n,\n\"1421660\"\n,\n\"1422451\"\n,\n\"1422642\"\n,\n\"1423322\"\n,\n\"1425268\"\n,\n\"1425560\"\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 18,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/leaver/date/20180324\"\n }\n ]\n}\n"}],"_postman_id":"9e84881b-1942-425f-bbbe-8bb7789adf4b"}],"id":"c2d08e37-6221-4839-b594-421bef63119b","description":"Use this service to query employees leaving based on a supplied date.
\n","event":[{"listen":"prerequest","script":{"id":"ce0a46bf-2b11-4855-a836-7021e75541fd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0d5711ed-e393-4736-8afc-94aad723e43e","type":"text/javascript","exec":[""]}}],"_postman_id":"c2d08e37-6221-4839-b594-421bef63119b"},{"name":"Left","item":[{"name":"/filter/jml/leaver/left/:days?","id":"f27510ed-2fa2-43cb-8360-61125d51570d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/leaver/left/1","description":"Use this service to query individuals who have left within the previous X number of days, use the parameter :days to set the X value. With this service it is possible to determine historical employees.
These employees are no longer considered active. The parameter must be positive.
\nThe service will assume yesterday when supplied with no value for :days.
Individuals leaving today will not appear in this result set. Those leaving today remain active until tomorrow.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","filter","jml","leaver","left","1"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f27510ed-2fa2-43cb-8360-61125d51570d"}],"id":"32767c0d-43f1-49a4-b21d-311361971e60","description":"Use this service to query individuals who have previously left i.e. left within the previous X number of days. These individuals are considered inactive and no longer employeed. The service simply querys the date an individual has left. The date queried is the individuals most recent leaving date (catering for the cases where an individual has re-joined and subsequently left).
\n","event":[{"listen":"prerequest","script":{"id":"9327b2ae-edd9-4243-a691-ae1cda6eec99","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4d71e9b7-5d81-4640-9674-7d96e8c2d2c7","type":"text/javascript","exec":[""]}}],"_postman_id":"32767c0d-43f1-49a4-b21d-311361971e60"}],"id":"9d9db2f4-9258-414f-b4bc-fe69c9b12c28","description":"This module relates to employees leaving, the service will query an individuals leaving date, even though the employee may currently be active.
\nCommon use cases are:
\n- \n
- Determine individuals leaving within the next X number of days i.e. they are currently active, but have a leave date within the next 10 days. \n
- Determine individuals who are currently active but will have left by a certain future date i.e. provide a future date and the service will return individuals leaving between now and this future date. \n
- Determine individuals previously left. \n
This service is focused on recent starters i.e. active individuals who recently joined. With this service you can determine individuals who started within the previous X number of days, i.e. this is a between NOW and - X days.
\nin cases where no days parameter has been provided, the service assumes 0 i.e. who has started today. In most cases it is expected to provide 30 / 60 or 90 days. A max of 36500 is set for the upper limit.
In all cases employees starting today are included.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","filter","jml","joiner","recent","30"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"91f81bf0-4b8c-4b68-af87-dde3e23109f3","name":"Previous 30 Days","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/joiner/recent/30"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 15 Mar 2018 11:53:56 GMT","name":"Date","description":""},{"key":"ETag","value":"\"140VlUC1D3FC3GEyZ2rH9bAWqVN9hnlxbHzATll48Aj8fNKuVg9wYkKSP/n3RUXZ+h9hRJFOjMHr+CTw2P3fgQ==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"0927066f-15b4-4ceb-ab46-10c24ebde76e-000df1b3","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"employees\" : [\n\"5990404\"\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/joiner/recent/\"\n }\n ]\n}\n"},{"id":"b4e4a150-c21c-45b0-857d-f4cac5685000","name":"Exceeding the Max Threshold","originalRequest":{"method":"GET","header":[],"url":"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/joiner/recent/36501"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 15 Mar 2018 12:12:36 GMT","name":"Date","description":""},{"key":"ETag","value":"\"nN2x9d3E41tTPKzxvz7dKw0hP6y+uPBjgI4mv2+zdxx8IXg8lojzVWg23GzD4VkZycVmFyVr/KOQvZWKurl0kA==\"","name":"ETag","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"0927066f-15b4-4ceb-ab46-10c24ebde76e-000dfe97","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"004\",\"errorMessage\" :\"Validation failed. Max of 36500 (~100 years)\" }}\n"}],"_postman_id":"e120a95d-0b05-4e06-9950-b61bd90afe65"}],"id":"946ef874-753d-4a94-936a-01a739f83784","description":"This service is focused on recent starters i.e. active individuals who recently joined. With this service you can determine individuals you started within the previous X number of days.
\nin cases where no days parameter has been provided, the service assumes 0 i.e. who has started today. In most cases it is expected to provide 30 / 60 or 90 days. A max of 36500 is set for the upper limit.
Determine individuals due to start within the next X number of days.
\nIn cases where no days parameter has been provided, the service assumes 0 i.e. who has started today. In most cases it is expected to provide 30 / 60 or 90 days. A max of 36500 is set for the upper limit.
In all cases employees starting today are included.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","filter","jml","joiner","future","5"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7cf60d52-98ce-4230-bf1b-3d566a7a6269","name":"Starting Next 5 Days.","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/joiner/future/5"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 16 Mar 2018 09:06:02 GMT","name":"Date","description":""},{"key":"ETag","value":"\"a57aOwmxwydB4kqrVe87nAzw9DQGCbwJ+w+BGb7ygM2NEY37h+ymWOeSbINkBYdsAjKEEV+GpYdRIyszNKFUXg==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"cb89685b-0a33-4e88-9829-ed0bf23cf3fc-0000597a","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"employees\" : [\n\"1409000\"\n,\n\"1410828\"\n,\n\"1416471\"\n,\n\"1419656\"\n,\n\"1421133\"\n,\n\"5990404\"\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 6,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/joiner/future/5\"\n }\n ]\n}\n"},{"id":"e50ca0c5-b4e6-4045-bc82-5ac8a3029d2b","name":"Starting Today","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/joiner/future/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 16 Mar 2018 09:14:11 GMT","name":"Date","description":""},{"key":"ETag","value":"\"uvizmfzh9HbIvg+bU9Db97yB/zZdZHUPZKquXaeGXMz25ZoDudfkO6lH/nfFZrEDkA99VtHMaWK9iAGZnxcWtw==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"cb89685b-0a33-4e88-9829-ed0bf23cf3fc-00005eff","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"employees\" : [\n\"1265972\"\n,\n\"1266093\"\n,\n\"1266267\"\n,\n\"1266320\"\n,\n\"1425560\"\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 5,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/joiner/future/\"\n }\n ]\n}\n"}],"_postman_id":"05078afc-28c9-4767-bfc8-1bfab0593b70"}],"id":"1e08ec5e-252e-49ac-af93-dc3449d9d38a","description":"This service is focused on individuals starting in the future i.e. individuals who are due to start, but are not currently active. With this service you can determine individuals due to commence within the next X number of days i.e. this is a between NOW and + X days.
\n","event":[{"listen":"prerequest","script":{"id":"a83c89ce-f1d2-47f1-bdab-f43cf55ed75b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d6d81bc0-a5b4-4926-99d3-1c5190677d94","type":"text/javascript","exec":[""]}}],"_postman_id":"1e08ec5e-252e-49ac-af93-dc3449d9d38a"}],"id":"fdda5684-e4f6-435a-a60b-5efe451aa6c5","description":"This module relates to employees joining, the service will query individuals starting date, even though the employee may currently be active. An individuals start date is their most recent start date, in cases where an employee has left and rejoined, their current start date is the most recent date, this service only queries the most recent start date. The service will not look at original start dates aka day Zero.
Common use cases are:
\n- \n
- Determine individual's recently joined, i.e. started in last 30 days. \n
- Determine individual's joining at a future date, i.e. starting in the next 30 days. \n
This modules refers to Joiners, Movers and Leavers hence /JML/. Various use cases exist, for example, use this module to determine:
\n- \n
- recently joined employees \n
- employee's joining within next X number of days \n
- employee's due to leave based on dates / date \n
In general this module will provide filters for employees joining, moving and leaving. The objective is to return an employee result set matching certain use cases.
\n","event":[{"listen":"prerequest","script":{"id":"5d907c00-e3a5-4a79-9c7c-f3166d3d0664","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"81437677-c2b3-4395-9642-9711d9a7cc60","type":"text/javascript","exec":[""]}}],"_postman_id":"aa12a8f6-22a2-493e-bb9f-afdcc07c233f"}],"id":"06f9f219-d97f-4d20-8abe-e48a6cca46b3","description":"The filter's module objective, is to decouple common query requests. Instead of each service supporting the common queries, these queries are decoupled in this filter module.
\nCommon Queries include get a list (i.e. a result set) of:
\n- \n
- active employees \n
- employee's due to leave \n
- employee's recently joined \n
- employee's due to join in the near future \n
- employee's appointments (typically the employees Job) \n
Use these filers to query for employees under above headings, and then use the result set to feed other services.
\nPagination and Limits
\nThese filters allow for larger than normal pagesizes. For example, typically the pagesize (i.e. the result set) is 100 results, however you can now set the pagesize to 10,000 (this is a max value). Therefore if you have 10,000 employees you can make one request, if you have more than 10,000 active employees, the filter will provide the first 10,000 and provide a reference link for the next 10,000.
\nDo not set the pagesize above 10,000, if you do, only 100 results will be returned. The web services framework will always revert back to the default (i.e. 100) if the max value has been breached.
\nAny instances where more than pagesize exist, e.g. (a pagesize of 100 is used, and 1,000 records exist) the response body will include a link array with additonal links for pagination.
\nEach GET request includes following
\n- \n
- limit \n
represents the maximum number of records returned in one request e.g. 100 (or whatever the pagesize is)
\n- \n
- offsetby \n
represents pagination, the first request will always have an offsetby 0 i.e. the start. Where more than the limit exists offsetby controls the starting position, typically in batches of 100. Each GET request can accept the offsetby parameter.
\n- \n
- count \n
the number of records for this reponse, the maximum count will equal the limit parameter i.e. 100.
\n- \n
- hasMore \n
a boolean representation indicating if more records exist.
\n- \n
- links \n
includes links to first and next. The next link is used when pagination is discovered i.e. more than the limit per request.
\n","event":[{"listen":"prerequest","script":{"id":"16a8ddce-40c8-435d-a553-0be640de542a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ca8b0414-33e6-4d44-add0-34121b2af4fc","type":"text/javascript","exec":[""]}}],"_postman_id":"06f9f219-d97f-4d20-8abe-e48a6cca46b3"},{"name":"Person","item":[{"name":"address","item":[{"name":"home","item":[{"name":"/person/address/home/:personnelNo","id":"b6ef6167-ae65-46f3-9337-0a99ee8dcf82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/home/5990404","description":"This service simply returns the home address for an individual.
\nHome address's have effective dates and have the concept of being active, the current effective and active home address is returned.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","address","home","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"88eaa242-da14-42d8-bd25-137c287f9ddd","name":"Home Address","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/home/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 17:46:29 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"LHgoPsSqJ5Zp8UqBgh5MgVJG1HOKKCBfPREAx0YMiAa1XGYZQFGCugkHcVG78YpKDshSr27rdW7q+8qo0Xaa1Q==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0000c169","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"line1\":\"01 Sherringham Avenue\",\"line2\":\"Westmore\",\"line3\":\"Windsor\",\"line4\":\"Tottenham\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N17\",\"postCodeSuffix\":\"9XJ\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/address/home/5990404\"\n }\n ]\n}\n"}],"_postman_id":"b6ef6167-ae65-46f3-9337-0a99ee8dcf82"}],"id":"acbf4261-0fba-49e5-86d3-e009eceaa6b3","description":"This service simply returns the home address for an individual.
\n","event":[{"listen":"prerequest","script":{"id":"1ad0b0dc-d812-4905-a8eb-baed9dc7462b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"31a94f89-563f-423e-b398-370ec87edaa5","type":"text/javascript","exec":[""]}}],"_postman_id":"acbf4261-0fba-49e5-86d3-e009eceaa6b3"},{"name":"nextOfKin","item":[{"name":"/person/address/nextofkin/:personnelNo","id":"326f7e04-ca9e-41a7-9130-878f9dc7da9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/nextofkin/5990404","description":"This service simply returns the next of kin address for an individual.
\nNext of Kin address's have effective dates and have the concept of being active, the current effective and active Next of Kin address is returned.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","address","nextofkin","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"98c9ea9f-2438-479f-accc-610554e42fae","name":"Next Of Kin Address","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/nextofkin/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 17:47:03 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"GH0Ws6A72ZRA9hGnM/hkQzulABHsxNo+6L4wYBM7/01GxS47hp98GWrAUk1Z3T0UyQgnPFcoFtJlDKvttTJzwQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=99","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0000c1be","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"line1\":\"01 Windsor Street\",\"line2\":\"East Bridge\",\"line3\":\"Kings Avenue\",\"line4\":\"Windsor\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N18\",\"postCodeSuffix\":\"8ZJ\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/address/nextofkin/5990404\"\n }\n ]\n}\n"}],"_postman_id":"326f7e04-ca9e-41a7-9130-878f9dc7da9a"}],"id":"87dd8f0f-c301-4891-83c5-d98b38baf208","description":"This service simply returns the next of kin address for an individual.
\n","event":[{"listen":"prerequest","script":{"id":"200a3a50-6c5b-47a5-bf74-f41381852beb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6411c89a-56f3-46d1-b8e9-510f1b907ab1","type":"text/javascript","exec":[""]}}],"_postman_id":"87dd8f0f-c301-4891-83c5-d98b38baf208"},{"name":"work ","item":[{"name":"/person/address/work/:personnelNo","id":"1f957bfc-b8d7-4170-b40f-bdaf89d816e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/work/5990404","description":"This service simply returns the work address for an individual.
\nWork address's have effective dates and have the concept of being active, the current effective and active work address is returned.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","address","work","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"5b596601-b2bf-4f3a-ad48-454786ee7c6a","name":"Work Address","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/work/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 17:50:18 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"BfvMfrRK99guHS+1Cxo2GDYQj7LsqayBrWRnoH+84jV80kgOOa38STTJaL7oNDTYQNuu9qlKrJPfMDqZZfKWeg==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0000c393","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"line1\":\"100 Fleetmore Street\",\"line2\":\"West Kings State\",\"line3\":\"Queens Avenue\",\"line4\":\"Windsor\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N17\",\"postCodeSuffix\":\"9SD\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/address/work/5990404\"\n }\n ]\n}\n"}],"_postman_id":"1f957bfc-b8d7-4170-b40f-bdaf89d816e7"}],"id":"3a0ea542-c90b-4ba2-a69c-378b4940437d","description":"This service simply returns the work address for an individual. The address type of 'work' is not deafult address type as part of CoreHR. However, this address type is often created by system Administrators. For this web service to return an Address, the address type must be 'WORK'.
\n","event":[{"listen":"prerequest","script":{"id":"09200ccc-be1c-44c6-8e8f-421e82b85ec9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"38e07840-8126-42f7-b51f-e18085e1b7f5","type":"text/javascript","exec":[""]}}],"_postman_id":"3a0ea542-c90b-4ba2-a69c-378b4940437d"},{"name":"all","item":[{"name":"/person/address/all/:personnelNo","id":"120b5591-fd03-4a54-ad69-5a6fae2320d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/all/5990404","description":"This service returns all active addresses for an individual currently ineffective. This includes home, next of kin and other address.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","address","all","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"8a947441-76a0-4e26-9b8e-d75e090ce53d","name":"All Addresses","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/all/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 17:54:13 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"whBYl/hO41707uWg37s7brO+oRGWKVUVCArWwHkfSzyVWhRscn+I6GNpgMHTDembglIL4AUg8sl4ShdOw6gEhQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0000c5f8","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"WORK\",\"line1\":\"100 Fleetmore Street\",\"line2\":\"West Kings State\",\"line3\":\"Queens Avenue\",\"line4\":\"Windsor\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N17\",\"postCodeSuffix\":\"9SD\"}\n,\n{\"type\":\"home\",\"line1\":\"01 Sherringham Avenue\",\"line2\":\"Westmore\",\"line3\":\"Windsor\",\"line4\":\"Tottenham\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N17\",\"postCodeSuffix\":\"9XJ\"}\n,\n{\"type\":\"nextOfKin\",\"line1\":\"01 Windsor Street\",\"line2\":\"East Bridge\",\"line3\":\"Kings Avenue\",\"line4\":\"Windsor\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N18\",\"postCodeSuffix\":\"8ZJ\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 3,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/address/all/5990404\"\n }\n ]\n}\n"}],"_postman_id":"120b5591-fd03-4a54-ad69-5a6fae2320d3"}],"id":"90457752-1aa5-4087-8bf7-76ac4cc192e7","description":"Use this service for all addresses associated with an individual. A tenant has the ability to create several additional address types. This service will return a result set of additional addresses i.e. all addresses associated with the individual including Home and NextOfKin.
\nTo determine descriptions for these additional address type, one can use the reference module.
\nIf a web service app has access to the reference module, and your administrator has whitelisted the reference type ADDTYP the app can query the reference module using the type ADDTYP. These additional other address types are best explained by the HR administrators of the CoreHR application.
The address module's objective is to determine individual's addresses. PeopleXD provides a complete and detailed module for defining different types of addresses. Individual's may have several different addresses, typically referred to as address types e.g. home, business, next of kin, overseas etc. Not all personnel will have each of these address types. Assigning addresses to each person is a matter for each tenant. The PeopleXD app also faciliates tenants adding various additional addresses.
\nIn general, use cases for these services include obtaining:
\n- \n
- an individual's home address \n
- an individual's next of kin address \n
- an individual's work address \n
- other address types associated with an individual \n
This module has been split into different easy to use scenarios:
\n* Home Address\n* Next of Kin\n* Work\n* All
\nHome and Next of Kin addresses are simple and explicit. While others are slightly more completex. If the requirement is home address simply use the home address service, and for next of kin use next of kin service. For Other address types refer to the all address service below. Work address has been added as it's a typical use case, however, work address may or may not be in use.
\nAddress Templating
\nThis service does not implement address templating. Address type templating is a higher level display facility, providing options around the order of how to display an address e.g. display address line 3 before address line 1. Instead, the address is displayed in order 1 through 5.
\nParameters
\nEach of the address web services use the following parameters:
\n* personnelNo
\nManadatory
\nType: AlphaNumeric
\nMax Length : 12
\n","event":[{"listen":"prerequest","script":{"id":"64a0a0f0-d943-4452-9591-59067af6d73d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bd322577-e279-4eef-8d8e-1f1c82362d35","type":"text/javascript","exec":[""]}}],"_postman_id":"9f183d18-0798-437d-8381-62b26f219521"},{"name":"allowances","item":[{"name":"/person/allowances/paid/currentperiod/:personnelNo","id":"6ecf151c-17aa-4d1e-a1b1-728cde24ab0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/allowances/paid/currentperiod/4956040","description":"The specific end point will provide allowances that have been processed for the employee's most recent period that has been completed i.e. from the employees most recent payslip that has been completed for the employees pay group.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
appointmenId
\nA unique reference identifier for the appointment, this is a system generated identifier.
\n \npayCode
\n \n
Represents the actual payCode used to process this item.
\n- \n
- payCodeDescription \n
This attribute represents a free text description associated with the paycode.
\n- \n
- analysisCode \n
Represents the associated anylsis code associated with the paycode. Analysis codes are used to represent a distinction or grouping of payCodes and are typically used for reporting and grouping purposes.
\n- \n
- analysisCodeDescription \n
This attribute represents a free text description associated with the analysisCode.
\n- \n
- value \n
This represents the amount on the employee's payslip, in most cases the allowances will be a positive amount, but there can be cases where this amount will be negative.
\n- \n
- payrollPeriod \n
This attribute represents the payroll period that the allowance included. This should represent the payroll period associated with the employees pay group that is marked as 'Completed Update'.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","allowances","paid","currentperiod","4956040"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"73b5bc54-dbde-410c-9155-153818d8a5b2","name":"success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/allowances/paid/currentperiod/4956040"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 02 Nov 2018 15:37:02 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;"},{"key":"X-ORACLE-DMS-ECID","value":"fc0eaafe-cec9-418c-9c67-dd411ddfe4e1-00171402"},{"key":"ETag","value":"\"CzWVSoBAGGzx6TAhnBF94Nn1BjnGS+22nCwEWwo0RBzizYGZmXu8kL2iCZVsL8TsMa63EWIkj4bHVKIOfuE7XQ==-gzip\""},{"key":"X-ORACLE-DMS-RID","value":"0"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate"},{"key":"Access-Control-Max-Age","value":"600"},{"key":"Access-Control-Allow-Methods-Age","value":"GET, POST, PATCH, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-CSRF, X-REQUESTED-WITH, CONTENT-TYPE, X-COREHR-PROXY-AS, X-COREHR-DEBUG, AUTHORIZATION,X-COREHR-INTEGRITY"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"2001\",\n \"payCodeDescription\": \"OVERTIME @ 1.00\",\n \"analysisCode\": \"2000\",\n \"analysisCodeDescription\": \"OVERTIME\",\n \"value\": \"147.2\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"6017\",\n \"payCodeDescription\": \"USC\",\n \"analysisCode\": \"6000\",\n \"analysisCodeDescription\": \"STATUTORY DEDUCTIONS\",\n \"value\": \"-327.4\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"9500\",\n \"payCodeDescription\": \"EMPLOYER PRSI\",\n \"analysisCode\": \"9000\",\n \"analysisCodeDescription\": \"EMPLOYER NI\",\n \"value\": \"-.74\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"6500\",\n \"payCodeDescription\": \"EMPLOYEE PRSI\",\n \"analysisCode\": \"6000\",\n \"analysisCodeDescription\": \"STATUTORY DEDUCTIONS\",\n \"value\": \"0\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"6000\",\n \"payCodeDescription\": \"PAYE\",\n \"analysisCode\": \"6000\",\n \"analysisCodeDescription\": \"STATUTORY DEDUCTIONS\",\n \"value\": \"-1862.48\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"625\",\n \"payCodeDescription\": \"ADVANCE MISC\",\n \"analysisCode\": \"7000\",\n \"analysisCodeDescription\": \"VOLUNTARY DEDUCTIONS\",\n \"value\": \"-74.34\"\n }\n ],\n \"limit\": 100,\n \"offsetby\": 0,\n \"count\": 6,\n \"hasMore\": false,\n \"links\": [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/allowances/paid/currentperiod/4956040\"\n }\n ]\n}"}],"_postman_id":"6ecf151c-17aa-4d1e-a1b1-728cde24ab0d"}],"id":"f71c02cf-297d-4849-9896-14c7d56cda00","description":"The allowance module deals with providing allowance information associated with an employee. At this time the module only deals with allowances that have been paid, and is not aware of future allowances.
\n","event":[{"listen":"prerequest","script":{"id":"bb936281-bfa8-49c3-a7e8-58941f5e9843","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"16566b77-6e2f-48df-b288-f783e71a17df","type":"text/javascript","exec":[""]}}],"_postman_id":"f71c02cf-297d-4849-9896-14c7d56cda00"},{"name":"appointment","item":[{"name":"/person/appointment/:personnelNo","id":"c78a8900-6fb5-4f4c-ab73-8d2327b42fc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"This service returns an individuals appointment related information. An appointment has various different descriptions including Contract, Post, Job, Position etc. Individuals may have more than one appointment at any given moment, though typically an individual will hold one appointment at any one time.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
appointmenId
\nA unique reference identifier for the appointment, this is a system generated identifier.
\n \nappointmentStatus - following explains the details:
\n \n
- \n
\nPL(Planned) - When a new appointment is created it will have the status of PL. This is like a placeholder appointment. You can enter planned details like the planned contract dates. No person is linked to the appointment at this stage. As such for this service you should never see this status. \n
\nAU(Authorised) - When the post administrator authorises a planned appointment, the appointment status changes to AU. This is a placeholder appointment that has been authorised. No person is linked to the appointment at this stage. As such for this service you should never see this status. \n
\nRE(Recruitment in Progress) - If the recruitment module is in use, you can optionally link an authorised appointment to an open vacancy. The appointment status changes to RE. A person gets linked to the appointment via the recruitment module when they are offered and accept a vacancy offer. \n
\nAP(Appointed) - The appointment status changes to AP when an employee new or existing is appointed to the appointment. Further contract details can be entered at this stage. It is usually indicative of a person accepting the contract but has not yet started it. The post can be configured that when you link an employee to the appointment that this stage is bypassed and the status goes straight to commenced. \n
\nCOCommenced - The person has started on the appointment. A salary record is generated. For new starters they cannot be brought on to payroll until they are commenced. This should be the most common status encountered. \n
\nCFCommenced Future - The person is commencing the appointment at a future date. The status reverts to CO when the start date of the appointment becomes effective. \n
\nENEnded - The appointment has been ended because the person has left the organisation or has started in a new appointment. \n
- \n
- category \n
Categorises appointments based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The appointment start date.
\n- \n
- endDate \n
The appointment start date.
\n- \n
- lastAmendedDate \n
(requires v27.0.3)
\nThis date indicated a changed has been made to the appointment.
\n- \n
- targetEndDate \n
The appointment target end date.
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
contractId
\nprovides ability to set a contract identifier and associate with the appiointment.
\n \njobTitle
\n \n
The title of the apponitment ad used to describe the name of the position.
\n- \n
- jobCategory \n
This is an appointment level field used to categorise job titles into groups of similar job titles. For associated descriptions use the Reference Module with the reference type JOBCAT.
- \n
- postNumber \n
the is the post profile number from which the appointmnet is based on. A post is essentially a blue print for the appointments.
\n- \n
- primaryFlag \n
this attribute will simply indicate if the appointment is the \"Substantive\" appointment as of today, this is an employees primary appointment.
\n- \n
- project \n
this attribute is populated when the appointment is associated with a project
\n- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
This service provides the ability to obtain an employees list of appointments, an employee can have more than one appointment. All appointments are returned, however each individual movement is not returned. The most recent detail associated with the appointment is returned.
\nAn appointment has various different descriptions including Contract, Post, Job, Position etc. Individuals may have more than one appointment at any given moment, though typically an individual will hold one appointment at any one time.
\nExample
\nOn 1st Jan 2018, employee Marco is a software engineer and his appoointment has a cost centre 100.
\nAppointment - 001
\nTitle - Software Engineer
\nCost Centre - 100
\nAll requests for Marcos appointment will return one appointmnet for Marco with a cost of 100.
\nOn 10th July 2018, management decide to move all engineering to a new cost centre 200, this is called a movement i.e. some change of attribute associated with Marco's appointment. In this case the change relates to a cost centre.
\nAppointment - 001
\nTitle - Software Engineer
\nCost Centre - 200
\nAll requests (from 10th July 2018) for Marcos appointment will return one appointment for Marco with a cost of 200.
\n","event":[{"listen":"prerequest","script":{"id":"7ccf45ac-b025-466a-a285-9e42150bf421","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"040f5fad-cfde-423d-9430-7cb4c6cb3f10","type":"text/javascript","exec":[""]}}],"_postman_id":"b7649c05-e6f2-4392-aa94-b58dd8c8c788"},{"name":"bank","item":[{"name":"/person/bank/:personnelNo","id":"22a412ad-a1ae-4d97-bfa6-fbbf4770fc53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/bank/5990404","description":"Provides an employees bank account details both Salary and Expense. In addition the building society number is also available form this web service.
\nNB - relates to tenants implementing HR, no special consideration has been provided to Payroll Only Special tenants.
\nTenant's implement different approaches to storing an individual's bank account detail. This service provides both traditional sort code / bank account code's and the newer BIC and IBAN.
\nNo conversion process takes place, instead the information held in CoreHR is displayed i.e. if the tenant has not provided BIC and IBAN for an individual, the expectation for this service is not to display same.
\n- \n
- personnelNo \n
this is manadatory, at a minimum this parameter must be provided.
\nReturns following information for both Salary and Expense:
\n- \n
- Sort Code \n
An individual's traditional Bank Branch identification. This is left padded with 0's for values less than 6 characters. (requires v27.0.8 for the left padding).
\n- \n
- Bank Account Number \n
An individual's traditional Bank Account Number. This is left padded with 0's for values less than 8 characters (requires v27.0.8 for the left padding).
\n- \n
- BIC \n
An individual's Bank Identification code
\n- \n
- IBAN \n
An individual's International Bank Account Number
\n- \n
- Building Society Reference \n
An individual's building society reference number
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","bank","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b94164fb-5e77-41ce-90b9-705426cc7146","name":"Salary and Expense","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/bank/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 05 Apr 2018 14:24:56 GMT","name":"Date","description":""},{"key":"ETag","value":"\"kPah9YnLuQejW3/UQrmaws6hdxEb5O4JN3azU8xWPt3TOpcq+1RDvvJdvW8ILk19RiBm3x/Ypr/sHf/UhfyiiQ==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"d99bff8e-c042-4720-8fb9-2dea429dc7ce-0001db16","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"accounts\" : [\n{\"type\":\"salary\",\"bankSortCode\":\"902813\",\"bankAccountNumber\":\"12345678\",\"bic\":\"AIBKIE2DXXX\",\"iBan\":\"IE49AIBK93015612345678\"}\n,\n{\"type\":\"expense\",\"bankSortCode\":\"912314\",\"bankAccountNumber\":\"87235622\",\"bic\":\"AIBKIE2DXXX\",\"iBan\":\"IE49AIBK93015612345678\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 2,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/bank/5990404\"\n }\n ]\n}\n"}],"_postman_id":"22a412ad-a1ae-4d97-bfa6-fbbf4770fc53"}],"id":"4f8fb50e-234e-4255-b82f-2be8bfd60268","description":"A simply service to retrieve an individuals bank account details.
\nAn individual may have more than one bank account, e.g. one for Salary payments and another for Expense. These account details maybe the same or different.
\nThis service caters for both Salary and Expense bank accounts.
\n","event":[{"listen":"prerequest","script":{"id":"2c11a085-89b3-4635-bd19-6c71e4a1e4b6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b43ddcd4-071d-4d28-919f-cf1456997d89","type":"text/javascript","exec":[""]}}],"_postman_id":"4f8fb50e-234e-4255-b82f-2be8bfd60268"},{"name":"basicAttributes","item":[{"name":"/person/basicattributes/:personnelNo","id":"42d80b5f-6c95-4245-bc8d-30828c33d221","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/","description":"This module returns some of the employee's most basic attributes, however, certain basic attributes are not include in this service for privacy reasons e.g. Social Security Number (SSN). To obtain SSN a separate service is available. The person module typically accepts only personnelNo. Use the filter module to obtain a result sets for various employees status e.g. recently joined, left , active etc.
Most of these attributes are provied by the tenant, the descriptions may not exactly match with the value provided. For example: A field exists known as \"Home Telephone Number\" a tenant may use this for a Landline Number, a personal business number, a mobile number etc.
\nNB No confirmation takes place on the personnelNo, if an incorrect personnelNo is presented the service will simply respond with no data.
\nFollowing attributes are returned:
\nGeneral
\n- \n
- First Name \n
Indicates a persons first name.
\n- \n
- Middle Name \n
Indicates a persons middle name.
\n- \n
- Last Name \n
Indicates a persons middle name.
\n- \n
- Previous Surname \n
Indicates a persons previous surname.
\n- \n
- Known As \n
Sometimes a person is known as a slightly different name that first, last or middle name. This field represents such sceanrios.
\n- \n
- Title \n
Indicates the persons full title description.
\n- \n
- Active \n
Simply indicates Y or N, answering the question at this point in time ( i.e. when the serice is called) \"Is Person Currently active?\". In cases where an individual has a leaving date on the same date the service is executed i.e. today the individual is considered active and will have a value of 'Y'.
\n- \n
- OnBoarding Completed \n
This attribute will be flagged as 'Y' indicating individual has completed their onboarding process, otherwise this will be flagged as 'N'.
\n- \n
- Next of Kin Name \n
The name in CoreHR provided for the individual's next of kin.
\n- \n
- Next of Kin Relationship \n
The name in CoreHR provided for the individual's next of kin relationship.
\n- \n
- Next of Kin Contact Number \n
The contact number associated with the next of kin.
\n- \n
- Home Telephone Number \n
An individuals home telephone number, the area code is included in this field.
\n- \n
- salaryPayMethod \n
Represents the method of payment for one's salary. This is a code e.g 'PP', to obtain the description use the reference module web service using a type of PAYM. Your system administrator will have to ensure this reference type is whitelisted.
NB To obtain Next of Kin Address use the address module.
\n- \n
- loginId \n
An individuals login identifier for self service and mobile applications. NB for SAML enabled sites this attribute will display N/A (SAML enabled site).
\nDates
\nAll dates are represented as : YYYYMMDD
\n- \n
- Date of Birth \n
An individuals date of birth formated
\n- \n
- Termination Date \n
Indicates an individuals most recent date for leaving. In cases where a person has left and rejoined and is flag to leave again this date will alsways be the most recent date for leaving. This may not be populated, this date can be in the futrue.
\n- \n
- Current start Date \n
An individuals most recent date started. This will cater for sceanrios where an individual has left and rejoined. It will always represent the current start date.
\n- \n
- Original Start Date \n
An individuals first time starting with an organisation. This can cater for scnearioes where an employee has left and rejoined. This date never changes, if an individual is currently active and has never left, this is the same date as Current Start Date. If this date is differnt to current start date, this typically means an individual has rejoined.
\n- \n
- Continuous Service Date \n
This date is used for calculating an individual length of service. Within the CorEHR engine this can be a complex process. This field represents the correct continuous service date, there should be no need to attempt to derive this date from the various other dates supplied.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","basicattributes",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"1f97da7f-16cd-43bf-b0c7-b5a2417bdd8b","name":"Validation Failed Wrong Field Length","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/1234567890123"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 22 Jun 2018 11:07:28 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"T2L98k5uY4oOIYGERPhm/fRFFPlBFj5IYfwnRplcyTaCuRCN5aZXRLqBxQjdHdbnstHQbumRWP7agQ3j8kc0FA==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"30038f37-18e0-4c74-a73d-1ed97dac4bc1-00143c86","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"The maximum length of this field is 12\",\n \"code\": \"9011\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"},{"id":"36bed440-18e5-44c4-a7e8-ea7a73aa5911","name":"Mandatory Field Missing","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 22 Jun 2018 11:05:26 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"Xv9lRXYEJ7eVD2nC2gIUqerGRIFOD81+JnHtfOxPQgWOYt9i+LRFxXCLUSr7Xr8sssp6vyRHeKI0cUBgSxjMyg==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"30038f37-18e0-4c74-a73d-1ed97dac4bc1-001439db","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"This field is mandatory.\",\n \"code\": \"9001\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"},{"id":"c159e15d-cfaa-4cd7-a38a-04f4798767b4","name":"Validation Failed AlphaNumeric ","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/123!!"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 22 Jun 2018 11:06:40 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"RmAmWESpjPx1HQcC4yM3LakCm1+pazrdxEpor92H2/Bbgfn5+PkfVrR1SNs1fnfVhP7f+MscIk1F07yw1loGjw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"30038f37-18e0-4c74-a73d-1ed97dac4bc1-00143b6d","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"Alphanumeric characters only.\",\n \"code\": \"9002\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"},{"id":"dcc9089f-840e-4781-ad49-bc21cc6a58f1","name":"Working Example","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 16:16:43 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"QozGpjQ/pokQfFuXCrLby9Kfov86tifSFSwitSSyqwRrHSB0VIhvBagWvIthkxz1i96lihX/dAAhFAsj+KzgJQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-000062cb","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"firstName\":\"Marco\",\"middleName\":\"Rufus\",\"lastName\":\"Donnini\",\"previousSurname\":\"Radinski\",\"knownAs\":\"Marco\",\"title\":\"Professor\",\"active\":\"Y\",\"onboardingCompleted\":\"N\",\"dateOfBirth\":\"19700101\",\"currentStartDate\":\"20180315\",\"terminationDate\":\"\",\"originalStartDate\":\"20170102\",\"continuousServiceDate\":\"20180315\",\"nextOfKinName\":\"Rufus Stravous\",\"nextOfKinContactNumber\":\"+44 765892350\",\"nextOfKinRelationship\":\"Partner\",\"salaryPayMethod\":\"PP\",\"homeTelehoneNumber\":\"4401892350\",\"loginId\":\"N/A (SAML enabled site)\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/basicattributes/5990404\"\n }\n ]\n}\n"}],"_postman_id":"42d80b5f-6c95-4245-bc8d-30828c33d221"}],"id":"e7c923ab-962f-461b-9919-181d929ee498","description":"This section deals with an individuals most basic attributes e.g. name, title, date of birth etc. As PeopleXD is a HR system, every field within the app could be argued to be included. Our objective is to provide services for use cases and not expose all fields in one monolithic web service. We also have to consider privacy and security e.g. not every third party service app requires Social Security Number or Bank Account Details etc. Hence, such fields are not included in the basicAttributes service, instead they are available via specific services.
\nYou might ask where are email, mobile numbers etc and why are they not provided here?
\nInstead they are provided via the Contact module (such detail is highly configurable)
Following attributes are provided as part of this basicAttribute module:
\nGeneral
\n* First Name
\nIndicates an individuals first name.
\n* Middle Name
\nIndicates an individuals middle name.
\n* Last Name
\nIndicates an individuals middle name.
\n* Known As
\nSometimes a person is known as a slightly different name thatn their first, last or middle name. This field represents such scenarios.
\n* Title
\nIndicates an individuals full title description.
\n* Active
\nSimply indicates Y or N, answering the question at this point in time ( i.e. when the serice is called) Is Person Currently active?
\n* Onabording Completed
\nSimply indicates Y or N, representing if the individual has completed their onboarding.
\n* Next Of Kin
\nInformation regarding the individuals next of kin.
\nDates
\nAll dates are represented as : YYYYMMDD
\n* Date of Birth
\nAn individuals date of birth.
\n* Termination Date
\nIndicates an individuals most recent date for leaving. In cases where a person has left, and rejoined, and is flagged to leave again, this date will always represent the most recent date for leaving. This date field may not be populated, this date can be in the futrue.
\n* Current start Date
\nAn individuals most recent date started. This will cater for scenarios where an individual has left and rejoined. It will always represent the current start date.
\n* Original Start Date
\nRepresents an individuals first date, when they started Day Zero with an organisation. This can cater for scenarios where an employee has left and rejoined. This date never changes, if an individual is currently active and has never left, this is the same date as Current Start Date. If this date is different to current start date, typically suggests an individual has rejoined.
\n* Continuous Service Date
\nThis date is used for calculating an individual length of service. Within the PeopleXD engine this can be a complex process. This field represents the correct continuous service date, there should be no need to attempt to derive this date from the various other dates supplied.
\n","event":[{"listen":"prerequest","script":{"id":"1fdd5a50-4eae-4ab7-a6d0-54f1404d15aa","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1646b227-4021-4e1c-94cc-1785b56e17c1","type":"text/javascript","exec":[""]}}],"_postman_id":"e7c923ab-962f-461b-9919-181d929ee498"},{"name":"costAllocation","item":[{"name":"/person/costallocation/:personnelNo","id":"7c93d78d-6cfa-449c-ba6d-bde01c27a512","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/costallocation/5990404","description":"This service provides the ability to obtain an employees cost allocations, all cost allocations are returned both current and historic (dates are provided to distinguish open / closed allocations). Generally this service not return 100's of cost allocations, and therefore no special filters are created.
\nCost Alloactions can be defined at the employee or appointment level.This service is defined at the employee level, but will return appointment ID's where appropriate.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- costCentre \n
the cost centre, this code can be mapped to the reference module, using COST. This attribute should always be populated.
- \n
- percent \n
the percentage applied to this cost allocation. This attribute should always be populated.
\n- \n
- location \n
the location applied to this cost allocation, this code can be mapped to the reference module, using LOC
- \n
- project \n
the project applied to this cost allocation, this code can be mapped to the reference module, using PROJ
- \n
- expense \n
the expense applied to this cost allocation, this code can be mapped to the reference module, using EXPS
- \n
- allocationId \n
unique identifier for a cost allocation. Provides an ability to link directly back to the cost allocation. This attribute should always be populated.
\nExample:
\nAn employees salary is calculated and associated with three different cost centres, and query where the value at cost centre X comes from, the allocation ID (if present) can link back to the exact cost allocation that triggered it, e.g. 25% of costs to cost centre X.
\n- \n
- appointmentId \n
The appointment associated with this cost allocation
\n- \n
- startDate \n
the date this cost allocation comes into affect, format YYYYMMDD
\n- \n
- endDate \n
the date this cost allocation is no longer in effect, format YYYYMMDD
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","costallocation","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"857d84ab-9292-434f-a3dc-06b3377afeb3","name":"Success Cost Allocations","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/costallocation/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 02 May 2018 11:00:39 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"6XCcIUTnTS/FuB7jjB/DDFRD/fz8jTWUTGZDWvK6rZuE8/isin3lnJogmwcCAHD4IuCST8s+6cRPWCA2FDMbCw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"d99bff8e-c042-4720-8fb9-2dea429dc7ce-003c1ddc","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"attributes\" : [\n{\"costCentre\":\"BM40008\",\"startDate\":\"20170715\",\"endDate\":\"20170831\",\"percent\":\"100\",\"location\":\"\",\"allocationId\":2017071974748241,\"appointmentId\":\"502629-3\",\"expense\":\"40290\",\"project\":\"7\"}\n,\n{\"costCentre\":\"BM40008\",\"startDate\":\"20170711\",\"endDate\":\"20170714\",\"percent\":\"100\",\"location\":\"\",\"allocationId\":2017071974745300,\"appointmentId\":\"502629-1\",\"expense\":\"40290\",\"project\":\"7\"}\n,\n{\"costCentre\":\"BM40014\",\"startDate\":\"20170704\",\"endDate\":\"20170710\",\"percent\":\"50\",\"location\":\"\",\"allocationId\":2017071974745296,\"appointmentId\":\"502629-1\",\"expense\":\"40560\",\"project\":\"5\"}\n,\n{\"costCentre\":\"BM00000\",\"startDate\":\"20170704\",\"endDate\":\"20170710\",\"percent\":\"50\",\"location\":\"1\",\"allocationId\":2017071974745298,\"appointmentId\":\"502629-1\",\"expense\":\"40290\",\"project\":\"7\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 4,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/costallocation/5990404\"\n }\n ]\n}\n"}],"_postman_id":"7c93d78d-6cfa-449c-ba6d-bde01c27a512"}],"id":"6e2ffb84-e2db-4418-a5b4-5f903a5cb1b1","description":"This service provides the ability to obtain an employees cost allocations, all cost allocations are returned both current and historic (dates are provided to distinguish open / closed allocations). Generally this service not return 100's of cost allocations, and therefore no special filters are created.
\nCost Alloactions can be defined at the employee or appointment level.This service is defined at the employee level, but will return appointment ID's where appropriate.
\n","event":[{"listen":"prerequest","script":{"id":"763c3fcd-c965-4645-b2ca-62cb7ae91c00","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"13275fe7-2366-4376-afec-15cac7430864","type":"text/javascript","exec":[""]}}],"_postman_id":"6e2ffb84-e2db-4418-a5b4-5f903a5cb1b1"},{"name":"genderIdentity","item":[{"name":"/person/genderidentity/:personnelNo","id":"7a0bf036-56e3-423d-be71-59b0805028e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/genderidentity/5990404","description":"Provides an individuals legal sex and gender identification detail.
\n- \n
- personnelNo \n
this is manadatory, at a minimum this parameter must be provided.
\nReturns following attributes:
\n- \n
Legal Sex
\n \nGender Identity
\n \n
This is a gender identification code, for associated descriptions use the Reference Module with the reference type GNDRID.
This service provides information relating to an individual's gender identification.
\n","_postman_id":"a6b6caeb-37a4-49a8-bb6a-dfa1e4dd922d"},{"name":"maritalstatus","item":[{"name":"/person/maritalstatus/:personnelNo","id":"880749d7-66d3-443f-9179-ed71fbde67d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Provides an individuals Marital Status information.
\n- \n
- Marital Status Code \n
Provides an individuals martial status information.
\n- \n
- Marital Status Code \n
Provides an individuals nationality information.
\n- \n
- Nationality Code \n
Provides an individuals nationality information.
\n- \n
- Nationality Code \n
This is a very simple web service returning basic information for an individuals pension. All entries related to an employee pension will be returned including active and ended.
\nParameters
\n- \n
- personnelNo \n
Manadatory
\nType: AlphaNumeric
\nMax Length : 12
\nJSON Response Body Explained
\nAn array of all pension schemes associated with the individual is returned, the most recently joined pension scheme is returned first.
\n- \n
- schemeCode \n
A unique code associated with the pension scheme.
\n- \n
- appointmentID \n
this attribute is populated if the individual's pension scheme is associated with a particular appointment.
\n- \n
- dateEnd \n
indicates when the pension scheme ended for the individual, returned in format YYYYMMDD.
\n- \n
- dateJoined \n
indicates when the employee joined the pension scheme, returned in format YYYYMMDD
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","pension","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3894d4a1-511d-49ee-9919-741592e47c53","name":"Pension Information","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/pension/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 28 Jun 2018 14:23:26 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"W5TPVaB+Aiz7z+FMBASz6aWxLjN19XWifM8GIKX9g1eWI9T7Qvo5y/XuEu4PwXTwb3XEpiy20o/FgtMMdrJRdQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0006b88a","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"schemeCode\":16,\"dateJoined\":\"20170601\",\"dateEnd\":\"\",\"appointmentID\":\"DP0007-2077\"}\n,\n{\"schemeCode\":15,\"dateJoined\":\"20161022\",\"dateEnd\":\"20170901\",\"appointmentID\":\"SD88712-1\"}\n,\n{\"schemeCode\":16,\"dateJoined\":\"20151019\",\"dateEnd\":\"\",\"appointmentID\":\"FD4005-1\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 3,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/pension/5990404\"\n }\n ]\n}\n"},{"id":"52e35a31-08bb-4f6d-b3ca-5ecea9d3bf87","name":"Mandatory Data Missing","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/pension/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 28 Jun 2018 16:05:30 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"IIhsxH2Ji400+QeroRmFt6gc2g7b1QHixhZywWjc6NIWGfPAw4CjTnzhC2v+lA38covxOStmFbtsMyf36pPvsw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-00073eeb","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"This field is mandatory.\",\n \"code\": \"9001\",\n \"jsonKey\": \"personnelNo\",\n \"isWarning\": false\n}\n]}\n"}],"_postman_id":"5ce8837f-43cd-4bae-a3db-585d9c9f9ea5"}],"id":"0333e7db-05a9-43fe-a6ed-fa762a37281e","description":"This web service returns data related to an individual's pension.
\n","event":[{"listen":"prerequest","script":{"id":"c8a193b1-d4aa-4d0f-be75-26ce760aaba9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4307e484-4c0f-4a72-ac0c-a0ed06925896","type":"text/javascript","exec":[""]}}],"_postman_id":"0333e7db-05a9-43fe-a6ed-fa762a37281e"},{"name":"probation","item":[{"name":"/person/probation/:personnelNo","id":"2aa4a92a-e1d8-4811-aae0-3ea4dd1faf28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/probation/:personnelNo","description":"The following attributes are associated with an individual's probabtion detail. Not all attributes will be populated.
\nAll dates presented in 'YYYYMMDD' format.
\n- \n
- Date Complete \n
The probabtion completion date is the date which the individuals probstion is completed.
\n- \n
- Date Expires \n
The probation expiry date is the date which the individual's probation is due to expire.
\n- \n
- Date Review One \n
The probation review date is the first review date for the individuals probation.
\n- \n
- Date Review Two \n
This probation review date is the second review date for the individual's probation.
\n- \n
- Date Extension \n
This date represents the individual's probation extension where applicable.
\n- \n
- Extension Reason \n
The probation extension reason represents the reason for extending the persons probation. This is a reference related attribute, the associated desription is available from the reference module under the reference type PEXRSN. Note, in order to obtain the description your system administrator will be required to whitelist the reference type PEXRSN and granted the app approrpiate privileges.
This module provides an individual's probation detail.
\n","event":[{"listen":"prerequest","script":{"id":"faca3492-83d9-4d88-a04b-12c726ae17b7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a297923c-626c-4150-97f3-3908defe8225","type":"text/javascript","exec":[""]}}],"_postman_id":"bc25afa0-2cf2-4b2a-9c84-1b7e027a4851"},{"name":"reportsTo","item":[{"name":"person/reportsto/:personnelNumber/:appointmentid?","id":"5e747cd9-b32c-466a-be72-e63d5c8003ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/","description":"Parameters
\n- \n
- personnelNumber \n
This attribute is the personnelNumber of the individual to find their reportsTo / manager.
\nManadatory
\nType : AlphaNumeric
\nMax Length : 12
\n- \n
- appointmentId \n
This attribute can be any of the individuals appointmentId's. An individual is required to have at least one appointmentID and is often referred to as substantive / primary appointmentId.
\nOptional
\nType : AlphaNumeric
\n(this field is typically XXXXX-XX, even though it is flagged as alpha Numberic, the '-' (dash) is excluded from a validation perspective i.e. when validation / sanitisation is performed the dash is excluded)
\nMax Length : 16
\nJSON Response Body Explained
\n- \n
- reportsToPersonnelNumber \n
This attribute represents the individual's 'Report To Personnel Number', typically their manager / line manager / Supervisor etc. You can use this attribute as the personnelNumber for any other web service requesting personnelNumber. As such it is possible to obtain further information for the 'ReportsTo'.
\n- \n
- reportsToName \n
This attribute represents the individual's 'Report To Name' i.e. typically the name of their manager / line manager / Supervisor etc.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","reportsto","5990404",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0f61d5c2-71d9-4024-8e58-602579b2088b","name":"PersonnelNumber Only","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 09:43:26 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"pZVLqJiJtJRnx3Q2SNnEn7mzHsEJE7h3AYFTFFddSSAABwOp+IfG7nt/RNZwkio5FpXtWJPuYQ8Vk8/lKfjWkw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-0013bc9c","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"reportsToPersonnelNumber\":\"5990181\",\"reportsToName\":\"Sasha Digweed\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/reportsto/5990404/\"\n }\n ]\n}\n"},{"id":"3dd6cce5-b661-42a1-b6b2-c9fe242f4a63","name":"Invalid PersonnelNumber Type","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/12345678[]/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:36:25 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"l61gq8U/3Ddnb8zX5veO7cQVtiR39qcu0L0AUV3aYxGLsn2WfS2frH7+m+AsDD+dAiRYTAdNcYd29zRxkhBYKA==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-00140227","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"Alphanumeric characters only.\",\n \"code\": \"9002\",\n \"jsonKey\": \"personnelNo\",\n \"isWarning\": false\n}\n]}\n"},{"id":"4c98a0ec-5272-4178-a211-5d1207687eb9","name":"Invalid AppointmentID Type","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/123!"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:40:29 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"RmAmWESpjPx1HQcC4yM3LakCm1+pazrdxEpor92H2/Bbgfn5+PkfVrR1SNs1fnfVhP7f+MscIk1F07yw1loGjw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-0014079d","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"Alphanumeric characters only.\",\n \"code\": \"9002\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"},{"id":"62d40726-421b-425c-8e94-d328eb481c3c","name":"Invalid AppointmentID Length","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/12345678901234567"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:39:34 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"2hERA1Oq6h48UWWRIfHmdaguVn33swa/4feFw1P/coF2t3J4ZczHKP+Kd64JweIz++0TdVUF4Bh+ni899eavNw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-00140659","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"The maximum length of this field is 16\",\n \"code\": \"9008\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"},{"id":"c07c762d-e114-459a-809b-d7d2ddcd25d1","name":"PersonnelNumber and AppointmentID","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/599014-25"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:21:14 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"31sy6J0QsiwFzAdrVi7qAyzs+hvz6E2rE/5kyizpDEhT65JmvEMorDrEovo3NLM/eYUCQmpmBAz06mwdCt2Yew==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-0013edca","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"reportsToPersonnelNumber\":\"5990181\",\"reportsToName\":\"Sasha Digweed\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/reportsto/5990404/599014-25\"\n }\n ]\n}\n"},{"id":"d2270ef9-a91c-4cde-9fdf-9c61dd75a478","name":"Invalid PersonnelNumber Length","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/1234567890123/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:37:19 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"U1TQYcXzLmuMBybM9sxQnH+pnJ45yfK9QyLZfZerGvSE8XpFYujUbMeaYutfoYGti5eB8XXY1L1Zsc/zuvTYJQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-00140369","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"The maximum length of this field is 12\",\n \"code\": \"9008\",\n \"jsonKey\": \"personnelNo\",\n \"isWarning\": false\n}\n]}\n"}],"_postman_id":"5e747cd9-b32c-466a-be72-e63d5c8003ad"}],"id":"4491e82c-fa83-4ffd-ab84-6892e0b45d0d","description":"This web service returns an individual's Reporting to manager / supervisor etc. It is a very simple web service, simply provide the personnel number and the individual's 'ReportTo' is returned. By only providing the personnelNumber, the individuals substantive (primary) appointment is used.
\nOptionally provide an appointment ID, this will then indicate to the service to return an individuals 'ReportTo' for the person and the specific appointment provided.
\nWith respect to the 'ReportsTo' effective date, in all cases this web service uses the current date i.e. the date the web service is called.
\n","_postman_id":"4491e82c-fa83-4ffd-ab84-6892e0b45d0d"},{"name":"salary","item":[{"name":"/person/salary/:personnelNo/:date?","id":"9fd89783-694a-432c-bcd8-d42346849292","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/salary/5990404/","description":"Provides an employees salary, has the ability to get an employees full salary history along with Salary for a specific date. It is therefore possible to determine current, full history or salary for a specfic date across all of an employees appointments.
\nParameters
\n- \n
- personnelNo \n
Manadatory
\nType: AlphaNumeric
\nMax Length : 12
\n- \n
- date \n
Optional
\nFormat : YYYYMMDD
\nWhen no date is provided, the service assumes current active salary details. When populated \n(note the date formatted must be YYYYMMDD) this will provide employees salary for the specfic date. While providing 0 indicates to the service to return a result set of employees entire salary history.
This module will provide salary detail for an individual. Salary information can be a complex topic, outlined explains in as simply terms as possible how an employees rate of pay is determined.
\nUses Cases determine
\n- \n
- an employee's current salary detail \n
- an employee's historical salary detail \n
- an employee's salary per appointment \n
- an employee's salary on a specific date \n
This salary module is aware of multi-appointments i.e. in cases where an individual has more than one active position (i.e. more than one appointment) two entries or more, will be included in the results set. In cases where only one position is associated with an employee only one entry will be returned.
\nEmployee's rates of pay can be based on various frequencies:
\n- \n
- Hourly \n
- Daily \n
- Weekly \n
- Annual \n
Not all attributes will be populated, the fields populated are dependent on how your system administrators have configured salary / pay details.
\nFollowing attributes are returned:
\n- \n
- annual \n
An annual salary rate, typically used for salary based employees. Each month this rate is divided by 12.
\n- \n
- weekly \n
A weekly based rate of pay.
\n- \n
- daily \n
A daily based rate of pay.
\n- \n
- hourly \n
An hourly based rate of pay.
\n- \n
- dateActive \n
The date when the rate(s) of pay are effective for employee. An employee can only have one set of active pay rates per appointment.
\n- \n
- dateExpire \n
The date when the rate(s) of pay have ended and are no longer active for employee. Useful when viewing historical rates of pay.
\n- \n
- multiplier \n
This is a number applied to the rate of pay, typically set to 1, indicating the individual is paid the (rate of pay * 1), often used in cases where employee is part time.
\n- \n
- annualised \n
The annual rate of pay, in cases where weekly rate is only provided, this figure presents an annual rate. In cases where the annual rate is defined, this annualised figure is the same value.
\n- \n
- actualPay \n
Takes the provided rate(s) of pay and applies the multiplier.
\n- \n
- actualAnnualisedPay \n
Takes the annualised figure and applies the multiplier.
\n- \n
- appointmentID \n
Employee's unique Job identifier, typically referred to as appointment ID. It is possible an individual has more than one Job/Appointment, if this is the case more the result set will reflect this.
\n- \n
- grade \n
This attribute reprsents an employee's salary grade, typically this represents one's Role / Job.
\n- \n
- point \n
This attribute represents a level within the Grade, sometimes termed Spine Point. In some cases this value can be '9999', this represents an individual has been assigned a personal point.
\n","event":[{"listen":"prerequest","script":{"id":"55759be1-4ffa-4ca6-a96f-9bb51f86f8d9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9685fcfd-4eeb-4f58-84f0-d89782cc44b0","type":"text/javascript","exec":[""]}}],"_postman_id":"1b79aa6e-00c8-4e8c-a6af-0f154982efaa"},{"name":"socialSecurityNumber","item":[{"name":"/person/socialsecuritynumber/:personnelNo","id":"eecb9862-2f29-4804-9268-35ac59e1424c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/socialsecuritynumber/5990404","description":"Simply gets an individuals Social Security Number.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","socialsecuritynumber","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"23cdebae-fe26-4dd9-8db6-d90c00de3ec3","name":"Current Active Salary","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/salary/5990404/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 21 Mar 2018 17:57:37 GMT","name":"Date","description":""},{"key":"ETag","value":"\"FDsnzuXPBRCYJbbDVL2OyeQ9P2HxpYUXcZyf2t1OE5u8nKCRru6K48Y/V+cXg/9KPl/nUAaF7IDq1H8s3HEVSA==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"253df163-0e02-4479-b26d-f2eaa8228ccf-00011b68","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"salary\" : [\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20170108\",\"dateExpire\":\"\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"TS0011-18339\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/salary/5990404/\"\n }\n ]\n}\n"},{"id":"76367912-ac28-4bf9-a5e6-1e97aaaa8401","name":"All Salary History","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/salary/5990404/0"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 21 Mar 2018 17:58:04 GMT","name":"Date","description":""},{"key":"ETag","value":"\"hkaOE4XQSbYdfEu/G4B7X3hnwbEZbElMx/uzYF1NoEK/tWmjE8dhIE0XKrxzA2nxzOD+upOc7BFrs9bjOQsoyw==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"253df163-0e02-4479-b26d-f2eaa8228ccf-00011b92","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"salary\" : [\n{\"annual\":\"14448.25\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.1\",\"dateActive\":\"20130718\",\"dateExpire\":\"20160401\",\"multiplier\":\"1\",\"annualised\":\"14448.25\",\"actualPay\":\"14448.25\",\"actualAnnualisedPay\":\"14448.25\",\"appointmentID\":\"JXXXXX-4347\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20161211\",\"dateExpire\":\"20170107\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"OU0011-12458\"}\n,\n{\"annual\":\"14448.25\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.1\",\"dateActive\":\"20160402\",\"dateExpire\":\"20160923\",\"multiplier\":\".25641\",\"annualised\":\"14448.25\",\"actualPay\":\"3704.67578\",\"actualAnnualisedPay\":\"3704.67578\",\"appointmentID\":\"OU0011-2694\"}\n,\n{\"annual\":\"14448.25\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.1\",\"dateActive\":\"20160924\",\"dateExpire\":\"20160915\",\"multiplier\":\".25641\",\"annualised\":\"14448.25\",\"actualPay\":\"3704.67578\",\"actualAnnualisedPay\":\"3704.67578\",\"appointmentID\":\"OU0011-2694\"}\n,\n{\"annual\":\"14448.25\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.1\",\"dateActive\":\"20160916\",\"dateExpire\":\"20160922\",\"multiplier\":\".25641\",\"annualised\":\"14448.25\",\"actualPay\":\"3704.67578\",\"actualAnnualisedPay\":\"3704.67578\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15262.24\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.5\",\"dateActive\":\"20160923\",\"dateExpire\":\"20160924\",\"multiplier\":\".25641\",\"annualised\":\"15262.24\",\"actualPay\":\"3913.39096\",\"actualAnnualisedPay\":\"3913.39096\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"\",\"daily\":\"\",\"hourly\":\"\",\"dateActive\":\"20160925\",\"dateExpire\":\"20160925\",\"multiplier\":\".25641\",\"annualised\":\"15770.98\",\"actualPay\":\"4043.83698\",\"actualAnnualisedPay\":\"4043.83698\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"\",\"daily\":\"\",\"hourly\":\"\",\"dateActive\":\"20160926\",\"dateExpire\":\"20160930\",\"multiplier\":\".410256\",\"annualised\":\"15770.98\",\"actualPay\":\"6470.13917\",\"actualAnnualisedPay\":\"6470.13917\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20161001\",\"dateExpire\":\"20161029\",\"multiplier\":\".410256\",\"annualised\":\"15770.98\",\"actualPay\":\"6470.13917\",\"actualAnnualisedPay\":\"6470.13917\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20161030\",\"dateExpire\":\"20161210\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20170108\",\"dateExpire\":\"\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"TS0011-18339\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 11,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/salary/5990404/0\"\n }\n ]\n}\n"},{"id":"fe1c4a59-187b-4c73-acf5-456ed28cfa0f","name":"Salary on Specific Date ","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/salary/5990404/20170101"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 21 Mar 2018 17:58:29 GMT","name":"Date","description":""},{"key":"ETag","value":"\"X8DO7XKppamdtc8NWRGV4/oL9G8Xqsj7zouGAbNqDV2Y9g4Wwdl3gRdBM3iciy40xCIPV9WwIQRbWiWwY0QFKg==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"253df163-0e02-4479-b26d-f2eaa8228ccf-00011bba","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"salary\" : [\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20161211\",\"dateExpire\":\"20170107\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"OU0011-12458\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/salary/5990404/20170101\"\n }\n ]\n}\n"}],"_postman_id":"eecb9862-2f29-4804-9268-35ac59e1424c"}],"id":"528108ce-d4a7-41e8-adb4-c5d93e367217","description":"An individuals National Social number e.g. Social Security Number.
\n","event":[{"listen":"prerequest","script":{"id":"6702cb59-001b-4c48-8586-c78e86159aa9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0a46e200-559c-4517-bf57-4b3eacddde6d","type":"text/javascript","exec":[""]}}],"_postman_id":"528108ce-d4a7-41e8-adb4-c5d93e367217"},{"name":"workpermit","item":[{"name":"/person/workpermit/:personnelNo","id":"11236e50-e94f-4c5b-a351-2b6f450e7d5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/workpermit/5990404","description":"Provides an individuals work permit information.
\n- \n
Work Permit Number
\n \nWork Permit
\n \nDate Work Permit Issued
\n \nDate Work Permit Expires
\n \n
Provides an individuals work permit information.
\n- \n
Work Permit Number
\n \nWork Permit
\n \nDate Work Permit Issued
\n \nDate Work Permit Expires
\n \n
This person module is all about personnel associated with an organisation, typically employee's, though sometimes contractors.
\nAll personnel entities have a personnelNo. Each of these services will accept a personnelNo as an atttrbute. To obtain sets of personnelNo use the filter module. The person module is typically used to determine following detail regarind an organisations personnel:
- \n
- basic attributes (name, joined date etc.) \n
- address detail \n
- probation information \n
- work permit details \n
- bank Account information \n
- salary information \n
Separate services are defined for each of above, rather than one large service.
\nNB : as this module only accepts the primary identifer personnelNo the pagesize option has no affect.
Parameters
\npersonnelNo
\nMandatory: Yes
\nExpected Type: AlphaNumeric
\nLength Max : 12
\n","event":[{"listen":"prerequest","script":{"id":"05cbeca5-4b00-4d33-9ec2-42c276a126cd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"58b8564a-1c07-428a-9347-8cd683b28891","type":"text/javascript","exec":[""]}}],"_postman_id":"0ace6d2b-f4f1-4b6e-b7a6-fc9c93f6db1c"},{"name":"Organisation","item":[{"name":"structure","item":[{"name":"config","item":[{"name":"/organisation/structure/config","id":"2ea8dbdf-02a1-4a45-8740-0fb1aa891921","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/organisation/structure/config","description":"Parameters
\nno parameters are required to call this service.
\nJSON Response Body Explained
\nAn array of organisational structures are returned.
\n- \n
- structureCode \n
A unique identifier associated with this specfic organisations hierarchy.
\n- \n
- hierarchyName \n
A description for this structure / hierarchy. The description will be defined by your HR Administration colleagues.
\n- \n
- level1Type .. level12Type \n
This is a list from 1 through 12. These will list the types for each of the levels of hierarchy, for example Level One might by Company, Level 2 might be Management unit etc. These levels will be based on Reference data and can be mapped back to the reference module. In general it it is possible to use this type and reference back to the reference module.
\n- \n
- hierarchyInd1 .. hierarchyInd12 \n
This is a list from 1 through 12. These attributes indicate if the corresponding level is part of a hierarchy rather than just part of the structure. Reference back to the Organisation Module description for an explaination of the Hierarchy v's Structure concept. The indicator is simply Y or N.
\n- \n
- label1 .. label12 \n
These are the descriptions associated with the level1 .. level12 type.
\n- \n
- displayMode1 .. displayMode12 \n
It is possible to configure the display description for each element. This mode can return one of the following CD (code description), DC (description code) and D (description).
\nFor example - \nif the displayMode is CD (code description) then the description would be\n\n1001 : Engineering \n\nthe code is 1001 while the description is Engineering\n- \n
- dateApplied \n
indicates the date the structure was made active.
\n- \n
- dateInput \n
this is the date the structure was first created.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","{{version}}","organisation","structure","config"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"89df2b78-630e-461d-97e7-03d00dea8834","name":"Success 200","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/organisation/structure/config"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 18 Jun 2018 14:17:29 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"QdYOzMA/b7fLqDLuLuinGXapZCFy2sgKwURL3ZcmhlywvfNbIke+t0+o8zLlq3NRlMvneOeex5JqR1ExtMDm2g==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"30038f37-18e0-4c74-a73d-1ed97dac4bc1-0008576a","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"structure\" : [\n{\"structureCode\":\"7000\",\"hierarchyName\":\"Company 7000\",\"dateInput\":\"20170209\",\"dateApplied\":\"20170209\",\"level1Type\":\"ORGZ\",\"level2Type\":\"MGTU\",\"level3Type\":\"DEPT\",\"level4Type\":\"USER1\",\"level5Type\":\"DIV\",\"level6Type\":\"COST\",\"level7Type\":\"LOC\",\"level8Type\":\"WRKGRP\",\"level9Type\":\"\",\"level10Type\":\"\",\"level11Type\":\"\",\"level12Type\":\"\",\"label1\":\"Company\",\"label2\":\"Management Unit\",\"label3\":\"Department\",\"label4\":\"Team\",\"label5\":\"Division\",\"label6\":\"Cost Centre\",\"label7\":\"Location\",\"label8\":\"Work Group\",\"label9\":\"\",\"label10\":\"\",\"label11\":\"\",\"label12\":\"\",\"hierarchy1Ind\":\"Y\",\"hierarchy2Ind\":\"Y\",\"hierarchy3Ind\":\"Y\",\"hierarchy4Ind\":\"N\",\"hierarchy5Ind\":\"N\",\"hierarchy6Ind\":\"N\",\"hierarchy7Ind\":\"N\",\"hierarchy8Ind\":\"N\",\"hierarchy9Ind\":\"N\",\"hierarchy10Ind\":\"N\",\"hierarchy11Ind\":\"N\",\"hierarchy12Ind\":\"N\",\"displayMode1\":\"CD\",\"displayMode2\":\"CD\",\"displayMode3\":\"CD\",\"displayMode4\":\"CD\",\"displayMode5\":\"CD\",\"displayMode6\":\"CD\",\"displayMode7\":\"CD\",\"displayMode8\":\"CD\",\"displayMode9\":\"CD\",\"displayMode10\":\"CD\",\"displayMode11\":\"CD\",\"displayMode12\":\"CD\"}\n,\n{\"structureCode\":\"7001\",\"hierarchyName\":\"Company 7001\",\"dateInput\":\"20170209\",\"dateApplied\":\"20170209\",\"level1Type\":\"ORGZ\",\"level2Type\":\"MGTU\",\"level3Type\":\"DEPT\",\"level4Type\":\"USER1\",\"level5Type\":\"DIV\",\"level6Type\":\"COST\",\"level7Type\":\"LOC\",\"level8Type\":\"WRKGRP\",\"level9Type\":\"\",\"level10Type\":\"\",\"level11Type\":\"\",\"level12Type\":\"\",\"label1\":\"Company\",\"label2\":\"Management Unit\",\"label3\":\"Department\",\"label4\":\"Team\",\"label5\":\"Division\",\"label6\":\"Cost Centre\",\"label7\":\"Location\",\"label8\":\"Work Group\",\"label9\":\"\",\"label10\":\"\",\"label11\":\"\",\"label12\":\"\",\"hierarchy1Ind\":\"Y\",\"hierarchy2Ind\":\"Y\",\"hierarchy3Ind\":\"Y\",\"hierarchy4Ind\":\"N\",\"hierarchy5Ind\":\"N\",\"hierarchy6Ind\":\"N\",\"hierarchy7Ind\":\"N\",\"hierarchy8Ind\":\"N\",\"hierarchy9Ind\":\"N\",\"hierarchy10Ind\":\"N\",\"hierarchy11Ind\":\"N\",\"hierarchy12Ind\":\"N\",\"displayMode1\":\"CD\",\"displayMode2\":\"CD\",\"displayMode3\":\"CD\",\"displayMode4\":\"CD\",\"displayMode5\":\"CD\",\"displayMode6\":\"CD\",\"displayMode7\":\"CD\",\"displayMode8\":\"CD\",\"displayMode9\":\"CD\",\"displayMode10\":\"CD\",\"displayMode11\":\"CD\",\"displayMode12\":\"CD\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 2,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/organisation/settings\"\n }\n ]\n}\n"}],"_postman_id":"2ea8dbdf-02a1-4a45-8740-0fb1aa891921"}],"id":"9d318ee5-f92f-4fc8-af4b-9ba0c31db47d","description":"This web service returns the \"metadata\" / \"settings\" for a structure, describing how the structure is defined. This service does not return the actual data (see /organisation/data).
\n","event":[{"listen":"prerequest","script":{"id":"2072290e-ca55-4819-bf1f-6da3a31c10ba","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9672aba4-5817-4ffb-9cce-5e92366c33fb","type":"text/javascript","exec":[""]}}],"_postman_id":"9d318ee5-f92f-4fc8-af4b-9ba0c31db47d"},{"name":"nodes","item":[{"name":"/organisation/structure/nodes/:structureCode?","id":"67eb713a-49ad-4e89-929a-7d74c73f264e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/organisation/structure/nodes/7000","description":"This webservice is subject to pagination,and, therefore by default only 100 rows are returned, it is possible to set the pagesize up to a maximum of 5,000 if the use case is to reduce the number of requests and attempt to obtain all rows in one request.
\nParameters
\n- \n
- structureCode \n
A structure code is required to call this web service, use the /organisation/settings web service to get a list. Typically organisations will only have a few of these structure codes configured and usually this takes place during initial project implementation.
\nExpected Type: Alpha_Numeric
\nJSON Response Body Explained
\n- \n
- ID \n
A unique identifier associated with this specfic item, each item will have a unique ID.
\n- \n
- parentID \n
The parentID associated with the unique ID, each item will have a parentID. For the 'Root' the parent ID will be set to the structure code.
\n- \n
- nodeDepth \n
Each item has a depth associated with it, i.e. this is the level an item exists within the hierarchy. Starts at 1. For example all items with a nodeDepth of 1 should map directly to the number of structures defined, typically this is only a few, and nodeDepth's 2 and 3 will also only have a few, while the many nodeDepths from 4 will most likely exist.
\n- \n
- path \n
This attribute provides an easy to see path i.e. the hierarchy for the item, this defines each of the parents all the way up to root.
\nFor example: \nA path with 10:1:1000:1016\nindicates the current item has a nodeDepth 4 with the following hierarchy struture:\n - 10 \n - 1 \n - 1000 \n - 1016\nthe root would be 10 and the current item being 1016\n- \n
- description \n
This attributes describes the current item (not the entire path). The description may include both code and description, this is dependent on the displayMode as defined in the /organisation/settings. In cases where the code is to be included, the code and description will be ':'. There is no clue in this description as to the path or nodeDepth (unless of course HR administrations have defined in the description)
\nFor example:\n\n1001 : Engineering \n\nthe code is 1001 while the description is Engineering\nThis web service returns all the node data associated with a specific structure code. The /organisation/structure/config defines the configuration and associated hierarchy / structure of levels, while the /organisation/structure/nodes web service applies the configurtion settings and returns the node data associated with same, including ID, parentID and nodeDepthLevel etc.
\n","event":[{"listen":"prerequest","script":{"id":"5fc55300-3e25-46ba-a757-c4d9dee7e324","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9b27a19a-51be-42a1-8785-d7cb0746ba4c","type":"text/javascript","exec":[""]}}],"_postman_id":"05264613-4f10-4b74-9e86-2563d24c7bf4"}],"id":"46100acb-74d5-47be-8d41-b3b2e559245d","description":"This is just a grouping for all structure related elements, currently this is grouping only includes
\n- \n
- the structure configuration information \n
- the structure node information \n
Parameters
\n- \n
- role \n
This attribute is the organisational role of the employees that are required to be returned.
\nManadatory
\nType : AlphaNumeric
\nMax Length : 12
\n- \n
- group \n
This attribute is the organisational group of the employees that are required to be returned.
\nManadatory
\nType : AlphaNumeric
\nMax Length : 12
\n- \n
- groupItem \n
This attribute is the organisational group item of the employees that are required to be returned.
\nManadatory
\nType : AlphaNumeric
\nMax Length : 12
\nJSON Response Body Explained
\nAn array of employees (items) that match the parameters passed in
\n- \n
- personnelNumber \n
A unique reference identifier for the employee.
\n- \n
- personName \n
The name of the employee.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","organisation","person","MGRESS","USER1","PM06"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7b7cf51c-5b25-4b7f-babf-62d28f344385","name":"RoleGroupGroupItem","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/organisation/person/MGRESS/USER1/PM06"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:37:19 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"U1TQYcXzLmuMBybM9sxQnH+pnJ45yfK9QyLZfZerGvSE8XpFYujUbMeaYutfoYGti5eB8XXY1L1Zsc/zuvTYJQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-00140369","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"personnelNumber\": \"7214000055\",\n \"personName\": \"Brian Cummins\"\n }\n ],\n \"limit\": 100,\n \"offsetby\": 0,\n \"count\": 1,\n \"hasMore\": false,\n \"links\": [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/organisation/person/MGRESS/USER1/PM06\"\n }\n ]\n}"}],"_postman_id":"981ded39-e1c9-4730-8bec-4de487f21512"},{"name":"/person/:person","id":"e28f09b9-bbe4-494a-a5fc-ef08ffb29bd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"Delete an existing org role assignment.
\nYou can filter the deltion by passing a JSON body with the following keys. None of these are mandatory and any combination can be used.
\n{
\"orgrole\": \"MGRESS\",
\"orggroup\": \"WRKGRP\",
\"orggroupitem\": \"DC01\",
\"structurecode\": \"7204\"
}
The dynamic path variable :person is the
\npersonnelNumber key returned in the /organisation//person/:role/:group/:groupItem
endpoint.
\n- \n
- This endpoint is protected using oAuth2, it requires a valid Bearer Token to be sent in the Authorization header. Please refer to the Authorization guidelines outlined in the introduction. \n
This web service returns all employees that match a given organisational role, group and group item.
\ne.g. Organisational role 'MGRESS' for organisational group 'DEPT' and organisational group item '1' will return all employees with the MGRESS role for department 1.
\n","_postman_id":"ff6708f3-c143-46be-885d-69b78b163c14"}],"id":"70e965d2-544c-45fa-9b44-9fede8ea9755","description":"An organisation will set up an organisational structure within PeopleXD . This service will return an organisational structure.
\nFor Example:
\n- Company \n - Management Unit \n - Department \n - Cost Centre\n\nAs part of the organisational setup, an important concept exists Structure v's Hierarchy. A hierarchy is considered a subset of the previous level. For example from the above example, lets assume all are part of the hierarchy, this would mean:
\nFor a company, the available management units are mapped to a company, selecting a company means a specfic list of management units a valid to be selected, and selecting a management unit drives the departments that can be selected, once a department is selected only specific cost centres can then be selected. In other words the entire strucutre has a hierarchy link. PeopleXD can support up to 12 levels of structure / hierarchy, the number of levels used is set by your HR administration colleagues.
\nThis hierearchy is completely configurable. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured PeopleXD .
\n","event":[{"listen":"prerequest","script":{"id":"4136e557-f7e4-4fca-a60b-872be11fec05","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"484e4757-042c-449e-98dd-084cde73e401","type":"text/javascript","exec":[""]}}],"_postman_id":"70e965d2-544c-45fa-9b44-9fede8ea9755"},{"name":"HESA","item":[{"name":"staffid","item":[{"name":"/hesa/staffid/:personnelNo","id":"b8d893d7-3c66-4018-bb40-f26107b6d032","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/hesa/staffid/9913681","description":"The specific end point will return an employee's HESA assigned staff ID. This staff ID is derived based on an algorithm that includes personnel number, year joined, institute ID an a check digit.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
staffid
\nA unique reference identifier for the appointment, this is a system generated identifier.
\n \n
The specific end point will return an employee's HESA assigned staff ID. This staff ID is derived based on an algorithm that includes personnel number, year joined, institute ID an a check digit.
\n","event":[{"listen":"prerequest","script":{"id":"fd286e96-50ba-42e5-a98c-6fe611b82785","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4f765f63-1e58-471a-b73a-fcd2eb719384","type":"text/javascript","exec":[""]}}],"_postman_id":"1a3490cb-9ca7-42f2-8b7f-1d44e1df9d73"}],"id":"6ae30042-a981-431d-9f7f-3efcd530187f","description":"HESA relates only to the higher education (HE) in the UK.
\n","event":[{"listen":"prerequest","script":{"id":"444cf1fa-ae42-4a27-9534-4d7f0e27a66c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c83311f2-c6bc-459a-bbcf-874f03919208","type":"text/javascript","exec":[""]}}],"_postman_id":"6ae30042-a981-431d-9f7f-3efcd530187f"},{"name":"Training","item":[{"name":"Person","item":[{"name":"/Training/Person","id":"e2644e7c-a981-4d15-b9bf-69dc85d70a33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/training/person?personnelNo=7304000005","description":"This service provides the ability to obtain a list of employee training records.\nThis list of can be filtered by certain parameters e.g. Employee No, Course Code, Training Status, Start Date or End Date.
\nThe optional parameters are below, but at least 1 filter parameter must be used.
\n- \n
personnelNo.
\n- \n
- Max length 10. \n
- Must be a valid person number. \n
\ncourseCode.
\n- \n
- Max length 8. \n
- Must be a valid course code as set up in XD Training \n
\ntrainingStatus.
\n- \n
- Max length 4. \n
- Must be a valid training status code as set up in XD Training \n
\nstartdate.
\n- \n
- Must be in valid date format \n
\nendDate.
\n- \n
- Must be in valid date format \n
\n
- \n
The JSON Response
\n- \n
- trainingID
- \n
- String. Unique identifier for the training record \n
\n - person
- \n
- String. Personnel No \n
\n - personName
- \n
- String. Employees Name \n
\n - courseCode
- \n
- String. Code for the course \n
\n - courseName
- \n
- String. Descriptive title for the course code \n
\n - courseID
- \n
- String. Unique identifier for the course scheduled instance \n
\n - trainingStatusCode
- \n
- String. Code for the training status \n
\n - trainingStatus
- \n
- String. Descriptive title for the training status \n
\n - repeatInterval
- \n
- String. Repeat Interval for the course code \n
\n - startDate
- \n
- String. Format dd/mm/yy. Course Start Date \n
\n - endDate
- \n
- String. Format dd/mm/yy. Course End Date \n
\n - repeatTrainingInd
- \n
- String. Indicator to specify this is a repeat course \n
\n - courseStatus
- \n
- String. The status of the course eg Open/Closed/Cancelled \n
\n
\n- trainingID
This service provides the ability to create a training record for an employee\nIt will create a training log record for the person/course passed in
\nIf a scheduled course instance for the course code/start date/end date combination passed in \ndoes not exist a Training ID will be generated and a scheduled instance created
\nThe required input parameters are below:-
\n- \n
personnelNo.
\n- \n
- Max length 10. \n
- Must be a valid person number. \n
\ncourseCode.
\n- \n
- Max length 8. \n
- Must be a valid course code as set up in XD Training \n
\nstartdate.
\n- \n
- Must be in valid date format \n
\nendDate.
\n- \n
- Must be in valid date format \n
\n
The optional parameters are below:-
\n- \n
- trainingStatus.
- \n
- Max Length 4 \n
- Must be in valid training status Code \n
\n
Response Object
\nA response objects is always provided and within success will either be true. In which case as ws_id (unique web service identifier that allows us to refer back to this record).
Alternatively, the success value can be false if this is the cause an errorCode and errorMessage are provided. Additional error details - if the error pertains to a specific value in the body - is provided in the validationError object. This will contain one or more JSON objects relating to each specific error. The param_name will contain the field the validation error relates to the field_name is the label of the field used in CoreHR and the message will contain a detailed explanation of what validation is failing.
Error Codes
\nConvention is HTTP Status Code / Verbose Code. These are shared by all these Training Person endpoints and explained in the Error Codes section at the start of the Training documentation.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","training","person"],"host":["{{url}}"],"query":[{"key":"PersonnelNo","value":"7304000005"},{"key":"courseCode","value":"MICRO"},{"key":"startDate","value":"01-JUN-2021"},{"key":"endDate","value":"2-JUN-2021"}],"variable":[]}},"response":[{"id":"b43036a4-e9a8-483a-9856-a5dd11f5fbdc","name":"Create New Training Record","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{url}}/ws/{{tenant}}/{{schema}}/v1/training/person?PersonnelNo=7304000005&courseCode=MICRO&startDate=01-JUN-2021&endDate=2-JUN-2021","host":["{{url}}"],"path":["ws","{{tenant}}","{{schema}}","v1","training","person"],"query":[{"key":"PersonnelNo","value":"7304000005"},{"key":"courseCode","value":"MICRO"},{"key":"startDate","value":"01-JUN-2021"},{"key":"endDate","value":"2-JUN-2021"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Tue, 06 Jul 2021 14:00:35 GMT"},{"key":"Server","value":"Apache"},{"key":"X-ORACLE-DMS-ECID","value":"7d4b169c-0027-4159-9c48-be61a5417e5d-00659f69"},{"key":"X-ORACLE-DMS-RID","value":"0"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'none'; frame-ancestors 'self' https://*.corehr.com https://*.xd.accessacloud.com; img-src 'self'; style-src 'self';"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=631138519; includeSubDomains"},{"key":"Cache-Control","value":"max-age=0, no-cache, no-store"},{"key":"Access-Control-Max-Age","value":"600"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PATCH, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-CSRF, X-REQUESTED-WITH, CONTENT-TYPE, X-COREHR-PROXY-AS, X-COREHR-DEBUG, AUTHORIZATION, X-COREHR-INTEGRITY, CACHE-CONTROL, X-COREHR-FILE-NAME, X-COREHR-WARNINGS"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"![](\"/resources/i/logo.svg\"){kind=logo}
401 - Unauthorized
"}],"_postman_id":"fa03c494-c561-4771-8480-a475d9daef2d"},{"name":"/Training/Person","id":"57238904-d04f-4bbb-85fe-a687b1865b1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/training/person?PersonnelNo=7304000005&courseCode=MICRO&startDate=01-JUN-2021&endDate=2-JUN-2021","description":"This service provides the ability to update a training record for an employee,\nie update a training request to be a completed training record\nIt will update the training log record for the person/course/dates passed in
\nIf a scheduled course instance for the course code/start date/end date combination passed in \ndoes not exist, a Training ID will be generated and a scheduled instance created
\nThe required input parameters are below:-
\n- \n
personnelNo.
\n- \n
- Max length 10. \n
- Must be a valid person number. \n
\ncourseCode.
\n- \n
- Max length 8. \n
- Must be a valid course code as set up in XD Training \n
\nstartdate.
\n- \n
- Must be in valid date format \n
\nendDate.
\n- \n
- Must be in valid date format \n
\n
The optional parameters are below:-
\n- \n
- trainingStatus.
- \n
- Max length 4. \n
- Must be a valid training status code as set up in XD Training \n
\n
Response Object
\nA response objects is always provided and within success will either be true. In which case as ws_id (unique web service identifier that allows us to refer back to this record).
Alternatively, the success value can be false if this is the cause an errorCode and errorMessage are provided. Additional error details - if the error pertains to a specific value in the body - is provided in the validationError object. This will contain one or more JSON objects relating to each specific error. The param_name will contain the field the validation error relates to the field_name is the label of the field used in CoreHR and the message will contain a detailed explanation of what validation is failing.
Error Codes
\nConvention is HTTP Status Code / Verbose Code. These are shared by all these Training Person endpoints and explained in the Error Codes section at the start of the Training documentation.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","training","person"],"host":["{{url}}"],"query":[{"key":"PersonnelNo","value":"7304000005"},{"key":"courseCode","value":"MICRO"},{"key":"startDate","value":"01-JUN-2021"},{"key":"endDate","value":"2-JUN-2021"}],"variable":[]}},"response":[{"id":"ab927a47-ada1-4b87-bd8c-7d8798738bca","name":"Update Training Record","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"{{url}}/ws/{{tenant}}/{{schema}}/v1/training/person?PersonnelNo=7304000005&courseCode=MICRO&startDate=01-JUN-2021&endDate=2-JUN-2021","host":["{{url}}"],"path":["ws","{{tenant}}","{{schema}}","v1","training","person"],"query":[{"key":"PersonnelNo","value":"7304000005"},{"key":"courseCode","value":"MICRO"},{"key":"startDate","value":"01-JUN-2021"},{"key":"endDate","value":"2-JUN-2021"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Tue, 06 Jul 2021 14:00:35 GMT"},{"key":"Server","value":"Apache"},{"key":"X-ORACLE-DMS-ECID","value":"7d4b169c-0027-4159-9c48-be61a5417e5d-00659f69"},{"key":"X-ORACLE-DMS-RID","value":"0"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'none'; frame-ancestors 'self' https://*.corehr.com https://*.xd.accessacloud.com; img-src 'self'; style-src 'self';"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=631138519; includeSubDomains"},{"key":"Cache-Control","value":"max-age=0, no-cache, no-store"},{"key":"Access-Control-Max-Age","value":"600"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PATCH, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-CSRF, X-REQUESTED-WITH, CONTENT-TYPE, X-COREHR-PROXY-AS, X-COREHR-DEBUG, AUTHORIZATION, X-COREHR-INTEGRITY, CACHE-CONTROL, X-COREHR-FILE-NAME, X-COREHR-WARNINGS"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":" 401 - Unauthorized
"}],"_postman_id":"57238904-d04f-4bbb-85fe-a687b1865b1d"}],"id":"68200f60-f040-46f4-b21d-077a8e7549a6","_postman_id":"68200f60-f040-46f4-b21d-077a8e7549a6","description":""}],"id":"bd9930c7-21f3-43de-b4bd-7eadd44f5790","description":"The Training Module is a suite of web services that will allow you to
\nGet of list of employee training courses\nLoad completed training records into the system\nRemove pending/outstanding training requests that may exist for an employee/course \nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Invalid personnel no. \n
- 404 / 002 Invalid course code. \n
- 404 / 003 Invalid training status. \n
- 404 / 004 Course profile is inactive. \n
- 404 / 006 Training status cannot be an initial status. \n
- 404 / 007 Training start date cannot be after training end date. \n
- 400 / 008 Training ID does not exist \n
- 404 / 009 At least 1 filter parameter must be selected. \n
This Web Service provides a means of reporting the data that has been sent to the Clocking web service and the status of that clocking data in terms of it being interfaced into CoreTime.
\nParameters
\n- \n
id
\nType : Numeric Optional
\nThe ws_id unique id of the web service clocking. When a clocking is POSTed to the /clocking/user/ web service it returns this unique ws_id relating to the data just added.
\n \nperson
\nType : Alphanumeric Optional
\nThe personnel number in CoreHR of the person for whom the web service related clockings will be retrieved for.
\n \nbadge_no
\nType : Numeric Optional
\nThe badge number in CoreHR of the person for whom web service related clockings will be retrieved for.
\n \nappointment_id
\nType : Alphanumeric Optional
\nThe appointment id in CoreHR for which web service related clockings will be retrieved.
\n \ndevice_id
\nType : Alphanumeric Optional
\nThe device ID from which the clocking originated for which web service related clockings will be retrieved.
\n \nmoved_to_coretime
\nType : Alpha Optional
\nThe status of the clocking records being queried. Options include:
\n- \n
Y- Clockings that have been successfully interfaced into CoreTime \nN- Clockings that have not yet been interfaced into CoreTime. These will be actioned the next time the Clocking Interface to CoreTime is invoked. \nE- Clockings that have been attempted to be interfaced into CoreTime but have not been successfully inserted into coretime. Further details of the Error are included in the errMsg results returned. \n
\nstart_date_range
\nType : Date Optional
\nThe start of the date range from which Web Service Clocking will be retrieved. Required to use the standard ISO 8601 / CoreHR Standard YYYY-MM-DD format.
\n \nend_date_range
\nType : Date Optional
\nThe end of the date range from which Web Service Clocking will be retrieved. Required to use the standard ISO 8601 / CoreHR Sandard YYYY-MM-DD format.
\n \nThe JSON Response
\n- \n
WSID
\n- \n
- The unique id of the web service clocking record. \n
\nPERSON
\n- \n
- The CoreHR personnel number of the person the clocking record is for. Note that this will be automatically populated based on the badge number of the record if that was used to insert the clocking - provided that the badge number is associated with a valid CoreHR employee. \n
\nAPPOINTMENTID
\n- \n
- The Appointment ID of the clocking being queried. Only populated on sites where CoreTime is configured to run as multi-appointment. \n
\nBADGENO
\n- \n
- The CoreTime Badge Number of the clocking record. Only populated where the clocking was inserted using a badge number. \n
\nCLOCKDATETIME
\n- \n
- The Clock Date Time in the standard
YYYY-MM-DD HH24:MI TZH:TZMformat. This is the format the clocking record came in as. e.g.2018-09-04 00:16 +01:00\n Note that CoreHR will convert the data into the server system time before interfacing to CoreTime. \n
\n- The Clock Date Time in the standard
INSERTDATETIME
\n- \n
- The date (without time) that the clocking record was inserted. \n
\nRECORDTYPE
\n- \n
- The transactional event type that the clocking record is. \n
\nFUNCTIONCODE
\n- \n
- The optional function code related to the clocking record. \n
\nFUNCTIONVALUE
\n- \n
- The function value related to the function code above. e.g. if the FUNCTIONCODE was
COSTand the FUNCTIONVALUE was1then the clocking would relate to Cost Centre 1. \n
\n- The function value related to the function code above. e.g. if the FUNCTIONCODE was
DEVICEID
\n- \n
- Text field to report on the device that the clocking originated from. \n
\nCLOCKDATESYSTEMTZ
\n- \n
- The Clock Date converted to the System Time Zone for the clocking record. e.g. a clocking for
2018-09-20 00:46 +02:00would be2018-09-19when converted to system date presuming server resides in +01:00 time zone (i.e UTC+1 for daylight savings). \n
\n- The Clock Date converted to the System Time Zone for the clocking record. e.g. a clocking for
CLOCKTIMESYSTEMTZ
\n- \n
- The Clock time converted to the System Time Zone for the clocking record. e.g. a clocking for
2018-09-20 00:46 +02:00would be23:46when converted to system date presuming server resides in +01:00 time zone (i.e UTC+1 for daylight savings). \n
\n- The Clock time converted to the System Time Zone for the clocking record. e.g. a clocking for
CORETIMECLOCKDATE
\n- \n
- The CoreTime Date. This is because CoreTime may need to perform some adjustments to the clocking once it is inserted into CoreTime based on the pattern the person is working and if it relates to an overnight. \n
\nCORETIMECLOCKTIME
\n- \n
- The CoreTime Time. This is because CoreTime may need to perform some adjustments to the clocking once it is inserted into CoreTime based on the pattern the person is working and if it relates to an overnight. \n
\nCORETIMEACTUALCLOCKDATE
\n- \n
- The CoreTime actual date of clocking for reporting purposes. \n
\nMOVEDTOCORETIME
\n- \n
- Indicates what the status of this clocking record is in terms of its having been transferred to CoreTime. Options are:\n
Ywhere the record has been successfully transferred into CoreTime.\nNwhere the record has not yet been attempted to be transferred into CoreTime.\nEwhere an attempt was made to move the record into CoreTime but an error occurred when doing so. \n
\n- Indicates what the status of this clocking record is in terms of its having been transferred to CoreTime. Options are:\n
ERRIND
\n- \n
- Indicates if an error occurred when transferring the clocking for the web service into CoreTime. Can be either
YorN. \n
\n- Indicates if an error occurred when transferring the clocking for the web service into CoreTime. Can be either
ERRLOGID
\n- \n
- The unique id of the error record on the system. Only ever populated when there was an error transferring the clocking to CoreTime. i.e. only populated when ERRIND above is
Y. \n
\n- The unique id of the error record on the system. Only ever populated when there was an error transferring the clocking to CoreTime. i.e. only populated when ERRIND above is
ERRMSG
\n- \n
- A message explaining the error that occurred when transferring the record into CoreTime. \n
\n
\n
Create a clocking record in the clocking module for subsequent transfer into CoreTime. On successful completion, users will have submitted a new clocking record which subject to subsequent CoreTime validation will be transferred into CoreTime the next time the interface runs.
\nJSON Request Body Explained
\nperson
\nIs an CoreHR employee id also known as personnel number although it is alphanumeric.
badge_no
\nIs the badge number that the CoreHR employee uses. Badge must be valid and linked to a valid CoreHR employee for the clocking to interface into CoreTime.
\nclock_date_time
\nThe Date and Time that this particular clocking is for. Required to be in YYYY-MM-DD HH24:MI TZH:TZM format. Mandatory.
\nrecord_type
\nThe Transactional event associated with the clocking. Optional but if specified must be one of:
\n- \n
B0Undefined. \nB1In. \nB2Out. \nB3Business Absence. \n
function_code
\nOptional function code but if specified must be one of:
\n- \n
CALLIN\nUNSBRK\nSTD\nTNAIN\nCALLOT\nTNAOUT\nOVERTM\nCOST\n
function_value
\nOptional function_value relating to the above code. When using the function_code COST then the Cost Centre provided in the function_value is validated against the CoreHR Cost Centres.
device_id
\nOptional free text to describe the Device ID where the clocking was recorded e.g. Main Entrance Device.
\nappointment_id
\nCoreHR Appointment ID of person clocking in. Note: if using this field then person must also be used. i.e. this field cannot be used in conjunction with the badge_no field. Also note: this cannot be used at all if the CoreTime site is not Multi-Appointment. If the site is Multi-Appointment then the field is optional unless the ClockingWebservices Appointment Mandatory for Clockings option in the CoreTime Global Parameters screen is selected.
Mandatory
\n- \n
- Either
personorbadge_no\n clock_date_time\nappointment_idfor Multi-Appointment sites where the Webservices Appointment Mandatory for Clockings option in the CoreTime Global Parameters screen is selected. \n
The clocking module provides ability to insert Core Time clocking records for a CoreHR employee.
\nConstraints, Limitations, Mandatory and Validation
\nThe clocking module is designed to handle clockings for CoreTime. Clocking by person or badge_no is possible. It is also as of Version 27 possible to perform clocking by appointment for CoreTime Multi-Appointment sites. When using clock by appointment both the appointment_id and the person must be provided. i.e. badge_no cannot be used together with appointment_id. Appointments for the clocking web service can only be used as long as CoreTime is configured in Multi-Appointment mode (ct_global_param.multi_appointment). Provided CoreTime is running as a Mutli- Appointment site it is possible to make appointments mandatory for the clocking web service using the Appointment Mandatory For Clockings option (ct_global_param.ws_clocking_appt_mandatory) in the CoreTime Global Params screen.
In Version 27 (V27) of CoreHR the Clocking webservice completes the following validation:
\n- \n
- Person is a valid CoreHR employee. \n
- Badge is a valid CoreHR Badge for a valid CoreHR employee. If both badge and person are populated badge take precedence. \n
- Record Type is valid. \n
- Function Code is valid. When using COST then it validates that the Function Value is a valid Cost Centre. \n
- Appointment ID is valid on the specified clocking date - if the site is Multi-Appointment based. Also validates that the field is populated if it is mandatory. \n
- Duplicate Clocking - defined as where a clocking already exists in CoreTime for this person at the same date/time. Clockings are converted to system time for this comparison i.e. 09:00 +00:00 is the same as 08:00 +01:00.\nPrior to V27 much of the above validation was performed later at the point of interface into CoreTime. \n
Fields are as in the table below:
\nNote: Clock Date Time is mandatory and either Person or Badge No must also be provided.
\nNote2: Appointment ID is an optional parameter for use if the site is configured as CoreTime Multi-Appointment. This can be made mandatory by also activating the Appointment Mandatory for Clockings option in CoreTime.
\nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Both badge and person fields are not populated. One must be populated. \n
- 400 / 002 clock_date_time field is not populated. \n
- 400 / 003 clock_date_time field is not in the correct format. \n
- 404 / 004 Non standard database exception inserting this clocking. \n
- 404 / 005 record_type is invalid. Must be either empty, B0, B1, B2 or B3. \n
- 400 / 006 function_code is invalid. Must be either empty, CALLIN, UNSBRK, STD, TNAIN, CALLOT, TNAOUT, OVERTM or COST. \n
- 400 / 007 CoreTime is not configured to run using appoinments but an appointment has been provided as part of this request. \n
- 400 / 008 badge_no and appointment_id cannot be used together. If you want to clock by appointment, then only personnel_no and appointment_id must be provided but badge_no must be blank. \n
- 400 / 009 appointment_id is configured to be a required field but none has been provided. \n
- 400 / 010 The appointment_id provided for this person is not valid - check that the appointment id is valid on the system and that it is valid on the clocking date provided. \n
- 400 / 011 The badge_no provided is not a valid badge on the system. \n
- 400 / 012 The person provided is not a valid person on the system. \n
- 400 / 013 The Cost Centre provided in the function_value for is not a valid Cost Centre on the system. \n
- 400 / 014 This is a duplicate Clocking. Clocking with this detail has already been interfaced to Core Time. \n
- 400 / 015 Clocking with this detail is already in the queue to be interfaced to Core Time. \n
- 400 / 016 When specifying a date range to use the start date range must be before the end date range. \n
- 400 / 017 When using the id parameter only numeric values are valid. \n
- 400 / 999 Basic sanitization error. Where a filed is not the correct data type or length or the data is deemed to be unsafe for recording within the system. Details of the fields failing sanitization are returned in the sanatizeError object in the Response. \n
Get a list of registered / whitelisted contacts. Tenant has an ability to define contacts available for creating / updating. A tenant may not allow all contacts to be updated or created, this base URI provides the list of valid contact types. In cases where server returns validation errors, refer to this list.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0ab66224-fead-4f47-87d9-a4983e268e5a","name":"200 - Response OK","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:00:52 GMT","name":"Date","description":""},{"key":"ETag","value":"\"uwlnRwLu1teq90JMcLw3B68+EOyVApqwZ0O87dUiP4G6rHtTNS14dRJz0YaKyE8k7RmWTnrUodwqt3OwuAMICA==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"EMAIL\", \"length\": 80, \"dataType\" : \"EMAIL\"}\n,\n{\"type\":\"MOBILE\", \"length\": 20, \"dataType\" : \"MOB\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 2,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/contact/\"\n }\n ]\n}\n"}],"_postman_id":"9a40d5ac-20aa-46de-8e99-34eef5b7490c"},{"name":"/contact/:type/","id":"8ada6255-60af-4c7b-b45d-a27795ae25ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/EMAIL/","description":"Get a list of all users for a particular contact type. Typically used to get a list of all users email addresses.
This service will only return whitelisted contact types. A tenant may decide to only whitelist a subset of all contacts e.g. EMAIL is whitelisted while MOBILE is not. Only accounts where the contact type is populated are returned. To find accounts with missing contact information use the web service /contact/missing/:type
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","EMAIL",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"1c0aadb9-b91b-4808-9645-435773f7230f","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/EMAIL/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 15 Nov 2016 19:46:57 GMT","name":"Date","description":""},{"key":"ETag","value":"\"6iQZlpyFhjCcA3IiwUAR9L8mLF0w4tdo6M6kmFN3AV+v32sX/fFbqqgk/bMg7pMmUv2y1+9/cnGbLcj57836dw==-gzip\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"coreHRId\":\"003676\", \"value\": \"webservices003676@corehr.com\"}\n,\n{\"coreHRId\":\"003674\", \"value\": \"webservices003674@corehr.com\"}\n,\n{\"coreHRId\":\"003332\", \"value\": \"webservices003332@corehr.com\"}\n,\n{\"coreHRId\":\"003333\", \"value\": \"webservices003333@corehr.com\"}\n,\n{\"coreHRId\":\"INT009\", \"value\": \"webservicesINT009@corehr.com\"}\n,\n{\"coreHRId\":\"INT010\", \"value\": \"webservicesINT010@corehr.com\"}\n,\n{\"coreHRId\":\"600100\", \"value\": \"webservices600100@corehr.com\"}\n,\n{\"coreHRId\":\"600101\", \"value\": \"webservices600101@corehr.com\"}\n,\n{\"coreHRId\":\"600102\", \"value\": \"webservices600102@corehr.com\"}\n,\n{\"coreHRId\":\"7777\", \"value\": \"webservices7777@corehr.com\"}\n,\n{\"coreHRId\":\"C876876\", \"value\": \"webservicesC876876@corehr.com\"}\n,\n{\"coreHRId\":\"003193\", \"value\": \"webservices003193@corehr.com\"}\n,\n{\"coreHRId\":\"003528\", \"value\": \"webservices003528@corehr.com\"}\n,\n{\"coreHRId\":\"gh1234\", \"value\": \"webservicesgh1234@corehr.com\"}\n,\n{\"coreHRId\":\"JG1234\", \"value\": \"webservicesJG1234@corehr.com\"}\n,\n{\"coreHRId\":\"002145\", \"value\": \"webservices002145@corehr.com\"}\n,\n{\"coreHRId\":\"002144\", \"value\": \"webservices002144@corehr.com\"}\n,\n{\"coreHRId\":\"002146\", \"value\": \"webservices002146@corehr.com\"}\n,\n{\"coreHRId\":\"000660\", \"value\": \"webservices000660@corehr.com\"}\n,\n{\"coreHRId\":\"002626\", \"value\": \"webservices002626@corehr.com\"}\n,\n{\"coreHRId\":\"000740\", \"value\": \"webservices000740@corehr.com\"}\n,\n{\"coreHRId\":\"000936\", \"value\": \"webservices000936@corehr.com\"}\n,\n{\"coreHRId\":\"000830\", \"value\": \"webservices000830@corehr.com\"}\n,\n{\"coreHRId\":\"000831\", \"value\": \"webservices000831@corehr.com\"}\n,\n{\"coreHRId\":\"000880\", \"value\": \"webservices000880@corehr.com\"}\n,\n{\"coreHRId\":\"1000491\", \"value\": \"webservices1000491@corehr.com\"}\n,\n{\"coreHRId\":\"000014\", \"value\": \"webservices000014@corehr.com\"}\n,\n{\"coreHRId\":\"000115\", \"value\": \"webservices000115@corehr.com\"}\n,\n{\"coreHRId\":\"000012\", \"value\": \"webservices000012@corehr.com\"}\n,\n{\"coreHRId\":\"000015\", \"value\": \"webservices000015@corehr.com\"}\n,\n{\"coreHRId\":\"000296\", \"value\": \"webservices000296@corehr.com\"}\n,\n{\"coreHRId\":\"000297\", \"value\": \"webservices000297@corehr.com\"}\n,\n{\"coreHRId\":\"000328\", \"value\": \"webservices000328@corehr.com\"}\n,\n{\"coreHRId\":\"000590\", \"value\": \"webservices000590@corehr.com\"}\n,\n{\"coreHRId\":\"000227\", \"value\": \"webservices000227@corehr.com\"}\n,\n{\"coreHRId\":\"001873\", \"value\": \"webservices001873@corehr.com\"}\n,\n{\"coreHRId\":\"000275\", \"value\": \"webservices000275@corehr.com\"}\n,\n{\"coreHRId\":\"CUT-001\", \"value\": \"webservicesCUT-001@corehr.com\"}\n,\n{\"coreHRId\":\"END-001\", \"value\": \"webservicesEND-001@corehr.com\"}\n,\n{\"coreHRId\":\"000286\", \"value\": \"webservices000286@corehr.com\"}\n,\n{\"coreHRId\":\"001987\", \"value\": \"webservices001987@corehr.com\"}\n,\n{\"coreHRId\":\"000180\", \"value\": \"webservices000180@corehr.com\"}\n,\n{\"coreHRId\":\"001993\", \"value\": \"webservices001993@corehr.com\"}\n,\n{\"coreHRId\":\"000598\", \"value\": \"webservices000598@corehr.com\"}\n,\n{\"coreHRId\":\"000601\", \"value\": \"webservices000601@corehr.com\"}\n,\n{\"coreHRId\":\"002037\", \"value\": \"webservices002037@corehr.com\"}\n,\n{\"coreHRId\":\"GH992\", \"value\": \"webservicesGH992@corehr.com\"}\n,\n{\"coreHRId\":\"000119\", \"value\": \"webservices000119@corehr.com\"}\n,\n{\"coreHRId\":\"000124\", \"value\": \"webservices000124@corehr.com\"}\n,\n{\"coreHRId\":\"000587\", \"value\": \"webservices000587@corehr.com\"}\n,\n{\"coreHRId\":\"000588\", \"value\": \"webservices000588@corehr.com\"}\n,\n{\"coreHRId\":\"000592\", \"value\": \"webservices000592@corehr.com\"}\n,\n{\"coreHRId\":\"000594\", \"value\": \"webservices000594@corehr.com\"}\n,\n{\"coreHRId\":\"002315\", \"value\": \"webservices002315@corehr.com\"}\n,\n{\"coreHRId\":\"000904\", \"value\": \"webservices000904@corehr.com\"}\n,\n{\"coreHRId\":\"002261\", \"value\": \"webservices002261@corehr.com\"}\n,\n{\"coreHRId\":\"002262\", \"value\": \"webservices002262@corehr.com\"}\n,\n{\"coreHRId\":\"CUT-012\", \"value\": \"webservicesCUT-012@corehr.com\"}\n,\n{\"coreHRId\":\"002248\", \"value\": \"webservices002248@corehr.com\"}\n,\n{\"coreHRId\":\"002249\", \"value\": \"webservices002249@corehr.com\"}\n,\n{\"coreHRId\":\"002250\", \"value\": \"webservices002250@corehr.com\"}\n,\n{\"coreHRId\":\"002367\", \"value\": \"webservices002367@corehr.com\"}\n,\n{\"coreHRId\":\"002368\", \"value\": \"webservices002368@corehr.com\"}\n,\n{\"coreHRId\":\"002369\", \"value\": \"webservices002369@corehr.com\"}\n,\n{\"coreHRId\":\"000826\", \"value\": \"webservices000826@corehr.com\"}\n,\n{\"coreHRId\":\"000897\", \"value\": \"webservices000897@corehr.com\"}\n,\n{\"coreHRId\":\"001128\", \"value\": \"webservices001128@corehr.com\"}\n,\n{\"coreHRId\":\"002629\", \"value\": \"webservices002629@corehr.com\"}\n,\n{\"coreHRId\":\"002697\", \"value\": \"webservices002697@corehr.com\"}\n,\n{\"coreHRId\":\"000934\", \"value\": \"webservices000934@corehr.com\"}\n,\n{\"coreHRId\":\"002624\", \"value\": \"webservices002624@corehr.com\"}\n,\n{\"coreHRId\":\"000290\", \"value\": \"webservices000290@corehr.com\"}\n,\n{\"coreHRId\":\"000837\", \"value\": \"webservices000837@corehr.com\"}\n,\n{\"coreHRId\":\"002444\", \"value\": \"webservices002444@corehr.com\"}\n,\n{\"coreHRId\":\"002685\", \"value\": \"webservices002685@corehr.com\"}\n,\n{\"coreHRId\":\"002227\", \"value\": \"webservices002227@corehr.com\"}\n,\n{\"coreHRId\":\"002169\", \"value\": \"webservices002169@corehr.com\"}\n,\n{\"coreHRId\":\"000849\", \"value\": \"webservices000849@corehr.com\"}\n,\n{\"coreHRId\":\"000808\", \"value\": \"webservices000808@corehr.com\"}\n,\n{\"coreHRId\":\"002091\", \"value\": \"webservices002091@corehr.com\"}\n,\n{\"coreHRId\":\"1010101010\", \"value\": \"webservices1010101010@corehr.com\"}\n,\n{\"coreHRId\":\"20202020\", \"value\": \"webservices20202020@corehr.com\"}\n,\n{\"coreHRId\":\"GM967\", \"value\": \"webservicesGM967@corehr.com\"}\n,\n{\"coreHRId\":\"GM969\", \"value\": \"webservicesGM969@corehr.com\"}\n,\n{\"coreHRId\":\"DB678\", \"value\": \"webservicesDB678@corehr.com\"}\n,\n{\"coreHRId\":\"002651\", \"value\": \"webservices002651@corehr.com\"}\n,\n{\"coreHRId\":\"gh23\", \"value\": \"webservicesgh23@corehr.com\"}\n,\n{\"coreHRId\":\"6633228\", \"value\": \"webservices6633228@corehr.com\"}\n,\n{\"coreHRId\":\"250\", \"value\": \"webservices250@corehr.com\"}\n,\n{\"coreHRId\":\"260\", \"value\": \"webservices260@corehr.com\"}\n,\n{\"coreHRId\":\"002705\", \"value\": \"webservices002705@corehr.com\"}\n,\n{\"coreHRId\":\"002103\", \"value\": \"webservices002103@corehr.com\"}\n,\n{\"coreHRId\":\"000950\", \"value\": \"webservices000950@corehr.com\"}\n,\n{\"coreHRId\":\"002756\", \"value\": \"webservices002756@corehr.com\"}\n,\n{\"coreHRId\":\"002652\", \"value\": \"webservices002652@corehr.com\"}\n,\n{\"coreHRId\":\"jg1234\", \"value\": \"webservicesjg1234@corehr.com\"}\n,\n{\"coreHRId\":\"DF5609\", \"value\": \"webservicesDF5609@corehr.com\"}\n,\n{\"coreHRId\":\"002289\", \"value\": \"webservices002289@corehr.com\"}\n,\n{\"coreHRId\":\"002727\", \"value\": \"webservices002727@corehr.com\"}\n,\n{\"coreHRId\":\"000179\", \"value\": \"webservices000179@corehr.com\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 100,\"hasMore\":true\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://localhost/ws/tenant/corehr/v1/contact/EMAIL/\"\n },\n {\n \"rel\": \"next\",\n \"href\": \"https://localhost/ws/tenant/corehr/v1/contact/EMAIL/?offsetby=100\"\n }\n ]\n}\n"},{"id":"f59f3a9c-afd1-4aa1-8f8f-69af8b986678","name":"404 - Invalid Contact type","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/MOB/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 15 Nov 2016 19:51:28 GMT","name":"Date","description":""},{"key":"ETag","value":"\"WIZPZbpKwxRRgssW8lwH34floeFnPJzhb0Pc1fxiiWRv2Gqy41LgVu19up1qzvTBBMK6i635jWpyDaAsi5TVnQ==-gzip\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"002\",\"errorMessage\" :\"Validation failed. Contact type does not exist\" }}\n"}],"_postman_id":"8ada6255-60af-4c7b-b45d-a27795ae25ef"},{"name":"/contact/user/:person/","id":"2d7ea985-a640-4b19-8575-01c9c2da8c9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/","description":"This web service returns all contacts for the person.
This web service returns a specific contact for an associated person and type. Refer to /contact/ for a complete list of contacts available.
This web service provides ability to create a new contact type for a user. The contact type should not already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available.
\nThe value of the contact type must be provided in the request body as JSON e.g.
\n\n\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"02c7e516-ef5e-45d9-a93a-e829bb79f514","name":"400 - Bad Request - Error Code 006","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:41:20 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"006\",\"errorMessage\" :\"Validation failed. Existing contact for user, use PATCH to update\" }}\n"},{"id":"4f55615a-71f5-4a1c-8e23-b89dc0595f17","name":"404 - Not Found - Error Code 003","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/7788/EMAIL"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:43:31 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"003\",\"errorMessage\" :\"Validation failed. User account does not exist\" }}\n"},{"id":"6d6452aa-3e93-4d44-90e7-ae9586ef0487","name":"201 - Success - Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:40:49 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"},{"id":"bfd2b4c8-e01d-4c1b-b5a8-6365dc237e53","name":"400 - Bad Request - Error Code 001","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:42:45 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"001\",\"errorMessage\" :\"Mandatory fields are missing\" }}\n"},{"id":"fe425a37-2eb8-4075-9a88-77e2f64a8ab3","name":"400 - Bad Request - Error Code 005","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/PHONE"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:44:28 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"005\",\"errorMessage\" :\"Validation failed. Ensure contact type is allowed and has correct format\" }}\n"}],"_postman_id":"f25b9c9b-a8ea-41d5-af8e-a65eb2e59ae8"},{"name":"/contact/user/:person/:type","id":"0ec6201e-3c9d-4a2f-8eb0-0ba893625793","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"value\" :\"darragh.james.duffy@corehr.com\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL","description":"{\"value\" :\"darragh.james.duffy@corehr.com\"}
\n
This web service provides ability to patch / update a contact type for a user. The contact type must already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available.
\nThe value of the contact type must be provided in the request body as JSON e.g.
\n\n\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2eeb8337-8009-4f2b-a36f-b6f8a38e88d4","name":"400 - Bad Request - Error Code 001","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:46:55 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"001\",\"errorMessage\" :\"Mandatory fields are missing\" }}\n"},{"id":"70713828-81c3-4b18-bfd9-debf29c05bd4","name":"404 - Not Found - Error Code 002","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/Phone"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:48:16 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"002\",\"errorMessage\" :\"Validation failed. Contact does not exist\" }}\n"},{"id":"7ca023e1-6909-4cf4-aaed-eb78384ca0b9","name":"201- Success - Created","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:45:19 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"},{"id":"81140d7a-fe0f-41e2-a8ec-da0d80df8cb3","name":"404 - Not Found - Error Code 003","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/7788/EMAIL"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:47:30 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"003\",\"errorMessage\" :\"Validation failed. User account does not exist\" }}\n"}],"_postman_id":"0ec6201e-3c9d-4a2f-8eb0-0ba893625793"},{"name":"/contact/user/:person/:type","id":"35a26043-2da0-411d-ad38-9ff0cffee96a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL","description":"{\"value\" :\"darragh.james.duffy@corehr.com\"}
\n
This web service provides ability to delete a contact from a users / employees profile. The contact type should already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available. All contact types are case sensitive.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"06afa29b-9c89-4770-b594-7164c2d41807","name":"200 - Response OK","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 11 Nov 2016 14:46:13 GMT","name":"Date","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"35a26043-2da0-411d-ad38-9ff0cffee96a"},{"name":"/contact/missing/:type","id":"034c6291-3913-4a4b-8439-f9d301f0d93c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/missing/EMAIL","description":"This web service provides ability to list user accounts with missing contact types. For example find all users with a missing EMAIL contact.
This examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Contact module provides ability to interact with contact information associated with an account in CoreHR. Different contact types exist and can be defined by a tenant e.g EMAIL, MOBILE etc. Not all tenants have the same list of contacts i.e. each tenant can define a whitelist of contacts exposed to web services.
\nContraints, Limitations & Mandatory
\nThe contact module is case senstive, no process converts the contact type provided to upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned. Within CoreHR contact types are typically uppercase.
\nPerson is mandatory, person represents users unique CoreHR ID, this is often referenced as personnel number
Optionally
\nProvide the type of contact e.g. EMAIL to get users associated email address.
In cases where type is not specified all contact details are returned associated with employee.
In Summary contact provides ability to
\n- \n
- Enumerate users contact information \n
- Obtain a specific contact type \n
- Update / Patch an existing contact type \n
- Assign a new contact type to a user \n
Error Codes
\nNote type is case senstive, no process converts the type provided into upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned.
Convention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Mandatory fields are missing \n
- 404 / 002 Validation failed. Contact does not exist \n
- 404 / 003 Validation failed. User account does not exist \n
- 400 / 005 Validation failed. Ensure contact type is allowed and has correct format \n
- 400 / 006 Validation failed. Existing contact for user, use PATCH to update \n
- 404 / 007 Contact type does not exist for user, consider using POST to create \n
Note
\nWhere a contact exists within CoreHR, this does not mean an account in CoreHR has this contact assigned, e.g. not every account would have a mobile / cell number. Keep this in mind if you attempt to PATCH a contact type and server responds with a validation error.
\n","_postman_id":"83d9df80-8604-4023-a3df-2f59e946f30a"},{"name":"Image","item":[{"name":"/image/user/","id":"1558f8e2-3b6a-42ec-8b2d-3c45e4c42860","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"Bearer MZun_JVHkiiNm9SXgadz4A.."}],"url":"{{url}}/ws/{{schema}}/{{version}}/image/user/0890126","description":"This Web Service is used to retrieve (GET) the image profile for a CoreHR user on the system. Returns a binary image file.
\nExample cURL:
\n$ curl -o ./local_copy_of_profile.jpeg -k --request GET --url https://devapi.corehr.com/ws/frame/corehr/v1/image/user/0890126 \\\n --header 'authorization: Bearer MZun_JVHkiiNm9SXgadz4A..'\nThis command will save the binary image of CoreHR User 0890126 into the file local_copy_of_profile.jpeg. If alternatively the person did not have an image on the system then the web service would return an http code 404 with and verbose errorCode of 1008.
Example cURL:
\n$ curl --request POST --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/png' \\\n --header 'authorization: Bearer E63-fevVwKH-CV4E_TScUA..' \\\n --data-binary \"@./original_profile.png\" \nThe above cURL will insert the file original_profile.png as the binary image profile photo for the CoreHR User 0890126 where they do not have an profile image already configured on the system.
Web Service used to update the profile image for a CoreHR user on the system. This overwrites their current profile image with this new image. The image is provided as binary data in the body of the request.
\nExample cURL:
\n$ curl --request PATCH --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/jpeg' \\\n --header 'authorization: Bearer Fbbanqy44exS0Nat7Ep3oQ..' \\\n --data-binary \"@./new_profile.jpg\" \nThe above cURL will insert the file new_profile.jpg as the binary image profile photo for the CoreHR User 0890126 where they already have a profile image in CoreHR. This will over-write the existing profile image.
This Web Service is used to retrieve (GET) the image profile for a CoreHR user on the system. Returns a binary image file.
\nExample cURL:
\n$ curl -o ./local_copy_of_profile.jpeg -k --request GET --url https://devapi.corehr.com/ws/frame/corehr/v1/image/user/0890126 \\\n --header 'authorization: Bearer MZun_JVHkiiNm9SXgadz4A..'\nThis command will save the binary image of CoreHR User 0890126 into the file local_copy_of_profile.jpeg. If alternatively the person did not have an image on the system then the web service would return an http code 404 with and verbose errorCode of 1008.
Web Service used to update the profile image for a CoreHR user on the system. This overwrites their current profile image with this new image. The image is provided as binary data in the body of the request.
\nExample cURL:
\n$ curl --request PATCH --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/jpeg' \\\n --header 'authorization: Bearer Fbbanqy44exS0Nat7Ep3oQ..' \\\n --data-binary \"@./new_profile.jpg\" \nThe above cURL will insert the file new_profile.jpg as the binary image profile photo for the CoreHR User 0890126 where they already have a profile image in CoreHR. This will over-write the existing profile image.
This Web Service is used to insert a profile image for a CoreHR user on the system where none exists. The image is provided as binary data in the body of the request.
\nExample cURL:
\n$ curl --request POST --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/png' \\\n --header 'authorization: Bearer E63-fevVwKH-CV4E_TScUA..' \\\n --data-binary \"@./original_profile.png\" \nThe above cURL will insert the file original_profile.png as the binary image profile photo for the CoreHR User 0890126 where they do not have an profile image already configured on the system.
The image web service provides a means for uploading and viewing a CoreHR user's profile picture.
\nConstraints, Limitations, Mandatory and Validation
\nImages uploaded can be a maximum of 500KB in size and must be provided in one of the following file formats:
\n- \n
- gif \n
- png \n
- jpeg \n
- tiff \n
Error Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 415 / 1001 Invalid content type, only image/gif, image/png, image/jpeg or image/tiff allowed \n
- 415 / 1002 n image file (gif, png, jpeg or tiff) of size greater than zero must be attached to this request. \n
- 415 / 1003 There was an issue with the supplied image being recognized as a supported image (gif, png, jpeg or tiff) please save as another supported format and re-try. \n
- 415 / 1004 The attached image exceeded the maximum allowed file size for an image. \n
- 400 / 1005 The person supplied is not currently a valid person on the system. Please check the personnel details. \n
- 400 / 1006 This person does not have an image on the system to update please change this request to POST to insert the image. \n
- 400 / 1007 This person already has an image on the system to insert please change this request to PATCH to update the image. \n
- 404 / 1008 This person does not currently have an image on the system to retrieve. \n
Use this service if you want to remove UUID's. The service can facility bulk UUID removal/purge and individual employee UUID.
\nThis is useful in cases where you have a need
\n- \n
- to remove an individuals UUID e.g. as part of a leaver process. \n
- to implement a policy requiring users to re-register, this would be similar to a password policy \n
Constraints and Limitations
\n- \n
typemust be one of the following: \n
ALL
\n- \n
id\n
must now be a valid type i.e. a valid Email address. In cases where ALL is used for type, the id should be left blank.
\nIf invalid ID provided nothing is deleted, i.e. if an invalid email address provided a status of 404 is returned. For valid email address a 200 is returned, indicating a success.
\nParameters
\n- \n
typethis must be email, username, employeeNumber or all. \"ALL\" is reserved for bulk removal, this will remove all the registered UUID's, therefore use with caution \nidthis must be a valid email address \n
CoreHR's native mobile application facilitates users registering once and then using biometric (e.g. touchID, FaceID) or PIN to unlock the application i.e. the user does not require a username / password each time they login. However a user is required to unlock the app via biometric or PIN.
\nA tenant may have a requirement to implement a different policy e.g. a user must authenticate via username / password at least once a day, week or month i.e. similar to password policies. CoreHR makes no assumptions for password policies, instead tenants can implement their own policies.
\nIn order to faciliate these requirments web services can be used. A tenant can generate a new app grant priviliges to this module and end point.
\n","_postman_id":"e2852191-5bea-42ae-83e1-a4d338e2a346"}],"id":"f86c7be0-9a1e-45b8-90ab-4e41a2c2aa29","description":"The native module manages authentication and tokens for the CoreHR native application. These services cater for both SAML and non-SAML customers. All request will be handled via TLS.
\nThis service provides:
\n- \n
- Ability to remove / purge / reset Uses UUID's \n
Find all non provisioned accounts. This endpoint will return all users not yet provisioned.
\nThis examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Optionally provide number of days, this service is used to offset users start date. Provides ability to determine accounts not yet provisioned in CoreHR for Core|Portal self service access. This service will include employees due to start in the future.
\nAllowing the following scenario.
\n- \n
obtain user accounts to be provisioned within the last X number of days, i.e. a start date occurring in the past.
\n \nobtain user accounts to be provisioned with a future start date, i.e. users starting in the future.
\n \n
This examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Provisions a new CorePortal account; on successful completion, users will have ability to access CoreHR's self service features via CorePortal. As noted in the introduction to the provisioning module, where an IDM or third party application understands CorePortal privileges this module will accept these privileges. Example provided below includes Users Privilege.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- authType \n
This is the authentication type for the employee, the value here should be either inApplicationPassword or LDAP. For all single sign on authenticated accounts use LDAP. For non single sign on account set this value to inApplicationPassword this then requires the password attribute to be set. Leaving this parameter null indicates to CoreHR that the user account should pick up the system default authentication type, this parameter can be found in CoreHR as 'authtype'.
- \n
- password \n
This attribute is required when authType is inApplicationPassword. The value here will be validated against the password policy in CoreHR.
- \n
- privileges \n
An array, each array object contains a privilege.
\nMandatory
\n- \n
- corehrid \n
- loginid \n
- password (only when authType is inApplicationPassword) \n
Provides ability to patch (amend) an existing account. Account must have previously been provisioned, this means corehrID must previously have been generated via POST. In general this service supports Single Sign On style accounts.
It is possible to use this service with non SSO accounts, in such cases all parameters are mandatory including password and explcitly setting authType to inApplicationPassword. In cases where authType is not provided the account is assumed to be Single Sign On.
The use cases for this web service includes
\n- \n
- loginId changing \n
Where a user changes their loginId e.g. their name changes because of marriage, this web service faciliates this change of ID.
\n- \n
- privilege changing \n
executing this web service will remove all current privileges and replace with the privileges array. It is therefore possible to use this web service to revoke all privileges for a user by sending a blank array of privileges.
\nExample provided below changes both Login ID and privileges.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- authType \n
This is the authentication type for the employee, the value here should be either inApplicationPassword or LDAP. For all single sign on authenticated accounts use LDAP. For non single sign on account set this value to inApplicationPassword this then requires the password attribute to be set. In cases where this attribute is null, assumpetion is Single Sign On.
- \n
- password \n
This attribute is required when authType is inApplicationPassword. The value here will be validated against the password policy in CoreHR.
- \n
- privileges \n
An array, each array object contains a privilege. If this is blank all privs are revoked.
\nMandatory
\n- \n
- corehrid \n
- loginid \n
- password (only when authType is inApplicationPassword) \n
For Non SSO Accounts all parameters are mandatory.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","provision","user"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f053d6a2-5ce9-451e-a7e7-dc689d1ad660","name":"201 - Created - Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\n \"corehrid\" : \"002875\",\n \"loginid\" : \"jones.donovan@corehr.com\",\n \"privileges\" : [\n {\"privilege\" : \"developmentTeam\"},\n {\"privilege\" : \"VPNGroup\"}\n ]\n}\n"},"url":"{{url}}/ws/{{schema}}/{{version}}//provision/user"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 05 Oct 2016 16:42:46 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"b967fde7-937c-44a6-806d-627f5c44d2eb"},{"name":"/provision/user/status/:id","id":"b402db20-cfbc-474a-9aad-d04cc6e9cca5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100","description":"Obtain user account status indicator; determining if an account is active or not. The parameter id can be users coreHRID or account username.
Obtain user authentication type. Response indicates either LDAP or inApplicationPassword.
The parameter id can be users coreHRID or loginID.
Provides an ability to activate or deactivate an account. Setting an account to be deactive results in a user not being allowed sign into CoreHR self Service module CorePortal. This does not apply to SAML authentication. Credentials and access needs to be checked by the SAML IDP.
\nWhen an account is created via POST /provision/user the account is assumed to be active. You do not need to execute this web services to activate an account once it has been created. However if you execute this web services and set active to N then you must execute this web services again to re-activate the account by setting active to Y.
The id parameter can be either coreHRID or the username associated with the account. The Active parameter must be N or Y.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","provision","user","status","100"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"75883d0d-cf23-4804-a2bd-d5ab0afc335a","name":"400 - Validation Failed","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\"active\" : \"N\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/1001"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 19:02:41 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"007\",\"errorMessage\" :\"Validation failed. Either user account does not exist or request data is invalid.\" }}\n"},{"id":"cca980bd-4f0b-436e-9fd2-d1ffa3b65277","name":"201 - Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\"active\" : \"N\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 19:02:16 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"},{"id":"cf854e38-3907-4195-b7af-0428cfd7eb65","name":"200 - Account Active","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 18:04:52 GMT","name":"Date","description":""},{"key":"ETag","value":"\"L/idwKxNGWvlkQGQ4j3vC0+brkecdYNqpY2o9nJxaN5RiPktu/5d3OJrX6yJIWMlOB0ocscXHR0OVsUrx7Decw==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"{\"items\":[{\"isaccountactive\":\"Yes\"}],\"hasMore\":false,\"limit\":100,\"offset\":0,\"count\":1,\"links\":[{\"rel\":\"self\",\"href\":\"http://localhost:8585/ws/corehr/v1/provision/user/status/100\"},{\"rel\":\"describedby\",\"href\":\"http://localhost:8585/ws/corehr/metadata-catalog/v1/provision/user/status/item\"},{\"rel\":\"first\",\"href\":\"http://localhost:8585/ws/corehr/v1/provision/user/status/100\"}]}"}],"_postman_id":"653e61a5-fa03-45f0-a9fe-b86d4ae10191"},{"name":"/provision/user/privilege","id":"9195e76c-a731-419d-893e-e75f7160ab24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"loginid\" : \"jones.donovan@corehr.com\",\n \"privilege\" : \"hrAdmin\"\n }\n"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/privilege","description":"Provisions a new privilege for a user. This service allows one new privilege to be assigned to the user account. In addition this service assumes an account has already been provisioned. Validation is performed on the account confirming existence.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- privilege \n
a new privilege for the user.
\nSpecial Usage Note
\nuse one of the following combinations, do not use all three fields. If you do an error will be returned.
\n- \n
- corehrid and a privilege \n
or
\n- \n
- loginid and a privilege \n
CoreHR v25.0.7 required
\nThis service will list all currently granted privileges associated with a user.
\nParameter
\nid can be either the users loginid or the users corehrid (personnelNumber).
CoreHR v25.0.7 required
\nProvides an ability to revoke all user privileges associated with the user account.
\nA privilege here relates to all granted menu security items i.e. feature access and not access to a specific user, while access to the user is not revoked the privilege to use the feature is revoked.
\nNB this revokes all.
\nOther attributes associated with the user Account are not affected e.g. account will still exist, authentication type will remain as is, and password for non SSO accounts remain in place etc.
\nThis service assumes an account has already been provisioned. Validation is performed on the account confirming existence. This is a simple purge request, in cases where the user has no privileges, this service will not respond with an error, instead a successful response is returned.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by using the new filter services.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\nSpecial Usage Note
\nuse one of the following combinations, do not use both fields. If you do an error will be returned.
\n- \n
- corehrid \n
or
\n- \n
- loginid \n
Provisioning facility allowing Core|Portal accounts to be provisioned. Core|Portal is the self service module within CoreHR. A employee may have a record in CoreHR, this does not automatically suggest same employee has access to self service features via CorePortal. In order to access CorePortal a self service account is required. This module provides a web service mechanism to provision an employee.
\nIn Summary provisioning provides ability to
\n- \n
- Determine accounts yet to be provisioned \n
- Determine accounts yet to be provisioned within X number of days (including future start dates) \n
- Provision a new account \n
- Provision a new account with privileges \n
- Update existing accounts privileges \n
- Add additional privilege to an account \n
- Set authentication Type in cases where a mix of Single Sign On, SAML and inApplicationPasswords exist \n
Contraints, Limitations & Mandatory
\nAccounts to be provisioned simply indicates accounts (employees) not yet provisioned. These accounts must satisfy following criteria
\n- \n
- Active Employee Record \n
indicates employees record must not have a date left.
\nDo not assume logic applies indicating certain categories of employees are allowed access and others are not allowed. No other conditions are applied. Additional attributes are possible to add to the response to help an IDM provider make this decision, CoreHR will work with an IDM provider to best determine.
\nCorePortal privileges can be assigned by the IDM using the privileges array (example below). Where an IDM can not determine privileges, this provisioning web service module integrates with the CoreHR user profile matrix, and in cases where this matrix is not configured the fall back is all users are granted a default access profile typically \"coreportal_employee\".
\nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Mandatory fields are missing \n
- 400 / 002 Validation failed. If attempting to update use PATCH method \n
- 400 / 003 Unexpected error, unable to provision account \n
- 404 / 004 Validation failed. User account does not exist \n
- 404 / 005 Validation failed. Account must first be provisioned, use POST method \n
- 400 / 006 Validation failed. Invalid fields used \n
- 400 / 007 Validation failed. Either user account does not exist or request data is invalid. \n
- 400 / 008 Validation failed. Authtype must be either LDAP or inApplicationPassword. If choosing inApplicationPassword a password is required \n
- 400 / 009 Validation failed. Supplied password has not passed password \n
- \n
- 400 / 010 Validation failed, type is mandatory (must email or all), and id should be populated when type is email, when type is all no id should be provided. The JSON keys are case sensitve, type and id should be lower case. \n
\n- \n
- 404 / 011 Nothing found for this email address. \n
\n
Get a list of registered / whitelisted referene types. Tenant has an ability to define reference types available for creating / updating. A tenant may not allow all references to be updated or created, this base URI provides the list of valid reference types. In cases where server returns validation errors, refer to this list to confirm the reference type is whitelisted.
\nThis examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Returns a list of codes and descriptions for a reference type, a reference type could be COST, DEPT etc. Reference Types are typically upper case. As already noted reference types can be whitelisted by a tenant.
For a full list of available reference types use /reference/
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","{{version}}","reference","type","DEPT",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"cbf86e8a-e007-49a9-95c1-b7289bcde973","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/COST/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:35:18 GMT","name":"Date","description":""},{"key":"ETag","value":"\"ZInz0RdXlDlkFr0RxOWVt0Xe8DrUJnBC2+V/aZmUKdeVao7Vnt+tTjTY7a88qxAW/95HgOuX3zxv4wgdqSdatg==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"COST\", \"code\": \"1\", \"description\": \"Cost Centre Web Services 1\"}\n,\n{\"type\":\"COST\", \"code\": \"10\", \"description\": \"Cost Centre Web Services 10\"}\n,\n{\"type\":\"COST\", \"code\": \"100A\", \"description\": \"Cost Centre Web Services 100A\"}\n,\n{\"type\":\"COST\", \"code\": \"111\", \"description\": \"Cost Centre Web Services 111\"}\n,\n{\"type\":\"COST\", \"code\": \"123456789\", \"description\": \"Cost Centre Web Services 123456789\"}\n,\n{\"type\":\"COST\", \"code\": \"149\", \"description\": \"Cost Centre Web Services 149\"}\n,\n{\"type\":\"COST\", \"code\": \"159\", \"description\": \"Cost Centre Web Services 159\"}\n,\n{\"type\":\"COST\", \"code\": \"20\", \"description\": \"Cost Centre Web Services 20\"}\n,\n{\"type\":\"COST\", \"code\": \"200A\", \"description\": \"Cost Centre Web Services 200A\"}\n,\n{\"type\":\"COST\", \"code\": \"21\", \"description\": \"Cost Centre Web Services 21\"}\n,\n{\"type\":\"COST\", \"code\": \"22\", \"description\": \"Cost Centre Web Services 22\"}\n,\n{\"type\":\"COST\", \"code\": \"222\", \"description\": \"Cost Centre Web Services 222\"}\n,\n{\"type\":\"COST\", \"code\": \"23\", \"description\": \"Cost Centre Web Services 23\"}\n,\n{\"type\":\"COST\", \"code\": \"24\", \"description\": \"Cost Centre Web Services 24\"}\n,\n{\"type\":\"COST\", \"code\": \"25\", \"description\": \"Cost Centre Web Services 25\"}\n,\n{\"type\":\"COST\", \"code\": \"26\", \"description\": \"Cost Centre Web Services 26\"}\n,\n{\"type\":\"COST\", \"code\": \"27\", \"description\": \"Cost Centre Web Services 27\"}\n,\n{\"type\":\"COST\", \"code\": \"28\", \"description\": \"Cost Centre Web Services 28\"}\n,\n{\"type\":\"COST\", \"code\": \"29\", \"description\": \"Cost Centre Web Services 29\"}\n,\n{\"type\":\"COST\", \"code\": \"2908100\", \"description\": \"Cost Centre Web Services 2908100\"}\n,\n{\"type\":\"COST\", \"code\": \"30\", \"description\": \"Cost Centre Web Services 30\"}\n,\n{\"type\":\"COST\", \"code\": \"300A\", \"description\": \"Cost Centre Web Services 300A\"}\n,\n{\"type\":\"COST\", \"code\": \"356\", \"description\": \"Cost Centre Web Services 356\"}\n,\n{\"type\":\"COST\", \"code\": \"39\", \"description\": \"Cost Centre Web Services 39\"}\n,\n{\"type\":\"COST\", \"code\": \"40\", \"description\": \"Cost Centre Web Services 40\"}\n,\n{\"type\":\"COST\", \"code\": \"451\", \"description\": \"Cost Centre Web Services 451\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC\", \"description\": \"Cost Centre Web Services ABC\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC001\", \"description\": \"Cost Centre Web Services ABC001\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC0010\", \"description\": \"Cost Centre Web Services ABC0010\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC003\", \"description\": \"Cost Centre Web Services ABC003\"}\n,\n{\"type\":\"COST\", \"code\": \"J12345\", \"description\": \"Cost Centre Web Services J12345\"}\n,\n{\"type\":\"COST\", \"code\": \"JKL333\", \"description\": \"Cost Centre Web Services JKL333\"}\n,\n{\"type\":\"COST\", \"code\": \"PROD\", \"description\": \"Cost Centre Web Services PROD\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 33,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/reference/type/COST/\"\n }\n ]\n}\n"}],"_postman_id":"30baaaa9-77fc-4aeb-99c0-de6fd9472a13"},{"name":"/reference/type/:atype/:code?","id":"ea71f2ce-6390-434b-b2db-cebb0f404c3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/reference/type/DEPT/7001","description":"Returns an individual reference description associated with a reference type and code. A reference type could be COST, DEPT etc. Reference Types are typically upper case. As already noted reference types can be whitelisted by a tenant.
For a full list of available reference types use /reference/
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","{{version}}","reference","type","DEPT","7001"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"78b6e508-d25d-4ab5-b5f4-5194b8c8f0ef","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/COST/10"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:35:39 GMT","name":"Date","description":""},{"key":"ETag","value":"\"Q3jVQU2iTQ/v0g70PelGZKl9U6wG1LV/Ns7vRxFBtB7MUyXAAgUcC+nxdBtW/mQMcQPoQhSS1jjRtrAA4a7uzQ==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"COST\", \"code\": \"10\", \"description\": \"Cost Centre Web Services 10\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/reference/type/COST/10\"\n }\n ]\n}\n"}],"_postman_id":"ea71f2ce-6390-434b-b2db-cebb0f404c3d"},{"name":"/reference/type/:atype","id":"4aa95b5a-562e-4996-a51c-17958509c6aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"value\" : \"1\",\n\"description\" : \"Department One\"\n}"},"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/reference/type/DEPT/","description":"Add reference data based on the reference type, code and description. The reference type is expected in the URL, while the request body should include code and description
Ability to update a description associated with an existing reference code / type combination. The reference type is expected in the URL, while the request body should include code and description
It is possible to also provide an active parameter, this parameter can also be provided via the request body must be either Y or N.
Delete reference data based on the reference type, code. The reference type is expected in the URL, while the request body should include code.
Reference module provides ability to view, add and update reference related items for CoreHR e.g. Cost Centre, Department, Projects etc.
\nContraints, Limitations & Mandatory
\nThe reference module is case senstive, no process converts the type provided into upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned. Within CoreHR reference types are typically uppercase.
\nIn most cases a type is mandatory. Following are some examples, for more detail review each URI and method below.
\nFor endpoint /reference/type/aType/ aType is mandatory e.g. /reference/type/COST/. Another example /reference/type/COST/1 will return Reference Type COST where the cost centre code is 1. For /reference/types/ no type is required.
Further information per method below.
\nLimitations
\nDescription max length - 40 Characters
\nCode max length - 13 Characters
\nWRKGRP only GETS are supported, POST, PATCH and DELETE are not supported.
Error Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Mandatory fields are missing \n
- 400 / 002 Validation failed. If attempting to update use PATCH method \n
- 404 / 003 Validation failed. Reference type does not exist \n
- 400 / 004 Validation failed. Sanitization of data failed, ensure field lengths are correct \n
- 400 / 005 Validation failed. Reference code does not exist. If attempting to add use POST method. \n
- 400 / 006 Validation failed. Validation failed. Reference type and code do not exist. \n
- 400 / 007 Validation failed. Validation failed. Active Indicator can only be Y or N. \n
Defined below are the endpoints, sample requests and responses.
\n","event":[{"listen":"prerequest","script":{"id":"45c95afc-98cb-4937-9268-64d10ebd9a10","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f2ac59d2-12d0-4183-89cb-3c2a75dd6cd9","type":"text/javascript","exec":[""]}}],"_postman_id":"059f18ba-c8e7-4e0c-9d23-ca900a78fdb2"},{"name":"User Defined Fields","item":[{"name":"/udf/user/:udf_type","id":"1a6a912f-8346-4d6b-b702-811ee0422b02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 9m1zDcUnJrxvkqTfEsTOfQ.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20","description":"Creating a new UDF Type Record for a user
\nAdding a new User record for a UDF Type requires the following fields. UDF Type code is mandatory and specified as part of the URL.
\nThe rest of the fields are provided as JSON in the request body. Un-used/empty fields should be left blank. Successful inserts results in a JSON Response object with success value of true. Also included in the JSON Response is the ws_id which is the unique Web Service ID that can be used to identify this specific record.
\nFields are sent in the JSON are as in the table below:
\n¹ Either personnel_no OR appointment_id are mandatory.
² Date1 and Date2 are input in the format DD-MON-RRRR.
\n³ Text1 to Text12 must ALWAYS be provided. If the field is not being used for the UDF Type use a blank value string e.g. \"\".
\n¬ Text1 to Text12 field requirements are defined by the UDF Type configuration in CoreHR. Text fields can be marked as mandatory/optional and of specific data types including:
\n- \n
- Text - to a maximum of 4000 characters long. \n
- Number - number values only \n
- Date required to be in the format DD-MON-YYYY. \n
- List - Based on the allowed list for the UDF Type as configured in CoreHR. \n
Response Object\nSample responses are shown to the right under different conditions.
\nA response objects is always provided and within success will either be true. In which case as ws_id (unique web service identifier that allows us to refer back to this record).
Alternatively, the success value can be false if this is the cause an errorCode and errorMessage are provided. Additional error details - if the error pertains to a specific value in the body - is provided in the validationError object. This will contain one or more JSON objects relating to each specific error. The param_name will contain the field the validation error relates to the field_name is the label of the field used in CoreHR and the message will contain a detailed explanation of what validation is failing.
Error Codes
\nConvention is HTTP Status Code / Verbose Code. These are shared by all these UDF endpoints and explained in the Error Codes section at the start of the UDF documentation.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","udf","user","AB20"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"8b2ee312-bf4d-4c16-a820-76f593e82b11","name":"1. Successful date fields example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer _QsnRadImZrbh8w9_4B6UA.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"1409000\",\n \"appointment_id\": \"\",\n \"text1\": \"27-JAN-2017\",\n \"text2\": \"24-FEB-2017\",\n \"text3\": \"31-MAR-2017\",\n \"text4\": \"28-APR-2017\",\n \"text5\": \"27-MAY-2017\",\n \"text6\": \"30-JUN-2017\",\n \"text7\": \"28-JUL-2017\",\n \"text8\": \"25-AUG-2017\",\n \"text9\": \"29-SEP-2017\",\n \"text10\": \"28-OCT-2017\",\n \"text11\": \"24-NOV-2017\",\n \"text12\": \"29-DEC-2017\",\n \"date1\": \"\",\n \"date2\": \"\",\n \"user_code\": \"\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Fri, 11 Aug 2017 16:05:48 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"41431680-ec3d-4690-8100-5e5ec94a3c78-00002f6a","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true, \"ws_id\":\"2017081171563091\"}}\n"},{"id":"c7ee507e-08a7-459d-8e9b-2b69ddb7fef2","name":"2. Validation Fail","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer _QsnRadImZrbh8w9_4B6UA.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"1409000\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"27-JAN-2017\",\n \"text2\": \"24-FEB-2017\",\n \"text3\": \"31-MAR-2017\",\n \"text4\": \"28-APR-2017\",\n \"text5\": \"27-MAY-2017\",\n \"text6\": \"30-JUN-2017\",\n \"text7\": \"28-JUL-2017\",\n \"text8\": \"25-AUG-2017\",\n \"text9\": \"29-SEP-2017\",\n \"text10\": \"28-OCT-2017\",\n \"text11\": \"24-NOV-2017\",\n \"text12\": \"29-DEC-2017\",\n \"date1\": \"\",\n \"date2\": \"\",\n \"user_code\": \"\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Fri, 11 Aug 2017 16:14:20 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"41431680-ec3d-4690-8100-5e5ec94a3c78-00002f6d","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"002\",\"errorMessage\" :\"Validation failed. Provide either a personnel number or an Appointment ID. It is not possible to use both.\" }}\n"},{"id":"ce162074-2493-47a8-aab7-d086debdb903","name":"3. Sanatization Fail Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer _QsnRadImZrbh8w9_4B6UA.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"1409000\",\n \"appointment_id\": \"\",\n \"text1\": \"27\",\n \"text2\": \"24\",\n \"text3\": \"31\",\n \"text4\": \"28\",\n \"text5\": \"27\",\n \"text6\": \"30\",\n \"text7\": \"28\",\n \"text8\": \"25\",\n \"text9\": \"29\",\n \"text10\": \"28\",\n \"text11\": \"24\",\n \"text12\": \"29\",\n \"date1\": \"\",\n \"date2\": \"\",\n \"user_code\": \"\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"close","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Fri, 11 Aug 2017 16:16:01 GMT","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"41431680-ec3d-4690-8100-5e5ec94a3c78-00002f6f","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[],"responseTime":null,"body":"\n\n { \"Response\": {\n \"success\" : false,\n \"errorCode\" : \"998\",\n \"errorMessage\" : \"UDF Type validation errors. Review validationError object for more details of data errors for this UDF type.\",\n \"validationError\" : [\n\n {\n \"param_name\" : \"text1\",\n \"field_name\" : \"COREHR 7600\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text2\",\n \"field_name\" : \"text2\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text3\",\n \"field_name\" : \"text3\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text4\",\n \"field_name\" : \"text4\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text5\",\n \"field_name\" : \"text5\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text6\",\n \"field_name\" : \"text6\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text7\",\n \"field_name\" : \"text7\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text8\",\n \"field_name\" : \"text8\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text9\",\n \"field_name\" : \"text9\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text10\",\n \"field_name\" : \"text10\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text11\",\n \"field_name\" : \"text11\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text12\",\n \"field_name\" : \"text12\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n]\n }\n }\n"},{"id":"ea1623c4-ee34-405e-9816-a78510f805fb","name":"4. User Code example to use pre-defined data in all text fields","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 9m1zDcUnJrxvkqTfEsTOfQ.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Mon, 14 Aug 2017 12:10:39 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"f38c5093-1095-4e7e-be35-0074f4d4eb81-0000002c","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true, \"ws_id\":\"2017081471563097\"}}\n"}],"_postman_id":"1a6a912f-8346-4d6b-b702-811ee0422b02"},{"name":"/udf/user/:udf_type","id":"3a40a4a4-d4cd-4423-94ff-94bd2e6651cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer 9m1zDcUnJrxvkqTfEsTOfQ.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20","description":"Updating existing UDF Type Record for a user
\nUpdating a user record for a UDF Type uses the personnel_no/appoinment_id, date1, date2 and the udf_type to determine if the record is an update. i.e. If there is an existing record(s) with the same person/appointment and date1 and date2 then it is an update and the existing record(s) will be patched (updated) to the new values provided in the JSON code. UDF Type is of course mandatory and specified as part of the URL.
\nThe rest of the fields are provided as JSON in the request body. Un-used/empty fields should be left blank. Successful updates result in a JSON Response object with success value of true.
\nFields are sent in the JSON are as in the table below:
\n¹ Either personnel_no OR appointment_id are mandatory.
² Date1 and Date2 are input in the format DD-MON-RRRR.
\n³ Text1 to Text12 must ALWAYS be provided. If the field is not being used for the UDF Type use a blank value string e.g. \"\".
\n¬ Text1 to Text12 field requirements are defined by the UDF Type configuration in CoreHR. Text fields can be marked as mandatory/optional and of specific data types including:
\n- \n
- Text - to a maximum of 4000 characters long. \n
- Number - number values only \n
- Date required to be in the format DD-MON-YYYY. \n
- List - Based on the allowed list for the UDF Type as configured in CoreHR. \n
Response Object\nSample responses are shown to the right under different conditions.
\nA response objects is always provided and within success will either be true. In which case as ws_id (unique web service identifier that allows us to refer back to this record).
Alternatively, the success value can be false if this is the cause an errorCode and errorMessage are provided. Additional error details - if the error pertains to a specific value in the body - is provided in the validationError object. This will contain one or more JSON objects relating to each specific error. The param_name will contain the field the validation error relates to the field_name is the label of the field used in CoreHR and the message will contain a detailed explanation of what validation is failing.
Error Codes
\nConvention is HTTP Status Code / Verbose Code. These are shared by all these UDF endpoints and explained in the Error Codes section at the start of the UDF documentation.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","udf","user","AB20"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"64c79480-9a57-434b-8445-895a76363b5d","name":"Successful update using User Code","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Bearer 0nsn4KtX5QlKF4_4q0gNcw.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Thu, 17 Aug 2017 15:13:29 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"e491ed87-4cb1-4174-9763-76bbe5667c2b-0000009c","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"3a40a4a4-d4cd-4423-94ff-94bd2e6651cb"},{"name":"/udf/user/","id":"a7ca8d77-9e50-4169-8889-a17d4cba2ac1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/","description":"Web service to get the list of User Defined Field (UDF) records for a particular UDF Type. Mandatory search criteria include:
\n- \n
- udf_type - The UDF code. \n
- person - The CoreHR Personnel Number for whom records are to be retrieved.\nOptional criteria include: \n
- appointment_id - To search for details relating to a specific appointment. \n
- date1 - Commonly used as the Date From field. \n
- date2 - Commonly used as the Date To field. \n
A get request can return many records depending on the criteria poveded and consequently the ws_id value pair is the unique identifier that can be used with other web services to update this specific record.
Error Codes are documented at the start of the UDF documentation.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","udf","user",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"4dbf5df8-7268-43d2-ac59-410010aa5563","name":"Search using all citeria","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Bearer 8N7tv3Kwt2W5_i-B72dWew.."}],"url":{"raw":"{{url}}/ws/{{schema}}/{{version}}/udf/user/?udf_type=AB20&person=1409000&appointment_id=TS0011-2594&date1=01-JAN-2017&date2=31-DEC-2017","host":["{{url}}"],"path":["ws","{{schema}}","{{version}}","udf","user",""],"query":[{"key":"udf_type","value":"AB20"},{"key":"person","value":"1409000"},{"key":"appointment_id","value":"TS0011-2594"},{"key":"date1","value":"01-JAN-2017"},{"key":"date2","value":"31-DEC-2017"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"name":"connection","key":"connection","value":"Keep-Alive","description":"Options that are desired for the connection"},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":"Custom header"},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"name":"date","key":"date","value":"Thu, 17 Aug 2017 14:27:44 GMT","description":"The date and time that the message was sent"},{"name":"etag","key":"etag","value":"\"MQgB6VKjaT8lHDgADQKxxd0zqZ1ssI3lKuh3MursJBsVKHrOsHcxUeOJWWw6Lq7KQJ4hi5sQMuu9orqF0glhNg==\"","description":"An identifier for a specific version of a resource, often a message digest"},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":"Custom header"},{"name":"server","key":"server","value":"Apache","description":"A name for the server"},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"e491ed87-4cb1-4174-9763-76bbe5667c2b-0000008c","description":"Custom header"},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":"Custom header"},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":"Cross-site scripting (XSS) filter"}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{ \"items\" : [\n{\"udf_type\":\"AB20\",\"person\": \"1409000\",\"appointment_id\": \"TS0011-2594\",\"ws_id\": \"2017081171563091\",\"user_code\": \"AB20\",\"date1\": \"01-JAN-2017\",\"date2\": \"31-DEC-2017\",\"text1\": \"27-JAN-2017\",\"text2\": \"24-FEB-2017\",\"text3\": \"31-MAR-2017\",\"text4\": \"28-APR-2017\",\"text5\": \"27-MAY-2017\",\"text6\": \"30-JUN-2017\",\"text7\": \"28-JUL-2017\",\"text8\": \"25-AUG-2017\",\"text9\": \"29-SEP-2017\",\"text10\": \"28-OCT-2017\",\"text11\": \"24-NOV-2017\",\"text12\": \"29-DEC-2017\",\"last_update\": \"17-AUG-2017 12:46:49\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/frame/corehr/v1/udf/user/\"\n }\n ]\n}\n"},{"id":"8108a89e-a473-4110-a627-af108f5bad87","name":"Missing Person parameter","originalRequest":{"method":"GET","header":[{"key":"Authorization","name":"Authorization","value":"Bearer _E4Pl9nxSkcJFbic2dxD8w.."}],"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"name":"connection","key":"connection","value":"close","description":"Options that are desired for the connection"},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":"Custom header"},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"name":"date","key":"date","value":"Thu, 17 Aug 2017 11:54:53 GMT","description":"The date and time that the message was sent"},{"name":"etag","key":"etag","value":"\"hu/EykO6P9EsmiOfI5hQk+9yi5r2AxYFcmeD8ppL8ujowI4GmtSfFHQi+xgzudcWmF0pxNbJHLHEWwepH2J8/A==\"","description":"An identifier for a specific version of a resource, often a message digest"},{"name":"server","key":"server","value":"Apache","description":"A name for the server"},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"e491ed87-4cb1-4174-9763-76bbe5667c2b-00000044","description":"Custom header"},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":"Custom header"},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":"Cross-site scripting (XSS) filter"}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"013\",\"errorMessage\" :\"Person is a mandatory field.\" }}\n"}],"_postman_id":"a7ca8d77-9e50-4169-8889-a17d4cba2ac1"}],"id":"d6e63570-b946-42ec-8883-80a8c85fe6e8","description":"The User Defined Fields (UDF) module provides ability to insert/update and view the UDF records for a CoreHR employee.
\nThe list of UDF Types available is as configured in Core Personnel in the User Defined Fields under the Employee option i.e. those UDF types that related to a specific employee/user.
\nThese UDF Types must also be white listed using the Security option in Portal to allow them to be called via this Web Service.
\nConstraints, Limitations and Validation
\nFor all calls (insert/update/get) the personnel no. and the UDF Type code must be specified at a minimum. As previously mentioned the UDF Type must have been added to the whitelist to be accessed in any way.
\nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 404 / 000 The UDF Type does not exist in Core as a valid UDF Type for an Employee/User. \n
- 400 / 001 A Personnel Number or an Appointment ID must be provided. \n
- 404 / 002 Provide either a personnel number or an Appointment ID. It is not possible to use both. \n
- 404 / 003 There is no CoreHR personnel/user account associated with the personnel number provided. \n
- 404 / 004 The Appointment ID is invalid. \n
- 404 / 006 UDF Type with these details does not exist for user, consider using POST to create. \n
- 404 / 007 This UDF Type is not whitelisted for web services. \n
- 400 / 008 When using User Reference Data - by specifying a user_code - then do not provide values in parameters text1 to text12 i.e. pass in empty values in text1..text12. \n
- 404 / 009 This User Reference Data - as specified by the user_code - is not a a valid User Code for this UDF Type. \n
- 404 / 010 There is no UDF record of this type for this person with these details to update. Use POST if you want to insert a record. \n
- 400 / 011 Date1 field when used must be provided in the date format DD-MON-YYY. \n
- 400 / 012 Date2 field when used must be provided in the date format DD-MON-YYY. \n
- 400 / 013 Person is a mandatory field in this context. \n
- 400 / 014 UDF Type is a mandatory field in this context. \n
This service returns all position profiles, and is ordered by post number
\nParameters
\nNone
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- postNumber \n
A unique identifier associated with the position profile.
\n- \n
- postType \n
Provides information about the type of post e.g. permanent, part time, trainee, contractor etc. For associated descriptions use the Reference Module with the reference type EMPS. This attribute is available from CoreHR 26.0.6 and is not available in older versions.
- \n
- category \n
Categorises the position / post based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The date this position / post profile is effective from
\n- \n
- endDate \n
The date this position / post profile is no longer effective
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
- payScale \n
This is the \"scale\" related to salary information which is associated with the appointment. This attribute is also referred to as 'PositionCode' and 'Grade'. Note: if the requirement is to determine an individuals exact Grade use the /person/salary/ web service instead.
\n- \n
- postTileCode \n
A code that represents the description of the position / post profile. For associated descriptions use the Reference Module with the reference type POSTTL.
- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
This service returns only active position profiles, and is ordered by post number. An active position profile is based on the start and end dates of the position profile. Leaving the date parameter blank will return the current active appointments as of 'today'. Provide a date if the requirement is to determine active position profiles as of a specific date. An appointment with a start date >= today and a dormant date <= today is considered active. When the dormant date is not set for an appointment then it is active if the start date is >= today.
\nParameters
\ndate : format YYYYMMDD
\nMandatory : No
\nWhen blank, the service returns active appointments as of 'today'.
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- postNumber \n
A unique identifier associated with the position profile.
\n- \n
- postType \n
Provides information about the type of post e.g. permanent, part time, trainee, contractor etc. For associated descriptions use the Reference Module with the reference type EMPS. This attribute is available from CoreHR 26.0.6 and is not available in older versions.
- \n
- category \n
Categorises the position / post based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The date this position / post profile is effective from
\n- \n
- endDate \n
The date this position / post profile is no longer effective
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
- payScale \n
This is the \"scale\" related to salary information which is associated with the appointment. This attribute is also referred to as 'PositionCode' and 'Grade'. Note: if the requirement is to determine an individuals exact Grade use the /person/salary/ web service instead.
\n- \n
- postTileCode \n
A code that represents the description of the position / post profile. For associated descriptions use the Reference Module with the reference type POSTTL.
- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
This service returns only future position profiles, and is ordered by post number. A future position profile is based on the start of the position profile, and the start must be greater than 'today'.
\nParameters
\nNone
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- postNumber \n
A unique identifier associated with the position profile.
\n- \n
- postType \n
Provides information about the type of post e.g. permanent, part time, trainee, contractor etc. For associated descriptions use the Reference Module with the reference type EMPS. This attribute is available from CoreHR 26.0.6 and is not available in older versions.
- \n
- category \n
Categorises the position / post based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The date this position / post profile is effective from
\n- \n
- endDate \n
The date this position / post profile is no longer effective
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
- payScale \n
This is the \"scale\" related to salary information which is associated with the appointment. This attribute is also referred to as 'PositionCode' and 'Grade'. Note: if the requirement is to determine an individuals exact Grade use the /person/salary/ web service instead.
\n- \n
- postTileCode \n
A code that represents the description of the position / post profile. For associated descriptions use the Reference Module with the reference type POSTTL.
- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
A post number can be obtained by using the /person/appointment/:personnelNo web service.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- postNumber \n
A unique identifier associated with the position profile.
\n- \n
- postType \n
Provides information about the type of post e.g. permanent, part time, trainee, contractor etc. For associated descriptions use the Reference Module with the reference type EMPS. This attribute is available from CoreHR 26.0.6 and is not available in older versions.
- \n
- category \n
Categorises the position / post based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The date this position / post profile is effective from
\n- \n
- endDate \n
The date this position / post profile is no longer effective
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
- payScale \n
This is the \"scale\" related to salary information which is associated with the appointment. This attribute is also referred to as 'PositionCode' and 'Grade'. Note: if the requirement is to determine an individuals exact Grade use the /person/salary/ web service instead.
\n- \n
- postTileCode \n
A code that represents the description of the position / post profile. For associated descriptions use the Reference Module with the reference type POSTTL.
- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
Position Module
\nThe position module will retrieve position (aka post) profile information. This profile information is generally best described as a blueprint providing default information for appointments e.g. sets the cost centre, department, category information etc.
\nSeveral options exist for this module:
\n- \n
/position/profile/:postNumber
\n \n/position/profile/active
\n \n/position/profile/inactive
\n \n/position/profile/all
\n \n
Get all active employees, this will include employees who have a future leaving dates.
\nBy default only 100 active employees will be returned. In cases where you have a large employee base, set the pagesize filter via the URL. The max pagesize is 10,000 i.e it is possible to obtain an employee result set up to 10,000 employees. Setting the pagesize above this max threshold will result in only the default result set.
\n- \n
- Date\nan optional parameter, leaving this parameter blank, will simply return active employees as of 'today'. While providing a value for date (formated as YYYYMMDD) will return employees active for that specific date. Typically used to find employees active based on a specific historical date. It is therefore possible to obtain employees who have ceased employment. \n
This module relates to active employees, and will always only deal with active employees. The objective is to return an employee result set matching certain use cases, common use cases:
\n- \n
- Determine active employees \n
- Active employees on a particular date \n
Use this service to query employees leaving within the next X number of days, use the parameter :days to set the X value. These employees are currently active, however, they are set to leave within X number of days. The parameter must be positive.
The service will assume today when supplied with no value for :days or a value of 0, this returns employees leaving today.
Use this service to query employees leaving within the next X number of days.
\n","event":[{"listen":"prerequest","script":{"id":"6dbcd449-9e30-41fd-ae6f-9d249fcf3e30","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"feff06eb-b68c-4a31-9a12-5e0cebf18c3d","type":"text/javascript","exec":[""]}}],"_postman_id":"4507b078-48b9-4679-b9e0-92dc2bea3771"},{"name":"Date","item":[{"name":"/filter/jml/leaver/date/:date?","id":"e984d1f0-5372-4008-ab15-634de275353e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/leaver/date/20190101","description":"Use this service to query employees leaving based on a supplied date. By providing a future date the service will check employees who are due to leave between \"now\" and the future date. These employees are currently active, but are set to leave by the date provided.
\nDate format is YYYYMMDD and the date should be in the future, and the service treats date inclusive.
\nIf no date is supplied, by default the service will assume today as the date, i.e. find employees leaving today.
\nProviding a date less than \"today\" will always return 0 returns, no error will be provided, simply a response of 0 employees i.e. you must provide a future date.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","filter","jml","leaver","date","20190101"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2c974905-5021-4cc1-99bb-66ad7a4a8df5","name":"Leavers by 10th July 2017","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/leaver/date/20180710"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 12 Mar 2018 21:20:49 GMT","name":"Date","description":""},{"key":"ETag","value":"\"n64ZqihwRTaSnvtuJO8evqgaU7E41l1sQh6dvCZ2iJaA88DDSmbv8C/ph/M5S3l9M+IJJjYZ/KhVZTpDuEtdXQ==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"0927066f-15b4-4ceb-ab46-10c24ebde76e-00095dc9","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"employees\" : [\n\"1265972\"\n,\n\"1266093\"\n,\n\"1266320\"\n,\n\"1266812\"\n,\n\"1267013\"\n,\n\"1267172\"\n,\n\"1267412\"\n,\n\"1409000\"\n,\n\"1410828\"\n,\n\"1416471\"\n,\n\"1419656\"\n,\n\"1421133\"\n,\n\"1421660\"\n,\n\"1422451\"\n,\n\"1422642\"\n,\n\"1423322\"\n,\n\"1425268\"\n,\n\"1425560\"\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 18,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/leaver/date/20180324\"\n }\n ]\n}\n"}],"_postman_id":"e984d1f0-5372-4008-ab15-634de275353e"}],"id":"c528ebaf-3624-47fa-8783-3c318357d7ee","description":"Use this service to query employees leaving based on a supplied date.
\n","event":[{"listen":"prerequest","script":{"id":"93d61e37-2296-47f7-82c6-35224f300284","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"802ce7f5-9b1e-4b69-92d3-9ac4d5f7525d","type":"text/javascript","exec":[""]}}],"_postman_id":"c528ebaf-3624-47fa-8783-3c318357d7ee"},{"name":"Left","item":[{"name":"/filter/jml/leaver/left/:days?","id":"a816fc30-d180-4105-89bd-6d7cdfe42ed3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/leaver/left/1","description":"Use this service to query individuals who have left within the previous X number of days, use the parameter :days to set the X value. With this service it is possible to determine historical employees.
These employees are no longer considered active. The parameter must be positive.
\nThe service will assume yesterday when supplied with no value for :days.
Individuals leaving today will not appear in this result set. Those leaving today remain active until tomorrow.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","filter","jml","leaver","left","1"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a816fc30-d180-4105-89bd-6d7cdfe42ed3"}],"id":"ed0a1fc0-f3ed-4fcc-9915-94a0324f5652","description":"Use this service to query individuals who have previously left i.e. left within the previous X number of days. These individuals are considered inactive and no longer employeed. The service simply querys the date an individual has left. The date queried is the individuals most recent leaving date (catering for the cases where an individual has re-joined and subsequently left).
\n","event":[{"listen":"prerequest","script":{"id":"e9dc38b4-cddd-4eb2-a683-8d75fd3390a5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7747b522-5e90-4e95-9f7f-900209d251e5","type":"text/javascript","exec":[""]}}],"_postman_id":"ed0a1fc0-f3ed-4fcc-9915-94a0324f5652"}],"id":"9d65624b-e60f-4c0a-b6a2-14c61d344baf","description":"This module relates to employees leaving, the service will query an individuals leaving date, even though the employee may currently be active.
\nCommon use cases are:
\n- \n
- Determine individuals leaving within the next X number of days i.e. they are currently active, but have a leave date within the next 10 days. \n
- Determine individuals who are currently active but will have left by a certain future date i.e. provide a future date and the service will return individuals leaving between now and this future date. \n
- Determine individuals previously left. \n
This service is focused on recent starters i.e. active individuals who recently joined. With this service you can determine individuals who started within the previous X number of days, i.e. this is a between NOW and - X days.
\nin cases where no days parameter has been provided, the service assumes 0 i.e. who has started today. In most cases it is expected to provide 30 / 60 or 90 days. A max of 36500 is set for the upper limit.
In all cases employees starting today are included.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","filter","jml","joiner","recent","30"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"00ef7f5e-a369-41c5-8032-f07eb4eb5f80","name":"Previous 30 Days","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/joiner/recent/30"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 15 Mar 2018 11:53:56 GMT","name":"Date","description":""},{"key":"ETag","value":"\"140VlUC1D3FC3GEyZ2rH9bAWqVN9hnlxbHzATll48Aj8fNKuVg9wYkKSP/n3RUXZ+h9hRJFOjMHr+CTw2P3fgQ==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"0927066f-15b4-4ceb-ab46-10c24ebde76e-000df1b3","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"employees\" : [\n\"5990404\"\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/joiner/recent/\"\n }\n ]\n}\n"},{"id":"ffea43eb-eb6c-42b9-9d8a-611f19147c87","name":"Exceeding the Max Threshold","originalRequest":{"method":"GET","header":[],"url":"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/joiner/recent/36501"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 15 Mar 2018 12:12:36 GMT","name":"Date","description":""},{"key":"ETag","value":"\"nN2x9d3E41tTPKzxvz7dKw0hP6y+uPBjgI4mv2+zdxx8IXg8lojzVWg23GzD4VkZycVmFyVr/KOQvZWKurl0kA==\"","name":"ETag","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"0927066f-15b4-4ceb-ab46-10c24ebde76e-000dfe97","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"004\",\"errorMessage\" :\"Validation failed. Max of 36500 (~100 years)\" }}\n"}],"_postman_id":"f4436c84-2e4b-4351-87b4-b17e4a0de0d1"}],"id":"d2db111f-3f6a-4b11-9cb0-c7966af4cd1d","description":"This service is focused on recent starters i.e. active individuals who recently joined. With this service you can determine individuals you started within the previous X number of days.
\nin cases where no days parameter has been provided, the service assumes 0 i.e. who has started today. In most cases it is expected to provide 30 / 60 or 90 days. A max of 36500 is set for the upper limit.
Determine individuals due to start within the next X number of days.
\nIn cases where no days parameter has been provided, the service assumes 0 i.e. who has started today. In most cases it is expected to provide 30 / 60 or 90 days. A max of 36500 is set for the upper limit.
In all cases employees starting today are included.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","filter","jml","joiner","future","5"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"055bfa37-044a-4092-ac8c-485e15278541","name":"Starting Today","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/joiner/future/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 16 Mar 2018 09:14:11 GMT","name":"Date","description":""},{"key":"ETag","value":"\"uvizmfzh9HbIvg+bU9Db97yB/zZdZHUPZKquXaeGXMz25ZoDudfkO6lH/nfFZrEDkA99VtHMaWK9iAGZnxcWtw==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"cb89685b-0a33-4e88-9829-ed0bf23cf3fc-00005eff","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"employees\" : [\n\"1265972\"\n,\n\"1266093\"\n,\n\"1266267\"\n,\n\"1266320\"\n,\n\"1425560\"\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 5,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/joiner/future/\"\n }\n ]\n}\n"},{"id":"484427f1-0167-4a03-b812-0d2f579f50c7","name":"Starting Next 5 Days.","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/joiner/future/5"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 16 Mar 2018 09:06:02 GMT","name":"Date","description":""},{"key":"ETag","value":"\"a57aOwmxwydB4kqrVe87nAzw9DQGCbwJ+w+BGb7ygM2NEY37h+ymWOeSbINkBYdsAjKEEV+GpYdRIyszNKFUXg==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"cb89685b-0a33-4e88-9829-ed0bf23cf3fc-0000597a","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"employees\" : [\n\"1409000\"\n,\n\"1410828\"\n,\n\"1416471\"\n,\n\"1419656\"\n,\n\"1421133\"\n,\n\"5990404\"\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 6,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/joiner/future/5\"\n }\n ]\n}\n"}],"_postman_id":"e4e2e858-67a6-4b40-919b-9db788baf9ed"}],"id":"71e3f72c-1eab-480d-8cad-d6f10b8a2a53","description":"This service is focused on individuals starting in the future i.e. individuals who are due to start, but are not currently active. With this service you can determine individuals due to commence within the next X number of days i.e. this is a between NOW and + X days.
\n","event":[{"listen":"prerequest","script":{"id":"16643eb1-981a-4086-8aa9-c2059ba33c1f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d3b0e4b9-7363-4b39-82db-a9b19960a64a","type":"text/javascript","exec":[""]}}],"_postman_id":"71e3f72c-1eab-480d-8cad-d6f10b8a2a53"}],"id":"6dfe8004-bfd6-4035-a8b3-dbc021de3220","description":"This module relates to employees joining, the service will query individuals starting date, even though the employee may currently be active. An individuals start date is their most recent start date, in cases where an employee has left and rejoined, their current start date is the most recent date, this service only queries the most recent start date. The service will not look at original start dates aka day Zero.
Common use cases are:
\n- \n
- Determine individual's recently joined, i.e. started in last 30 days. \n
- Determine individual's joining at a future date, i.e. starting in the next 30 days. \n
This modules refers to Joiners, Movers and Leavers hence /JML/. Various use cases exist, for example, use this module to determine:
\n- \n
- recently joined employees \n
- employee's joining within next X number of days \n
- employee's due to leave based on dates / date \n
In general this module will provide filters for employees joining, moving and leaving. The objective is to return an employee result set matching certain use cases.
\n","event":[{"listen":"prerequest","script":{"id":"740af774-1c03-42fd-9252-f23e93b250f1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"250b9e8a-35cd-4052-b893-730bcf6b05dc","type":"text/javascript","exec":[""]}}],"_postman_id":"d39db4bf-6504-4f53-b55d-a86c63c52a84"}],"id":"3a933b20-94cc-4ed0-9d0f-c1091ffe4ca5","description":"The filter's module objective, is to decouple common query requests. Instead of each service supporting the common queries, these queries are decoupled in this filter module.
\nCommon Queries include get a list (i.e. a result set) of:
\n- \n
- active employees \n
- employee's due to leave \n
- employee's recently joined \n
- employee's due to join in the near future \n
- employee's appointments (typically the employees Job) \n
Use these filers to query for employees under above headings, and then use the result set to feed other services.
\nPagination and Limits
\nThese filters allow for larger than normal pagesizes. For example, typically the pagesize (i.e. the result set) is 100 results, however you can now set the pagesize to 10,000 (this is a max value). Therefore if you have 10,000 employees you can make one request, if you have more than 10,000 active employees, the filter will provide the first 10,000 and provide a reference link for the next 10,000.
\nDo not set the pagesize above 10,000, if you do, only 100 results will be returned. The web services framework will always revert back to the default (i.e. 100) if the max value has been breached.
\nAny instances where more than pagesize exist, e.g. (a pagesize of 100 is used, and 1,000 records exist) the response body will include a link array with additonal links for pagination.
\nEach GET request includes following
\n- \n
- limit \n
represents the maximum number of records returned in one request e.g. 100 (or whatever the pagesize is)
\n- \n
- offsetby \n
represents pagination, the first request will always have an offsetby 0 i.e. the start. Where more than the limit exists offsetby controls the starting position, typically in batches of 100. Each GET request can accept the offsetby parameter.
\n- \n
- count \n
the number of records for this reponse, the maximum count will equal the limit parameter i.e. 100.
\n- \n
- hasMore \n
a boolean representation indicating if more records exist.
\n- \n
- links \n
includes links to first and next. The next link is used when pagination is discovered i.e. more than the limit per request.
\n","event":[{"listen":"prerequest","script":{"id":"867f1f76-3f87-4d80-ae2c-a13b56555047","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2be39299-a7dd-4daf-ba44-305d6ea9fe7d","type":"text/javascript","exec":[""]}}],"_postman_id":"3a933b20-94cc-4ed0-9d0f-c1091ffe4ca5"},{"name":"Person","item":[{"name":"address","item":[{"name":"home","item":[{"name":"/person/address/home/:personnelNo","id":"b22f6822-e60d-47a4-91f4-d4eafd483505","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/home/5990404","description":"This service simply returns the home address for an individual.
\nHome address's have effective dates and have the concept of being active, the current effective and active home address is returned.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","address","home","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"de4e1554-605d-4ba7-8578-4861c8b43447","name":"Home Address","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/home/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 17:46:29 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"LHgoPsSqJ5Zp8UqBgh5MgVJG1HOKKCBfPREAx0YMiAa1XGYZQFGCugkHcVG78YpKDshSr27rdW7q+8qo0Xaa1Q==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0000c169","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"line1\":\"01 Sherringham Avenue\",\"line2\":\"Westmore\",\"line3\":\"Windsor\",\"line4\":\"Tottenham\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N17\",\"postCodeSuffix\":\"9XJ\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/address/home/5990404\"\n }\n ]\n}\n"}],"_postman_id":"b22f6822-e60d-47a4-91f4-d4eafd483505"}],"id":"ad42b11d-8ebf-4608-a83e-3788543b21f5","description":"This service simply returns the home address for an individual.
\n","event":[{"listen":"prerequest","script":{"id":"13f44fb6-3644-43f1-8539-188f9eea14f7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a2e2e134-0c18-4141-aca4-c7c0e252e263","type":"text/javascript","exec":[""]}}],"_postman_id":"ad42b11d-8ebf-4608-a83e-3788543b21f5"},{"name":"nextOfKin","item":[{"name":"/person/address/nextofkin/:personnelNo","id":"0800b457-a2c8-4b5d-ab91-efc019fe16e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/nextofkin/5990404","description":"This service simply returns the next of kin address for an individual.
\nNext of Kin address's have effective dates and have the concept of being active, the current effective and active Next of Kin address is returned.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","address","nextofkin","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0ef3d830-4ba3-4a86-ad83-ec7e595f3ec5","name":"Next Of Kin Address","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/nextofkin/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 17:47:03 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"GH0Ws6A72ZRA9hGnM/hkQzulABHsxNo+6L4wYBM7/01GxS47hp98GWrAUk1Z3T0UyQgnPFcoFtJlDKvttTJzwQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=99","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0000c1be","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"line1\":\"01 Windsor Street\",\"line2\":\"East Bridge\",\"line3\":\"Kings Avenue\",\"line4\":\"Windsor\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N18\",\"postCodeSuffix\":\"8ZJ\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/address/nextofkin/5990404\"\n }\n ]\n}\n"}],"_postman_id":"0800b457-a2c8-4b5d-ab91-efc019fe16e8"}],"id":"87caf662-165a-43e8-94ef-a1099e32719a","description":"This service simply returns the next of kin address for an individual.
\n","event":[{"listen":"prerequest","script":{"id":"c8571320-f5af-44fd-b6a8-ce3604a6bf1f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2a9e756b-8925-4668-acaf-0209f9c14c5e","type":"text/javascript","exec":[""]}}],"_postman_id":"87caf662-165a-43e8-94ef-a1099e32719a"},{"name":"work ","item":[{"name":"/person/address/work/:personnelNo","id":"083a0499-27b2-4fb7-90e9-acd025b1770c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/work/5990404","description":"This service simply returns the work address for an individual.
\nWork address's have effective dates and have the concept of being active, the current effective and active work address is returned.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","address","work","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b8b62b9c-6ee2-4cde-b3bb-706eac799f75","name":"Work Address","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/work/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 17:50:18 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"BfvMfrRK99guHS+1Cxo2GDYQj7LsqayBrWRnoH+84jV80kgOOa38STTJaL7oNDTYQNuu9qlKrJPfMDqZZfKWeg==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0000c393","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"line1\":\"100 Fleetmore Street\",\"line2\":\"West Kings State\",\"line3\":\"Queens Avenue\",\"line4\":\"Windsor\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N17\",\"postCodeSuffix\":\"9SD\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/address/work/5990404\"\n }\n ]\n}\n"}],"_postman_id":"083a0499-27b2-4fb7-90e9-acd025b1770c"}],"id":"f1e09a47-bbe1-45e5-bf5f-ba8e8ad519a7","description":"This service simply returns the work address for an individual. The address type of 'work' is not deafult address type as part of CoreHR. However, this address type is often created by system Administrators. For this web service to return an Address, the address type must be 'WORK'.
\n","event":[{"listen":"prerequest","script":{"id":"aaa944bb-d23a-4b17-934b-a3c94d9dae0f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"19992f97-2a88-472a-a38f-0d2fa7320b2d","type":"text/javascript","exec":[""]}}],"_postman_id":"f1e09a47-bbe1-45e5-bf5f-ba8e8ad519a7"},{"name":"all","item":[{"name":"/person/address/all/:personnelNo","id":"c1686ac0-f128-48b2-8e44-510c42b44ad9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/all/5990404","description":"This service returns all active addresses for an individual currently ineffective. This includes home, next of kin and other address.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","address","all","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0fff4fe9-79e3-40d0-8275-c42a4d1a9970","name":"All Addresses","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/all/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 17:54:13 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"whBYl/hO41707uWg37s7brO+oRGWKVUVCArWwHkfSzyVWhRscn+I6GNpgMHTDembglIL4AUg8sl4ShdOw6gEhQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0000c5f8","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"WORK\",\"line1\":\"100 Fleetmore Street\",\"line2\":\"West Kings State\",\"line3\":\"Queens Avenue\",\"line4\":\"Windsor\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N17\",\"postCodeSuffix\":\"9SD\"}\n,\n{\"type\":\"home\",\"line1\":\"01 Sherringham Avenue\",\"line2\":\"Westmore\",\"line3\":\"Windsor\",\"line4\":\"Tottenham\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N17\",\"postCodeSuffix\":\"9XJ\"}\n,\n{\"type\":\"nextOfKin\",\"line1\":\"01 Windsor Street\",\"line2\":\"East Bridge\",\"line3\":\"Kings Avenue\",\"line4\":\"Windsor\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N18\",\"postCodeSuffix\":\"8ZJ\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 3,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/address/all/5990404\"\n }\n ]\n}\n"}],"_postman_id":"c1686ac0-f128-48b2-8e44-510c42b44ad9"}],"id":"f4192cba-2f5f-4ecf-9797-403efbf2202d","description":"Use this service for all addresses associated with an individual. A tenant has the ability to create several additional address types. This service will return a result set of additional addresses i.e. all addresses associated with the individual including Home and NextOfKin.
\nTo determine descriptions for these additional address type, one can use the reference module.
\nIf a web service app has access to the reference module, and your administrator has whitelisted the reference type ADDTYP the app can query the reference module using the type ADDTYP. These additional other address types are best explained by the HR administrators of the CoreHR application.
The address module's objective is to determine individual's addresses. CoreHR provides a complete and detailed module for defining different types of addresses. Individual's may have several different addresses, typically referred to as address types e.g. home, business, next of kin, overseas etc. Not all personnel will have each of these address types. Assigning addresses to each person is a matter for each tenant. The CoreHR app also faciliates tenants adding various additional addresses.
\nIn general, use cases for these services include obtaining:
\n- \n
- an individual's home address \n
- an individual's next of kin address \n
- an individual's work address \n
- other address types associated with an individual \n
This module has been split into different easy to use scenarios:
\n- \n
- Home Address \n
- Next of Kin \n
- Work \n
- All \n
Home and Next of Kin addresses are simple and explicit. While others are slightly more completex. If the requirement is home address simply use the home address service, and for next of kin use next of kin service. For Other address types refer to the all address service below. Work address has been added as it's a typical use case, however, work address may or may not be in use.
\nAddress Templating
\nThis service does not implement address templating. Address type templating is a higher level display facility, providing options around the order of how to display an address e.g. display address line 3 before address line 1. Instead, the address is displayed in order 1 through 5.
\nParameters
\nEach of the address web services use the following parameters:
\n- \n
- personnelNo \n
Manadatory
\nType: AlphaNumeric
\nMax Length : 12
\n","event":[{"listen":"prerequest","script":{"id":"ce9c2773-4d46-44b4-b091-44385ce9cdf1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a8ac244e-e24e-44cc-ae6b-4afda0d85d6a","type":"text/javascript","exec":[""]}}],"_postman_id":"b762f636-c81b-4bb1-83c6-6bfd6d638105"},{"name":"allowances","item":[{"name":"/person/allowances/paid/currentperiod/:personnelNo","id":"f0c23924-c70d-4add-a6b6-1f520d3b5bab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/allowances/paid/currentperiod/4956040","description":"The specific end point will provide allowances that have been processed for the employee's most recent period that has been completed i.e. from the employees most recent payslip that has been completed for the employees pay group.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
appointmenId
\nA unique reference identifier for the appointment, this is a system generated identifier.
\n \npayCode
\n \n
Represents the actual payCode used to process this item.
\n- \n
- payCodeDescription \n
This attribute represents a free text description associated with the paycode.
\n- \n
- analysisCode \n
Represents the associated anylsis code associated with the paycode. Analysis codes are used to represent a distinction or grouping of payCodes and are typically used for reporting and grouping purposes.
\n- \n
- analysisCodeDescription \n
This attribute represents a free text description associated with the analysisCode.
\n- \n
- value \n
This represents the amount on the employee's payslip, in most cases the allowances will be a positive amount, but there can be cases where this amount will be negative.
\n- \n
- payrollPeriod \n
This attribute represents the payroll period that the allowance included. This should represent the payroll period associated with the employees pay group that is marked as 'Completed Update'.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","allowances","paid","currentperiod","4956040"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"edbc0f38-d3d0-4f4d-a059-80e773ead388","name":"success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/allowances/paid/currentperiod/4956040"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 02 Nov 2018 15:37:02 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;"},{"key":"X-ORACLE-DMS-ECID","value":"fc0eaafe-cec9-418c-9c67-dd411ddfe4e1-00171402"},{"key":"ETag","value":"\"CzWVSoBAGGzx6TAhnBF94Nn1BjnGS+22nCwEWwo0RBzizYGZmXu8kL2iCZVsL8TsMa63EWIkj4bHVKIOfuE7XQ==-gzip\""},{"key":"X-ORACLE-DMS-RID","value":"0"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate"},{"key":"Access-Control-Max-Age","value":"600"},{"key":"Access-Control-Allow-Methods-Age","value":"GET, POST, PATCH, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-CSRF, X-REQUESTED-WITH, CONTENT-TYPE, X-COREHR-PROXY-AS, X-COREHR-DEBUG, AUTHORIZATION,X-COREHR-INTEGRITY"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"2001\",\n \"payCodeDescription\": \"OVERTIME @ 1.00\",\n \"analysisCode\": \"2000\",\n \"analysisCodeDescription\": \"OVERTIME\",\n \"value\": \"147.2\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"6017\",\n \"payCodeDescription\": \"USC\",\n \"analysisCode\": \"6000\",\n \"analysisCodeDescription\": \"STATUTORY DEDUCTIONS\",\n \"value\": \"-327.4\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"9500\",\n \"payCodeDescription\": \"EMPLOYER PRSI\",\n \"analysisCode\": \"9000\",\n \"analysisCodeDescription\": \"EMPLOYER NI\",\n \"value\": \"-.74\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"6500\",\n \"payCodeDescription\": \"EMPLOYEE PRSI\",\n \"analysisCode\": \"6000\",\n \"analysisCodeDescription\": \"STATUTORY DEDUCTIONS\",\n \"value\": \"0\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"6000\",\n \"payCodeDescription\": \"PAYE\",\n \"analysisCode\": \"6000\",\n \"analysisCodeDescription\": \"STATUTORY DEDUCTIONS\",\n \"value\": \"-1862.48\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"625\",\n \"payCodeDescription\": \"ADVANCE MISC\",\n \"analysisCode\": \"7000\",\n \"analysisCodeDescription\": \"VOLUNTARY DEDUCTIONS\",\n \"value\": \"-74.34\"\n }\n ],\n \"limit\": 100,\n \"offsetby\": 0,\n \"count\": 6,\n \"hasMore\": false,\n \"links\": [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/allowances/paid/currentperiod/4956040\"\n }\n ]\n}"}],"_postman_id":"f0c23924-c70d-4add-a6b6-1f520d3b5bab"}],"id":"af8ec75b-2415-49ae-9b80-a7cc585b6f36","description":"This module has only been made available from CoreHR 26.0.6 and is not available in older versions.
\nThe allowance module deals with providing allowance information associated with an employee. At this time the module only deals with allowances that have been paid, and is not aware of future allowances.
\n","event":[{"listen":"prerequest","script":{"id":"a96caf6c-ea79-449d-a12d-456227d04c06","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9d0418f3-c47a-4720-b159-df3bd8d9fe6f","type":"text/javascript","exec":[""]}}],"_postman_id":"af8ec75b-2415-49ae-9b80-a7cc585b6f36"},{"name":"appointment","item":[{"name":"/person/appointment/:personnelNo","id":"1afa81ec-9ef4-4bf9-a758-5bae35fc26a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/appointment/5990404","description":"This service returns an individuals appointment related information. An appointment has various different descriptions including Contract, Post, Job, Position etc. Individuals may have more than one appointment at any given moment, though typically an individual will hold one appointment at any one time.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
appointmenId
\nA unique reference identifier for the appointment, this is a system generated identifier.
\n \nappointmentStatus - following explains the details:
\n \n
- \n
\nPL(Planned) - When a new appointment is created it will have the status of PL. This is like a placeholder appointment. You can enter planned details like the planned contract dates. No person is linked to the appointment at this stage. As such for this service you should never see this status. \n
\nAU(Authorised) - When the post administrator authorises a planned appointment, the appointment status changes to AU. This is a placeholder appointment that has been authorised. No person is linked to the appointment at this stage. As such for this service you should never see this status. \n
\nRE(Recruitment in Progress) - If the recruitment module is in use, you can optionally link an authorised appointment to an open vacancy. The appointment status changes to RE. A person gets linked to the appointment via the recruitment module when they are offered and accept a vacancy offer. \n
\nAP(Appointed) - The appointment status changes to AP when an employee new or existing is appointed to the appointment. Further contract details can be entered at this stage. It is usually indicative of a person accepting the contract but has not yet started it. The post can be configured that when you link an employee to the appointment that this stage is bypassed and the status goes straight to commenced. \n
\nCOCommenced - The person has started on the appointment. A salary record is generated. For new starters they cannot be brought on to payroll until they are commenced. This should be the most common status encountered. \n
\nCFCommenced Future - The person is commencing the appointment at a future date. The status reverts to CO when the start date of the appointment becomes effective. \n
\nENEnded - The appointment has been ended because the person has left the organisation or has started in a new appointment. \n
- \n
- category \n
Categorises appointments based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The appointment start date.
\n- \n
- endDate \n
The appointment start date.
\n- \n
- lastAmendedDate \n
(requires v27.0.3)
\nThis date indicated a changed has been made to the appointment.
\n- \n
- targetEndDate \n
The appointment target end date.
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
contractId
\nprovides ability to set a contract identifier and associate with the appiointment.
\n \njobTitle
\n \n
The title of the apponitment ad used to describe the name of the position.
\n- \n
- jobCategory \n
This is an appointment level field used to categorise job titles into groups of similar job titles. For associated descriptions use the Reference Module with the reference type JOBCAT.
- \n
- postNumber \n
the is the post profile number from which the appointmnet is based on. A post is essentially a blue print for the appointments.
\n- \n
- primaryFlag \n
this attribute will simply indicate if the appointment is the \"Substantive\" appointment as of today, this is an employees primary appointment.
\n- \n
- project \n
this attribute is populated when the appointment is associated with a project
\n- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
This service provides the ability to obtain an employees list of appointments, an employee can have more than one appointment. All appointments are returned, however each individual movement is not returned. The most recent detail associated with the appointment is returned.
\nAn appointment has various different descriptions including Contract, Post, Job, Position etc. Individuals may have more than one appointment at any given moment, though typically an individual will hold one appointment at any one time.
\nExample
\nOn 1st Jan 2018, employee Marco is a software engineer and his appoointment has a cost centre 100.
\nAppointment - 001
\nTitle - Software Engineer
\nCost Centre - 100
\nAll requests for Marcos appointment will return one appointmnet for Marco with a cost of 100.
\nOn 10th July 2018, management decide to move all engineering to a new cost centre 200, this is called a movement i.e. some change of attribute associated with Marco's appointment. In this case the change relates to a cost centre.
\nAppointment - 001
\nTitle - Software Engineer
\nCost Centre - 200
\nAll requests (from 10th July 2018) for Marcos appointment will return one appointment for Marco with a cost of 200.
\n","event":[{"listen":"prerequest","script":{"id":"55a63e07-159b-4426-8102-5b829da55ec0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3f29a3ec-ba77-409f-91ff-62712a851950","type":"text/javascript","exec":[""]}}],"_postman_id":"7106f0f0-0bd6-4b59-8b33-052da49828a9"},{"name":"bank","item":[{"name":"/person/bank/:personnelNo","id":"ac8622dd-1c1a-4045-9e9f-ce4f711eb092","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/bank/5990404","description":"Provides an employees bank account details both Salary and Expense. In addition the building society number is also available form this web service.
\nNB - relates to tenants implementing HR, no special consideration has been provided to Payroll Only Special tenants.
\nTenant's implement different approaches to storing an individual's bank account detail. This service provides both traditional sort code / bank account code's and the newer BIC and IBAN.
\nNo conversion process takes place, instead the information held in CoreHR is displayed i.e. if the tenant has not provided BIC and IBAN for an individual, the expectation for this service is not to display same.
\n- \n
- personnelNo \n
this is manadatory, at a minimum this parameter must be provided.
\nReturns following information for both Salary and Expense:
\n- \n
- Sort Code \n
An individual's traditional Bank Branch identification. This is left padded with 0's for values less than 6 characters. (requires v27.0.8 for the left padding).
\n- \n
- Bank Account Number \n
An individual's traditional Bank Account Number. This is left padded with 0's for values less than 8 characters (requires v27.0.8 for the left padding).
\n- \n
- BIC \n
An individual's Bank Identification code
\n- \n
- IBAN \n
An individual's International Bank Account Number
\n- \n
- Building Society Reference \n
An individual's building society reference number
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","bank","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"54f3bdb5-75cd-4dd9-a38b-6362379137f8","name":"Salary and Expense","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/bank/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 05 Apr 2018 14:24:56 GMT","name":"Date","description":""},{"key":"ETag","value":"\"kPah9YnLuQejW3/UQrmaws6hdxEb5O4JN3azU8xWPt3TOpcq+1RDvvJdvW8ILk19RiBm3x/Ypr/sHf/UhfyiiQ==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"d99bff8e-c042-4720-8fb9-2dea429dc7ce-0001db16","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"accounts\" : [\n{\"type\":\"salary\",\"bankSortCode\":\"902813\",\"bankAccountNumber\":\"12345678\",\"bic\":\"AIBKIE2DXXX\",\"iBan\":\"IE49AIBK93015612345678\"}\n,\n{\"type\":\"expense\",\"bankSortCode\":\"912314\",\"bankAccountNumber\":\"87235622\",\"bic\":\"AIBKIE2DXXX\",\"iBan\":\"IE49AIBK93015612345678\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 2,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/bank/5990404\"\n }\n ]\n}\n"}],"_postman_id":"ac8622dd-1c1a-4045-9e9f-ce4f711eb092"}],"id":"605a81a3-971d-4b3b-a268-4abc42efdb7c","description":"A simply service to retrieve an individuals bank account details.
\nAn individual may have more than one bank account, e.g. one for Salary payments and another for Expense. These account details maybe the same or different.
\nThis service caters for both Salary and Expense bank accounts.
\n","event":[{"listen":"prerequest","script":{"id":"2916e4c0-b3de-4767-9816-ef62123fae04","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d110070d-c249-4cd9-9558-940ff2073595","type":"text/javascript","exec":[""]}}],"_postman_id":"605a81a3-971d-4b3b-a268-4abc42efdb7c"},{"name":"basicAttributes","item":[{"name":"/person/basicattributes/:personnelNo","id":"5bc343bb-ad4d-4fab-af0a-deae4007670a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/","description":"This module returns some of the employee's most basic attributes, however, certain basic attributes are not include in this service for privacy reasons e.g. Social Security Number (SSN). To obtain SSN a separate service is available. The person module typically accepts only personnelNo. Use the filter module to obtain a result sets for various employees status e.g. recently joined, left , active etc.
Most of these attributes are provied by the tenant, the descriptions may not exactly match with the value provided. For example: A field exists known as \"Home Telephone Number\" a tenant may use this for a Landline Number, a personal business number, a mobile number etc.
\nNB No confirmation takes place on the personnelNo, if an incorrect personnelNo is presented the service will simply respond with no data.
\nFollowing attributes are returned:
\nGeneral
\n- \n
- First Name \n
Indicates a persons first name.
\n- \n
- Middle Name \n
Indicates a persons middle name.
\n- \n
- Last Name \n
Indicates a persons middle name.
\n- \n
- Previous Surname \n
Indicates a persons previous surname.
\n- \n
- Known As \n
Sometimes a person is known as a slightly different name that first, last or middle name. This field represents such sceanrios.
\n- \n
- Title \n
Indicates the persons full title description.
\n- \n
- Active \n
Simply indicates Y or N, answering the question at this point in time ( i.e. when the serice is called) \"Is Person Currently active?\". In cases where an individual has a leaving date on the same date the service is executed i.e. today the individual is considered active and will have a value of 'Y'.
\n- \n
- OnBoarding Completed \n
This attribute will be flagged as 'Y' indicating individual has completed their onboarding process, otherwise this will be flagged as 'N'.
\n- \n
- Next of Kin Name \n
The name in CoreHR provided for the individual's next of kin.
\n- \n
- Next of Kin Relationship \n
The name in CoreHR provided for the individual's next of kin relationship.
\n- \n
- Next of Kin Contact Number \n
The contact number associated with the next of kin.
\n- \n
- Home Telephone Number \n
An individuals home telephone number, the area code is included in this field.
\n- \n
- salaryPayMethod \n
Represents the method of payment for one's salary. This is a code e.g 'PP', to obtain the description use the reference module web service using a type of PAYM. Your system administrator will have to ensure this reference type is whitelisted.
NB To obtain Next of Kin Address use the address module.
\n- \n
- loginId \n
An individuals login identifier for self service and mobile applications. NB for SAML enabled sites this attribute will display N/A (SAML enabled site).
\nDates
\nAll dates are represented as : YYYYMMDD
\n- \n
- Date of Birth \n
An individuals date of birth formated
\n- \n
- Termination Date \n
Indicates an individuals most recent date for leaving. In cases where a person has left and rejoined and is flag to leave again this date will alsways be the most recent date for leaving. This may not be populated, this date can be in the futrue.
\n- \n
- Current start Date \n
An individuals most recent date started. This will cater for sceanrios where an individual has left and rejoined. It will always represent the current start date.
\n- \n
- Original Start Date \n
An individuals first time starting with an organisation. This can cater for scnearioes where an employee has left and rejoined. This date never changes, if an individual is currently active and has never left, this is the same date as Current Start Date. If this date is differnt to current start date, this typically means an individual has rejoined.
\n- \n
- Continuous Service Date \n
This date is used for calculating an individual length of service. Within the CorEHR engine this can be a complex process. This field represents the correct continuous service date, there should be no need to attempt to derive this date from the various other dates supplied.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","basicattributes",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3e2e5aaa-2dc7-48e5-ae05-fa0bdef6872f","name":"Mandatory Field Missing","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 22 Jun 2018 11:05:26 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"Xv9lRXYEJ7eVD2nC2gIUqerGRIFOD81+JnHtfOxPQgWOYt9i+LRFxXCLUSr7Xr8sssp6vyRHeKI0cUBgSxjMyg==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"30038f37-18e0-4c74-a73d-1ed97dac4bc1-001439db","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"This field is mandatory.\",\n \"code\": \"9001\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"},{"id":"697f6b09-5087-4837-985c-5e60b863215c","name":"Working Example","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 16:16:43 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"QozGpjQ/pokQfFuXCrLby9Kfov86tifSFSwitSSyqwRrHSB0VIhvBagWvIthkxz1i96lihX/dAAhFAsj+KzgJQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-000062cb","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"firstName\":\"Marco\",\"middleName\":\"Rufus\",\"lastName\":\"Donnini\",\"previousSurname\":\"Radinski\",\"knownAs\":\"Marco\",\"title\":\"Professor\",\"active\":\"Y\",\"onboardingCompleted\":\"N\",\"dateOfBirth\":\"19700101\",\"currentStartDate\":\"20180315\",\"terminationDate\":\"\",\"originalStartDate\":\"20170102\",\"continuousServiceDate\":\"20180315\",\"nextOfKinName\":\"Rufus Stravous\",\"nextOfKinContactNumber\":\"+44 765892350\",\"nextOfKinRelationship\":\"Partner\",\"salaryPayMethod\":\"PP\",\"homeTelehoneNumber\":\"4401892350\",\"loginId\":\"N/A (SAML enabled site)\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/basicattributes/5990404\"\n }\n ]\n}\n"},{"id":"960ac313-caa4-49c7-9922-17f271e142c2","name":"Validation Failed Wrong Field Length","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/1234567890123"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 22 Jun 2018 11:07:28 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"T2L98k5uY4oOIYGERPhm/fRFFPlBFj5IYfwnRplcyTaCuRCN5aZXRLqBxQjdHdbnstHQbumRWP7agQ3j8kc0FA==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"30038f37-18e0-4c74-a73d-1ed97dac4bc1-00143c86","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"The maximum length of this field is 12\",\n \"code\": \"9011\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"},{"id":"a5b37dfb-ece2-43bb-a1ba-6e63a614bcfb","name":"Validation Failed AlphaNumeric ","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/123!!"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 22 Jun 2018 11:06:40 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"RmAmWESpjPx1HQcC4yM3LakCm1+pazrdxEpor92H2/Bbgfn5+PkfVrR1SNs1fnfVhP7f+MscIk1F07yw1loGjw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"30038f37-18e0-4c74-a73d-1ed97dac4bc1-00143b6d","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"Alphanumeric characters only.\",\n \"code\": \"9002\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"}],"_postman_id":"5bc343bb-ad4d-4fab-af0a-deae4007670a"}],"id":"d1c390ac-9090-4c69-94c7-b32db3027283","description":"This section deals with an individuals most basic attributes e.g. name, title, date of birth etc. As CoreHR is a HR system, every field within the app could be argued to be included. Our objective is to provide services for use cases and not expose all fields in one monolithic web service. We also have to consider privacy and security e.g. not every third party service app requires Social Security Number or Bank Account Details etc. Hence, such fields are not included in the basicAttributes service, instead they are available via specific services.
\nYou might ask where are email, mobile numbers etc and why are they not provided here?
\nInstead they are provided via the Contact module (such detail is highly configurable)
Following attributes are provided as part of this basicAttribute module:
\nGeneral
\n- \n
- First Name \n
Indicates an individuals first name.
\n- \n
- Middle Name \n
Indicates an individuals middle name.
\n- \n
- Last Name \n
Indicates an individuals middle name.
\n- \n
- Known As \n
Sometimes a person is known as a slightly different name thatn their first, last or middle name. This field represents such scenarios.
\n- \n
- Title \n
Indicates an individuals full title description.
\n- \n
- Active \n
Simply indicates Y or N, answering the question at this point in time ( i.e. when the serice is called) Is Person Currently active?
\n- \n
- Onabording Completed \n
Simply indicates Y or N, representing if the individual has completed their onboarding.
\n- \n
- Next Of Kin \n
Information regarding the individuals next of kin.
\nDates
\nAll dates are represented as : YYYYMMDD
\n- \n
- Date of Birth \n
An individuals date of birth.
\n- \n
- Termination Date \n
Indicates an individuals most recent date for leaving. In cases where a person has left, and rejoined, and is flagged to leave again, this date will always represent the most recent date for leaving. This date field may not be populated, this date can be in the futrue.
\n- \n
- Current start Date \n
An individuals most recent date started. This will cater for scenarios where an individual has left and rejoined. It will always represent the current start date.
\n- \n
- Original Start Date \n
Represents an individuals first date, when they started Day Zero with an organisation. This can cater for scenarios where an employee has left and rejoined. This date never changes, if an individual is currently active and has never left, this is the same date as Current Start Date. If this date is different to current start date, typically suggests an individual has rejoined.
\n- \n
- Continuous Service Date \n
This date is used for calculating an individual length of service. Within the CoreHR engine this can be a complex process. This field represents the correct continuous service date, there should be no need to attempt to derive this date from the various other dates supplied.
\n","event":[{"listen":"prerequest","script":{"id":"768fc846-3703-4af3-a677-2c9498eb309c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6b1d93a0-7421-460c-9bfb-c6c41c00c48d","type":"text/javascript","exec":[""]}}],"_postman_id":"d1c390ac-9090-4c69-94c7-b32db3027283"},{"name":"costAllocation","item":[{"name":"/person/costallocation/:personnelNo","id":"3e3e1397-d5d3-4279-b924-333ae8bdfa4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/costallocation/5990404","description":"This service provides the ability to obtain an employees cost allocations, all cost allocations are returned both current and historic (dates are provided to distinguish open / closed allocations). Generally this service not return 100's of cost allocations, and therefore no special filters are created.
\nCost Alloactions can be defined at the employee or appointment level.This service is defined at the employee level, but will return appointment ID's where appropriate.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- costCentre \n
the cost centre, this code can be mapped to the reference module, using COST. This attribute should always be populated.
- \n
- percent \n
the percentage applied to this cost allocation. This attribute should always be populated.
\n- \n
- location \n
the location applied to this cost allocation, this code can be mapped to the reference module, using LOC
- \n
- project \n
the project applied to this cost allocation, this code can be mapped to the reference module, using PROJ
- \n
- expense \n
the expense applied to this cost allocation, this code can be mapped to the reference module, using EXPS
- \n
- allocationId \n
unique identifier for a cost allocation. Provides an ability to link directly back to the cost allocation. This attribute should always be populated.
\nExample:
\nAn employees salary is calculated and associated with three different cost centres, and query where the value at cost centre X comes from, the allocation ID (if present) can link back to the exact cost allocation that triggered it, e.g. 25% of costs to cost centre X.
\n- \n
- appointmentId \n
The appointment associated with this cost allocation
\n- \n
- startDate \n
the date this cost allocation comes into affect, format YYYYMMDD
\n- \n
- endDate \n
the date this cost allocation is no longer in effect, format YYYYMMDD
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","costallocation","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"010016cd-6ebc-48e3-b108-2cfafaaf56c6","name":"Success Cost Allocations","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/costallocation/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 02 May 2018 11:00:39 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"6XCcIUTnTS/FuB7jjB/DDFRD/fz8jTWUTGZDWvK6rZuE8/isin3lnJogmwcCAHD4IuCST8s+6cRPWCA2FDMbCw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"d99bff8e-c042-4720-8fb9-2dea429dc7ce-003c1ddc","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"attributes\" : [\n{\"costCentre\":\"BM40008\",\"startDate\":\"20170715\",\"endDate\":\"20170831\",\"percent\":\"100\",\"location\":\"\",\"allocationId\":2017071974748241,\"appointmentId\":\"502629-3\",\"expense\":\"40290\",\"project\":\"7\"}\n,\n{\"costCentre\":\"BM40008\",\"startDate\":\"20170711\",\"endDate\":\"20170714\",\"percent\":\"100\",\"location\":\"\",\"allocationId\":2017071974745300,\"appointmentId\":\"502629-1\",\"expense\":\"40290\",\"project\":\"7\"}\n,\n{\"costCentre\":\"BM40014\",\"startDate\":\"20170704\",\"endDate\":\"20170710\",\"percent\":\"50\",\"location\":\"\",\"allocationId\":2017071974745296,\"appointmentId\":\"502629-1\",\"expense\":\"40560\",\"project\":\"5\"}\n,\n{\"costCentre\":\"BM00000\",\"startDate\":\"20170704\",\"endDate\":\"20170710\",\"percent\":\"50\",\"location\":\"1\",\"allocationId\":2017071974745298,\"appointmentId\":\"502629-1\",\"expense\":\"40290\",\"project\":\"7\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 4,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/costallocation/5990404\"\n }\n ]\n}\n"}],"_postman_id":"3e3e1397-d5d3-4279-b924-333ae8bdfa4f"}],"id":"4b46a5fa-c842-451d-bf71-557a6243f24b","description":"This service provides the ability to obtain an employees cost allocations, all cost allocations are returned both current and historic (dates are provided to distinguish open / closed allocations). Generally this service not return 100's of cost allocations, and therefore no special filters are created.
\nCost Alloactions can be defined at the employee or appointment level.This service is defined at the employee level, but will return appointment ID's where appropriate.
\n","event":[{"listen":"prerequest","script":{"id":"e955a6b8-45e0-4a0b-8116-18664b7cad8c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3017f5a8-333f-43cd-b0c8-60ed611ca8bb","type":"text/javascript","exec":[""]}}],"_postman_id":"4b46a5fa-c842-451d-bf71-557a6243f24b"},{"name":"genderIdentity","item":[{"name":"/person/genderidentity/:personnelNo","id":"b22f91e3-d9e7-4605-9c74-bf574d1a75bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/genderidentity/5990404","description":"Provides an individuals legal sex and gender identification detail.
\n- \n
- personnelNo \n
this is manadatory, at a minimum this parameter must be provided.
\nReturns following attributes:
\n- \n
Legal Sex
\n \nGender Identity
\n \n
This is a gender identification code, for associated descriptions use the Reference Module with the reference type GNDRID.
This service provides information relating to an individual's gender identification.
\n","_postman_id":"0b2d28c4-47d1-4c5a-9ac6-0d995dc5be04"},{"name":"maritalstatus","item":[{"name":"/person/maritalstatus/:personnelNo","id":"32079e8d-bfb9-4494-90bc-47521b19139d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Provides an individuals Marital Status information.
\n- \n
- Marital Status Code \n
Provides an individuals martial status information.
\n- \n
- Marital Status Code \n
Provides an individuals nationality information.
\n- \n
- Nationality Code \n
Provides an individuals nationality information.
\n- \n
- Nationality Code \n
This is a very simple web service returning basic information for an individuals pension. All entries related to an employee pension will be returned including active and ended.
\nParameters
\n- \n
- personnelNo \n
Manadatory
\nType: AlphaNumeric
\nMax Length : 12
\nJSON Response Body Explained
\nAn array of all pension schemes associated with the individual is returned, the most recently joined pension scheme is returned first.
\n- \n
- schemeCode \n
A unique code associated with the pension scheme.
\n- \n
- appointmentID \n
this attribute is populated if the individual's pension scheme is associated with a particular appointment.
\n- \n
- dateEnd \n
indicates when the pension scheme ended for the individual, returned in format YYYYMMDD.
\n- \n
- dateJoined \n
indicates when the employee joined the pension scheme, returned in format YYYYMMDD
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","pension","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9e4644fb-957f-492d-ac1b-788f8b9e5073","name":"Pension Information","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/pension/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 28 Jun 2018 14:23:26 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"W5TPVaB+Aiz7z+FMBASz6aWxLjN19XWifM8GIKX9g1eWI9T7Qvo5y/XuEu4PwXTwb3XEpiy20o/FgtMMdrJRdQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0006b88a","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"schemeCode\":16,\"dateJoined\":\"20170601\",\"dateEnd\":\"\",\"appointmentID\":\"DP0007-2077\"}\n,\n{\"schemeCode\":15,\"dateJoined\":\"20161022\",\"dateEnd\":\"20170901\",\"appointmentID\":\"SD88712-1\"}\n,\n{\"schemeCode\":16,\"dateJoined\":\"20151019\",\"dateEnd\":\"\",\"appointmentID\":\"FD4005-1\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 3,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/pension/5990404\"\n }\n ]\n}\n"},{"id":"a5f9c40d-3e30-4957-bb49-06b6146c873d","name":"Mandatory Data Missing","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/pension/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 28 Jun 2018 16:05:30 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"IIhsxH2Ji400+QeroRmFt6gc2g7b1QHixhZywWjc6NIWGfPAw4CjTnzhC2v+lA38covxOStmFbtsMyf36pPvsw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-00073eeb","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"This field is mandatory.\",\n \"code\": \"9001\",\n \"jsonKey\": \"personnelNo\",\n \"isWarning\": false\n}\n]}\n"}],"_postman_id":"101bc03f-6c9b-4049-a65b-cd424fb6fb80"}],"id":"fe369fc1-57f3-41d9-a4bc-f74ef69830a2","description":"This web service returns data related to an individual's pension.
\n","event":[{"listen":"prerequest","script":{"id":"70839c2a-7e05-4b47-9555-0cdcbf25cf26","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9585ef9e-6604-44bc-be53-f36ca1100999","type":"text/javascript","exec":[""]}}],"_postman_id":"fe369fc1-57f3-41d9-a4bc-f74ef69830a2"},{"name":"probation","item":[{"name":"/person/probation/:personnelNo","id":"5828fb79-c7fa-453d-adaa-44c5e8ac0060","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/probation/:personnelNo","description":"The following attributes are associated with an individual's probabtion detail. Not all attributes will be populated.
\nAll dates presented in 'YYYYMMDD' format.
\n- \n
- Date Complete \n
The probabtion completion date is the date which the individuals probstion is completed.
\n- \n
- Date Expires \n
The probation expiry date is the date which the individual's probation is due to expire.
\n- \n
- Date Review One \n
The probation review date is the first review date for the individuals probation.
\n- \n
- Date Review Two \n
This probation review date is the second review date for the individual's probation.
\n- \n
- Date Extension \n
This date represents the individual's probation extension where applicable.
\n- \n
- Extension Reason \n
The probation extension reason represents the reason for extending the persons probation. This is a reference related attribute, the associated desription is available from the reference module under the reference type PEXRSN. Note, in order to obtain the description your system administrator will be required to whitelist the reference type PEXRSN and granted the app approrpiate privileges.
This module provides an individual's probation detail.
\n","event":[{"listen":"prerequest","script":{"id":"ab353ade-0209-4af2-a4e6-192224b2ec49","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c945bd6c-26d9-4850-9216-8662ef365934","type":"text/javascript","exec":[""]}}],"_postman_id":"736a037e-44d8-4a33-b93a-4e51faf32f26"},{"name":"reportsTo","item":[{"name":"person/reportsto/:personnelNumber/:appointmentid?","id":"88b24c9b-2562-4049-8e8e-a4a50536b39d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/","description":"Parameters
\n- \n
- personnelNumber \n
This attribute is the personnelNumber of the individual to find their reportsTo / manager.
\nManadatory
\nType : AlphaNumeric
\nMax Length : 12
\n- \n
- appointmentId \n
This attribute can be any of the individuals appointmentId's. An individual is required to have at least one appointmentID and is often referred to as substantive / primary appointmentId.
\nOptional
\nType : AlphaNumeric
\n(this field is typically XXXXX-XX, even though it is flagged as alpha Numberic, the '-' (dash) is excluded from a validation perspective i.e. when validation / sanitisation is performed the dash is excluded)
\nMax Length : 16
\nJSON Response Body Explained
\n- \n
- reportsToPersonnelNumber \n
This attribute represents the individual's 'Report To Personnel Number', typically their manager / line manager / Supervisor etc. You can use this attribute as the personnelNumber for any other web service requesting personnelNumber. As such it is possible to obtain further information for the 'ReportsTo'.
\n- \n
- reportsToName \n
This attribute represents the individual's 'Report To Name' i.e. typically the name of their manager / line manager / Supervisor etc.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","reportsto","5990404",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0542c831-e4a6-4276-bcff-9ad8fafe9208","name":"Invalid AppointmentID Length","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/12345678901234567"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:39:34 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"2hERA1Oq6h48UWWRIfHmdaguVn33swa/4feFw1P/coF2t3J4ZczHKP+Kd64JweIz++0TdVUF4Bh+ni899eavNw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-00140659","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"The maximum length of this field is 16\",\n \"code\": \"9008\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"},{"id":"212f25af-dbd3-4615-889e-534b81613a84","name":"PersonnelNumber and AppointmentID","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/599014-25"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:21:14 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"31sy6J0QsiwFzAdrVi7qAyzs+hvz6E2rE/5kyizpDEhT65JmvEMorDrEovo3NLM/eYUCQmpmBAz06mwdCt2Yew==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-0013edca","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"reportsToPersonnelNumber\":\"5990181\",\"reportsToName\":\"Sasha Digweed\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/reportsto/5990404/599014-25\"\n }\n ]\n}\n"},{"id":"26092c85-73d7-4d62-99cb-845ead18a7d4","name":"PersonnelNumber Only","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 09:43:26 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"pZVLqJiJtJRnx3Q2SNnEn7mzHsEJE7h3AYFTFFddSSAABwOp+IfG7nt/RNZwkio5FpXtWJPuYQ8Vk8/lKfjWkw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-0013bc9c","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"reportsToPersonnelNumber\":\"5990181\",\"reportsToName\":\"Sasha Digweed\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/reportsto/5990404/\"\n }\n ]\n}\n"},{"id":"6c9b2ff5-090c-4d4d-aeb2-9472ffe79b88","name":"Invalid PersonnelNumber Length","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/1234567890123/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:37:19 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"U1TQYcXzLmuMBybM9sxQnH+pnJ45yfK9QyLZfZerGvSE8XpFYujUbMeaYutfoYGti5eB8XXY1L1Zsc/zuvTYJQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-00140369","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"The maximum length of this field is 12\",\n \"code\": \"9008\",\n \"jsonKey\": \"personnelNo\",\n \"isWarning\": false\n}\n]}\n"},{"id":"726440ae-78e0-42cd-b7c2-fc8fe3973878","name":"Invalid PersonnelNumber Type","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/12345678[]/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:36:25 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"l61gq8U/3Ddnb8zX5veO7cQVtiR39qcu0L0AUV3aYxGLsn2WfS2frH7+m+AsDD+dAiRYTAdNcYd29zRxkhBYKA==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-00140227","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"Alphanumeric characters only.\",\n \"code\": \"9002\",\n \"jsonKey\": \"personnelNo\",\n \"isWarning\": false\n}\n]}\n"},{"id":"af2d8f57-c765-40ab-9b3c-977663f40477","name":"Invalid AppointmentID Type","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/123!"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:40:29 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"RmAmWESpjPx1HQcC4yM3LakCm1+pazrdxEpor92H2/Bbgfn5+PkfVrR1SNs1fnfVhP7f+MscIk1F07yw1loGjw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-0014079d","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"Alphanumeric characters only.\",\n \"code\": \"9002\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"}],"_postman_id":"88b24c9b-2562-4049-8e8e-a4a50536b39d"}],"id":"f3903f09-8ee9-4c05-a6a9-135362db37ef","description":"This web service returns an individual's Reporting to manager / supervisor etc. It is a very simple web service, simply provide the personnel number and the individual's 'ReportTo' is returned. By only providing the personnelNumber, the individuals substantive (primary) appointment is used.
\nOptionally provide an appointment ID, this will then indicate to the service to return an individuals 'ReportTo' for the person and the specific appointment provided.
\nWith respect to the 'ReportsTo' effective date, in all cases this web service uses the current date i.e. the date the web service is called.
\n","_postman_id":"f3903f09-8ee9-4c05-a6a9-135362db37ef"},{"name":"salary","item":[{"name":"/person/salary/:personnelNo/:date?","id":"538dd291-0072-4ee8-9256-fb76cfa38a7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/salary/5990404/","description":"Provides an employees salary, has the ability to get an employees full salary history along with Salary for a specific date. It is therefore possible to determine current, full history or salary for a specfic date across all of an employees appointments.
\nParameters
\n- \n
- personnelNo \n
Manadatory
\nType: AlphaNumeric
\nMax Length : 12
\n- \n
- date \n
Optional
\nFormat : YYYYMMDD
\nWhen no date is provided, the service assumes current active salary details. When populated \n(note the date formatted must be YYYYMMDD) this will provide employees salary for the specfic date. While providing 0 indicates to the service to return a result set of employees entire salary history.
This module will provide salary detail for an individual. Salary information can be a complex topic, outlined explains in as simply terms as possible how an employees rate of pay is determined.
\nUses Cases determine
\n- \n
- an employee's current salary detail \n
- an employee's historical salary detail \n
- an employee's salary per appointment \n
- an employee's salary on a specific date \n
This salary module is aware of multi-appointments i.e. in cases where an individual has more than one active position (i.e. more than one appointment) two entries or more, will be included in the results set. In cases where only one position is associated with an employee only one entry will be returned.
\nEmployee's rates of pay can be based on various frequencies:
\n- \n
- Hourly \n
- Daily \n
- Weekly \n
- Annual \n
Not all attributes will be populated, the fields populated are dependent on how your system administrators have configured salary / pay details.
\nFollowing attributes are returned:
\n- \n
- annual \n
An annual salary rate, typically used for salary based employees. Each month this rate is divided by 12.
\n- \n
- weekly \n
A weekly based rate of pay.
\n- \n
- daily \n
A daily based rate of pay.
\n- \n
- hourly \n
An hourly based rate of pay.
\n- \n
- dateActive \n
The date when the rate(s) of pay are effective for employee. An employee can only have one set of active pay rates per appointment.
\n- \n
- dateExpire \n
The date when the rate(s) of pay have ended and are no longer active for employee. Useful when viewing historical rates of pay.
\n- \n
- multiplier \n
This is a number applied to the rate of pay, typically set to 1, indicating the individual is paid the (rate of pay * 1), often used in cases where employee is part time.
\n- \n
- annualised \n
The annual rate of pay, in cases where weekly rate is only provided, this figure presents an annual rate. In cases where the annual rate is defined, this annualised figure is the same value.
\n- \n
- actualPay \n
Takes the provided rate(s) of pay and applies the multiplier.
\n- \n
- actualAnnualisedPay \n
Takes the annualised figure and applies the multiplier.
\n- \n
- appointmentID \n
Employee's unique Job identifier, typically referred to as appointment ID. It is possible an individual has more than one Job/Appointment, if this is the case more the result set will reflect this.
\n- \n
- grade \n
This attribute reprsents an employee's salary grade, typically this represents one's Role / Job.
\n- \n
- point \n
This attribute represents a level within the Grade, sometimes termed Spine Point. In some cases this value can be '9999', this represents an individual has been assigned a personal point.
\n","event":[{"listen":"prerequest","script":{"id":"625cc7af-f7b7-453a-8f81-5d97de553579","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"26ff0e77-0de1-4438-8830-01e66ffa626b","type":"text/javascript","exec":[""]}}],"_postman_id":"c829e8e9-b377-48ca-938d-c8107db6b7ff"},{"name":"socialSecurityNumber","item":[{"name":"/person/socialsecuritynumber/:personnelNo","id":"756ce314-3194-46ec-a14b-4e5deda279d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/socialsecuritynumber/5990404","description":"Simply gets an individuals Social Security Number.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","socialsecuritynumber","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"1efee1cc-b9ab-4a98-9261-d21201dd6940","name":"All Salary History","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/salary/5990404/0"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 21 Mar 2018 17:58:04 GMT","name":"Date","description":""},{"key":"ETag","value":"\"hkaOE4XQSbYdfEu/G4B7X3hnwbEZbElMx/uzYF1NoEK/tWmjE8dhIE0XKrxzA2nxzOD+upOc7BFrs9bjOQsoyw==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"253df163-0e02-4479-b26d-f2eaa8228ccf-00011b92","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"salary\" : [\n{\"annual\":\"14448.25\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.1\",\"dateActive\":\"20130718\",\"dateExpire\":\"20160401\",\"multiplier\":\"1\",\"annualised\":\"14448.25\",\"actualPay\":\"14448.25\",\"actualAnnualisedPay\":\"14448.25\",\"appointmentID\":\"JXXXXX-4347\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20161211\",\"dateExpire\":\"20170107\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"OU0011-12458\"}\n,\n{\"annual\":\"14448.25\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.1\",\"dateActive\":\"20160402\",\"dateExpire\":\"20160923\",\"multiplier\":\".25641\",\"annualised\":\"14448.25\",\"actualPay\":\"3704.67578\",\"actualAnnualisedPay\":\"3704.67578\",\"appointmentID\":\"OU0011-2694\"}\n,\n{\"annual\":\"14448.25\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.1\",\"dateActive\":\"20160924\",\"dateExpire\":\"20160915\",\"multiplier\":\".25641\",\"annualised\":\"14448.25\",\"actualPay\":\"3704.67578\",\"actualAnnualisedPay\":\"3704.67578\",\"appointmentID\":\"OU0011-2694\"}\n,\n{\"annual\":\"14448.25\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.1\",\"dateActive\":\"20160916\",\"dateExpire\":\"20160922\",\"multiplier\":\".25641\",\"annualised\":\"14448.25\",\"actualPay\":\"3704.67578\",\"actualAnnualisedPay\":\"3704.67578\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15262.24\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.5\",\"dateActive\":\"20160923\",\"dateExpire\":\"20160924\",\"multiplier\":\".25641\",\"annualised\":\"15262.24\",\"actualPay\":\"3913.39096\",\"actualAnnualisedPay\":\"3913.39096\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"\",\"daily\":\"\",\"hourly\":\"\",\"dateActive\":\"20160925\",\"dateExpire\":\"20160925\",\"multiplier\":\".25641\",\"annualised\":\"15770.98\",\"actualPay\":\"4043.83698\",\"actualAnnualisedPay\":\"4043.83698\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"\",\"daily\":\"\",\"hourly\":\"\",\"dateActive\":\"20160926\",\"dateExpire\":\"20160930\",\"multiplier\":\".410256\",\"annualised\":\"15770.98\",\"actualPay\":\"6470.13917\",\"actualAnnualisedPay\":\"6470.13917\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20161001\",\"dateExpire\":\"20161029\",\"multiplier\":\".410256\",\"annualised\":\"15770.98\",\"actualPay\":\"6470.13917\",\"actualAnnualisedPay\":\"6470.13917\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20161030\",\"dateExpire\":\"20161210\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20170108\",\"dateExpire\":\"\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"TS0011-18339\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 11,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/salary/5990404/0\"\n }\n ]\n}\n"},{"id":"c82bbdce-54c8-4cc1-824c-f53fcd05ec9b","name":"Current Active Salary","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/salary/5990404/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 21 Mar 2018 17:57:37 GMT","name":"Date","description":""},{"key":"ETag","value":"\"FDsnzuXPBRCYJbbDVL2OyeQ9P2HxpYUXcZyf2t1OE5u8nKCRru6K48Y/V+cXg/9KPl/nUAaF7IDq1H8s3HEVSA==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"253df163-0e02-4479-b26d-f2eaa8228ccf-00011b68","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"salary\" : [\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20170108\",\"dateExpire\":\"\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"TS0011-18339\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/salary/5990404/\"\n }\n ]\n}\n"},{"id":"f93d4bd7-6c78-4520-a01e-9fe86629c3af","name":"Salary on Specific Date ","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/salary/5990404/20170101"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 21 Mar 2018 17:58:29 GMT","name":"Date","description":""},{"key":"ETag","value":"\"X8DO7XKppamdtc8NWRGV4/oL9G8Xqsj7zouGAbNqDV2Y9g4Wwdl3gRdBM3iciy40xCIPV9WwIQRbWiWwY0QFKg==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"253df163-0e02-4479-b26d-f2eaa8228ccf-00011bba","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"salary\" : [\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20161211\",\"dateExpire\":\"20170107\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"OU0011-12458\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/salary/5990404/20170101\"\n }\n ]\n}\n"}],"_postman_id":"756ce314-3194-46ec-a14b-4e5deda279d1"}],"id":"9d2359f7-fb2c-4775-9e0e-a75059e8115f","description":"An individuals National Social number e.g. Social Security Number.
\n","event":[{"listen":"prerequest","script":{"id":"336a0031-27a3-4e1e-b558-68d220a6bb7c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"730958fd-954c-4c2b-aa15-4e4339632ede","type":"text/javascript","exec":[""]}}],"_postman_id":"9d2359f7-fb2c-4775-9e0e-a75059e8115f"},{"name":"workpermit","item":[{"name":"/person/workpermit/:personnelNo","id":"05214fe1-6392-4ed2-848f-69964de93131","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/workpermit/5990404","description":"Provides an individuals work permit information.
\n- \n
Work Permit Number
\n \nWork Permit
\n \nDate Work Permit Issued
\n \nDate Work Permit Expires
\n \n
Provides an individuals work permit information.
\n- \n
Work Permit Number
\n \nWork Permit
\n \nDate Work Permit Issued
\n \nDate Work Permit Expires
\n \n
This person module is all about personnel associated with an organisation, typically employee's, though sometimes contractors.
\nAll personnel entities have a personnelNo. Each of these services will accept a personnelNo as an atttrbute. To obtain sets of personnelNo use the filter module. The person module is typically used to determine following detail regarind an organisations personnel:
- \n
- basic attributes (name, joined date etc.) \n
- address detail \n
- probation information \n
- work permit details \n
- bank Account information \n
- salary information \n
Separate services are defined for each of above, rather than one large service.
\nNB : as this module only accepts the primary identifer personnelNo the pagesize option has no affect.
Parameters
\npersonnelNo
\nMandatory: Yes
\nExpected Type: AlphaNumeric
\nLength Max : 12
\n","event":[{"listen":"prerequest","script":{"id":"9ad45a85-28fc-4571-91ea-59dbf08e9b73","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"83d5c06c-2c44-4fc0-bbdb-72948b478c10","type":"text/javascript","exec":[""]}}],"_postman_id":"81481731-deaf-42fc-bc23-db7650fa00e3"},{"name":"Organisation","item":[{"name":"structure","item":[{"name":"config","item":[{"name":"/organisation/structure/config","id":"d7a4fc5b-5cad-4c08-98a1-9893c7ae9c3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/organisation/structure/config","description":"Parameters
\nno parameters are required to call this service.
\nJSON Response Body Explained
\nAn array of organisational structures are returned.
\n- \n
- structureCode \n
A unique identifier associated with this specfic organisations hierarchy.
\n- \n
- hierarchyName \n
A description for this structure / hierarchy. The description will be defined by your HR Administration colleagues.
\n- \n
- level1Type .. level12Type \n
This is a list from 1 through 12. These will list the types for each of the levels of hierarchy, for example Level One might by Company, Level 2 might be Management unit etc. These levels will be based on Reference data and can be mapped back to the reference module. In general it it is possible to use this type and reference back to the reference module.
\n- \n
- hierarchyInd1 .. hierarchyInd12 \n
This is a list from 1 through 12. These attributes indicate if the corresponding level is part of a hierarchy rather than just part of the structure. Reference back to the Organisation Module description for an explaination of the Hierarchy v's Structure concept. The indicator is simply Y or N.
\n- \n
- label1 .. label12 \n
These are the descriptions associated with the level1 .. level12 type.
\n- \n
- displayMode1 .. displayMode12 \n
It is possible to configure the display description for each element. This mode can return one of the following CD (code description), DC (description code) and D (description).
\nFor example - \nif the displayMode is CD (code description) then the description would be\n\n1001 : Engineering \n\nthe code is 1001 while the description is Engineering\n- \n
- dateApplied \n
indicates the date the structure was made active.
\n- \n
- dateInput \n
this is the date the structure was first created.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","{{version}}","organisation","structure","config"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"30d6a230-5553-42cc-be52-e5e62e42d1c4","name":"Success 200","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/organisation/structure/config"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 18 Jun 2018 14:17:29 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"QdYOzMA/b7fLqDLuLuinGXapZCFy2sgKwURL3ZcmhlywvfNbIke+t0+o8zLlq3NRlMvneOeex5JqR1ExtMDm2g==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"30038f37-18e0-4c74-a73d-1ed97dac4bc1-0008576a","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"structure\" : [\n{\"structureCode\":\"7000\",\"hierarchyName\":\"Company 7000\",\"dateInput\":\"20170209\",\"dateApplied\":\"20170209\",\"level1Type\":\"ORGZ\",\"level2Type\":\"MGTU\",\"level3Type\":\"DEPT\",\"level4Type\":\"USER1\",\"level5Type\":\"DIV\",\"level6Type\":\"COST\",\"level7Type\":\"LOC\",\"level8Type\":\"WRKGRP\",\"level9Type\":\"\",\"level10Type\":\"\",\"level11Type\":\"\",\"level12Type\":\"\",\"label1\":\"Company\",\"label2\":\"Management Unit\",\"label3\":\"Department\",\"label4\":\"Team\",\"label5\":\"Division\",\"label6\":\"Cost Centre\",\"label7\":\"Location\",\"label8\":\"Work Group\",\"label9\":\"\",\"label10\":\"\",\"label11\":\"\",\"label12\":\"\",\"hierarchy1Ind\":\"Y\",\"hierarchy2Ind\":\"Y\",\"hierarchy3Ind\":\"Y\",\"hierarchy4Ind\":\"N\",\"hierarchy5Ind\":\"N\",\"hierarchy6Ind\":\"N\",\"hierarchy7Ind\":\"N\",\"hierarchy8Ind\":\"N\",\"hierarchy9Ind\":\"N\",\"hierarchy10Ind\":\"N\",\"hierarchy11Ind\":\"N\",\"hierarchy12Ind\":\"N\",\"displayMode1\":\"CD\",\"displayMode2\":\"CD\",\"displayMode3\":\"CD\",\"displayMode4\":\"CD\",\"displayMode5\":\"CD\",\"displayMode6\":\"CD\",\"displayMode7\":\"CD\",\"displayMode8\":\"CD\",\"displayMode9\":\"CD\",\"displayMode10\":\"CD\",\"displayMode11\":\"CD\",\"displayMode12\":\"CD\"}\n,\n{\"structureCode\":\"7001\",\"hierarchyName\":\"Company 7001\",\"dateInput\":\"20170209\",\"dateApplied\":\"20170209\",\"level1Type\":\"ORGZ\",\"level2Type\":\"MGTU\",\"level3Type\":\"DEPT\",\"level4Type\":\"USER1\",\"level5Type\":\"DIV\",\"level6Type\":\"COST\",\"level7Type\":\"LOC\",\"level8Type\":\"WRKGRP\",\"level9Type\":\"\",\"level10Type\":\"\",\"level11Type\":\"\",\"level12Type\":\"\",\"label1\":\"Company\",\"label2\":\"Management Unit\",\"label3\":\"Department\",\"label4\":\"Team\",\"label5\":\"Division\",\"label6\":\"Cost Centre\",\"label7\":\"Location\",\"label8\":\"Work Group\",\"label9\":\"\",\"label10\":\"\",\"label11\":\"\",\"label12\":\"\",\"hierarchy1Ind\":\"Y\",\"hierarchy2Ind\":\"Y\",\"hierarchy3Ind\":\"Y\",\"hierarchy4Ind\":\"N\",\"hierarchy5Ind\":\"N\",\"hierarchy6Ind\":\"N\",\"hierarchy7Ind\":\"N\",\"hierarchy8Ind\":\"N\",\"hierarchy9Ind\":\"N\",\"hierarchy10Ind\":\"N\",\"hierarchy11Ind\":\"N\",\"hierarchy12Ind\":\"N\",\"displayMode1\":\"CD\",\"displayMode2\":\"CD\",\"displayMode3\":\"CD\",\"displayMode4\":\"CD\",\"displayMode5\":\"CD\",\"displayMode6\":\"CD\",\"displayMode7\":\"CD\",\"displayMode8\":\"CD\",\"displayMode9\":\"CD\",\"displayMode10\":\"CD\",\"displayMode11\":\"CD\",\"displayMode12\":\"CD\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 2,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/organisation/settings\"\n }\n ]\n}\n"}],"_postman_id":"d7a4fc5b-5cad-4c08-98a1-9893c7ae9c3a"}],"id":"2e1c5f7a-5bad-4520-b8dc-b8e97898de66","description":"This web service returns the \"metadata\" / \"settings\" for a structure, describing how the structure is defined. This service does not return the actual data (see /organisation/data).
\n","event":[{"listen":"prerequest","script":{"id":"1ad3d0f8-ea5a-45f0-923c-3c5a402319a4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cbaf1cc7-a854-4352-aec7-e0e04d486bae","type":"text/javascript","exec":[""]}}],"_postman_id":"2e1c5f7a-5bad-4520-b8dc-b8e97898de66"},{"name":"nodes","item":[{"name":"/organisation/structure/nodes/:structureCode?","id":"a2072752-9ffb-495b-bdb3-d5c4255b1de0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/organisation/structure/nodes/7000","description":"This webservice is subject to pagination,and, therefore by default only 100 rows are returned, it is possible to set the pagesize up to a maximum of 5,000 if the use case is to reduce the number of requests and attempt to obtain all rows in one request.
\nParameters
\n- \n
- structureCode \n
A structure code is required to call this web service, use the /organisation/settings web service to get a list. Typically organisations will only have a few of these structure codes configured and usually this takes place during initial project implementation.
\nExpected Type: Alpha_Numeric
\nJSON Response Body Explained
\n- \n
- ID \n
A unique identifier associated with this specfic item, each item will have a unique ID.
\n- \n
- parentID \n
The parentID associated with the unique ID, each item will have a parentID. For the 'Root' the parent ID will be set to the structure code.
\n- \n
- nodeDepth \n
Each item has a depth associated with it, i.e. this is the level an item exists within the hierarchy. Starts at 1. For example all items with a nodeDepth of 1 should map directly to the number of structures defined, typically this is only a few, and nodeDepth's 2 and 3 will also only have a few, while the many nodeDepths from 4 will most likely exist.
\n- \n
- path \n
This attribute provides an easy to see path i.e. the hierarchy for the item, this defines each of the parents all the way up to root.
\nFor example: \nA path with 10:1:1000:1016\nindicates the current item has a nodeDepth 4 with the following hierarchy struture:\n - 10 \n - 1 \n - 1000 \n - 1016\nthe root would be 10 and the current item being 1016\n- \n
- description \n
This attributes describes the current item (not the entire path). The description may include both code and description, this is dependent on the displayMode as defined in the /organisation/settings. In cases where the code is to be included, the code and description will be ':'. There is no clue in this description as to the path or nodeDepth (unless of course HR administrations have defined in the description)
\nFor example:\n\n1001 : Engineering \n\nthe code is 1001 while the description is Engineering\nThis web service returns all the node data associated with a specific structure code. The /organisation/structure/config defines the configuration and associated hierarchy / structure of levels, while the /organisation/structure/nodes web service applies the configurtion settings and returns the node data associated with same, including ID, parentID and nodeDepthLevel etc.
\n","event":[{"listen":"prerequest","script":{"id":"c52f33fb-b6ef-4dbb-be38-1f82f048cc77","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"81b1b071-eeb1-4dc7-9df0-237f605ad43a","type":"text/javascript","exec":[""]}}],"_postman_id":"c9e548c6-ef8c-4d2c-afd6-b0943da912ea"}],"id":"9e23f372-d325-4b33-afb3-9f8ce37a77da","description":"This is just a grouping for all structure related elements, currently this is grouping only includes
\n- \n
- the structure configuration information \n
- the structure node information \n
An organisation will set up an organisational structure within CoreHR. This service will return an organisational structure.
\nFor Example:
\n- Company \n - Management Unit \n - Department \n - Cost Centre\nAs part of the organisational setup, an important concept exists Structure v's Hierarchy. A hierarchy is considered a subset of the previous level. For example from the above example, lets assume all are part of the hierarchy, this would mean:
\nFor a company, the available management units are mapped to a company, selecting a company means a specfic list of management units a valid to be selected, and selecting a management unit drives the departments that can be selected, once a department is selected only specific cost centres can then be selected. In other words the entire strucutre has a hierarchy link. CoreHR can support up to 12 levels of structure / hierarchy, the number of levels used is set by your HR administration colleagues.
\nThis hierearchy is completely configurable. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR.
\n","event":[{"listen":"prerequest","script":{"id":"4cabf899-e92b-42b8-8740-7342cbdf71ae","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dd6195b4-f0c7-46c2-9709-a8b48b59e33a","type":"text/javascript","exec":[""]}}],"_postman_id":"f1cdc433-f36f-4a51-ad9d-4d12d696553b"},{"name":"HESA","item":[{"name":"staffid","item":[{"name":"/hesa/staffid/:personnelNo","id":"91d3cd5b-023d-4f9d-9a22-3655157d931f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/hesa/staffid/9913681","description":"The specific end point will return an employee's HESA assigned staff ID. This staff ID is derived based on an algorithm that includes personnel number, year joined, institute ID an a check digit.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
staffid
\nA unique reference identifier for the appointment, this is a system generated identifier.
\n \n
The specific end point will return an employee's HESA assigned staff ID. This staff ID is derived based on an algorithm that includes personnel number, year joined, institute ID an a check digit.
\n","event":[{"listen":"prerequest","script":{"id":"b6ba0f73-4bb1-41bd-b908-18401a2cf4a3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4739d7e9-ef32-497b-8bf2-b5648920c711","type":"text/javascript","exec":[""]}}],"_postman_id":"ee5f0fe2-36b1-4642-b418-0858955fdefa"}],"id":"f07a74aa-c6b2-4fa4-8c08-fecb6f725df9","description":"This module has only been made available from CoreHR 26.0.6 and is not available in older versions.
\nHESA relates only to the higher education (HE) in the UK.
\n","event":[{"listen":"prerequest","script":{"id":"e450ca2a-77df-42de-830f-46cb33a355a4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cc22e9a8-0569-4ac9-bd9f-9b634dbdf7dd","type":"text/javascript","exec":[""]}}],"_postman_id":"f07a74aa-c6b2-4fa4-8c08-fecb6f725df9"}],"id":"551695a7-60db-4239-872a-b0e65bd3c38b","event":[{"listen":"prerequest","script":{"id":"9b89bfb6-0e31-47b2-8589-ac4d2f9ecbff","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"de4724dc-e70d-4b19-8e68-515e98080a8c","type":"text/javascript","exec":[""]}}],"_postman_id":"551695a7-60db-4239-872a-b0e65bd3c38b","description":""},{"name":"V26","item":[{"name":"Clocking","item":[{"name":"/clocking/user/","id":"cfefbda2-49d6-415f-86ed-8bf9f26f61e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"content-type","value":"application/json"},{"key":"Authorization","value":"Bearer LBmqAWEBeoLdkbwNkJwPUQ.."}],"body":{"mode":"raw","raw":"{\n\"person\" : \"\", \"badge_no\": \"4752066\", \n\"clock_date_time\" : \"2017-02-15 08:56 +00:00\",\n\"record_type\" : \"\", \n\"function_code\" : \"COST\", \n\"function_value\" : \"2\", \n\"device_id\" : \"D123456789-1234567\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/clocking/user/","description":"Create a new clocking record in the clocking module for subsequent transfer into CoreTime. On successful completion, users will have submitted a new clocking record which subject subsequent CoreTime validation will be transferred into CoreTime the next time the interface runs.
\nJSON Request Body Explained
\nperson
\nIs an CoreHR employee id also known as personnel number although it is alphanumeric.
badge_no
\nIs the badge number that the CoreHR employee uses. Badge must be valid and linked to a valid CoreHR employee for the clocking to interface into CoreTime.
\nclock_date_time
\nThe Date and Time that this particular clocking is for. Required to be in YYYY-MM-DD HH24:MI TZH:TZM format. Mandatory.
\nrecord_type
\nThe Transactional event associated with the clocking. Optional but if specified must be one of:
\n- \n
B0Undefined. \nB1In. \nB2Out. \nB3Business Absence. \n
function_code
\nOptional function code but if specified must be one of:
\n- \n
CALLIN\nUNSBRK\nSTD\nTNAIN\nCALLOT\nTNAOUT\nOVERTM\nCOST\n
function_value
\nOptional function_value relating to the above code.
\ndevice_id
\nOptional free text to describe the Device ID where the clocking was recorded e.g. Main Entrance Device.
\nMandatory
\n- \n
- Either person or badge_no - if both are provided then badge_no takes precedence. \n
- clock_date_time \n
The clocking module provides ability to insert Core Time clocking records for a CoreHR employee.
\nConstraints, Limitations, Mandatory and Validation
\nThe clocking module is designed to handle a large volume of data and so validation at the point of insertion is limited to all required fields being present and the data in them being of the correct format, length and precision. \nAs such duplicate records, expired badges, invalid personnel etc.. will be received by the clocking module provided all data is in the correct format and length. The validation process is completed by the Core Time Interface.
\nFields are as in the table below:
\nNote: Clock Date Time is mandatory and either Person or Badge No must also be provided.
\nInterface to CoreTime and Validation
\nThe validation process is completed at the point of interface to CoreTime. It is during this process that duplicates are rejected and CoreTime related validation is performed. Specifically:
\n- \n
- Person does not exist as CoreHR employee \n
- Badge does not exist or is not valid \n
- Record Type is valid \n
- Function Code is valid \n
- Duplicate Clocking - defined as where a clocking already exists in CoreTime for this person at the same date/time. \n
Error Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Both badge and person fields are not populated. One must be populated. \n
- 400 / 002 clock_date_time field is not populated. \n
- 400 / 003 clock_date_time field is not in the correct format. \n
- 404 / 004 Non standard database exception inserting this clocking. \n
- 404 / 005 record_type is invalid. Must be either empty, B0, B1, B2 or B3. \n
- 400 / 006 function_code is invalid. Must be either empty, CALLIN, UNSBRK, STD, TNAIN, CALLOT, TNAOUT, OVERTM or COST. \n
- 400 / 999 Basic sanitization error. Where a filed is not the correct data type or length or the data is deemed to be unsafe for recording within the system. Details of the fields failing sanitization are returned in the sanatizeError object in the Response. \n
Get a list of registered / whitelisted contacts. Tenant has an ability to define contacts available for creating / updating. A tenant may not allow all contacts to be updated or created, this base URI provides the list of valid contact types. In cases where server returns validation errors, refer to this list.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7f56940a-f45c-4a98-8485-623c99abe789","name":"200 - Response OK","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:00:52 GMT","name":"Date","description":""},{"key":"ETag","value":"\"uwlnRwLu1teq90JMcLw3B68+EOyVApqwZ0O87dUiP4G6rHtTNS14dRJz0YaKyE8k7RmWTnrUodwqt3OwuAMICA==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"EMAIL\", \"length\": 80, \"dataType\" : \"EMAIL\"}\n,\n{\"type\":\"MOBILE\", \"length\": 20, \"dataType\" : \"MOB\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 2,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/contact/\"\n }\n ]\n}\n"}],"_postman_id":"57196fa6-b702-4de1-9690-691ff6f079a5"},{"name":"/contact/:type/","id":"e8abb813-6f1b-4207-8290-69122f7ca824","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/EMAIL/","description":"Get a list of all users for a particular contact type. Typically used to get a list of all users email addresses.
This service will only return whitelisted contact types. A tenant may decide to only whitelist a subset of all contacts e.g. EMAIL is whitelisted while MOBILE is not. Only accounts where the contact type is populated are returned. To find accounts with missing contact information use the web service /contact/missing/:type
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","EMAIL",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"14eabcb0-41f5-4e08-b351-88e068506277","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/EMAIL/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 15 Nov 2016 19:46:57 GMT","name":"Date","description":""},{"key":"ETag","value":"\"6iQZlpyFhjCcA3IiwUAR9L8mLF0w4tdo6M6kmFN3AV+v32sX/fFbqqgk/bMg7pMmUv2y1+9/cnGbLcj57836dw==-gzip\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"coreHRId\":\"003676\", \"value\": \"webservices003676@corehr.com\"}\n,\n{\"coreHRId\":\"003674\", \"value\": \"webservices003674@corehr.com\"}\n,\n{\"coreHRId\":\"003332\", \"value\": \"webservices003332@corehr.com\"}\n,\n{\"coreHRId\":\"003333\", \"value\": \"webservices003333@corehr.com\"}\n,\n{\"coreHRId\":\"INT009\", \"value\": \"webservicesINT009@corehr.com\"}\n,\n{\"coreHRId\":\"INT010\", \"value\": \"webservicesINT010@corehr.com\"}\n,\n{\"coreHRId\":\"600100\", \"value\": \"webservices600100@corehr.com\"}\n,\n{\"coreHRId\":\"600101\", \"value\": \"webservices600101@corehr.com\"}\n,\n{\"coreHRId\":\"600102\", \"value\": \"webservices600102@corehr.com\"}\n,\n{\"coreHRId\":\"7777\", \"value\": \"webservices7777@corehr.com\"}\n,\n{\"coreHRId\":\"C876876\", \"value\": \"webservicesC876876@corehr.com\"}\n,\n{\"coreHRId\":\"003193\", \"value\": \"webservices003193@corehr.com\"}\n,\n{\"coreHRId\":\"003528\", \"value\": \"webservices003528@corehr.com\"}\n,\n{\"coreHRId\":\"gh1234\", \"value\": \"webservicesgh1234@corehr.com\"}\n,\n{\"coreHRId\":\"JG1234\", \"value\": \"webservicesJG1234@corehr.com\"}\n,\n{\"coreHRId\":\"002145\", \"value\": \"webservices002145@corehr.com\"}\n,\n{\"coreHRId\":\"002144\", \"value\": \"webservices002144@corehr.com\"}\n,\n{\"coreHRId\":\"002146\", \"value\": \"webservices002146@corehr.com\"}\n,\n{\"coreHRId\":\"000660\", \"value\": \"webservices000660@corehr.com\"}\n,\n{\"coreHRId\":\"002626\", \"value\": \"webservices002626@corehr.com\"}\n,\n{\"coreHRId\":\"000740\", \"value\": \"webservices000740@corehr.com\"}\n,\n{\"coreHRId\":\"000936\", \"value\": \"webservices000936@corehr.com\"}\n,\n{\"coreHRId\":\"000830\", \"value\": \"webservices000830@corehr.com\"}\n,\n{\"coreHRId\":\"000831\", \"value\": \"webservices000831@corehr.com\"}\n,\n{\"coreHRId\":\"000880\", \"value\": \"webservices000880@corehr.com\"}\n,\n{\"coreHRId\":\"1000491\", \"value\": \"webservices1000491@corehr.com\"}\n,\n{\"coreHRId\":\"000014\", \"value\": \"webservices000014@corehr.com\"}\n,\n{\"coreHRId\":\"000115\", \"value\": \"webservices000115@corehr.com\"}\n,\n{\"coreHRId\":\"000012\", \"value\": \"webservices000012@corehr.com\"}\n,\n{\"coreHRId\":\"000015\", \"value\": \"webservices000015@corehr.com\"}\n,\n{\"coreHRId\":\"000296\", \"value\": \"webservices000296@corehr.com\"}\n,\n{\"coreHRId\":\"000297\", \"value\": \"webservices000297@corehr.com\"}\n,\n{\"coreHRId\":\"000328\", \"value\": \"webservices000328@corehr.com\"}\n,\n{\"coreHRId\":\"000590\", \"value\": \"webservices000590@corehr.com\"}\n,\n{\"coreHRId\":\"000227\", \"value\": \"webservices000227@corehr.com\"}\n,\n{\"coreHRId\":\"001873\", \"value\": \"webservices001873@corehr.com\"}\n,\n{\"coreHRId\":\"000275\", \"value\": \"webservices000275@corehr.com\"}\n,\n{\"coreHRId\":\"CUT-001\", \"value\": \"webservicesCUT-001@corehr.com\"}\n,\n{\"coreHRId\":\"END-001\", \"value\": \"webservicesEND-001@corehr.com\"}\n,\n{\"coreHRId\":\"000286\", \"value\": \"webservices000286@corehr.com\"}\n,\n{\"coreHRId\":\"001987\", \"value\": \"webservices001987@corehr.com\"}\n,\n{\"coreHRId\":\"000180\", \"value\": \"webservices000180@corehr.com\"}\n,\n{\"coreHRId\":\"001993\", \"value\": \"webservices001993@corehr.com\"}\n,\n{\"coreHRId\":\"000598\", \"value\": \"webservices000598@corehr.com\"}\n,\n{\"coreHRId\":\"000601\", \"value\": \"webservices000601@corehr.com\"}\n,\n{\"coreHRId\":\"002037\", \"value\": \"webservices002037@corehr.com\"}\n,\n{\"coreHRId\":\"GH992\", \"value\": \"webservicesGH992@corehr.com\"}\n,\n{\"coreHRId\":\"000119\", \"value\": \"webservices000119@corehr.com\"}\n,\n{\"coreHRId\":\"000124\", \"value\": \"webservices000124@corehr.com\"}\n,\n{\"coreHRId\":\"000587\", \"value\": \"webservices000587@corehr.com\"}\n,\n{\"coreHRId\":\"000588\", \"value\": \"webservices000588@corehr.com\"}\n,\n{\"coreHRId\":\"000592\", \"value\": \"webservices000592@corehr.com\"}\n,\n{\"coreHRId\":\"000594\", \"value\": \"webservices000594@corehr.com\"}\n,\n{\"coreHRId\":\"002315\", \"value\": \"webservices002315@corehr.com\"}\n,\n{\"coreHRId\":\"000904\", \"value\": \"webservices000904@corehr.com\"}\n,\n{\"coreHRId\":\"002261\", \"value\": \"webservices002261@corehr.com\"}\n,\n{\"coreHRId\":\"002262\", \"value\": \"webservices002262@corehr.com\"}\n,\n{\"coreHRId\":\"CUT-012\", \"value\": \"webservicesCUT-012@corehr.com\"}\n,\n{\"coreHRId\":\"002248\", \"value\": \"webservices002248@corehr.com\"}\n,\n{\"coreHRId\":\"002249\", \"value\": \"webservices002249@corehr.com\"}\n,\n{\"coreHRId\":\"002250\", \"value\": \"webservices002250@corehr.com\"}\n,\n{\"coreHRId\":\"002367\", \"value\": \"webservices002367@corehr.com\"}\n,\n{\"coreHRId\":\"002368\", \"value\": \"webservices002368@corehr.com\"}\n,\n{\"coreHRId\":\"002369\", \"value\": \"webservices002369@corehr.com\"}\n,\n{\"coreHRId\":\"000826\", \"value\": \"webservices000826@corehr.com\"}\n,\n{\"coreHRId\":\"000897\", \"value\": \"webservices000897@corehr.com\"}\n,\n{\"coreHRId\":\"001128\", \"value\": \"webservices001128@corehr.com\"}\n,\n{\"coreHRId\":\"002629\", \"value\": \"webservices002629@corehr.com\"}\n,\n{\"coreHRId\":\"002697\", \"value\": \"webservices002697@corehr.com\"}\n,\n{\"coreHRId\":\"000934\", \"value\": \"webservices000934@corehr.com\"}\n,\n{\"coreHRId\":\"002624\", \"value\": \"webservices002624@corehr.com\"}\n,\n{\"coreHRId\":\"000290\", \"value\": \"webservices000290@corehr.com\"}\n,\n{\"coreHRId\":\"000837\", \"value\": \"webservices000837@corehr.com\"}\n,\n{\"coreHRId\":\"002444\", \"value\": \"webservices002444@corehr.com\"}\n,\n{\"coreHRId\":\"002685\", \"value\": \"webservices002685@corehr.com\"}\n,\n{\"coreHRId\":\"002227\", \"value\": \"webservices002227@corehr.com\"}\n,\n{\"coreHRId\":\"002169\", \"value\": \"webservices002169@corehr.com\"}\n,\n{\"coreHRId\":\"000849\", \"value\": \"webservices000849@corehr.com\"}\n,\n{\"coreHRId\":\"000808\", \"value\": \"webservices000808@corehr.com\"}\n,\n{\"coreHRId\":\"002091\", \"value\": \"webservices002091@corehr.com\"}\n,\n{\"coreHRId\":\"1010101010\", \"value\": \"webservices1010101010@corehr.com\"}\n,\n{\"coreHRId\":\"20202020\", \"value\": \"webservices20202020@corehr.com\"}\n,\n{\"coreHRId\":\"GM967\", \"value\": \"webservicesGM967@corehr.com\"}\n,\n{\"coreHRId\":\"GM969\", \"value\": \"webservicesGM969@corehr.com\"}\n,\n{\"coreHRId\":\"DB678\", \"value\": \"webservicesDB678@corehr.com\"}\n,\n{\"coreHRId\":\"002651\", \"value\": \"webservices002651@corehr.com\"}\n,\n{\"coreHRId\":\"gh23\", \"value\": \"webservicesgh23@corehr.com\"}\n,\n{\"coreHRId\":\"6633228\", \"value\": \"webservices6633228@corehr.com\"}\n,\n{\"coreHRId\":\"250\", \"value\": \"webservices250@corehr.com\"}\n,\n{\"coreHRId\":\"260\", \"value\": \"webservices260@corehr.com\"}\n,\n{\"coreHRId\":\"002705\", \"value\": \"webservices002705@corehr.com\"}\n,\n{\"coreHRId\":\"002103\", \"value\": \"webservices002103@corehr.com\"}\n,\n{\"coreHRId\":\"000950\", \"value\": \"webservices000950@corehr.com\"}\n,\n{\"coreHRId\":\"002756\", \"value\": \"webservices002756@corehr.com\"}\n,\n{\"coreHRId\":\"002652\", \"value\": \"webservices002652@corehr.com\"}\n,\n{\"coreHRId\":\"jg1234\", \"value\": \"webservicesjg1234@corehr.com\"}\n,\n{\"coreHRId\":\"DF5609\", \"value\": \"webservicesDF5609@corehr.com\"}\n,\n{\"coreHRId\":\"002289\", \"value\": \"webservices002289@corehr.com\"}\n,\n{\"coreHRId\":\"002727\", \"value\": \"webservices002727@corehr.com\"}\n,\n{\"coreHRId\":\"000179\", \"value\": \"webservices000179@corehr.com\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 100,\"hasMore\":true\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://localhost/ws/tenant/corehr/v1/contact/EMAIL/\"\n },\n {\n \"rel\": \"next\",\n \"href\": \"https://localhost/ws/tenant/corehr/v1/contact/EMAIL/?offsetby=100\"\n }\n ]\n}\n"},{"id":"815a205f-0934-4985-879f-e17f47301aa5","name":"404 - Invalid Contact type","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/MOB/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 15 Nov 2016 19:51:28 GMT","name":"Date","description":""},{"key":"ETag","value":"\"WIZPZbpKwxRRgssW8lwH34floeFnPJzhb0Pc1fxiiWRv2Gqy41LgVu19up1qzvTBBMK6i635jWpyDaAsi5TVnQ==-gzip\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"002\",\"errorMessage\" :\"Validation failed. Contact type does not exist\" }}\n"}],"_postman_id":"e8abb813-6f1b-4207-8290-69122f7ca824"},{"name":"/contact/user/:person/","id":"04f16314-627b-4a17-aa6e-3c3569b1a592","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/","description":"This web service returns all contacts for the person.
This web service returns a specific contact for an associated person and type. Refer to /contact/ for a complete list of contacts available.
This web service provides ability to create a new contact type for a user. The contact type should not already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available.
\nThe value of the contact type must be provided in the request body as JSON e.g.
\n\n\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"54afd858-5691-4bfd-ada1-45f3f8f9326d","name":"400 - Bad Request - Error Code 001","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:42:45 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"001\",\"errorMessage\" :\"Mandatory fields are missing\" }}\n"},{"id":"6372a662-7d1c-4e67-8ab5-996b4f27ed65","name":"400 - Bad Request - Error Code 005","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/PHONE"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:44:28 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"005\",\"errorMessage\" :\"Validation failed. Ensure contact type is allowed and has correct format\" }}\n"},{"id":"830ed022-d2b2-47f1-8534-ee8e0ff8d624","name":"400 - Bad Request - Error Code 006","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:41:20 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"006\",\"errorMessage\" :\"Validation failed. Existing contact for user, use PATCH to update\" }}\n"},{"id":"a3f33e6e-7f50-451c-a025-bd384f2cee63","name":"404 - Not Found - Error Code 003","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/7788/EMAIL"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:43:31 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"003\",\"errorMessage\" :\"Validation failed. User account does not exist\" }}\n"},{"id":"b82d4217-99df-4c18-8353-6b11d95560d2","name":"201 - Success - Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:40:49 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"d1f981b1-89e2-431f-880b-e6ac6c403fd4"},{"name":"/contact/user/:person/:type","id":"a3966e47-7b88-4991-8d17-9e78150a73ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"value\" :\"darragh.james.duffy@corehr.com\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL","description":"{\"value\" :\"darragh.james.duffy@corehr.com\"}
\n
This web service provides ability to patch / update a contact type for a user. The contact type must already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available.
\nThe value of the contact type must be provided in the request body as JSON e.g.
\n\n\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3babcc54-c3d6-42f4-8dc1-3dbc3f6413e3","name":"201- Success - Created","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:45:19 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"},{"id":"71eaf918-681c-4e47-99ba-730f5666e878","name":"400 - Bad Request - Error Code 001","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:46:55 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"001\",\"errorMessage\" :\"Mandatory fields are missing\" }}\n"},{"id":"ad7760d4-99c1-459f-8031-58d02f7b9595","name":"404 - Not Found - Error Code 002","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/Phone"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:48:16 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"002\",\"errorMessage\" :\"Validation failed. Contact does not exist\" }}\n"},{"id":"cbd6375b-20e9-447f-9405-e272db39cfff","name":"404 - Not Found - Error Code 003","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/7788/EMAIL"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:47:30 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"003\",\"errorMessage\" :\"Validation failed. User account does not exist\" }}\n"}],"_postman_id":"a3966e47-7b88-4991-8d17-9e78150a73ea"},{"name":"/contact/user/:person/:type","id":"0dcd15e8-049d-4dba-a675-05fae477d265","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL","description":"{\"value\" :\"darragh.james.duffy@corehr.com\"}
\n
This web service provides ability to delete a contact from a users / employees profile. The contact type should already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available. All contact types are case sensitive.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b206418c-26ee-40af-b59a-65013c418d1f","name":"200 - Response OK","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 11 Nov 2016 14:46:13 GMT","name":"Date","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"0dcd15e8-049d-4dba-a675-05fae477d265"},{"name":"/contact/missing/:type","id":"4149037e-7e7e-48c1-ab7d-7ad7561314e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/missing/EMAIL","description":"This web service provides ability to list user accounts with missing contact types. For example find all users with a missing EMAIL contact.
This examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Contact module provides ability to interact with contact information associated with an account in CoreHR. Different contact types exist and can be defined by a tenant e.g EMAIL, MOBILE etc. Not all tenants have the same list of contacts i.e. each tenant can define a whitelist of contacts exposed to web services.
\nContraints, Limitations & Mandatory
\nThe contact module is case senstive, no process converts the contact type provided to upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned. Within CoreHR contact types are typically uppercase.
\nPerson is mandatory, person represents users unique CoreHR ID, this is often referenced as personnel number
Optionally
\nProvide the type of contact e.g. EMAIL to get users associated email address.
In cases where type is not specified all contact details are returned associated with employee.
In Summary contact provides ability to
\n- \n
- Enumerate users contact information \n
- Obtain a specific contact type \n
- Update / Patch an existing contact type \n
- Assign a new contact type to a user \n
Error Codes
\nNote type is case senstive, no process converts the type provided into upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned.
Convention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Mandatory fields are missing \n
- 404 / 002 Validation failed. Contact does not exist \n
- 404 / 003 Validation failed. User account does not exist \n
- 400 / 005 Validation failed. Ensure contact type is allowed and has correct format \n
- 400 / 006 Validation failed. Existing contact for user, use PATCH to update \n
- 404 / 007 Contact type does not exist for user, consider using POST to create \n
Note
\nWhere a contact exists within CoreHR, this does not mean an account in CoreHR has this contact assigned, e.g. not every account would have a mobile / cell number. Keep this in mind if you attempt to PATCH a contact type and server responds with a validation error.
\n","_postman_id":"7e6b21c5-d883-4921-a210-8083d49cda4e"},{"name":"Image","item":[{"name":"/image/user/","id":"c02bacd7-67f1-4910-a62e-32b3d666a0ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"Bearer MZun_JVHkiiNm9SXgadz4A.."}],"url":"{{url}}/ws/{{schema}}/{{version}}/image/user/0890126","description":"This Web Service is used to retrieve (GET) the image profile for a CoreHR user on the system. Returns a binary image file.
\nExample cURL:
\n$ curl -o ./local_copy_of_profile.jpeg -k --request GET --url https://devapi.corehr.com/ws/frame/corehr/v1/image/user/0890126 \\\n --header 'authorization: Bearer MZun_JVHkiiNm9SXgadz4A..'\nThis command will save the binary image of CoreHR User 0890126 into the file local_copy_of_profile.jpeg. If alternatively the person did not have an image on the system then the web service would return an http code 404 with and verbose errorCode of 1008.
Example cURL:
\n$ curl --request POST --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/png' \\\n --header 'authorization: Bearer E63-fevVwKH-CV4E_TScUA..' \\\n --data-binary \"@./original_profile.png\" \nThe above cURL will insert the file original_profile.png as the binary image profile photo for the CoreHR User 0890126 where they do not have an profile image already configured on the system.
Web Service used to update the profile image for a CoreHR user on the system. This overwrites their current profile image with this new image. The image is provided as binary data in the body of the request.
\nExample cURL:
\n$ curl --request PATCH --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/jpeg' \\\n --header 'authorization: Bearer Fbbanqy44exS0Nat7Ep3oQ..' \\\n --data-binary \"@./new_profile.jpg\" \nThe above cURL will insert the file new_profile.jpg as the binary image profile photo for the CoreHR User 0890126 where they already have a profile image in CoreHR. This will over-write the existing profile image.
This Web Service is used to retrieve (GET) the image profile for a CoreHR user on the system. Returns a binary image file.
\nExample cURL:
\n$ curl -o ./local_copy_of_profile.jpeg -k --request GET --url https://devapi.corehr.com/ws/frame/corehr/v1/image/user/0890126 \\\n --header 'authorization: Bearer MZun_JVHkiiNm9SXgadz4A..'\nThis command will save the binary image of CoreHR User 0890126 into the file local_copy_of_profile.jpeg. If alternatively the person did not have an image on the system then the web service would return an http code 404 with and verbose errorCode of 1008.
Web Service used to update the profile image for a CoreHR user on the system. This overwrites their current profile image with this new image. The image is provided as binary data in the body of the request.
\nExample cURL:
\n$ curl --request PATCH --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/jpeg' \\\n --header 'authorization: Bearer Fbbanqy44exS0Nat7Ep3oQ..' \\\n --data-binary \"@./new_profile.jpg\" \nThe above cURL will insert the file new_profile.jpg as the binary image profile photo for the CoreHR User 0890126 where they already have a profile image in CoreHR. This will over-write the existing profile image.
This Web Service is used to insert a profile image for a CoreHR user on the system where none exists. The image is provided as binary data in the body of the request.
\nExample cURL:
\n$ curl --request POST --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/png' \\\n --header 'authorization: Bearer E63-fevVwKH-CV4E_TScUA..' \\\n --data-binary \"@./original_profile.png\" \nThe above cURL will insert the file original_profile.png as the binary image profile photo for the CoreHR User 0890126 where they do not have an profile image already configured on the system.
The image web service provides a means for uploading and viewing a CoreHR user's profile picture.
\nConstraints, Limitations, Mandatory and Validation
\nImages uploaded can be a maximum of 500KB in size and must be provided in one of the following file formats:
\n- \n
- gif \n
- png \n
- jpeg \n
- tiff \n
Error Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 415 / 1001 Invalid content type, only image/gif, image/png, image/jpeg or image/tiff allowed \n
- 415 / 1002 n image file (gif, png, jpeg or tiff) of size greater than zero must be attached to this request. \n
- 415 / 1003 There was an issue with the supplied image being recognized as a supported image (gif, png, jpeg or tiff) please save as another supported format and re-try. \n
- 415 / 1004 The attached image exceeded the maximum allowed file size for an image. \n
- 400 / 1005 The person supplied is not currently a valid person on the system. Please check the personnel details. \n
- 400 / 1006 This person does not have an image on the system to update please change this request to POST to insert the image. \n
- 400 / 1007 This person already has an image on the system to insert please change this request to PATCH to update the image. \n
- 404 / 1008 This person does not currently have an image on the system to retrieve. \n
Use this service if you want to remove UUID's. The service can facility bulk UUID removal/purge and individual employee UUID.
\nThis is useful in cases where you have a need
\n- \n
- to remove an individuals UUID e.g. as part of a leaver process. \n
- to implement a policy requiring users to re-register, this would be similar to a password policy \n
Constraints and Limitations
\n- \n
typemust be one of the following: \n
ALL
\n- \n
id\n
must now be a valid type i.e. a valid Email address. In cases where ALL is used for type, the id should be left blank.
\nIf invalid ID provided nothing is deleted, i.e. if an invalid email address provided a status of 404 is returned. For valid email address a 200 is returned, indicating a success.
\nParameters
\n- \n
typethis must be email, username, employeeNumber or all. \"ALL\" is reserved for bulk removal, this will remove all the registered UUID's, therefore use with caution \nidthis must be a valid email address \n
CoreHR's native mobile application facilitates users registering once and then using biometric (e.g. touchID, FaceID) or PIN to unlock the application i.e. the user does not require a username / password each time they login. However a user is required to unlock the app via biometric or PIN.
\nA tenant may have a requirement to implement a different policy e.g. a user must authenticate via username / password at least once a day, week or month i.e. similar to password policies. CoreHR makes no assumptions for password policies, instead tenants can implement their own policies.
\nIn order to faciliate these requirments web services can be used. A tenant can generate a new app grant priviliges to this module and end point.
\n","_postman_id":"68bb3644-3120-4d1c-abf5-d7f663be25f2"}],"id":"a0383d0e-cee3-48ef-a75e-74a0edd17990","description":"The native module manages authentication and tokens for the CoreHR native application. These services cater for both SAML and non-SAML customers. All request will be handled via TLS.
\nThis service provides:
\n- \n
- Ability to remove / purge / reset Uses UUID's \n
Find all non provisioned accounts. This endpoint will return all users not yet provisioned.
\nThis examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Optionally provide number of days, this service is used to offset users start date. Provides ability to determine accounts not yet provisioned in CoreHR for Core|Portal self service access. This service will include employees due to start in the future.
\nAllowing the following scenario.
\n- \n
obtain user accounts to be provisioned within the last X number of days, i.e. a start date occurring in the past.
\n \nobtain user accounts to be provisioned with a future start date, i.e. users starting in the future.
\n \n
This examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Provisions a new CorePortal account; on successful completion, users will have ability to access CoreHR's self service features via CorePortal. As noted in the introduction to the provisioning module, where an IDM or third party application understands CorePortal privileges this module will accept these privileges. Example provided below includes Users Privilege.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- authType \n
This is the authentication type for the employee, the value here should be either inApplicationPassword or LDAP. For all single sign on authenticated accounts use LDAP. For non single sign on account set this value to inApplicationPassword this then requires the password attribute to be set. Leaving this parameter null indicates to CoreHR that the user account should pick up the system default authentication type, this parameter can be found in CoreHR as 'authtype'.
- \n
- password \n
This attribute is required when authType is inApplicationPassword. The value here will be validated against the password policy in CoreHR.
- \n
- privileges \n
An array, each array object contains a privilege.
\nMandatory
\n- \n
- corehrid \n
- loginid \n
- password (only when authType is inApplicationPassword) \n
Provides ability to patch (amend) an existing account. Account must have previously been provisioned, this means corehrID must previously have been generated via POST. In general this service supports Single Sign On style accounts.
It is possible to use this service with non SSO accounts, in such cases all parameters are mandatory including password and explcitly setting authType to inApplicationPassword. In cases where authType is not provided the account is assumed to be Single Sign On.
The use cases for this web service includes
\n- \n
- loginId changing \n
Where a user changes their loginId e.g. their name changes because of marriage, this web service faciliates this change of ID.
\n- \n
- privilege changing \n
executing this web service will remove all current privileges and replace with the privileges array. It is therefore possible to use this web service to revoke all privileges for a user by sending a blank array of privileges.
\nExample provided below changes both Login ID and privileges.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- authType \n
This is the authentication type for the employee, the value here should be either inApplicationPassword or LDAP. For all single sign on authenticated accounts use LDAP. For non single sign on account set this value to inApplicationPassword this then requires the password attribute to be set. In cases where this attribute is null, assumpetion is Single Sign On.
- \n
- password \n
This attribute is required when authType is inApplicationPassword. The value here will be validated against the password policy in CoreHR.
- \n
- privileges \n
An array, each array object contains a privilege. If this is blank all privs are revoked.
\nMandatory
\n- \n
- corehrid \n
- loginid \n
- password (only when authType is inApplicationPassword) \n
For Non SSO Accounts all parameters are mandatory.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","provision","user"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0ce80fce-6c6f-432e-be9e-5c9be93bbad2","name":"201 - Created - Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\n \"corehrid\" : \"002875\",\n \"loginid\" : \"jones.donovan@corehr.com\",\n \"privileges\" : [\n {\"privilege\" : \"developmentTeam\"},\n {\"privilege\" : \"VPNGroup\"}\n ]\n}\n"},"url":"{{url}}/ws/{{schema}}/{{version}}//provision/user"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 05 Oct 2016 16:42:46 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"0b3b2279-b03d-4886-8a4a-be1bbf7bc5db"},{"name":"/provision/user/status/:id","id":"82a92e54-cb3c-453c-af0f-487ffa5e30d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100","description":"Obtain user account status indicator; determining if an account is active or not. The parameter id can be users coreHRID or account username.
Obtain user authentication type. Response indicates either LDAP or inApplicationPassword.
The parameter id can be users coreHRID or loginID.
Provides an ability to activate or deactivate an account. Setting an account to be deactive results in a user not being allowed sign into CoreHR self Service module CorePortal. This applies irrespective of the users authentication type.
\nWhen an account is created via POST /provision/user the account is assumed to be active. You do not need to execute this web services to activate an account once it has been created. However if you execute this web services and set active to N then you must execute this web services again to re-activate the account by setting active to Y.
The id parameter can be either coreHRID or the username associated with the account. The Active parameter must be N or Y
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","provision","user","status","100"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"4a20be25-69da-46f1-b99b-7b201e20d131","name":"400 - Validation Failed","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\"active\" : \"N\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/1001"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 19:02:41 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"007\",\"errorMessage\" :\"Validation failed. Either user account does not exist or request data is invalid.\" }}\n"},{"id":"8f365ca3-5ad9-440a-b0e8-3d0f57a6690e","name":"200 - Account Active","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 18:04:52 GMT","name":"Date","description":""},{"key":"ETag","value":"\"L/idwKxNGWvlkQGQ4j3vC0+brkecdYNqpY2o9nJxaN5RiPktu/5d3OJrX6yJIWMlOB0ocscXHR0OVsUrx7Decw==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"{\"items\":[{\"isaccountactive\":\"Yes\"}],\"hasMore\":false,\"limit\":100,\"offset\":0,\"count\":1,\"links\":[{\"rel\":\"self\",\"href\":\"http://localhost:8585/ws/corehr/v1/provision/user/status/100\"},{\"rel\":\"describedby\",\"href\":\"http://localhost:8585/ws/corehr/metadata-catalog/v1/provision/user/status/item\"},{\"rel\":\"first\",\"href\":\"http://localhost:8585/ws/corehr/v1/provision/user/status/100\"}]}"},{"id":"d075a110-c854-4d44-99e9-28f39b97a32d","name":"201 - Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\"active\" : \"N\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 19:02:16 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"a827392d-27be-40dc-9af8-0c0dbc01c6f0"},{"name":"/provision/user/privilege","id":"cb83e72d-2f9a-4ab7-ae1c-a7c58010882c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"loginid\" : \"jones.donovan@corehr.com\",\n \"privilege\" : \"hrAdmin\"\n }\n"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/privilege","description":"Provisions a new privilege for a user. This service allows one new privilege to be assigned to the user account. In addition this service assumes an account has already been provisioned. Validation is performed on the account confirming existence.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- privilege \n
a new privilege for the user.
\nSpecial Usage Note
\nuse one of the following combinations, do not use all three fields. If you do an error will be returned.
\n- \n
- corehrid and a privilege \n
or
\n- \n
- loginid and a privilege \n
CoreHR v25.0.7 required
\nThis service will list all currently granted privileges associated with a user.
\nParameter
\nid can be either the users loginid or the users corehrid (personnelNumber).
CoreHR v25.0.7 required
\nProvides an ability to revoke all user privileges associated with the user account.
\nA privilege here relates to all granted menu security items i.e. feature access and not access to a specific user, while access to the user is not revoked the privilege to use the feature is revoked.
\nNB this revokes all.
\nOther attributes associated with the user Account are not affected e.g. account will still exist, authentication type will remain as is, and password for non SSO accounts remain in place etc.
\nThis service assumes an account has already been provisioned. Validation is performed on the account confirming existence. This is a simple purge request, in cases where the user has no privileges, this service will not respond with an error, instead a successful response is returned.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by using the new filter services.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\nSpecial Usage Note
\nuse one of the following combinations, do not use both fields. If you do an error will be returned.
\n- \n
- corehrid \n
or
\n- \n
- loginid \n
Provisioning facility allowing Core|Portal accounts to be provisioned. Core|Portal is the self service module within CoreHR. A employee may have a record in CoreHR, this does not automatically suggest same employee has access to self service features via CorePortal. In order to access CorePortal a self service account is required. This module provides a web service mechanism to provision an employee.
\nIn Summary provisioning provides ability to
\n- \n
- Determine accounts yet to be provisioned \n
- Determine accounts yet to be provisioned within X number of days (including future start dates) \n
- Provision a new account \n
- Provision a new account with privileges \n
- Update existing accounts privileges \n
- Add additional privilege to an account \n
- Set authentication Type in cases where a mix of Single Sign On, SAML and inApplicationPasswords exist \n
Contraints, Limitations & Mandatory
\nAccounts to be provisioned simply indicates accounts (employees) not yet provisioned. These accounts must satisfy following criteria
\n- \n
- Active Employee Record \n
indicates employees record must not have a date left.
\nDo not assume logic applies indicating certain categories of employees are allowed access and others are not allowed. No other conditions are applied. Additional attributes are possible to add to the response to help an IDM provider make this decision, CoreHR will work with an IDM provider to best determine.
\nCorePortal privileges can be assigned by the IDM using the privileges array (example below). Where an IDM can not determine privileges, this provisioning web service module integrates with the CoreHR user profile matrix, and in cases where this matrix is not configured the fall back is all users are granted a default access profile typically \"coreportal_employee\".
\nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Mandatory fields are missing \n
- 400 / 002 Validation failed. If attempting to update use PATCH method \n
- 400 / 003 Unexpected error, unable to provision account \n
- 404 / 004 Validation failed. User account does not exist \n
- 404 / 005 Validation failed. Account must first be provisioned, use POST method \n
- 400 / 006 Validation failed. Invalid fields used \n
- 400 / 007 Validation failed. Either user account does not exist or request data is invalid. \n
- 400 / 008 Validation failed. Authtype must be either LDAP or inApplicationPassword. If choosing inApplicationPassword a password is required \n
- 400 / 009 Validation failed. Supplied password has not passed password \n
- \n
- 400 / 010 Validation failed, type is mandatory (must email or all), and id should be populated when type is email, when type is all no id should be provided. The JSON keys are case sensitve, type and id should be lower case. \n
\n- \n
- 404 / 011 Nothing found for this email address. \n
\n
Get a list of registered / whitelisted referene types. Tenant has an ability to define reference types available for creating / updating. A tenant may not allow all references to be updated or created, this base URI provides the list of valid reference types. In cases where server returns validation errors, refer to this list to confirm the reference type is whitelisted.
\nThis examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Returns a list of codes and descriptions for a reference type, a reference type could be COST, DEPT etc. Reference Types are typically upper case. As already noted reference types can be whitelisted by a tenant.
For a full list of available reference types use /reference/
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","{{version}}","reference","type","DEPT",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"20962e11-1d70-4ec6-ac55-f5a16a8516d6","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/COST/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:35:18 GMT","name":"Date","description":""},{"key":"ETag","value":"\"ZInz0RdXlDlkFr0RxOWVt0Xe8DrUJnBC2+V/aZmUKdeVao7Vnt+tTjTY7a88qxAW/95HgOuX3zxv4wgdqSdatg==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"COST\", \"code\": \"1\", \"description\": \"Cost Centre Web Services 1\"}\n,\n{\"type\":\"COST\", \"code\": \"10\", \"description\": \"Cost Centre Web Services 10\"}\n,\n{\"type\":\"COST\", \"code\": \"100A\", \"description\": \"Cost Centre Web Services 100A\"}\n,\n{\"type\":\"COST\", \"code\": \"111\", \"description\": \"Cost Centre Web Services 111\"}\n,\n{\"type\":\"COST\", \"code\": \"123456789\", \"description\": \"Cost Centre Web Services 123456789\"}\n,\n{\"type\":\"COST\", \"code\": \"149\", \"description\": \"Cost Centre Web Services 149\"}\n,\n{\"type\":\"COST\", \"code\": \"159\", \"description\": \"Cost Centre Web Services 159\"}\n,\n{\"type\":\"COST\", \"code\": \"20\", \"description\": \"Cost Centre Web Services 20\"}\n,\n{\"type\":\"COST\", \"code\": \"200A\", \"description\": \"Cost Centre Web Services 200A\"}\n,\n{\"type\":\"COST\", \"code\": \"21\", \"description\": \"Cost Centre Web Services 21\"}\n,\n{\"type\":\"COST\", \"code\": \"22\", \"description\": \"Cost Centre Web Services 22\"}\n,\n{\"type\":\"COST\", \"code\": \"222\", \"description\": \"Cost Centre Web Services 222\"}\n,\n{\"type\":\"COST\", \"code\": \"23\", \"description\": \"Cost Centre Web Services 23\"}\n,\n{\"type\":\"COST\", \"code\": \"24\", \"description\": \"Cost Centre Web Services 24\"}\n,\n{\"type\":\"COST\", \"code\": \"25\", \"description\": \"Cost Centre Web Services 25\"}\n,\n{\"type\":\"COST\", \"code\": \"26\", \"description\": \"Cost Centre Web Services 26\"}\n,\n{\"type\":\"COST\", \"code\": \"27\", \"description\": \"Cost Centre Web Services 27\"}\n,\n{\"type\":\"COST\", \"code\": \"28\", \"description\": \"Cost Centre Web Services 28\"}\n,\n{\"type\":\"COST\", \"code\": \"29\", \"description\": \"Cost Centre Web Services 29\"}\n,\n{\"type\":\"COST\", \"code\": \"2908100\", \"description\": \"Cost Centre Web Services 2908100\"}\n,\n{\"type\":\"COST\", \"code\": \"30\", \"description\": \"Cost Centre Web Services 30\"}\n,\n{\"type\":\"COST\", \"code\": \"300A\", \"description\": \"Cost Centre Web Services 300A\"}\n,\n{\"type\":\"COST\", \"code\": \"356\", \"description\": \"Cost Centre Web Services 356\"}\n,\n{\"type\":\"COST\", \"code\": \"39\", \"description\": \"Cost Centre Web Services 39\"}\n,\n{\"type\":\"COST\", \"code\": \"40\", \"description\": \"Cost Centre Web Services 40\"}\n,\n{\"type\":\"COST\", \"code\": \"451\", \"description\": \"Cost Centre Web Services 451\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC\", \"description\": \"Cost Centre Web Services ABC\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC001\", \"description\": \"Cost Centre Web Services ABC001\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC0010\", \"description\": \"Cost Centre Web Services ABC0010\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC003\", \"description\": \"Cost Centre Web Services ABC003\"}\n,\n{\"type\":\"COST\", \"code\": \"J12345\", \"description\": \"Cost Centre Web Services J12345\"}\n,\n{\"type\":\"COST\", \"code\": \"JKL333\", \"description\": \"Cost Centre Web Services JKL333\"}\n,\n{\"type\":\"COST\", \"code\": \"PROD\", \"description\": \"Cost Centre Web Services PROD\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 33,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/reference/type/COST/\"\n }\n ]\n}\n"}],"_postman_id":"c86ff2bc-239c-4cbd-ac06-8875baaf3ccb"},{"name":"/reference/type/:atype/:code?","id":"e2829bf5-e271-473f-9015-8fd3c27773c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/reference/type/DEPT/7001","description":"Returns an individual reference description associated with a reference type and code. A reference type could be COST, DEPT etc. Reference Types are typically upper case. As already noted reference types can be whitelisted by a tenant.
For a full list of available reference types use /reference/
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","{{version}}","reference","type","DEPT","7001"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"25d94796-182a-4c4f-90f6-7735ca3edb1b","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/COST/10"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:35:39 GMT","name":"Date","description":""},{"key":"ETag","value":"\"Q3jVQU2iTQ/v0g70PelGZKl9U6wG1LV/Ns7vRxFBtB7MUyXAAgUcC+nxdBtW/mQMcQPoQhSS1jjRtrAA4a7uzQ==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"COST\", \"code\": \"10\", \"description\": \"Cost Centre Web Services 10\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/reference/type/COST/10\"\n }\n ]\n}\n"}],"_postman_id":"e2829bf5-e271-473f-9015-8fd3c27773c4"},{"name":"/reference/type/:atype","id":"0734c266-58d1-4315-a5fd-367fb712651e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"value\" : \"1\",\n\"description\" : \"Department One\"\n}"},"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/reference/type/DEPT/","description":"Add reference data based on the reference type, code and description. The reference type is expected in the URL, while the request body should include code and description
Ability to update a description associated with an existing reference code / type combination. The reference type is expected in the URL, while the request body should include code and description
It is possible to also provide an active parameter, this parameter can also be provided via the request body must be either Y or N.
Delete reference data based on the reference type, code. The reference type is expected in the URL, while the request body should include code.
Reference module provides ability to view, add and update reference related items for CoreHR e.g. Cost Centre, Department, Projects etc.
\nContraints, Limitations & Mandatory
\nThe reference module is case senstive, no process converts the type provided into upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned. Within CoreHR reference types are typically uppercase.
\nIn most cases a type is mandatory. Following are some examples, for more detail review each URI and method below.
\nFor endpoint /reference/type/aType/ aType is mandatory e.g. /reference/type/COST/. Another example /reference/type/COST/1 will return Reference Type COST where the cost centre code is 1. For /reference/types/ no type is required.
Further information per method below.
\nLimitations
\nDescription max length - 40 Characters
\nCode max length - 13 Characters
\nWRKGRP only GETS are supported, POST, PATCH and DELETE are not supported.
Error Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Mandatory fields are missing \n
- 400 / 002 Validation failed. If attempting to update use PATCH method \n
- 404 / 003 Validation failed. Reference type does not exist \n
- 400 / 004 Validation failed. Sanitization of data failed, ensure field lengths are correct \n
- 400 / 005 Validation failed. Reference code does not exist. If attempting to add use POST method. \n
- 400 / 006 Validation failed. Validation failed. Reference type and code do not exist. \n
- 400 / 007 Validation failed. Validation failed. Active Indicator can only be Y or N. \n
Defined below are the endpoints, sample requests and responses.
\n","event":[{"listen":"prerequest","script":{"id":"b21841da-655d-45bb-85e7-4088b669f016","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8394b87b-f3d4-49ce-9279-7e9e8381791e","type":"text/javascript","exec":[""]}}],"_postman_id":"02b759bd-2500-43c1-8dcc-d3aba550071e"},{"name":"User Defined Fields","item":[{"name":"/udf/user/:udf_type","id":"c91b577a-8dcd-41e8-baa3-547b53f3f0dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 9m1zDcUnJrxvkqTfEsTOfQ.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20","description":"Creating a new UDF Type Record for a user
\nAdding a new User record for a UDF Type requires the following fields. UDF Type code is mandatory and specified as part of the URL.
\nThe rest of the fields are provided as JSON in the request body. Un-used/empty fields should be left blank. Successful inserts results in a JSON Response object with success value of true. Also included in the JSON Response is the ws_id which is the unique Web Service ID that can be used to identify this specific record.
\nFields are sent in the JSON are as in the table below:
\n¹ Either personnel_no OR appointment_id are mandatory.
² Date1 and Date2 are input in the format DD-MON-RRRR.
\n³ Text1 to Text12 must ALWAYS be provided. If the field is not being used for the UDF Type use a blank value string e.g. \"\".
\n¬ Text1 to Text12 field requirements are defined by the UDF Type configuration in CoreHR. Text fields can be marked as mandatory/optional and of specific data types including:
\n- \n
- Text - to a maximum of 4000 characters long. \n
- Number - number values only \n
- Date required to be in the format DD-MON-YYYY. \n
- List - Based on the allowed list for the UDF Type as configured in CoreHR. \n
Response Object\nSample responses are shown to the right under different conditions.
\nA response objects is always provided and within success will either be true. In which case as ws_id (unique web service identifier that allows us to refer back to this record).
Alternatively, the success value can be false if this is the cause an errorCode and errorMessage are provided. Additional error details - if the error pertains to a specific value in the body - is provided in the validationError object. This will contain one or more JSON objects relating to each specific error. The param_name will contain the field the validation error relates to the field_name is the label of the field used in CoreHR and the message will contain a detailed explanation of what validation is failing.
Error Codes
\nConvention is HTTP Status Code / Verbose Code. These are shared by all these UDF endpoints and explained in the Error Codes section at the start of the UDF documentation.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","udf","user","AB20"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"8289ab12-d6e2-4ce0-9f73-e24c8ccb764e","name":"3. Sanatization Fail Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer _QsnRadImZrbh8w9_4B6UA.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"1409000\",\n \"appointment_id\": \"\",\n \"text1\": \"27\",\n \"text2\": \"24\",\n \"text3\": \"31\",\n \"text4\": \"28\",\n \"text5\": \"27\",\n \"text6\": \"30\",\n \"text7\": \"28\",\n \"text8\": \"25\",\n \"text9\": \"29\",\n \"text10\": \"28\",\n \"text11\": \"24\",\n \"text12\": \"29\",\n \"date1\": \"\",\n \"date2\": \"\",\n \"user_code\": \"\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"close","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Fri, 11 Aug 2017 16:16:01 GMT","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"41431680-ec3d-4690-8100-5e5ec94a3c78-00002f6f","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[],"responseTime":null,"body":"\n\n { \"Response\": {\n \"success\" : false,\n \"errorCode\" : \"998\",\n \"errorMessage\" : \"UDF Type validation errors. Review validationError object for more details of data errors for this UDF type.\",\n \"validationError\" : [\n\n {\n \"param_name\" : \"text1\",\n \"field_name\" : \"COREHR 7600\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text2\",\n \"field_name\" : \"text2\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text3\",\n \"field_name\" : \"text3\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text4\",\n \"field_name\" : \"text4\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text5\",\n \"field_name\" : \"text5\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text6\",\n \"field_name\" : \"text6\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text7\",\n \"field_name\" : \"text7\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text8\",\n \"field_name\" : \"text8\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text9\",\n \"field_name\" : \"text9\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text10\",\n \"field_name\" : \"text10\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text11\",\n \"field_name\" : \"text11\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text12\",\n \"field_name\" : \"text12\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n]\n }\n }\n"},{"id":"a5c7ffd7-d368-4787-9902-f14d69a64c05","name":"4. User Code example to use pre-defined data in all text fields","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 9m1zDcUnJrxvkqTfEsTOfQ.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Mon, 14 Aug 2017 12:10:39 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"f38c5093-1095-4e7e-be35-0074f4d4eb81-0000002c","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true, \"ws_id\":\"2017081471563097\"}}\n"},{"id":"b4eae090-4782-4c5c-a484-10a77853362b","name":"1. Successful date fields example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer _QsnRadImZrbh8w9_4B6UA.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"1409000\",\n \"appointment_id\": \"\",\n \"text1\": \"27-JAN-2017\",\n \"text2\": \"24-FEB-2017\",\n \"text3\": \"31-MAR-2017\",\n \"text4\": \"28-APR-2017\",\n \"text5\": \"27-MAY-2017\",\n \"text6\": \"30-JUN-2017\",\n \"text7\": \"28-JUL-2017\",\n \"text8\": \"25-AUG-2017\",\n \"text9\": \"29-SEP-2017\",\n \"text10\": \"28-OCT-2017\",\n \"text11\": \"24-NOV-2017\",\n \"text12\": \"29-DEC-2017\",\n \"date1\": \"\",\n \"date2\": \"\",\n \"user_code\": \"\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Fri, 11 Aug 2017 16:05:48 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"41431680-ec3d-4690-8100-5e5ec94a3c78-00002f6a","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true, \"ws_id\":\"2017081171563091\"}}\n"},{"id":"dca51563-4e92-4e81-8c65-ecf4a3b0e914","name":"2. Validation Fail","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer _QsnRadImZrbh8w9_4B6UA.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"1409000\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"27-JAN-2017\",\n \"text2\": \"24-FEB-2017\",\n \"text3\": \"31-MAR-2017\",\n \"text4\": \"28-APR-2017\",\n \"text5\": \"27-MAY-2017\",\n \"text6\": \"30-JUN-2017\",\n \"text7\": \"28-JUL-2017\",\n \"text8\": \"25-AUG-2017\",\n \"text9\": \"29-SEP-2017\",\n \"text10\": \"28-OCT-2017\",\n \"text11\": \"24-NOV-2017\",\n \"text12\": \"29-DEC-2017\",\n \"date1\": \"\",\n \"date2\": \"\",\n \"user_code\": \"\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Fri, 11 Aug 2017 16:14:20 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"41431680-ec3d-4690-8100-5e5ec94a3c78-00002f6d","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"002\",\"errorMessage\" :\"Validation failed. Provide either a personnel number or an Appointment ID. It is not possible to use both.\" }}\n"}],"_postman_id":"c91b577a-8dcd-41e8-baa3-547b53f3f0dd"},{"name":"/udf/user/:udf_type","id":"7326fab1-4245-451a-8190-d8108da463a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer 9m1zDcUnJrxvkqTfEsTOfQ.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20","description":"Updating existing UDF Type Record for a user
\nUpdating a user record for a UDF Type uses the personnel_no/appoinment_id, date1, date2 and the udf_type to determine if the record is an update. i.e. If there is an existing record(s) with the same person/appointment and date1 and date2 then it is an update and the existing record(s) will be patched (updated) to the new values provided in the JSON code. UDF Type is of course mandatory and specified as part of the URL.
\nThe rest of the fields are provided as JSON in the request body. Un-used/empty fields should be left blank. Successful updates result in a JSON Response object with success value of true.
\nFields are sent in the JSON are as in the table below:
\n¹ Either personnel_no OR appointment_id are mandatory.
² Date1 and Date2 are input in the format DD-MON-RRRR.
\n³ Text1 to Text12 must ALWAYS be provided. If the field is not being used for the UDF Type use a blank value string e.g. \"\".
\n¬ Text1 to Text12 field requirements are defined by the UDF Type configuration in CoreHR. Text fields can be marked as mandatory/optional and of specific data types including:
\n- \n
- Text - to a maximum of 4000 characters long. \n
- Number - number values only \n
- Date required to be in the format DD-MON-YYYY. \n
- List - Based on the allowed list for the UDF Type as configured in CoreHR. \n
Response Object\nSample responses are shown to the right under different conditions.
\nA response objects is always provided and within success will either be true. In which case as ws_id (unique web service identifier that allows us to refer back to this record).
Alternatively, the success value can be false if this is the cause an errorCode and errorMessage are provided. Additional error details - if the error pertains to a specific value in the body - is provided in the validationError object. This will contain one or more JSON objects relating to each specific error. The param_name will contain the field the validation error relates to the field_name is the label of the field used in CoreHR and the message will contain a detailed explanation of what validation is failing.
Error Codes
\nConvention is HTTP Status Code / Verbose Code. These are shared by all these UDF endpoints and explained in the Error Codes section at the start of the UDF documentation.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","udf","user","AB20"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f10c6efa-5c2d-432d-86ac-80d39b61d104","name":"Successful update using User Code","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Bearer 0nsn4KtX5QlKF4_4q0gNcw.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Thu, 17 Aug 2017 15:13:29 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"e491ed87-4cb1-4174-9763-76bbe5667c2b-0000009c","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"7326fab1-4245-451a-8190-d8108da463a7"},{"name":"/udf/user/","id":"2add095c-08f0-4e21-82d3-fc0c4338bd42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/","description":"Web service to get the list of User Defined Field (UDF) records for a particular UDF Type. Mandatory search criteria include:
\n- \n
- udf_type - The UDF code. \n
- person - The CoreHR Personnel Number for whom records are to be retrieved.\nOptional criteria include: \n
- appointment_id - To search for details relating to a specific appointment. \n
- date1 - Commonly used as the Date From field. \n
- date2 - Commonly used as the Date To field. \n
A get request can return many records depending on the criteria poveded and consequently the ws_id value pair is the unique identifier that can be used with other web services to update this specific record.
Error Codes are documented at the start of the UDF documentation.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","udf","user",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0f784b82-9f13-48f5-abf1-28c18395f1dc","name":"Search using all citeria","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Bearer 8N7tv3Kwt2W5_i-B72dWew.."}],"url":{"raw":"{{url}}/ws/{{schema}}/{{version}}/udf/user/?udf_type=AB20&person=1409000&appointment_id=TS0011-2594&date1=01-JAN-2017&date2=31-DEC-2017","host":["{{url}}"],"path":["ws","{{schema}}","{{version}}","udf","user",""],"query":[{"key":"udf_type","value":"AB20"},{"key":"person","value":"1409000"},{"key":"appointment_id","value":"TS0011-2594"},{"key":"date1","value":"01-JAN-2017"},{"key":"date2","value":"31-DEC-2017"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"name":"connection","key":"connection","value":"Keep-Alive","description":"Options that are desired for the connection"},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":"Custom header"},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"name":"date","key":"date","value":"Thu, 17 Aug 2017 14:27:44 GMT","description":"The date and time that the message was sent"},{"name":"etag","key":"etag","value":"\"MQgB6VKjaT8lHDgADQKxxd0zqZ1ssI3lKuh3MursJBsVKHrOsHcxUeOJWWw6Lq7KQJ4hi5sQMuu9orqF0glhNg==\"","description":"An identifier for a specific version of a resource, often a message digest"},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":"Custom header"},{"name":"server","key":"server","value":"Apache","description":"A name for the server"},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"e491ed87-4cb1-4174-9763-76bbe5667c2b-0000008c","description":"Custom header"},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":"Custom header"},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":"Cross-site scripting (XSS) filter"}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{ \"items\" : [\n{\"udf_type\":\"AB20\",\"person\": \"1409000\",\"appointment_id\": \"TS0011-2594\",\"ws_id\": \"2017081171563091\",\"user_code\": \"AB20\",\"date1\": \"01-JAN-2017\",\"date2\": \"31-DEC-2017\",\"text1\": \"27-JAN-2017\",\"text2\": \"24-FEB-2017\",\"text3\": \"31-MAR-2017\",\"text4\": \"28-APR-2017\",\"text5\": \"27-MAY-2017\",\"text6\": \"30-JUN-2017\",\"text7\": \"28-JUL-2017\",\"text8\": \"25-AUG-2017\",\"text9\": \"29-SEP-2017\",\"text10\": \"28-OCT-2017\",\"text11\": \"24-NOV-2017\",\"text12\": \"29-DEC-2017\",\"last_update\": \"17-AUG-2017 12:46:49\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/frame/corehr/v1/udf/user/\"\n }\n ]\n}\n"},{"id":"bb123a57-13ff-4de3-a1b6-ec00e88a9d8d","name":"Missing Person parameter","originalRequest":{"method":"GET","header":[{"key":"Authorization","name":"Authorization","value":"Bearer _E4Pl9nxSkcJFbic2dxD8w.."}],"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"name":"connection","key":"connection","value":"close","description":"Options that are desired for the connection"},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":"Custom header"},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"name":"date","key":"date","value":"Thu, 17 Aug 2017 11:54:53 GMT","description":"The date and time that the message was sent"},{"name":"etag","key":"etag","value":"\"hu/EykO6P9EsmiOfI5hQk+9yi5r2AxYFcmeD8ppL8ujowI4GmtSfFHQi+xgzudcWmF0pxNbJHLHEWwepH2J8/A==\"","description":"An identifier for a specific version of a resource, often a message digest"},{"name":"server","key":"server","value":"Apache","description":"A name for the server"},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"e491ed87-4cb1-4174-9763-76bbe5667c2b-00000044","description":"Custom header"},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":"Custom header"},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":"Cross-site scripting (XSS) filter"}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"013\",\"errorMessage\" :\"Person is a mandatory field.\" }}\n"}],"_postman_id":"2add095c-08f0-4e21-82d3-fc0c4338bd42"}],"id":"9f97da23-c5d8-4f81-8613-c302121f1db4","description":"The User Defined Fields (UDF) module provides ability to insert/update and view the UDF records for a CoreHR employee.
\nThe list of UDF Types available is as configured in Core Personnel in the User Defined Fields under the Employee option i.e. those UDF types that related to a specific employee/user.
\nThese UDF Types must also be white listed using the Security option in Portal to allow them to be called via this Web Service.
\nConstraints, Limitations and Validation
\nFor all calls (insert/update/get) the personnel no. and the UDF Type code must be specified at a minimum. As previously mentioned the UDF Type must have been added to the whitelist to be accessed in any way.
\nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 404 / 000 The UDF Type does not exist in Core as a valid UDF Type for an Employee/User. \n
- 400 / 001 A Personnel Number or an Appointment ID must be provided. \n
- 404 / 002 Provide either a personnel number or an Appointment ID. It is not possible to use both. \n
- 404 / 003 There is no CoreHR personnel/user account associated with the personnel number provided. \n
- 404 / 004 The Appointment ID is invalid. \n
- 404 / 006 UDF Type with these details does not exist for user, consider using POST to create. \n
- 404 / 007 This UDF Type is not whitelisted for web services. \n
- 400 / 008 When using User Reference Data - by specifying a user_code - then do not provide values in parameters text1 to text12 i.e. pass in empty values in text1..text12. \n
- 404 / 009 This User Reference Data - as specified by the user_code - is not a a valid User Code for this UDF Type. \n
- 404 / 010 There is no UDF record of this type for this person with these details to update. Use POST if you want to insert a record. \n
- 400 / 011 Date1 field when used must be provided in the date format DD-MON-YYY. \n
- 400 / 012 Date2 field when used must be provided in the date format DD-MON-YYY. \n
- 400 / 013 Person is a mandatory field in this context. \n
- 400 / 014 UDF Type is a mandatory field in this context. \n
This service returns all position profiles, and is ordered by post number
\nParameters
\nNone
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- postNumber \n
A unique identifier associated with the position profile.
\n- \n
- postType \n
Provides information about the type of post e.g. permanent, part time, trainee, contractor etc. For associated descriptions use the Reference Module with the reference type EMPS. This attribute is available from CoreHR 26.0.6 and is not available in older versions.
- \n
- category \n
Categorises the position / post based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The date this position / post profile is effective from
\n- \n
- endDate \n
The date this position / post profile is no longer effective
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
- payScale \n
This is the \"scale\" related to salary information which is associated with the appointment. This attribute is also referred to as 'PositionCode' and 'Grade'. Note: if the requirement is to determine an individuals exact Grade use the /person/salary/ web service instead.
\n- \n
- postTileCode \n
A code that represents the description of the position / post profile. For associated descriptions use the Reference Module with the reference type POSTTL.
- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
This service returns only active position profiles, and is ordered by post number. An active position profile is based on the start and end dates of the position profile. Leaving the date parameter blank will return the current active appointments as of 'today'. Provide a date if the requirement is to determine active position profiles as of a specific date. An appointment with a start date >= today and a dormant date <= today is considered active. When the dormant date is not set for an appointment then it is active if the start date is >= today.
\nParameters
\ndate : format YYYYMMDD
\nMandatory : No
\nWhen blank, the service returns active appointments as of 'today'.
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- postNumber \n
A unique identifier associated with the position profile.
\n- \n
- postType \n
Provides information about the type of post e.g. permanent, part time, trainee, contractor etc. For associated descriptions use the Reference Module with the reference type EMPS. This attribute is available from CoreHR 26.0.6 and is not available in older versions.
- \n
- category \n
Categorises the position / post based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The date this position / post profile is effective from
\n- \n
- endDate \n
The date this position / post profile is no longer effective
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
- payScale \n
This is the \"scale\" related to salary information which is associated with the appointment. This attribute is also referred to as 'PositionCode' and 'Grade'. Note: if the requirement is to determine an individuals exact Grade use the /person/salary/ web service instead.
\n- \n
- postTileCode \n
A code that represents the description of the position / post profile. For associated descriptions use the Reference Module with the reference type POSTTL.
- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
This service returns only future position profiles, and is ordered by post number. A future position profile is based on the start of the position profile, and the start must be greater than 'today'.
\nParameters
\nNone
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- postNumber \n
A unique identifier associated with the position profile.
\n- \n
- postType \n
Provides information about the type of post e.g. permanent, part time, trainee, contractor etc. For associated descriptions use the Reference Module with the reference type EMPS. This attribute is available from CoreHR 26.0.6 and is not available in older versions.
- \n
- category \n
Categorises the position / post based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The date this position / post profile is effective from
\n- \n
- endDate \n
The date this position / post profile is no longer effective
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
- payScale \n
This is the \"scale\" related to salary information which is associated with the appointment. This attribute is also referred to as 'PositionCode' and 'Grade'. Note: if the requirement is to determine an individuals exact Grade use the /person/salary/ web service instead.
\n- \n
- postTileCode \n
A code that represents the description of the position / post profile. For associated descriptions use the Reference Module with the reference type POSTTL.
- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
A post number can be obtained by using the /person/appointment/:personnelNo web service.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- postNumber \n
A unique identifier associated with the position profile.
\n- \n
- postType \n
Provides information about the type of post e.g. permanent, part time, trainee, contractor etc. For associated descriptions use the Reference Module with the reference type EMPS. This attribute is available from CoreHR 26.0.6 and is not available in older versions.
- \n
- category \n
Categorises the position / post based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The date this position / post profile is effective from
\n- \n
- endDate \n
The date this position / post profile is no longer effective
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
- payScale \n
This is the \"scale\" related to salary information which is associated with the appointment. This attribute is also referred to as 'PositionCode' and 'Grade'. Note: if the requirement is to determine an individuals exact Grade use the /person/salary/ web service instead.
\n- \n
- postTileCode \n
A code that represents the description of the position / post profile. For associated descriptions use the Reference Module with the reference type POSTTL.
- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
Position Module
\nThe position module will retrieve position (aka post) profile information. This profile information is generally best described as a blueprint providing default information for appointments e.g. sets the cost centre, department, category information etc.
\nSeveral options exist for this module:
\n- \n
/position/profile/:postNumber
\n \n/position/profile/active
\n \n/position/profile/inactive
\n \n/position/profile/all
\n \n
Get all active employees, this will include employees who have a future leaving dates.
\nBy default only 100 active employees will be returned. In cases where you have a large employee base, set the pagesize filter via the URL. The max pagesize is 10,000 i.e it is possible to obtain an employee result set up to 10,000 employees. Setting the pagesize above this max threshold will result in only the default result set.
\n- \n
- Date\nan optional parameter, leaving this parameter blank, will simply return active employees as of 'today'. While providing a value for date (formated as YYYYMMDD) will return employees active for that specific date. Typically used to find employees active based on a specific historical date. It is therefore possible to obtain employees who have ceased employment. \n
This module relates to active employees, and will always only deal with active employees. The objective is to return an employee result set matching certain use cases, common use cases:
\n- \n
- Determine active employees \n
- Active employees on a particular date \n
Use this service to query employees leaving within the next X number of days, use the parameter :days to set the X value. These employees are currently active, however, they are set to leave within X number of days. The parameter must be positive.
The service will assume today when supplied with no value for :days or a value of 0, this returns employees leaving today.
Use this service to query employees leaving within the next X number of days.
\n","event":[{"listen":"prerequest","script":{"id":"b5253eec-265b-40a8-8415-729fa774bbeb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ef616a76-9bca-49e5-8596-62d3eb137d6e","type":"text/javascript","exec":[""]}}],"_postman_id":"e1a48372-4a0e-4c12-911b-5279639e7228"},{"name":"Date","item":[{"name":"/filter/jml/leaver/date/:date?","id":"b8fe21a0-494e-4aee-8b1e-f8f9c5b909e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/leaver/date/20190101","description":"Use this service to query employees leaving based on a supplied date. By providing a future date the service will check employees who are due to leave between \"now\" and the future date. These employees are currently active, but are set to leave by the date provided.
\nDate format is YYYYMMDD and the date should be in the future, and the service treats date inclusive.
\nIf no date is supplied, by default the service will assume today as the date, i.e. find employees leaving today.
\nProviding a date less than \"today\" will always return 0 returns, no error will be provided, simply a response of 0 employees i.e. you must provide a future date.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","filter","jml","leaver","date","20190101"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0bfd035a-37e8-4010-b998-cc2027c02e09","name":"Leavers by 10th July 2017","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/leaver/date/20180710"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 12 Mar 2018 21:20:49 GMT","name":"Date","description":""},{"key":"ETag","value":"\"n64ZqihwRTaSnvtuJO8evqgaU7E41l1sQh6dvCZ2iJaA88DDSmbv8C/ph/M5S3l9M+IJJjYZ/KhVZTpDuEtdXQ==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"0927066f-15b4-4ceb-ab46-10c24ebde76e-00095dc9","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"employees\" : [\n\"1265972\"\n,\n\"1266093\"\n,\n\"1266320\"\n,\n\"1266812\"\n,\n\"1267013\"\n,\n\"1267172\"\n,\n\"1267412\"\n,\n\"1409000\"\n,\n\"1410828\"\n,\n\"1416471\"\n,\n\"1419656\"\n,\n\"1421133\"\n,\n\"1421660\"\n,\n\"1422451\"\n,\n\"1422642\"\n,\n\"1423322\"\n,\n\"1425268\"\n,\n\"1425560\"\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 18,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/leaver/date/20180324\"\n }\n ]\n}\n"}],"_postman_id":"b8fe21a0-494e-4aee-8b1e-f8f9c5b909e5"}],"id":"60822362-832a-4708-8bb6-bbac908475bf","description":"Use this service to query employees leaving based on a supplied date.
\n","event":[{"listen":"prerequest","script":{"id":"02d5e1ec-d98f-4c56-84b4-ec0ae853ad89","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ec808816-1ef0-4c62-8226-e1eb8dbaf653","type":"text/javascript","exec":[""]}}],"_postman_id":"60822362-832a-4708-8bb6-bbac908475bf"},{"name":"Left","item":[{"name":"/filter/jml/leaver/left/:days?","id":"ad6286b4-e822-4099-972f-1ca035506dcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/leaver/left/1","description":"Use this service to query individuals who have left within the previous X number of days, use the parameter :days to set the X value. With this service it is possible to determine historical employees.
These employees are no longer considered active. The parameter must be positive.
\nThe service will assume yesterday when supplied with no value for :days.
Individuals leaving today will not appear in this result set. Those leaving today remain active until tomorrow.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","filter","jml","leaver","left","1"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad6286b4-e822-4099-972f-1ca035506dcb"}],"id":"d59072cd-12a4-4376-9adb-e0f1ff868846","description":"Use this service to query individuals who have previously left i.e. left within the previous X number of days. These individuals are considered inactive and no longer employeed. The service simply querys the date an individual has left. The date queried is the individuals most recent leaving date (catering for the cases where an individual has re-joined and subsequently left).
\n","event":[{"listen":"prerequest","script":{"id":"dbe2712a-a4b2-4b9b-b0aa-c73f5690b77f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"205fbd7f-8282-42c2-8d70-f9b7b41c2336","type":"text/javascript","exec":[""]}}],"_postman_id":"d59072cd-12a4-4376-9adb-e0f1ff868846"}],"id":"43aec5dd-440e-4c51-97b7-6367c8b50784","description":"This module relates to employees leaving, the service will query an individuals leaving date, even though the employee may currently be active.
\nCommon use cases are:
\n- \n
- Determine individuals leaving within the next X number of days i.e. they are currently active, but have a leave date within the next 10 days. \n
- Determine individuals who are currently active but will have left by a certain future date i.e. provide a future date and the service will return individuals leaving between now and this future date. \n
- Determine individuals previously left. \n
This service is focused on recent starters i.e. active individuals who recently joined. With this service you can determine individuals who started within the previous X number of days, i.e. this is a between NOW and - X days.
\nin cases where no days parameter has been provided, the service assumes 0 i.e. who has started today. In most cases it is expected to provide 30 / 60 or 90 days. A max of 36500 is set for the upper limit.
In all cases employees starting today are included.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","filter","jml","joiner","recent","30"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"236c3d78-5280-42b5-ab51-2931e0494539","name":"Exceeding the Max Threshold","originalRequest":{"method":"GET","header":[],"url":"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/joiner/recent/36501"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 15 Mar 2018 12:12:36 GMT","name":"Date","description":""},{"key":"ETag","value":"\"nN2x9d3E41tTPKzxvz7dKw0hP6y+uPBjgI4mv2+zdxx8IXg8lojzVWg23GzD4VkZycVmFyVr/KOQvZWKurl0kA==\"","name":"ETag","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"0927066f-15b4-4ceb-ab46-10c24ebde76e-000dfe97","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"004\",\"errorMessage\" :\"Validation failed. Max of 36500 (~100 years)\" }}\n"},{"id":"ef67d0ed-654c-45a4-a907-5c89c40bf5fc","name":"Previous 30 Days","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/joiner/recent/30"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 15 Mar 2018 11:53:56 GMT","name":"Date","description":""},{"key":"ETag","value":"\"140VlUC1D3FC3GEyZ2rH9bAWqVN9hnlxbHzATll48Aj8fNKuVg9wYkKSP/n3RUXZ+h9hRJFOjMHr+CTw2P3fgQ==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"0927066f-15b4-4ceb-ab46-10c24ebde76e-000df1b3","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"employees\" : [\n\"5990404\"\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/joiner/recent/\"\n }\n ]\n}\n"}],"_postman_id":"dfa3b814-63f0-4616-85d3-11810b3fd029"}],"id":"4c47e129-dd62-496d-b6f1-789d5bac177d","description":"This service is focused on recent starters i.e. active individuals who recently joined. With this service you can determine individuals you started within the previous X number of days.
\nin cases where no days parameter has been provided, the service assumes 0 i.e. who has started today. In most cases it is expected to provide 30 / 60 or 90 days. A max of 36500 is set for the upper limit.
Determine individuals due to start within the next X number of days.
\nIn cases where no days parameter has been provided, the service assumes 0 i.e. who has started today. In most cases it is expected to provide 30 / 60 or 90 days. A max of 36500 is set for the upper limit.
In all cases employees starting today are included.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","filter","jml","joiner","future","5"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"50cecdd5-b236-435c-b392-07cf5c7280f7","name":"Starting Next 5 Days.","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/joiner/future/5"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 16 Mar 2018 09:06:02 GMT","name":"Date","description":""},{"key":"ETag","value":"\"a57aOwmxwydB4kqrVe87nAzw9DQGCbwJ+w+BGb7ygM2NEY37h+ymWOeSbINkBYdsAjKEEV+GpYdRIyszNKFUXg==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"cb89685b-0a33-4e88-9829-ed0bf23cf3fc-0000597a","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"employees\" : [\n\"1409000\"\n,\n\"1410828\"\n,\n\"1416471\"\n,\n\"1419656\"\n,\n\"1421133\"\n,\n\"5990404\"\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 6,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/joiner/future/5\"\n }\n ]\n}\n"},{"id":"b17049bc-8963-4bae-b0bb-3317a575417e","name":"Starting Today","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/filter/jml/joiner/future/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 16 Mar 2018 09:14:11 GMT","name":"Date","description":""},{"key":"ETag","value":"\"uvizmfzh9HbIvg+bU9Db97yB/zZdZHUPZKquXaeGXMz25ZoDudfkO6lH/nfFZrEDkA99VtHMaWK9iAGZnxcWtw==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"cb89685b-0a33-4e88-9829-ed0bf23cf3fc-00005eff","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"employees\" : [\n\"1265972\"\n,\n\"1266093\"\n,\n\"1266267\"\n,\n\"1266320\"\n,\n\"1425560\"\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 5,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/filter/jml/joiner/future/\"\n }\n ]\n}\n"}],"_postman_id":"a684aa91-a8e8-48a1-89f1-e6d29c72b968"}],"id":"c2a63d4f-922c-45a0-8db6-243222a367aa","description":"This service is focused on individuals starting in the future i.e. individuals who are due to start, but are not currently active. With this service you can determine individuals due to commence within the next X number of days i.e. this is a between NOW and + X days.
\n","event":[{"listen":"prerequest","script":{"id":"1ef7f08c-3854-4ef7-a2c9-9474091172db","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"04c408e5-a38a-4d4a-8a07-a7237e1750b9","type":"text/javascript","exec":[""]}}],"_postman_id":"c2a63d4f-922c-45a0-8db6-243222a367aa"}],"id":"182240bc-fdf9-40df-a253-6e02c0f1a1a9","description":"This module relates to employees joining, the service will query individuals starting date, even though the employee may currently be active. An individuals start date is their most recent start date, in cases where an employee has left and rejoined, their current start date is the most recent date, this service only queries the most recent start date. The service will not look at original start dates aka day Zero.
Common use cases are:
\n- \n
- Determine individual's recently joined, i.e. started in last 30 days. \n
- Determine individual's joining at a future date, i.e. starting in the next 30 days. \n
This modules refers to Joiners, Movers and Leavers hence /JML/. Various use cases exist, for example, use this module to determine:
\n- \n
- recently joined employees \n
- employee's joining within next X number of days \n
- employee's due to leave based on dates / date \n
In general this module will provide filters for employees joining, moving and leaving. The objective is to return an employee result set matching certain use cases.
\n","event":[{"listen":"prerequest","script":{"id":"6a0833b8-423d-42d9-ab30-d75ffd5e7ae8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b5f910b4-7fe8-41ed-8f7a-d25e94f70d22","type":"text/javascript","exec":[""]}}],"_postman_id":"b3f3cee6-d70c-43bf-ad93-f34596f2adcf"}],"id":"b40a4004-2ec3-44f8-b3bc-f8680f1acb67","description":"The filter's module objective, is to decouple common query requests. Instead of each service supporting the common queries, these queries are decoupled in this filter module.
\nCommon Queries include get a list (i.e. a result set) of:
\n- \n
- active employees \n
- employee's due to leave \n
- employee's recently joined \n
- employee's due to join in the near future \n
- employee's appointments (typically the employees Job) \n
Use these filers to query for employees under above headings, and then use the result set to feed other services.
\nPagination and Limits
\nThese filters allow for larger than normal pagesizes. For example, typically the pagesize (i.e. the result set) is 100 results, however you can now set the pagesize to 10,000 (this is a max value). Therefore if you have 10,000 employees you can make one request, if you have more than 10,000 active employees, the filter will provide the first 10,000 and provide a reference link for the next 10,000.
\nDo not set the pagesize above 10,000, if you do, only 100 results will be returned. The web services framework will always revert back to the default (i.e. 100) if the max value has been breached.
\nAny instances where more than pagesize exist, e.g. (a pagesize of 100 is used, and 1,000 records exist) the response body will include a link array with additonal links for pagination.
\nEach GET request includes following
\n- \n
- limit \n
represents the maximum number of records returned in one request e.g. 100 (or whatever the pagesize is)
\n- \n
- offsetby \n
represents pagination, the first request will always have an offsetby 0 i.e. the start. Where more than the limit exists offsetby controls the starting position, typically in batches of 100. Each GET request can accept the offsetby parameter.
\n- \n
- count \n
the number of records for this reponse, the maximum count will equal the limit parameter i.e. 100.
\n- \n
- hasMore \n
a boolean representation indicating if more records exist.
\n- \n
- links \n
includes links to first and next. The next link is used when pagination is discovered i.e. more than the limit per request.
\n","event":[{"listen":"prerequest","script":{"id":"eb403191-c6ed-4b16-90a2-80f85efd422c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"50bb2ac3-b46d-468d-937e-a2a2859d317c","type":"text/javascript","exec":[""]}}],"_postman_id":"b40a4004-2ec3-44f8-b3bc-f8680f1acb67"},{"name":"Person","item":[{"name":"allowances","item":[{"name":"/person/allowances/paid/currentperiod/:personnelNo","id":"870f8b93-974f-4e9f-9a0f-f58180353120","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/allowances/paid/currentperiod/4956040","description":"The specific end point will provide allowances that have been processed for the employee's most recent period that has been completed i.e. from the employees most recent payslip that has been completed for the employees pay group.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
appointmenId
\nA unique reference identifier for the appointment, this is a system generated identifier.
\n \npayCode
\n \n
Represents the actual payCode used to process this item.
\n- \n
- payCodeDescription \n
This attribute represents a free text description associated with the paycode.
\n- \n
- analysisCode \n
Represents the associated anylsis code associated with the paycode. Analysis codes are used to represent a distinction or grouping of payCodes and are typically used for reporting and grouping purposes.
\n- \n
- analysisCodeDescription \n
This attribute represents a free text description associated with the analysisCode.
\n- \n
- value \n
This represents the amount on the employee's payslip, in most cases the allowances will be a positive amount, but there can be cases where this amount will be negative.
\n- \n
- payrollPeriod \n
This attribute represents the payroll period that the allowance included. This should represent the payroll period associated with the employees pay group that is marked as 'Completed Update'.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","allowances","paid","currentperiod","4956040"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"35eb71f7-9e83-4bb0-b718-ce29cf56b3c5","name":"success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/allowances/paid/currentperiod/4956040"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 02 Nov 2018 15:37:02 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;"},{"key":"X-ORACLE-DMS-ECID","value":"fc0eaafe-cec9-418c-9c67-dd411ddfe4e1-00171402"},{"key":"ETag","value":"\"CzWVSoBAGGzx6TAhnBF94Nn1BjnGS+22nCwEWwo0RBzizYGZmXu8kL2iCZVsL8TsMa63EWIkj4bHVKIOfuE7XQ==-gzip\""},{"key":"X-ORACLE-DMS-RID","value":"0"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate"},{"key":"Access-Control-Max-Age","value":"600"},{"key":"Access-Control-Allow-Methods-Age","value":"GET, POST, PATCH, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-CSRF, X-REQUESTED-WITH, CONTENT-TYPE, X-COREHR-PROXY-AS, X-COREHR-DEBUG, AUTHORIZATION,X-COREHR-INTEGRITY"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"2001\",\n \"payCodeDescription\": \"OVERTIME @ 1.00\",\n \"analysisCode\": \"2000\",\n \"analysisCodeDescription\": \"OVERTIME\",\n \"value\": \"147.2\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"6017\",\n \"payCodeDescription\": \"USC\",\n \"analysisCode\": \"6000\",\n \"analysisCodeDescription\": \"STATUTORY DEDUCTIONS\",\n \"value\": \"-327.4\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"9500\",\n \"payCodeDescription\": \"EMPLOYER PRSI\",\n \"analysisCode\": \"9000\",\n \"analysisCodeDescription\": \"EMPLOYER NI\",\n \"value\": \"-.74\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"6500\",\n \"payCodeDescription\": \"EMPLOYEE PRSI\",\n \"analysisCode\": \"6000\",\n \"analysisCodeDescription\": \"STATUTORY DEDUCTIONS\",\n \"value\": \"0\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"6000\",\n \"payCodeDescription\": \"PAYE\",\n \"analysisCode\": \"6000\",\n \"analysisCodeDescription\": \"STATUTORY DEDUCTIONS\",\n \"value\": \"-1862.48\"\n },\n {\n \"appointmentId\": \"WL0007-4\",\n \"payrollPeriod\": \"201635\",\n \"payCode\": \"625\",\n \"payCodeDescription\": \"ADVANCE MISC\",\n \"analysisCode\": \"7000\",\n \"analysisCodeDescription\": \"VOLUNTARY DEDUCTIONS\",\n \"value\": \"-74.34\"\n }\n ],\n \"limit\": 100,\n \"offsetby\": 0,\n \"count\": 6,\n \"hasMore\": false,\n \"links\": [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/allowances/paid/currentperiod/4956040\"\n }\n ]\n}"}],"_postman_id":"870f8b93-974f-4e9f-9a0f-f58180353120"}],"id":"b5bf3743-eae2-447e-9b84-ecf76ffa0f1c","description":"This module has only been made available from CoreHR 26.0.6 and is not available in older versions.
\nThe allowance module deals with providing allowance information associated with an employee. At this time the module only deals with allowances that have been paid, and is not aware of future allowances.
\n","event":[{"listen":"prerequest","script":{"id":"bbaba21f-5b40-4689-bba0-9f7cf4d11249","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b7c70822-80cf-43a5-ad94-4698d2b35c87","type":"text/javascript","exec":[""]}}],"_postman_id":"b5bf3743-eae2-447e-9b84-ecf76ffa0f1c"},{"name":"basicAttributes","item":[{"name":"/person/basicattributes/:personnelNo","id":"ae59a3db-3157-4d7c-8d56-05a88158416f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/","description":"This module returns some of the employee's most basic attributes, however, certain basic attributes are not include in this service for privacy reasons e.g. Social Security Number (SSN). To obtain SSN a separate service is available. The person module typically accepts only personnelNo. Use the filter module to obtain a result sets for various employees status e.g. recently joined, left , active etc.
Most of these attributes are provied by the tenant, the descriptions may not exactly match with the value provided. For example: A field exists known as \"Home Telephone Number\" a tenant may use this for a Landline Number, a personal business number, a mobile number etc.
\nNB No confirmation takes place on the personnelNo, if an incorrect personnelNo is presented the service will simply respond with no data.
\nFollowing attributes are returned:
\nGeneral
\n- \n
- First Name \n
Indicates a persons first name.
\n- \n
- Middle Name \n
Indicates a persons middle name.
\n- \n
- Last Name \n
Indicates a persons middle name.
\n- \n
- Previous Surname \n
Indicates a persons previous surname.
\n- \n
- Known As \n
Sometimes a person is known as a slightly different name that first, last or middle name. This field represents such sceanrios.
\n- \n
- Title \n
Indicates the persons full title description.
\n- \n
- Active \n
Simply indicates Y or N, answering the question at this point in time ( i.e. when the serice is called) \"Is Person Currently active?\". In cases where an individual has a leaving date on the same date the service is executed i.e. today the individual is considered active and will have a value of 'Y'.
\n- \n
- OnBoarding Completed \n
This attribute will be flagged as 'Y' indicating individual has completed their onboarding process, otherwise this will be flagged as 'N'.
\n- \n
- Next of Kin Name \n
The name in CoreHR provided for the individual's next of kin.
\n- \n
- Next of Kin Relationship \n
The name in CoreHR provided for the individual's next of kin relationship.
\n- \n
- Next of Kin Contact Number \n
The contact number associated with the next of kin.
\n- \n
- Home Telephone Number \n
An individuals home telephone number, the area code is included in this field.
\n- \n
- salaryPayMethod \n
Represents the method of payment for one's salary. This is a code e.g 'PP', to obtain the description use the reference module web service using a type of PAYM. Your system administrator will have to ensure this reference type is whitelisted.
NB To obtain Next of Kin Address use the address module.
\n- \n
- loginId \n
An individuals login identifier for self service and mobile applications. NB for SAML enabled sites this attribute will display N/A (SAML enabled site).
\nDates
\nAll dates are represented as : YYYYMMDD
\n- \n
- Date of Birth \n
An individuals date of birth formated
\n- \n
- Termination Date \n
Indicates an individuals most recent date for leaving. In cases where a person has left and rejoined and is flag to leave again this date will alsways be the most recent date for leaving. This may not be populated, this date can be in the futrue.
\n- \n
- Current start Date \n
An individuals most recent date started. This will cater for sceanrios where an individual has left and rejoined. It will always represent the current start date.
\n- \n
- Original Start Date \n
An individuals first time starting with an organisation. This can cater for scnearioes where an employee has left and rejoined. This date never changes, if an individual is currently active and has never left, this is the same date as Current Start Date. If this date is differnt to current start date, this typically means an individual has rejoined.
\n- \n
- Continuous Service Date \n
This date is used for calculating an individual length of service. Within the CorEHR engine this can be a complex process. This field represents the correct continuous service date, there should be no need to attempt to derive this date from the various other dates supplied.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","basicattributes",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"05cbe99a-fda7-4437-9dea-eb09ea7acaaf","name":"Validation Failed AlphaNumeric ","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/123!!"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 22 Jun 2018 11:06:40 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"RmAmWESpjPx1HQcC4yM3LakCm1+pazrdxEpor92H2/Bbgfn5+PkfVrR1SNs1fnfVhP7f+MscIk1F07yw1loGjw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"30038f37-18e0-4c74-a73d-1ed97dac4bc1-00143b6d","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"Alphanumeric characters only.\",\n \"code\": \"9002\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"},{"id":"081f2257-2c78-45d4-b98b-7d7f46a05b4e","name":"Mandatory Field Missing","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 22 Jun 2018 11:05:26 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"Xv9lRXYEJ7eVD2nC2gIUqerGRIFOD81+JnHtfOxPQgWOYt9i+LRFxXCLUSr7Xr8sssp6vyRHeKI0cUBgSxjMyg==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"30038f37-18e0-4c74-a73d-1ed97dac4bc1-001439db","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"This field is mandatory.\",\n \"code\": \"9001\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"},{"id":"1df5b8ab-1edf-453f-9bc2-db8fca011fdd","name":"Working Example","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 16:16:43 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"QozGpjQ/pokQfFuXCrLby9Kfov86tifSFSwitSSyqwRrHSB0VIhvBagWvIthkxz1i96lihX/dAAhFAsj+KzgJQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-000062cb","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"firstName\":\"Marco\",\"middleName\":\"Rufus\",\"lastName\":\"Donnini\",\"previousSurname\":\"Radinski\",\"knownAs\":\"Marco\",\"title\":\"Professor\",\"active\":\"Y\",\"onboardingCompleted\":\"N\",\"dateOfBirth\":\"19700101\",\"currentStartDate\":\"20180315\",\"terminationDate\":\"\",\"originalStartDate\":\"20170102\",\"continuousServiceDate\":\"20180315\",\"nextOfKinName\":\"Rufus Stravous\",\"nextOfKinContactNumber\":\"+44 765892350\",\"nextOfKinRelationship\":\"Partner\",\"salaryPayMethod\":\"PP\",\"homeTelehoneNumber\":\"4401892350\",\"loginId\":\"N/A (SAML enabled site)\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/basicattributes/5990404\"\n }\n ]\n}\n"},{"id":"47debd88-9eaa-41d8-844a-f7cec2b492fa","name":"Validation Failed Wrong Field Length","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/basicattributes/1234567890123"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 22 Jun 2018 11:07:28 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"T2L98k5uY4oOIYGERPhm/fRFFPlBFj5IYfwnRplcyTaCuRCN5aZXRLqBxQjdHdbnstHQbumRWP7agQ3j8kc0FA==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"30038f37-18e0-4c74-a73d-1ed97dac4bc1-00143c86","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"The maximum length of this field is 12\",\n \"code\": \"9011\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"}],"_postman_id":"ae59a3db-3157-4d7c-8d56-05a88158416f"}],"id":"41651273-9057-4a3c-aace-2f31ae1fc3fa","description":"This section deals with an individuals most basic attributes e.g. name, title, date of birth etc. As CoreHR is a HR system, every field within the app could be argued to be included. Our objective is to provide services for use cases and not expose all fields in one monolithic web service. We also have to consider privacy and security e.g. not every third party service app requires Social Security Number or Bank Account Details etc. Hence, such fields are not included in the basicAttributes service, instead they are available via specific services.
\nYou might ask where are email, mobile numbers etc and why are they not provided here?
\nInstead they are provided via the Contact module (such detail is highly configurable)
Following attributes are provided as part of this basicAttribute module:
\nGeneral
\n- \n
- First Name \n
Indicates an individuals first name.
\n- \n
- Middle Name \n
Indicates an individuals middle name.
\n- \n
- Last Name \n
Indicates an individuals middle name.
\n- \n
- Known As \n
Sometimes a person is known as a slightly different name thatn their first, last or middle name. This field represents such scenarios.
\n- \n
- Title \n
Indicates an individuals full title description.
\n- \n
- Active \n
Simply indicates Y or N, answering the question at this point in time ( i.e. when the serice is called) Is Person Currently active?
\n- \n
- Onabording Completed \n
Simply indicates Y or N, representing if the individual has completed their onboarding.
\n- \n
- Next Of Kin \n
Information regarding the individuals next of kin.
\nDates
\nAll dates are represented as : YYYYMMDD
\n- \n
- Date of Birth \n
An individuals date of birth.
\n- \n
- Termination Date \n
Indicates an individuals most recent date for leaving. In cases where a person has left, and rejoined, and is flagged to leave again, this date will always represent the most recent date for leaving. This date field may not be populated, this date can be in the futrue.
\n- \n
- Current start Date \n
An individuals most recent date started. This will cater for scenarios where an individual has left and rejoined. It will always represent the current start date.
\n- \n
- Original Start Date \n
Represents an individuals first date, when they started Day Zero with an organisation. This can cater for scenarios where an employee has left and rejoined. This date never changes, if an individual is currently active and has never left, this is the same date as Current Start Date. If this date is different to current start date, typically suggests an individual has rejoined.
\n- \n
- Continuous Service Date \n
This date is used for calculating an individual length of service. Within the CoreHR engine this can be a complex process. This field represents the correct continuous service date, there should be no need to attempt to derive this date from the various other dates supplied.
\n","event":[{"listen":"prerequest","script":{"id":"cd286b42-6036-4883-bcbf-f88b5d064a04","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9a3416a2-821a-43b3-8c19-e07a73bb2692","type":"text/javascript","exec":[""]}}],"_postman_id":"41651273-9057-4a3c-aace-2f31ae1fc3fa"},{"name":"address","item":[{"name":"home","item":[{"name":"/person/address/home/:personnelNo","id":"3ba5a34f-6195-48d3-80e5-277c328a41fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/home/5990404","description":"This service simply returns the home address for an individual.
\nHome address's have effective dates and have the concept of being active, the current effective and active home address is returned.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","address","home","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"1cde8e07-a7cb-4757-86eb-687bdf5a5664","name":"Home Address","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/home/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 17:46:29 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"LHgoPsSqJ5Zp8UqBgh5MgVJG1HOKKCBfPREAx0YMiAa1XGYZQFGCugkHcVG78YpKDshSr27rdW7q+8qo0Xaa1Q==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0000c169","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"line1\":\"01 Sherringham Avenue\",\"line2\":\"Westmore\",\"line3\":\"Windsor\",\"line4\":\"Tottenham\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N17\",\"postCodeSuffix\":\"9XJ\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/address/home/5990404\"\n }\n ]\n}\n"}],"_postman_id":"3ba5a34f-6195-48d3-80e5-277c328a41fc"}],"id":"4e7598d3-b2a6-499f-9d8a-8b81ed7f434a","description":"This service simply returns the home address for an individual.
\n","event":[{"listen":"prerequest","script":{"id":"6b956ad4-7633-41dc-bacb-3a3afd2625eb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2122e651-4b7b-489c-8a06-0100786b105a","type":"text/javascript","exec":[""]}}],"_postman_id":"4e7598d3-b2a6-499f-9d8a-8b81ed7f434a"},{"name":"nextOfKin","item":[{"name":"/person/address/nextofkin/:personnelNo","id":"cf67bc60-d711-4ae4-94f4-ecca9e0f9c3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/nextofkin/5990404","description":"This service simply returns the next of kin address for an individual.
\nNext of Kin address's have effective dates and have the concept of being active, the current effective and active Next of Kin address is returned.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","address","nextofkin","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"80d16e8f-8f7d-4472-bf67-b61751ee616a","name":"Next Of Kin Address","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/nextofkin/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 17:47:03 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"GH0Ws6A72ZRA9hGnM/hkQzulABHsxNo+6L4wYBM7/01GxS47hp98GWrAUk1Z3T0UyQgnPFcoFtJlDKvttTJzwQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=99","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0000c1be","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"line1\":\"01 Windsor Street\",\"line2\":\"East Bridge\",\"line3\":\"Kings Avenue\",\"line4\":\"Windsor\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N18\",\"postCodeSuffix\":\"8ZJ\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/address/nextofkin/5990404\"\n }\n ]\n}\n"}],"_postman_id":"cf67bc60-d711-4ae4-94f4-ecca9e0f9c3c"}],"id":"0278fb47-bbcb-4f97-b2c1-5111692277d6","description":"This service simply returns the next of kin address for an individual.
\n","event":[{"listen":"prerequest","script":{"id":"f505f458-f561-4ad5-af9b-04b14b10958a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"500acf61-a1e4-4296-91f0-dac836d9a945","type":"text/javascript","exec":[""]}}],"_postman_id":"0278fb47-bbcb-4f97-b2c1-5111692277d6"},{"name":"work ","item":[{"name":"/person/address/work/:personnelNo","id":"8c1d3d41-8350-4232-86f4-71551900814c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/work/5990404","description":"This service simply returns the work address for an individual.
\nWork address's have effective dates and have the concept of being active, the current effective and active work address is returned.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","address","work","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3d7ea8d3-e60e-4224-b1df-1e250c2e16b6","name":"Work Address","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/work/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 17:50:18 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"BfvMfrRK99guHS+1Cxo2GDYQj7LsqayBrWRnoH+84jV80kgOOa38STTJaL7oNDTYQNuu9qlKrJPfMDqZZfKWeg==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0000c393","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"line1\":\"100 Fleetmore Street\",\"line2\":\"West Kings State\",\"line3\":\"Queens Avenue\",\"line4\":\"Windsor\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N17\",\"postCodeSuffix\":\"9SD\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/address/work/5990404\"\n }\n ]\n}\n"}],"_postman_id":"8c1d3d41-8350-4232-86f4-71551900814c"}],"id":"b0e61097-22e4-4c1f-9a55-e21aec8b5578","description":"This service simply returns the work address for an individual. The address type of 'work' is not deafult address type as part of CoreHR. However, this address type is often created by system Administrators. For this web service to return an Address, the address type must be 'WORK'.
\n","event":[{"listen":"prerequest","script":{"id":"3c3d4f71-810a-4c7a-b5cd-8223f86aba6d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9ce2f934-5067-41b1-9d5f-2e14a33472e7","type":"text/javascript","exec":[""]}}],"_postman_id":"b0e61097-22e4-4c1f-9a55-e21aec8b5578"},{"name":"all","item":[{"name":"/person/address/all/:personnelNo","id":"d85d8682-c0ab-4bda-b2fe-6fdb6f5efb22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/all/5990404","description":"This service returns all active addresses for an individual currently ineffective. This includes home, next of kin and other address.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","address","all","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"c92d8970-c302-4066-80d9-ad647660ca7c","name":"All Addresses","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/address/all/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 26 Jun 2018 17:54:13 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"whBYl/hO41707uWg37s7brO+oRGWKVUVCArWwHkfSzyVWhRscn+I6GNpgMHTDembglIL4AUg8sl4ShdOw6gEhQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0000c5f8","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"WORK\",\"line1\":\"100 Fleetmore Street\",\"line2\":\"West Kings State\",\"line3\":\"Queens Avenue\",\"line4\":\"Windsor\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N17\",\"postCodeSuffix\":\"9SD\"}\n,\n{\"type\":\"home\",\"line1\":\"01 Sherringham Avenue\",\"line2\":\"Westmore\",\"line3\":\"Windsor\",\"line4\":\"Tottenham\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N17\",\"postCodeSuffix\":\"9XJ\"}\n,\n{\"type\":\"nextOfKin\",\"line1\":\"01 Windsor Street\",\"line2\":\"East Bridge\",\"line3\":\"Kings Avenue\",\"line4\":\"Windsor\",\"line5\":\"London\",\"countyCode\":\"LON\",\"countryCode\":\"GBR\",\"postCodePrefix\":\"N18\",\"postCodeSuffix\":\"8ZJ\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 3,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/address/all/5990404\"\n }\n ]\n}\n"}],"_postman_id":"d85d8682-c0ab-4bda-b2fe-6fdb6f5efb22"}],"id":"27208112-32a8-47fb-a67b-fda795620967","description":"Use this service for all addresses associated with an individual. A tenant has the ability to create several additional address types. This service will return a result set of additional addresses i.e. all addresses associated with the individual including Home and NextOfKin.
\nTo determine descriptions for these additional address type, one can use the reference module.
\nIf a web service app has access to the reference module, and your administrator has whitelisted the reference type ADDTYP the app can query the reference module using the type ADDTYP. These additional other address types are best explained by the HR administrators of the CoreHR application.
The address module's objective is to determine individual's addresses. CoreHR provides a complete and detailed module for defining different types of addresses. Individual's may have several different addresses, typically referred to as address types e.g. home, business, next of kin, overseas etc. Not all personnel will have each of these address types. Assigning addresses to each person is a matter for each tenant. The CoreHR app also faciliates tenants adding various additional addresses.
\nIn general, use cases for these services include obtaining:
\n- \n
- an individual's home address \n
- an individual's next of kin address \n
- an individual's work address \n
- other address types associated with an individual \n
This module has been split into different easy to use scenarios:
\n- \n
- Home Address \n
- Next of Kin \n
- Work \n
- All \n
Home and Next of Kin addresses are simple and explicit. While others are slightly more completex. If the requirement is home address simply use the home address service, and for next of kin use next of kin service. For Other address types refer to the all address service below. Work address has been added as it's a typical use case, however, work address may or may not be in use.
\nAddress Templating
\nThis service does not implement address templating. Address type templating is a higher level display facility, providing options around the order of how to display an address e.g. display address line 3 before address line 1. Instead, the address is displayed in order 1 through 5.
\nParameters
\nEach of the address web services use the following parameters:
\n- \n
- personnelNo \n
Manadatory
\nType: AlphaNumeric
\nMax Length : 12
\n","event":[{"listen":"prerequest","script":{"id":"25d23e83-6871-424e-99ea-24ccbec1fee0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cfdb6a84-a2c8-49ad-9e4d-81bc637d4dca","type":"text/javascript","exec":[""]}}],"_postman_id":"f76b62db-bbb9-401f-9f9e-47f64fc6d1b3"},{"name":"workpermit","item":[{"name":"/person/workpermit/:personnelNo","id":"e0032c9a-ed9d-4402-9906-ba88767f8d78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/workpermit/5990404","description":"Provides an individuals work permit information.
\n- \n
Work Permit Number
\n \nWork Permit
\n \nDate Work Permit Issued
\n \nDate Work Permit Expires
\n \n
Provides an individuals work permit information.
\n- \n
Work Permit Number
\n \nWork Permit
\n \nDate Work Permit Issued
\n \nDate Work Permit Expires
\n \n
The following attributes are associated with an individual's probabtion detail. Not all attributes will be populated.
\nAll dates presented in 'YYYYMMDD' format.
\n- \n
- Date Complete \n
The probabtion completion date is the date which the individuals probstion is completed.
\n- \n
- Date Expires \n
The probation expiry date is the date which the individual's probation is due to expire.
\n- \n
- Date Review One \n
The probation review date is the first review date for the individuals probation.
\n- \n
- Date Review Two \n
This probation review date is the second review date for the individual's probation.
\n- \n
- Date Extension \n
This date represents the individual's probation extension where applicable.
\n- \n
- Extension Reason \n
The probation extension reason represents the reason for extending the persons probation. This is a reference related attribute, the associated desription is available from the reference module under the reference type PEXRSN. Note, in order to obtain the description your system administrator will be required to whitelist the reference type PEXRSN and granted the app approrpiate privileges.
This module provides an individual's probation detail.
\n","event":[{"listen":"prerequest","script":{"id":"d0eb92ba-651a-417f-a1d2-f52bd67b974c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4f112ea2-bb1b-420a-8ab7-86f6c8dec89d","type":"text/javascript","exec":[""]}}],"_postman_id":"d27a924b-36e4-4647-9e7c-13b8c8c3472c"},{"name":"salary","item":[{"name":"/person/salary/:personnelNo/:date?","id":"e3825bc4-20ec-4bae-b6f1-4dd1a2f14887","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/salary/5990404/","description":"Provides an employees salary, has the ability to get an employees full salary history along with Salary for a specific date. It is therefore possible to determine current, full history or salary for a specfic date across all of an employees appointments.
\nParameters
\n- \n
- personnelNo \n
Manadatory
\nType: AlphaNumeric
\nMax Length : 12
\n- \n
- date \n
Optional
\nFormat : YYYYMMDD
\nWhen no date is provided, the service assumes current active salary details. When populated \n(note the date formatted must be YYYYMMDD) this will provide employees salary for the specfic date. While providing 0 indicates to the service to return a result set of employees entire salary history.
This module will provide salary detail for an individual. Salary information can be a complex topic, outlined explains in as simply terms as possible how an employees rate of pay is determined.
\nUses Cases determine
\n- \n
- an employee's current salary detail \n
- an employee's historical salary detail \n
- an employee's salary per appointment \n
- an employee's salary on a specific date \n
This salary module is aware of multi-appointments i.e. in cases where an individual has more than one active position (i.e. more than one appointment) two entries or more, will be included in the results set. In cases where only one position is associated with an employee only one entry will be returned.
\nEmployee's rates of pay can be based on various frequencies:
\n- \n
- Hourly \n
- Daily \n
- Weekly \n
- Annual \n
Not all attributes will be populated, the fields populated are dependent on how your system administrators have configured salary / pay details.
\nFollowing attributes are returned:
\n- \n
- annual \n
An annual salary rate, typically used for salary based employees. Each month this rate is divided by 12.
\n- \n
- weekly \n
A weekly based rate of pay.
\n- \n
- daily \n
A daily based rate of pay.
\n- \n
- hourly \n
An hourly based rate of pay.
\n- \n
- dateActive \n
The date when the rate(s) of pay are effective for employee. An employee can only have one set of active pay rates per appointment.
\n- \n
- dateExpire \n
The date when the rate(s) of pay have ended and are no longer active for employee. Useful when viewing historical rates of pay.
\n- \n
- multiplier \n
This is a number applied to the rate of pay, typically set to 1, indicating the individual is paid the (rate of pay * 1), often used in cases where employee is part time.
\n- \n
- annualised \n
The annual rate of pay, in cases where weekly rate is only provided, this figure presents an annual rate. In cases where the annual rate is defined, this annualised figure is the same value.
\n- \n
- actualPay \n
Takes the provided rate(s) of pay and applies the multiplier.
\n- \n
- actualAnnualisedPay \n
Takes the annualised figure and applies the multiplier.
\n- \n
- appointmentID \n
Employee's unique Job identifier, typically referred to as appointment ID. It is possible an individual has more than one Job/Appointment, if this is the case more the result set will reflect this.
\n- \n
- grade \n
This attribute reprsents an employee's salary grade, typically this represents one's Role / Job.
\n- \n
- point \n
This attribute represents a level within the Grade, sometimes termed Spine Point. In some cases this value can be '9999', this represents an individual has been assigned a personal point.
\n","event":[{"listen":"prerequest","script":{"id":"c4027c03-4245-4132-a9bc-e7bad0a4b8a9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2fea5d69-8e27-47f3-b67a-cca1e5207f98","type":"text/javascript","exec":[""]}}],"_postman_id":"15e3b198-0e16-4e52-b616-fc6af3691726"},{"name":"socialSecurityNumber","item":[{"name":"/person/socialsecuritynumber/:personnelNo","id":"d73080bd-c6e0-44c5-bb03-e6881a37ed13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/socialsecuritynumber/5990404","description":"Simply gets an individuals Social Security Number.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","socialsecuritynumber","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"487b311d-1475-4977-90d7-b200f6bb5714","name":"Salary on Specific Date ","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/salary/5990404/20170101"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 21 Mar 2018 17:58:29 GMT","name":"Date","description":""},{"key":"ETag","value":"\"X8DO7XKppamdtc8NWRGV4/oL9G8Xqsj7zouGAbNqDV2Y9g4Wwdl3gRdBM3iciy40xCIPV9WwIQRbWiWwY0QFKg==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"253df163-0e02-4479-b26d-f2eaa8228ccf-00011bba","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"salary\" : [\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20161211\",\"dateExpire\":\"20170107\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"OU0011-12458\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/salary/5990404/20170101\"\n }\n ]\n}\n"},{"id":"d805a7dc-9491-4311-9d88-cc034272da34","name":"Current Active Salary","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/salary/5990404/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 21 Mar 2018 17:57:37 GMT","name":"Date","description":""},{"key":"ETag","value":"\"FDsnzuXPBRCYJbbDVL2OyeQ9P2HxpYUXcZyf2t1OE5u8nKCRru6K48Y/V+cXg/9KPl/nUAaF7IDq1H8s3HEVSA==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"253df163-0e02-4479-b26d-f2eaa8228ccf-00011b68","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"salary\" : [\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20170108\",\"dateExpire\":\"\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"TS0011-18339\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/salary/5990404/\"\n }\n ]\n}\n"},{"id":"dc7eb5f8-2d96-4ddd-8d0a-9cf48508c09d","name":"All Salary History","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/salary/5990404/0"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 21 Mar 2018 17:58:04 GMT","name":"Date","description":""},{"key":"ETag","value":"\"hkaOE4XQSbYdfEu/G4B7X3hnwbEZbElMx/uzYF1NoEK/tWmjE8dhIE0XKrxzA2nxzOD+upOc7BFrs9bjOQsoyw==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"253df163-0e02-4479-b26d-f2eaa8228ccf-00011b92","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"salary\" : [\n{\"annual\":\"14448.25\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.1\",\"dateActive\":\"20130718\",\"dateExpire\":\"20160401\",\"multiplier\":\"1\",\"annualised\":\"14448.25\",\"actualPay\":\"14448.25\",\"actualAnnualisedPay\":\"14448.25\",\"appointmentID\":\"JXXXXX-4347\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20161211\",\"dateExpire\":\"20170107\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"OU0011-12458\"}\n,\n{\"annual\":\"14448.25\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.1\",\"dateActive\":\"20160402\",\"dateExpire\":\"20160923\",\"multiplier\":\".25641\",\"annualised\":\"14448.25\",\"actualPay\":\"3704.67578\",\"actualAnnualisedPay\":\"3704.67578\",\"appointmentID\":\"OU0011-2694\"}\n,\n{\"annual\":\"14448.25\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.1\",\"dateActive\":\"20160924\",\"dateExpire\":\"20160915\",\"multiplier\":\".25641\",\"annualised\":\"14448.25\",\"actualPay\":\"3704.67578\",\"actualAnnualisedPay\":\"3704.67578\",\"appointmentID\":\"OU0011-2694\"}\n,\n{\"annual\":\"14448.25\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.1\",\"dateActive\":\"20160916\",\"dateExpire\":\"20160922\",\"multiplier\":\".25641\",\"annualised\":\"14448.25\",\"actualPay\":\"3704.67578\",\"actualAnnualisedPay\":\"3704.67578\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15262.24\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.5\",\"dateActive\":\"20160923\",\"dateExpire\":\"20160924\",\"multiplier\":\".25641\",\"annualised\":\"15262.24\",\"actualPay\":\"3913.39096\",\"actualAnnualisedPay\":\"3913.39096\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"\",\"daily\":\"\",\"hourly\":\"\",\"dateActive\":\"20160925\",\"dateExpire\":\"20160925\",\"multiplier\":\".25641\",\"annualised\":\"15770.98\",\"actualPay\":\"4043.83698\",\"actualAnnualisedPay\":\"4043.83698\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"\",\"daily\":\"\",\"hourly\":\"\",\"dateActive\":\"20160926\",\"dateExpire\":\"20160930\",\"multiplier\":\".410256\",\"annualised\":\"15770.98\",\"actualPay\":\"6470.13917\",\"actualAnnualisedPay\":\"6470.13917\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20161001\",\"dateExpire\":\"20161029\",\"multiplier\":\".410256\",\"annualised\":\"15770.98\",\"actualPay\":\"6470.13917\",\"actualAnnualisedPay\":\"6470.13917\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20161030\",\"dateExpire\":\"20161210\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"TS0011-12438\"}\n,\n{\"annual\":\"15770.98\",\"weekly\":\"0\",\"daily\":\"0\",\"hourly\":\"7.75\",\"dateActive\":\"20170108\",\"dateExpire\":\"\",\"multiplier\":\".307692\",\"annualised\":\"15770.98\",\"actualPay\":\"4852.60438\",\"actualAnnualisedPay\":\"4852.60438\",\"appointmentID\":\"TS0011-18339\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 11,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/salary/5990404/0\"\n }\n ]\n}\n"}],"_postman_id":"d73080bd-c6e0-44c5-bb03-e6881a37ed13"}],"id":"a1951999-c09e-4473-ae4b-37934627fdfe","description":"An individuals National Social number e.g. Social Security Number.
\n","event":[{"listen":"prerequest","script":{"id":"bacefca3-38c3-46c0-b830-7cb900b216b8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3a0c86e6-4085-44ac-8ad4-67d9dbdce7bf","type":"text/javascript","exec":[""]}}],"_postman_id":"a1951999-c09e-4473-ae4b-37934627fdfe"},{"name":"bank","item":[{"name":"/person/bank/:personnelNo","id":"d86f426d-75a9-47a9-bb7d-ef7325d2a9bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/bank/5990404","description":"Provides an employees bank account details both Salary and Expense. In addition the building society number is also available form this web service.
\nNB - relates to tenants implementing HR, no special consideration has been provided to Payroll Only Special tenants.
\nTenant's implement different approaches to storing an individual's bank account detail. This service provides both traditional sort code / bank account code's and the newer BIC and IBAN.
\nNo conversion process takes place, instead the information held in CoreHR is displayed i.e. if the tenant has not provided BIC and IBAN for an individual, the expectation for this service is not to display same.
\n- \n
- personnelNo \n
this is manadatory, at a minimum this parameter must be provided.
\nReturns following information for both Salary and Expense:
\n- \n
- Sort Code \n
An individual's traditional Bank Branch identification. Left padding with 0's is not applied when the value is less than 6 characters. This is fixed in V27.0.8+.
\n- \n
- Bank Account Number \n
An individual's traditional Bank Account Number. Left padding with 0's is not applied when the value is less than 8 characters. This is fixed in V27.0.8+.
\n- \n
- BIC \n
An individual's Bank Identification code
\n- \n
- IBAN \n
An individual's International Bank Account Number
\n- \n
- Building Society Reference \n
An individual's building society reference number
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","bank","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b5edba5c-6214-409f-aa5e-e6d99eb85426","name":"Salary and Expense","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/bank/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 05 Apr 2018 14:24:56 GMT","name":"Date","description":""},{"key":"ETag","value":"\"kPah9YnLuQejW3/UQrmaws6hdxEb5O4JN3azU8xWPt3TOpcq+1RDvvJdvW8ILk19RiBm3x/Ypr/sHf/UhfyiiQ==\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-ORACLE-DMS-ECID","value":"d99bff8e-c042-4720-8fb9-2dea429dc7ce-0001db16","name":"X-ORACLE-DMS-ECID","description":""},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"accounts\" : [\n{\"type\":\"salary\",\"bankSortCode\":\"902813\",\"bankAccountNumber\":\"12345678\",\"bic\":\"AIBKIE2DXXX\",\"iBan\":\"IE49AIBK93015612345678\"}\n,\n{\"type\":\"expense\",\"bankSortCode\":\"912314\",\"bankAccountNumber\":\"87235622\",\"bic\":\"AIBKIE2DXXX\",\"iBan\":\"IE49AIBK93015612345678\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 2,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/bank/5990404\"\n }\n ]\n}\n"}],"_postman_id":"d86f426d-75a9-47a9-bb7d-ef7325d2a9bc"}],"id":"96fe8873-a576-42e0-bf4f-0a5340d43b7d","description":"A simply service to retrieve an individuals bank account details.
\nAn individual may have more than one bank account, e.g. one for Salary payments and another for Expense. These account details maybe the same or different.
\nThis service caters for both Salary and Expense bank accounts.
\n","event":[{"listen":"prerequest","script":{"id":"afed91d9-7499-47c4-a04f-f1b9f4a83fc5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fb319359-2692-4685-a1a0-abb4812ef7f2","type":"text/javascript","exec":[""]}}],"_postman_id":"96fe8873-a576-42e0-bf4f-0a5340d43b7d"},{"name":"genderIdentity","item":[{"name":"/person/genderidentity/:personnelNo","id":"70820e11-dec9-474b-b66b-99c28ae36d60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/genderidentity/5990404","description":"Provides an individuals legal sex and gender identification detail.
\n- \n
- personnelNo \n
this is manadatory, at a minimum this parameter must be provided.
\nReturns following attributes:
\n- \n
Legal Sex
\n \nGender Identity
\n \n
This is a gender identification code, for associated descriptions use the Reference Module with the reference type GNDRID.
This service provides information relating to an individual's gender identification.
\n","_postman_id":"a8a6b8a4-bb2e-44d9-9439-27a524f15fc7"},{"name":"costAllocation","item":[{"name":"/person/costallocation/:personnelNo","id":"5ca60eb6-281a-4490-a2d3-3e6b1ba2a8d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/costallocation/5990404","description":"This service provides the ability to obtain an employees cost allocations, all cost allocations are returned both current and historic (dates are provided to distinguish open / closed allocations). Generally this service not return 100's of cost allocations, and therefore no special filters are created.
\nCost Alloactions can be defined at the employee or appointment level.This service is defined at the employee level, but will return appointment ID's where appropriate.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
- costCentre \n
the cost centre, this code can be mapped to the reference module, using COST. This attribute should always be populated.
- \n
- percent \n
the percentage applied to this cost allocation. This attribute should always be populated.
\n- \n
- location \n
the location applied to this cost allocation, this code can be mapped to the reference module, using LOC
- \n
- project \n
the project applied to this cost allocation, this code can be mapped to the reference module, using PROJ
- \n
- expense \n
the expense applied to this cost allocation, this code can be mapped to the reference module, using EXPS
- \n
- allocationId \n
unique identifier for a cost allocation. Provides an ability to link directly back to the cost allocation. This attribute should always be populated.
\nExample:
\nAn employees salary is calculated and associated with three different cost centres, and query where the value at cost centre X comes from, the allocation ID (if present) can link back to the exact cost allocation that triggered it, e.g. 25% of costs to cost centre X.
\n- \n
- appointmentId \n
The appointment associated with this cost allocation
\n- \n
- startDate \n
the date this cost allocation comes into affect, format YYYYMMDD
\n- \n
- endDate \n
the date this cost allocation is no longer in effect, format YYYYMMDD
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","costallocation","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6db8f3a4-5969-46a2-ac58-f12a52ae450b","name":"Success Cost Allocations","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/costallocation/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 02 May 2018 11:00:39 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"6XCcIUTnTS/FuB7jjB/DDFRD/fz8jTWUTGZDWvK6rZuE8/isin3lnJogmwcCAHD4IuCST8s+6cRPWCA2FDMbCw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"d99bff8e-c042-4720-8fb9-2dea429dc7ce-003c1ddc","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"attributes\" : [\n{\"costCentre\":\"BM40008\",\"startDate\":\"20170715\",\"endDate\":\"20170831\",\"percent\":\"100\",\"location\":\"\",\"allocationId\":2017071974748241,\"appointmentId\":\"502629-3\",\"expense\":\"40290\",\"project\":\"7\"}\n,\n{\"costCentre\":\"BM40008\",\"startDate\":\"20170711\",\"endDate\":\"20170714\",\"percent\":\"100\",\"location\":\"\",\"allocationId\":2017071974745300,\"appointmentId\":\"502629-1\",\"expense\":\"40290\",\"project\":\"7\"}\n,\n{\"costCentre\":\"BM40014\",\"startDate\":\"20170704\",\"endDate\":\"20170710\",\"percent\":\"50\",\"location\":\"\",\"allocationId\":2017071974745296,\"appointmentId\":\"502629-1\",\"expense\":\"40560\",\"project\":\"5\"}\n,\n{\"costCentre\":\"BM00000\",\"startDate\":\"20170704\",\"endDate\":\"20170710\",\"percent\":\"50\",\"location\":\"1\",\"allocationId\":2017071974745298,\"appointmentId\":\"502629-1\",\"expense\":\"40290\",\"project\":\"7\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 4,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/costallocation/5990404\"\n }\n ]\n}\n"}],"_postman_id":"5ca60eb6-281a-4490-a2d3-3e6b1ba2a8d9"}],"id":"8d301d78-55ad-41dc-b656-a00a43965e5c","description":"This service provides the ability to obtain an employees cost allocations, all cost allocations are returned both current and historic (dates are provided to distinguish open / closed allocations). Generally this service not return 100's of cost allocations, and therefore no special filters are created.
\nCost Alloactions can be defined at the employee or appointment level.This service is defined at the employee level, but will return appointment ID's where appropriate.
\n","event":[{"listen":"prerequest","script":{"id":"fdbe4c65-0306-4321-b393-14665af8720a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"904d2c56-564c-4630-806d-47ade091ca34","type":"text/javascript","exec":[""]}}],"_postman_id":"8d301d78-55ad-41dc-b656-a00a43965e5c"},{"name":"appointment","item":[{"name":"/person/appointment/:personnelNo","id":"fab040f4-305f-4991-9a04-d58257ad695e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/appointment/5990404","description":"This service returns an individuals appointment related information. An appointment has various different descriptions including Contract, Post, Job, Position etc. Individuals may have more than one appointment at any given moment, though typically an individual will hold one appointment at any one time.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
appointmenId
\nA unique reference identifier for the appointment, this is a system generated identifier.
\n \nappointmentStatus - following explains the details:
\n \n
- \n
\nPL(Planned) - When a new appointment is created it will have the status of PL. This is like a placeholder appointment. You can enter planned details like the planned contract dates. No person is linked to the appointment at this stage. As such for this service you should never see this status. \n
\nAU(Authorised) - When the post administrator authorises a planned appointment, the appointment status changes to AU. This is a placeholder appointment that has been authorised. No person is linked to the appointment at this stage. As such for this service you should never see this status. \n
\nRE(Recruitment in Progress) - If the recruitment module is in use, you can optionally link an authorised appointment to an open vacancy. The appointment status changes to RE. A person gets linked to the appointment via the recruitment module when they are offered and accept a vacancy offer. \n
\nAP(Appointed) - The appointment status changes to AP when an employee new or existing is appointed to the appointment. Further contract details can be entered at this stage. It is usually indicative of a person accepting the contract but has not yet started it. The post can be configured that when you link an employee to the appointment that this stage is bypassed and the status goes straight to commenced. \n
\nCOCommenced - The person has started on the appointment. A salary record is generated. For new starters they cannot be brought on to payroll until they are commenced. This should be the most common status encountered. \n
\nCFCommenced Future - The person is commencing the appointment at a future date. The status reverts to CO when the start date of the appointment becomes effective. \n
\nENEnded - The appointment has been ended because the person has left the organisation or has started in a new appointment. \n
- \n
- category \n
Categorises appointments based on an organisations requirements. E.g. Categorising employees who are entitled to additional levels of annual leave. For associated descriptions use the Reference Module with the reference type CATG.
- \n
subCategory
\nTypically used to further break down the Category. For associated descriptions use the Reference Module with the reference type
\nSUBC. \nstartDate
\n \n
The appointment start date.
\n- \n
- endDate \n
The appointment start date.
\n- \n
- lastAmendedDate \n
(requires version 26.0.9+)
\nThis date indicated a changed has been made to the appointment.
\n- \n
- FTE \n
Full Time Eqivalence of the appointment between 0 and 1 (inclusive).
\n- \n
contractId
\nprovides ability to set a contract identifier and associate with the appiointment.
\n \njobTitle
\n \n
The title of the apponitment ad used to describe the name of the position.
\n- \n
- jobCategory \n
This is an appointment level field used to categorise job titles into groups of similar job titles. For associated descriptions use the Reference Module with the reference type JOBCAT.
- \n
- postNumber \n
the is the post profile number from which the appointmnet is based on. A post is essentially a blue print for the appointments.
\n- \n
- primaryFlag \n
this attribute will simply indicate if the appointment is the \"Substantive\" appointment as of today, this is an employees primary appointment.
\n- \n
- project \n
this attribute is populated when the appointment is associated with a project
\n- \n
- Hierarchy / Structure Related - explains where the appointment fits within an organisation, not all of these fields will be populated. The number of fields populated depend on the the configuration of the organisation structure. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR. \n
- \n
\nstructureCode- ability to map back to the Organisation Hierarchy end point /organisation \n
\ncompany- Used to indicate the company / organisation on the structure of where the person's appointment sits. This is usually the highest level of the organisation. For associated descriptions use the Reference Module with the reference typeORGZ. \n
\nmanagementUnit- Used to indicate the management unit within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeMGTU. \n
\ndepartment- Used to indicate the department within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDEPT. \n
\ncostCentre- The cost centre associated with this appointment. For associated descriptions use the Reference Module with the reference typeCOST. \n
\ndivision- Used to indicate the division within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeDIV. \n
\nlocation- Used to indicate the location within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeLOC. \n
\nworkGroup- Used to indicate the workGroup within the organisation on the structure of where the person's appointment sits. For associated descriptions use the Reference Module with the reference typeWRKGRP. \n
\nuser1..user5- Additional customized fields, how these are mapped and defined refer to the web service /organisation, using the provided structure code. \n
This service provides the ability to obtain an employees list of appointments, an employee can have more than one appointment. All appointments are returned, however each individual movement is not returned. The most recent detail associated with the appointment is returned.
\nAn appointment has various different descriptions including Contract, Post, Job, Position etc. Individuals may have more than one appointment at any given moment, though typically an individual will hold one appointment at any one time.
\nExample
\nOn 1st Jan 2018, employee Marco is a software engineer and his appoointment has a cost centre 100.
\nAppointment - 001
\nTitle - Software Engineer
\nCost Centre - 100
\nAll requests for Marcos appointment will return one appointmnet for Marco with a cost of 100.
\nOn 10th July 2018, management decide to move all engineering to a new cost centre 200, this is called a movement i.e. some change of attribute associated with Marco's appointment. In this case the change relates to a cost centre.
\nAppointment - 001
\nTitle - Software Engineer
\nCost Centre - 200
\nAll requests (from 10th July 2018) for Marcos appointment will return one appointment for Marco with a cost of 200.
\n","event":[{"listen":"prerequest","script":{"id":"44d8342d-db31-4362-a99d-c180f55736e5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d574af8c-5321-42f0-92b6-190c500691b4","type":"text/javascript","exec":[""]}}],"_postman_id":"5e000f16-79ba-423d-a7c6-b7d4709ec173"},{"name":"pension","item":[{"name":"/person/pension/:personnelNo","id":"6612e17d-fab2-4328-8325-c37ea5fb22e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/pension/5990404","description":"This is a very simple web service returning basic information for an individuals pension. All entries related to an employee pension will be returned including active and ended.
\nParameters
\n- \n
- personnelNo \n
Manadatory
\nType: AlphaNumeric
\nMax Length : 12
\nJSON Response Body Explained
\nAn array of all pension schemes associated with the individual is returned, the most recently joined pension scheme is returned first.
\n- \n
- schemeCode \n
A unique code associated with the pension scheme.
\n- \n
- appointmentID \n
this attribute is populated if the individual's pension scheme is associated with a particular appointment.
\n- \n
- dateEnd \n
indicates when the pension scheme ended for the individual, returned in format YYYYMMDD.
\n- \n
- dateJoined \n
indicates when the employee joined the pension scheme, returned in format YYYYMMDD
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","pension","5990404"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"00d4d30e-bfc6-49fa-9cd9-c386cbe3d13a","name":"Mandatory Data Missing","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/pension/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 28 Jun 2018 16:05:30 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"IIhsxH2Ji400+QeroRmFt6gc2g7b1QHixhZywWjc6NIWGfPAw4CjTnzhC2v+lA38covxOStmFbtsMyf36pPvsw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-00073eeb","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"This field is mandatory.\",\n \"code\": \"9001\",\n \"jsonKey\": \"personnelNo\",\n \"isWarning\": false\n}\n]}\n"},{"id":"2aa845bb-5b7d-4cf6-b7c1-4fff5ef8ffc3","name":"Pension Information","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/pension/5990404"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 28 Jun 2018 14:23:26 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"W5TPVaB+Aiz7z+FMBASz6aWxLjN19XWifM8GIKX9g1eWI9T7Qvo5y/XuEu4PwXTwb3XEpiy20o/FgtMMdrJRdQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"36358185-2628-4866-b940-6211236b00ea-0006b88a","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"schemeCode\":16,\"dateJoined\":\"20170601\",\"dateEnd\":\"\",\"appointmentID\":\"DP0007-2077\"}\n,\n{\"schemeCode\":15,\"dateJoined\":\"20161022\",\"dateEnd\":\"20170901\",\"appointmentID\":\"SD88712-1\"}\n,\n{\"schemeCode\":16,\"dateJoined\":\"20151019\",\"dateEnd\":\"\",\"appointmentID\":\"FD4005-1\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 3,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/pension/5990404\"\n }\n ]\n}\n"}],"_postman_id":"6612e17d-fab2-4328-8325-c37ea5fb22e6"}],"id":"16f4b005-e986-490b-bf8f-2eac4c3e7955","description":"This web service returns data related to an individual's pension.
\n","event":[{"listen":"prerequest","script":{"id":"e366cc15-5db1-4194-8d6e-f28d61eb8e65","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"48dd53de-2489-4e5f-8afd-a6e8a77e9052","type":"text/javascript","exec":[""]}}],"_postman_id":"16f4b005-e986-490b-bf8f-2eac4c3e7955"},{"name":"reportsTo","item":[{"name":"person/reportsto/:personnelNumber/:appointmentid?","id":"764d4ada-4d0a-4048-859e-cac31c917ff4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/","description":"Parameters
\n- \n
- personnelNumber \n
This attribute is the personnelNumber of the individual to find their reportsTo / manager.
\nManadatory
\nType : AlphaNumeric
\nMax Length : 12
\n- \n
- appointmentId \n
This attribute can be any of the individuals appointmentId's. An individual is required to have at least one appointmentID and is often referred to as substantive / primary appointmentId.
\nOptional
\nType : AlphaNumeric
\n(this field is typically XXXXX-XX, even though it is flagged as alpha Numberic, the '-' (dash) is excluded from a validation perspective i.e. when validation / sanitisation is performed the dash is excluded)
\nMax Length : 16
\nJSON Response Body Explained
\n- \n
- reportsToPersonnelNumber \n
This attribute represents the individual's 'Report To Personnel Number', typically their manager / line manager / Supervisor etc. You can use this attribute as the personnelNumber for any other web service requesting personnelNumber. As such it is possible to obtain further information for the 'ReportsTo'.
\n- \n
- reportsToName \n
This attribute represents the individual's 'Report To Name' i.e. typically the name of their manager / line manager / Supervisor etc.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","v1","person","reportsto","5990404",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"504c90c7-4ce4-4eb8-8380-99ac4bc073eb","name":"Invalid PersonnelNumber Length","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/1234567890123/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:37:19 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"U1TQYcXzLmuMBybM9sxQnH+pnJ45yfK9QyLZfZerGvSE8XpFYujUbMeaYutfoYGti5eB8XXY1L1Zsc/zuvTYJQ==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-00140369","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"The maximum length of this field is 12\",\n \"code\": \"9008\",\n \"jsonKey\": \"personnelNo\",\n \"isWarning\": false\n}\n]}\n"},{"id":"76f2aecf-2b9b-40e4-947d-3d05c0ff9a03","name":"Invalid PersonnelNumber Type","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/12345678[]/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:36:25 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"l61gq8U/3Ddnb8zX5veO7cQVtiR39qcu0L0AUV3aYxGLsn2WfS2frH7+m+AsDD+dAiRYTAdNcYd29zRxkhBYKA==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-00140227","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"Alphanumeric characters only.\",\n \"code\": \"9002\",\n \"jsonKey\": \"personnelNo\",\n \"isWarning\": false\n}\n]}\n"},{"id":"96adf328-c6cd-4dd1-a642-94321cee1131","name":"PersonnelNumber and AppointmentID","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/599014-25"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:21:14 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"31sy6J0QsiwFzAdrVi7qAyzs+hvz6E2rE/5kyizpDEhT65JmvEMorDrEovo3NLM/eYUCQmpmBAz06mwdCt2Yew==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-0013edca","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"reportsToPersonnelNumber\":\"5990181\",\"reportsToName\":\"Sasha Digweed\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/reportsto/5990404/599014-25\"\n }\n ]\n}\n"},{"id":"ed28f7bf-e088-43c2-8c31-738361ec6e5d","name":"Invalid AppointmentID Type","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/123!"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:40:29 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"RmAmWESpjPx1HQcC4yM3LakCm1+pazrdxEpor92H2/Bbgfn5+PkfVrR1SNs1fnfVhP7f+MscIk1F07yw1loGjw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-0014079d","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"Alphanumeric characters only.\",\n \"code\": \"9002\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"},{"id":"eeaf2aae-0f8d-47a2-91fb-287d0080f7ae","name":"PersonnelNumber Only","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 09:43:26 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"pZVLqJiJtJRnx3Q2SNnEn7mzHsEJE7h3AYFTFFddSSAABwOp+IfG7nt/RNZwkio5FpXtWJPuYQ8Vk8/lKfjWkw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-0013bc9c","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"reportsToPersonnelNumber\":\"5990181\",\"reportsToName\":\"Sasha Digweed\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/person/reportsto/5990404/\"\n }\n ]\n}\n"},{"id":"f06d3c2a-7193-4284-ae5a-199fc44ad593","name":"Invalid AppointmentID Length","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/person/reportsto/5990404/12345678901234567"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Security-Policy","value":"default-src 'none'; connect-src '*'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Jul 2018 10:39:34 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"2hERA1Oq6h48UWWRIfHmdaguVn33swa/4feFw1P/coF2t3J4ZczHKP+Kd64JweIz++0TdVUF4Bh+ni899eavNw==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"7207ce2e-8434-4e7f-aeb0-a3761f6b1b32-00140659","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{\n \"total\": 1,\n \"errors\": 1,\n \"warnings\": 0,\n \"log\": [\n{\n \"message\": \"The maximum length of this field is 16\",\n \"code\": \"9008\",\n \"jsonKey\": false,\n \"isWarning\": false\n}\n]}\n"}],"_postman_id":"764d4ada-4d0a-4048-859e-cac31c917ff4"}],"id":"9c54acb7-0614-42d0-b4a0-22084575537a","description":"This web service returns an individual's Reporting to manager / supervisor etc. It is a very simple web service, simply provide the personnel number and the individual's 'ReportTo' is returned. By only providing the personnelNumber, the individuals substantive (primary) appointment is used.
\nOptionally provide an appointment ID, this will then indicate to the service to return an individuals 'ReportTo' for the person and the specific appointment provided.
\nWith respect to the 'ReportsTo' effective date, in all cases this web service uses the current date i.e. the date the web service is called.
\n","_postman_id":"9c54acb7-0614-42d0-b4a0-22084575537a"}],"id":"4851f821-6d30-4dd1-af0e-2730695c2047","description":"This person module is all about personnel associated with an organisation, typically employee's, though sometimes contractors.
\nAll personnel entities have a personnelNo. Each of these services will accept a personnelNo as an atttrbute. To obtain sets of personnelNo use the filter module. The person module is typically used to determine following detail regarind an organisations personnel:
- \n
- basic attributes (name, joined date etc.) \n
- address detail \n
- probation information \n
- work permit details \n
- bank Account information \n
- salary information \n
Separate services are defined for each of above, rather than one large service.
\nNB : as this module only accepts the primary identifer personnelNo the pagesize option has no affect.
Parameters
\npersonnelNo
\nMandatory: Yes
\nExpected Type: AlphaNumeric
\nLength Max : 12
\n","event":[{"listen":"prerequest","script":{"id":"a113da35-5890-4852-82f8-08b6dbb258d7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d108a441-2386-4cd0-99eb-66f205fb96c6","type":"text/javascript","exec":[""]}}],"_postman_id":"4851f821-6d30-4dd1-af0e-2730695c2047"},{"name":"Organisation","item":[{"name":"structure","item":[{"name":"config","item":[{"name":"/organisation/structure/config","id":"d1008e52-a85c-49ef-aa09-d310747c3371","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/organisation/structure/config","description":"Parameters
\nno parameters are required to call this service.
\nJSON Response Body Explained
\nAn array of organisational structures are returned.
\n- \n
- structureCode \n
A unique identifier associated with this specfic organisations hierarchy.
\n- \n
- hierarchyName \n
A description for this structure / hierarchy. The description will be defined by your HR Administration colleagues.
\n- \n
- level1Type .. level12Type \n
This is a list from 1 through 12. These will list the types for each of the levels of hierarchy, for example Level One might by Company, Level 2 might be Management unit etc. These levels will be based on Reference data and can be mapped back to the reference module. In general it it is possible to use this type and reference back to the reference module.
\n- \n
- hierarchyInd1 .. hierarchyInd12 \n
This is a list from 1 through 12. These attributes indicate if the corresponding level is part of a hierarchy rather than just part of the structure. Reference back to the Organisation Module description for an explaination of the Hierarchy v's Structure concept. The indicator is simply Y or N.
\n- \n
- label1 .. label12 \n
These are the descriptions associated with the level1 .. level12 type.
\n- \n
- displayMode1 .. displayMode12 \n
It is possible to configure the display description for each element. This mode can return one of the following CD (code description), DC (description code) and D (description).
\nFor example - \nif the displayMode is CD (code description) then the description would be\n\n1001 : Engineering \n\nthe code is 1001 while the description is Engineering\n- \n
- dateApplied \n
indicates the date the structure was made active.
\n- \n
- dateInput \n
this is the date the structure was first created.
\n","urlObject":{"path":["ws","{{tenant}}","{{schema}}","{{version}}","organisation","structure","config"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"48249c34-ba9e-41f5-aaf6-d17d5adbd87a","name":"Success 200","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/organisation/structure/config"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 18 Jun 2018 14:17:29 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"\"QdYOzMA/b7fLqDLuLuinGXapZCFy2sgKwURL3ZcmhlywvfNbIke+t0+o8zLlq3NRlMvneOeex5JqR1ExtMDm2g==\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-ORACLE-DMS-ECID","value":"30038f37-18e0-4c74-a73d-1ed97dac4bc1-0008576a","name":"X-ORACLE-DMS-ECID","description":"Custom header"},{"key":"X-ORACLE-DMS-RID","value":"0","name":"X-ORACLE-DMS-RID","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"\n{ \"structure\" : [\n{\"structureCode\":\"7000\",\"hierarchyName\":\"Company 7000\",\"dateInput\":\"20170209\",\"dateApplied\":\"20170209\",\"level1Type\":\"ORGZ\",\"level2Type\":\"MGTU\",\"level3Type\":\"DEPT\",\"level4Type\":\"USER1\",\"level5Type\":\"DIV\",\"level6Type\":\"COST\",\"level7Type\":\"LOC\",\"level8Type\":\"WRKGRP\",\"level9Type\":\"\",\"level10Type\":\"\",\"level11Type\":\"\",\"level12Type\":\"\",\"label1\":\"Company\",\"label2\":\"Management Unit\",\"label3\":\"Department\",\"label4\":\"Team\",\"label5\":\"Division\",\"label6\":\"Cost Centre\",\"label7\":\"Location\",\"label8\":\"Work Group\",\"label9\":\"\",\"label10\":\"\",\"label11\":\"\",\"label12\":\"\",\"hierarchy1Ind\":\"Y\",\"hierarchy2Ind\":\"Y\",\"hierarchy3Ind\":\"Y\",\"hierarchy4Ind\":\"N\",\"hierarchy5Ind\":\"N\",\"hierarchy6Ind\":\"N\",\"hierarchy7Ind\":\"N\",\"hierarchy8Ind\":\"N\",\"hierarchy9Ind\":\"N\",\"hierarchy10Ind\":\"N\",\"hierarchy11Ind\":\"N\",\"hierarchy12Ind\":\"N\",\"displayMode1\":\"CD\",\"displayMode2\":\"CD\",\"displayMode3\":\"CD\",\"displayMode4\":\"CD\",\"displayMode5\":\"CD\",\"displayMode6\":\"CD\",\"displayMode7\":\"CD\",\"displayMode8\":\"CD\",\"displayMode9\":\"CD\",\"displayMode10\":\"CD\",\"displayMode11\":\"CD\",\"displayMode12\":\"CD\"}\n,\n{\"structureCode\":\"7001\",\"hierarchyName\":\"Company 7001\",\"dateInput\":\"20170209\",\"dateApplied\":\"20170209\",\"level1Type\":\"ORGZ\",\"level2Type\":\"MGTU\",\"level3Type\":\"DEPT\",\"level4Type\":\"USER1\",\"level5Type\":\"DIV\",\"level6Type\":\"COST\",\"level7Type\":\"LOC\",\"level8Type\":\"WRKGRP\",\"level9Type\":\"\",\"level10Type\":\"\",\"level11Type\":\"\",\"level12Type\":\"\",\"label1\":\"Company\",\"label2\":\"Management Unit\",\"label3\":\"Department\",\"label4\":\"Team\",\"label5\":\"Division\",\"label6\":\"Cost Centre\",\"label7\":\"Location\",\"label8\":\"Work Group\",\"label9\":\"\",\"label10\":\"\",\"label11\":\"\",\"label12\":\"\",\"hierarchy1Ind\":\"Y\",\"hierarchy2Ind\":\"Y\",\"hierarchy3Ind\":\"Y\",\"hierarchy4Ind\":\"N\",\"hierarchy5Ind\":\"N\",\"hierarchy6Ind\":\"N\",\"hierarchy7Ind\":\"N\",\"hierarchy8Ind\":\"N\",\"hierarchy9Ind\":\"N\",\"hierarchy10Ind\":\"N\",\"hierarchy11Ind\":\"N\",\"hierarchy12Ind\":\"N\",\"displayMode1\":\"CD\",\"displayMode2\":\"CD\",\"displayMode3\":\"CD\",\"displayMode4\":\"CD\",\"displayMode5\":\"CD\",\"displayMode6\":\"CD\",\"displayMode7\":\"CD\",\"displayMode8\":\"CD\",\"displayMode9\":\"CD\",\"displayMode10\":\"CD\",\"displayMode11\":\"CD\",\"displayMode12\":\"CD\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 2,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/devws/corehr/v1/organisation/settings\"\n }\n ]\n}\n"}],"_postman_id":"d1008e52-a85c-49ef-aa09-d310747c3371"}],"id":"de2511a0-0b7f-49b5-ada5-83a843b1c05f","description":"This web service returns the \"metadata\" / \"settings\" for a structure, describing how the structure is defined. This service does not return the actual data (see /organisation/data).
\n","event":[{"listen":"prerequest","script":{"id":"10219f6a-6b3d-4e00-a96b-bccc79671081","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"54e349b6-f476-47a6-92e2-9483e4bc4c05","type":"text/javascript","exec":[""]}}],"_postman_id":"de2511a0-0b7f-49b5-ada5-83a843b1c05f"},{"name":"nodes","item":[{"name":"/organisation/structure/nodes/:structureCode?","id":"de6e95d5-9841-4d9b-b05b-7fadda7dcccb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/{{version}}/organisation/structure/nodes/7000","description":"This webservice is subject to pagination,and, therefore by default only 100 rows are returned, it is possible to set the pagesize up to a maximum of 5,000 if the use case is to reduce the number of requests and attempt to obtain all rows in one request.
\nParameters
\n- \n
- structureCode \n
A structure code is required to call this web service, use the /organisation/settings web service to get a list. Typically organisations will only have a few of these structure codes configured and usually this takes place during initial project implementation.
\nExpected Type: Alpha_Numeric
\nJSON Response Body Explained
\n- \n
- ID \n
A unique identifier associated with this specfic item, each item will have a unique ID.
\n- \n
- parentID \n
The parentID associated with the unique ID, each item will have a parentID. For the 'Root' the parent ID will be set to the structure code.
\n- \n
- nodeDepth \n
Each item has a depth associated with it, i.e. this is the level an item exists within the hierarchy. Starts at 1. For example all items with a nodeDepth of 1 should map directly to the number of structures defined, typically this is only a few, and nodeDepth's 2 and 3 will also only have a few, while the many nodeDepths from 4 will most likely exist.
\n- \n
- path \n
This attribute provides an easy to see path i.e. the hierarchy for the item, this defines each of the parents all the way up to root.
\nFor example: \nA path with 10:1:1000:1016\nindicates the current item has a nodeDepth 4 with the following hierarchy struture:\n - 10 \n - 1 \n - 1000 \n - 1016\nthe root would be 10 and the current item being 1016\n- \n
- description \n
This attributes describes the current item (not the entire path). The description may include both code and description, this is dependent on the displayMode as defined in the /organisation/settings. In cases where the code is to be included, the code and description will be ':'. There is no clue in this description as to the path or nodeDepth (unless of course HR administrations have defined in the description)
\nFor example:\n\n1001 : Engineering \n\nthe code is 1001 while the description is Engineering\nThis web service returns all the node data associated with a specific structure code. The /organisation/structure/config defines the configuration and associated hierarchy / structure of levels, while the /organisation/structure/nodes web service applies the configurtion settings and returns the node data associated with same, including ID, parentID and nodeDepthLevel etc.
\n","event":[{"listen":"prerequest","script":{"id":"022226e0-74e9-412d-a225-54247ed4787d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9df61879-a130-4898-99dd-b52303dd458e","type":"text/javascript","exec":[""]}}],"_postman_id":"e7af35ed-deab-4425-8eae-18d0d64e9658"}],"id":"f695efdf-c5c5-4b81-8b61-0e51f4902eec","description":"This is just a grouping for all structure related elements, currently this is grouping only includes
\n- \n
- the structure configuration information \n
- the structure node information \n
An organisation will set up an organisational structure within CoreHR. This service will return an organisational structure.
\nFor Example:
\n- Company \n - Management Unit \n - Department \n - Cost Centre\nAs part of the organisational setup, an important concept exists Structure v's Hierarchy. A hierarchy is considered a subset of the previous level. For example from the above example, lets assume all are part of the hierarchy, this would mean:
\nFor a company, the available management units are mapped to a company, selecting a company means a specfic list of management units a valid to be selected, and selecting a management unit drives the departments that can be selected, once a department is selected only specific cost centres can then be selected. In other words the entire strucutre has a hierarchy link. CoreHR can support up to 12 levels of structure / hierarchy, the number of levels used is set by your HR administration colleagues.
\nThis hierearchy is completely configurable. The structure of the organisation is best discussed with the appropriate HR individuals within your organisation who have configured CoreHR.
\n","event":[{"listen":"prerequest","script":{"id":"bd2b8f6b-83c1-4df1-814a-77ee9c95435a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"71535318-4f3a-47f4-ad3b-4d1e4c9aaf61","type":"text/javascript","exec":[""]}}],"_postman_id":"b611622e-e845-44ea-a006-44fbbebaadd5"},{"name":"HESA","item":[{"name":"staffid","item":[{"name":"/hesa/staffid/:personnelNo","id":"381cb49b-d36b-4299-ad64-f3350664eace","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{tenant}}/{{schema}}/v1/hesa/staffid/9913681","description":"The specific end point will return an employee's HESA assigned staff ID. This staff ID is derived based on an algorithm that includes personnel number, year joined, institute ID an a check digit.
\nParameters
\nrequires personnelNumber, use the /filter/* endpoints to obtain personnelNumbers
\nJSON Response Body Explained
\nAn array of appointments are returned.
\n- \n
staffid
\nA unique reference identifier for the appointment, this is a system generated identifier.
\n \n
The specific end point will return an employee's HESA assigned staff ID. This staff ID is derived based on an algorithm that includes personnel number, year joined, institute ID an a check digit.
\n","event":[{"listen":"prerequest","script":{"id":"b2a3215a-e7d1-4174-9da6-57918dcded5c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"72f36502-0b19-4025-866a-3e83d381f974","type":"text/javascript","exec":[""]}}],"_postman_id":"9c8de1b3-20e8-4fec-a910-730021512dc4"}],"id":"7800ee3b-bad2-4550-a00a-54de2e5d4bb6","description":"This module has only been made available from CoreHR 26.0.6 and is not available in older versions.
\nHESA relates only to the higher education (HE) in the UK.
\n","event":[{"listen":"prerequest","script":{"id":"07b5b218-325b-49f1-a802-c8166d5d4c39","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e3eaaa28-2081-4dc0-af83-27b190220bfb","type":"text/javascript","exec":[""]}}],"_postman_id":"7800ee3b-bad2-4550-a00a-54de2e5d4bb6"}],"id":"79446a18-37aa-4e44-a557-da141fd13c70","_postman_id":"79446a18-37aa-4e44-a557-da141fd13c70","description":""},{"name":"V25","item":[{"name":"Clocking","item":[{"name":"/clocking/user/","id":"158b17df-f131-48f4-83ac-9c40af83b063","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"content-type","value":"application/json"},{"key":"Authorization","value":"Bearer LBmqAWEBeoLdkbwNkJwPUQ.."}],"body":{"mode":"raw","raw":"{\n\"person\" : \"\", \"badge_no\": \"4752066\", \n\"clock_date_time\" : \"2017-02-15 08:56 +00:00\",\n\"record_type\" : \"\", \n\"function_code\" : \"COST\", \n\"function_value\" : \"2\", \n\"device_id\" : \"D123456789-1234567\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/clocking/user/","description":"Create a new clocking record in the clocking module for subsequent transfer into CoreTime. On successful completion, users will have submitted a new clocking record which subject subsequent CoreTime validation will be transferred into CoreTime the next time the interface runs.
\nJSON Request Body Explained
\nperson
\nIs an CoreHR employee id also known as personnel number although it is alphanumeric.
badge_no
\nIs the badge number that the CoreHR employee uses. Badge must be valid and linked to a valid CoreHR employee for the clocking to interface into CoreTime.
\nclock_date_time
\nThe Date and Time that this particular clocking is for. Required to be in YYYY-MM-DD HH24:MI TZH:TZM format. Mandatory.
\nrecord_type
\nThe Transactional event associated with the clocking. Optional but if specified must be one of:
\n- \n
B0Undefined. \nB1In. \nB2Out. \nB3Business Absence. \n
function_code
\nOptional function code but if specified must be one of:
\n- \n
CALLIN\nUNSBRK\nSTD\nTNAIN\nCALLOT\nTNAOUT\nOVERTM\nCOST\n
function_value
\nOptional function_value relating to the above code.
\ndevice_id
\nOptional free text to describe the Device ID where the clocking was recorded e.g. Main Entrance Device.
\nMandatory
\n- \n
- Either person or badge_no - if both are provided then badge_no takes precedence. \n
- clock_date_time \n
The clocking module provides ability to insert Core Time clocking records for a CoreHR employee.
\nConstraints, Limitations, Mandatory and Validation
\nThe clocking module is designed to handle a large volume of data and so validation at the point of insertion is limited to all required fields being present and the data in them being of the correct format, length and precision. \nAs such duplicate records, expired badges, invalid personnel etc.. will be received by the clocking module provided all data is in the correct format and length. The validation process is completed by the Core Time Interface.
\nFields are as in the table below:
\nNote: Clock Date Time is mandatory and either Person or Badge No must also be provided.
\nInterface to CoreTime and Validation
\nThe validation process is completed at the point of interface to CoreTime. It is during this process that duplicates are rejected and CoreTime related validation is performed. Specifically:
\n- \n
- Person does not exist as CoreHR employee \n
- Badge does not exist or is not valid \n
- Record Type is valid \n
- Function Code is valid \n
- Duplicate Clocking - defined as where a clocking already exists in CoreTime for this person at the same date/time. \n
Error Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Both badge and person fields are not populated. One must be populated. \n
- 400 / 002 clock_date_time field is not populated. \n
- 400 / 003 clock_date_time field is not in the correct format. \n
- 404 / 004 Non standard database exception inserting this clocking. \n
- 404 / 005 record_type is invalid. Must be either empty, B0, B1, B2 or B3. \n
- 400 / 006 function_code is invalid. Must be either empty, CALLIN, UNSBRK, STD, TNAIN, CALLOT, TNAOUT, OVERTM or COST. \n
- 400 / 999 Basic sanitization error. Where a filed is not the correct data type or length or the data is deemed to be unsafe for recording within the system. Details of the fields failing sanitization are returned in the sanatizeError object in the Response. \n
Get a list of registered / whitelisted contacts. Tenant has an ability to define contacts available for creating / updating. A tenant may not allow all contacts to be updated or created, this base URI provides the list of valid contact types. In cases where server returns validation errors, refer to this list.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"18ce5e84-cfb9-40fd-8517-370b9a18e8a8","name":"200 - Response OK","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:00:52 GMT","name":"Date","description":""},{"key":"ETag","value":"\"uwlnRwLu1teq90JMcLw3B68+EOyVApqwZ0O87dUiP4G6rHtTNS14dRJz0YaKyE8k7RmWTnrUodwqt3OwuAMICA==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"EMAIL\", \"length\": 80, \"dataType\" : \"EMAIL\"}\n,\n{\"type\":\"MOBILE\", \"length\": 20, \"dataType\" : \"MOB\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 2,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/contact/\"\n }\n ]\n}\n"}],"_postman_id":"88a37d0e-2770-467b-8897-baed597a66f5"},{"name":"/contact/:type/","id":"bf1f79dc-0fe4-4792-b5e0-bb865ba0f8f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/EMAIL/","description":"Get a list of all users for a particular contact type. Typically used to get a list of all users email addresses.
This service will only return whitelisted contact types. A tenant may decide to only whitelist a subset of all contacts e.g. EMAIL is whitelisted while MOBILE is not. Only accounts where the contact type is populated are returned. To find accounts with missing contact information use the web service /contact/missing/:type
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","EMAIL",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"75d27db3-703c-4786-9a81-76c7af00c67a","name":"404 - Invalid Contact type","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/MOB/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 15 Nov 2016 19:51:28 GMT","name":"Date","description":""},{"key":"ETag","value":"\"WIZPZbpKwxRRgssW8lwH34floeFnPJzhb0Pc1fxiiWRv2Gqy41LgVu19up1qzvTBBMK6i635jWpyDaAsi5TVnQ==-gzip\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"002\",\"errorMessage\" :\"Validation failed. Contact type does not exist\" }}\n"},{"id":"7cc5919c-e318-4e10-82fd-784ed7ad1350","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/EMAIL/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 15 Nov 2016 19:46:57 GMT","name":"Date","description":""},{"key":"ETag","value":"\"6iQZlpyFhjCcA3IiwUAR9L8mLF0w4tdo6M6kmFN3AV+v32sX/fFbqqgk/bMg7pMmUv2y1+9/cnGbLcj57836dw==-gzip\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"coreHRId\":\"003676\", \"value\": \"webservices003676@corehr.com\"}\n,\n{\"coreHRId\":\"003674\", \"value\": \"webservices003674@corehr.com\"}\n,\n{\"coreHRId\":\"003332\", \"value\": \"webservices003332@corehr.com\"}\n,\n{\"coreHRId\":\"003333\", \"value\": \"webservices003333@corehr.com\"}\n,\n{\"coreHRId\":\"INT009\", \"value\": \"webservicesINT009@corehr.com\"}\n,\n{\"coreHRId\":\"INT010\", \"value\": \"webservicesINT010@corehr.com\"}\n,\n{\"coreHRId\":\"600100\", \"value\": \"webservices600100@corehr.com\"}\n,\n{\"coreHRId\":\"600101\", \"value\": \"webservices600101@corehr.com\"}\n,\n{\"coreHRId\":\"600102\", \"value\": \"webservices600102@corehr.com\"}\n,\n{\"coreHRId\":\"7777\", \"value\": \"webservices7777@corehr.com\"}\n,\n{\"coreHRId\":\"C876876\", \"value\": \"webservicesC876876@corehr.com\"}\n,\n{\"coreHRId\":\"003193\", \"value\": \"webservices003193@corehr.com\"}\n,\n{\"coreHRId\":\"003528\", \"value\": \"webservices003528@corehr.com\"}\n,\n{\"coreHRId\":\"gh1234\", \"value\": \"webservicesgh1234@corehr.com\"}\n,\n{\"coreHRId\":\"JG1234\", \"value\": \"webservicesJG1234@corehr.com\"}\n,\n{\"coreHRId\":\"002145\", \"value\": \"webservices002145@corehr.com\"}\n,\n{\"coreHRId\":\"002144\", \"value\": \"webservices002144@corehr.com\"}\n,\n{\"coreHRId\":\"002146\", \"value\": \"webservices002146@corehr.com\"}\n,\n{\"coreHRId\":\"000660\", \"value\": \"webservices000660@corehr.com\"}\n,\n{\"coreHRId\":\"002626\", \"value\": \"webservices002626@corehr.com\"}\n,\n{\"coreHRId\":\"000740\", \"value\": \"webservices000740@corehr.com\"}\n,\n{\"coreHRId\":\"000936\", \"value\": \"webservices000936@corehr.com\"}\n,\n{\"coreHRId\":\"000830\", \"value\": \"webservices000830@corehr.com\"}\n,\n{\"coreHRId\":\"000831\", \"value\": \"webservices000831@corehr.com\"}\n,\n{\"coreHRId\":\"000880\", \"value\": \"webservices000880@corehr.com\"}\n,\n{\"coreHRId\":\"1000491\", \"value\": \"webservices1000491@corehr.com\"}\n,\n{\"coreHRId\":\"000014\", \"value\": \"webservices000014@corehr.com\"}\n,\n{\"coreHRId\":\"000115\", \"value\": \"webservices000115@corehr.com\"}\n,\n{\"coreHRId\":\"000012\", \"value\": \"webservices000012@corehr.com\"}\n,\n{\"coreHRId\":\"000015\", \"value\": \"webservices000015@corehr.com\"}\n,\n{\"coreHRId\":\"000296\", \"value\": \"webservices000296@corehr.com\"}\n,\n{\"coreHRId\":\"000297\", \"value\": \"webservices000297@corehr.com\"}\n,\n{\"coreHRId\":\"000328\", \"value\": \"webservices000328@corehr.com\"}\n,\n{\"coreHRId\":\"000590\", \"value\": \"webservices000590@corehr.com\"}\n,\n{\"coreHRId\":\"000227\", \"value\": \"webservices000227@corehr.com\"}\n,\n{\"coreHRId\":\"001873\", \"value\": \"webservices001873@corehr.com\"}\n,\n{\"coreHRId\":\"000275\", \"value\": \"webservices000275@corehr.com\"}\n,\n{\"coreHRId\":\"CUT-001\", \"value\": \"webservicesCUT-001@corehr.com\"}\n,\n{\"coreHRId\":\"END-001\", \"value\": \"webservicesEND-001@corehr.com\"}\n,\n{\"coreHRId\":\"000286\", \"value\": \"webservices000286@corehr.com\"}\n,\n{\"coreHRId\":\"001987\", \"value\": \"webservices001987@corehr.com\"}\n,\n{\"coreHRId\":\"000180\", \"value\": \"webservices000180@corehr.com\"}\n,\n{\"coreHRId\":\"001993\", \"value\": \"webservices001993@corehr.com\"}\n,\n{\"coreHRId\":\"000598\", \"value\": \"webservices000598@corehr.com\"}\n,\n{\"coreHRId\":\"000601\", \"value\": \"webservices000601@corehr.com\"}\n,\n{\"coreHRId\":\"002037\", \"value\": \"webservices002037@corehr.com\"}\n,\n{\"coreHRId\":\"GH992\", \"value\": \"webservicesGH992@corehr.com\"}\n,\n{\"coreHRId\":\"000119\", \"value\": \"webservices000119@corehr.com\"}\n,\n{\"coreHRId\":\"000124\", \"value\": \"webservices000124@corehr.com\"}\n,\n{\"coreHRId\":\"000587\", \"value\": \"webservices000587@corehr.com\"}\n,\n{\"coreHRId\":\"000588\", \"value\": \"webservices000588@corehr.com\"}\n,\n{\"coreHRId\":\"000592\", \"value\": \"webservices000592@corehr.com\"}\n,\n{\"coreHRId\":\"000594\", \"value\": \"webservices000594@corehr.com\"}\n,\n{\"coreHRId\":\"002315\", \"value\": \"webservices002315@corehr.com\"}\n,\n{\"coreHRId\":\"000904\", \"value\": \"webservices000904@corehr.com\"}\n,\n{\"coreHRId\":\"002261\", \"value\": \"webservices002261@corehr.com\"}\n,\n{\"coreHRId\":\"002262\", \"value\": \"webservices002262@corehr.com\"}\n,\n{\"coreHRId\":\"CUT-012\", \"value\": \"webservicesCUT-012@corehr.com\"}\n,\n{\"coreHRId\":\"002248\", \"value\": \"webservices002248@corehr.com\"}\n,\n{\"coreHRId\":\"002249\", \"value\": \"webservices002249@corehr.com\"}\n,\n{\"coreHRId\":\"002250\", \"value\": \"webservices002250@corehr.com\"}\n,\n{\"coreHRId\":\"002367\", \"value\": \"webservices002367@corehr.com\"}\n,\n{\"coreHRId\":\"002368\", \"value\": \"webservices002368@corehr.com\"}\n,\n{\"coreHRId\":\"002369\", \"value\": \"webservices002369@corehr.com\"}\n,\n{\"coreHRId\":\"000826\", \"value\": \"webservices000826@corehr.com\"}\n,\n{\"coreHRId\":\"000897\", \"value\": \"webservices000897@corehr.com\"}\n,\n{\"coreHRId\":\"001128\", \"value\": \"webservices001128@corehr.com\"}\n,\n{\"coreHRId\":\"002629\", \"value\": \"webservices002629@corehr.com\"}\n,\n{\"coreHRId\":\"002697\", \"value\": \"webservices002697@corehr.com\"}\n,\n{\"coreHRId\":\"000934\", \"value\": \"webservices000934@corehr.com\"}\n,\n{\"coreHRId\":\"002624\", \"value\": \"webservices002624@corehr.com\"}\n,\n{\"coreHRId\":\"000290\", \"value\": \"webservices000290@corehr.com\"}\n,\n{\"coreHRId\":\"000837\", \"value\": \"webservices000837@corehr.com\"}\n,\n{\"coreHRId\":\"002444\", \"value\": \"webservices002444@corehr.com\"}\n,\n{\"coreHRId\":\"002685\", \"value\": \"webservices002685@corehr.com\"}\n,\n{\"coreHRId\":\"002227\", \"value\": \"webservices002227@corehr.com\"}\n,\n{\"coreHRId\":\"002169\", \"value\": \"webservices002169@corehr.com\"}\n,\n{\"coreHRId\":\"000849\", \"value\": \"webservices000849@corehr.com\"}\n,\n{\"coreHRId\":\"000808\", \"value\": \"webservices000808@corehr.com\"}\n,\n{\"coreHRId\":\"002091\", \"value\": \"webservices002091@corehr.com\"}\n,\n{\"coreHRId\":\"1010101010\", \"value\": \"webservices1010101010@corehr.com\"}\n,\n{\"coreHRId\":\"20202020\", \"value\": \"webservices20202020@corehr.com\"}\n,\n{\"coreHRId\":\"GM967\", \"value\": \"webservicesGM967@corehr.com\"}\n,\n{\"coreHRId\":\"GM969\", \"value\": \"webservicesGM969@corehr.com\"}\n,\n{\"coreHRId\":\"DB678\", \"value\": \"webservicesDB678@corehr.com\"}\n,\n{\"coreHRId\":\"002651\", \"value\": \"webservices002651@corehr.com\"}\n,\n{\"coreHRId\":\"gh23\", \"value\": \"webservicesgh23@corehr.com\"}\n,\n{\"coreHRId\":\"6633228\", \"value\": \"webservices6633228@corehr.com\"}\n,\n{\"coreHRId\":\"250\", \"value\": \"webservices250@corehr.com\"}\n,\n{\"coreHRId\":\"260\", \"value\": \"webservices260@corehr.com\"}\n,\n{\"coreHRId\":\"002705\", \"value\": \"webservices002705@corehr.com\"}\n,\n{\"coreHRId\":\"002103\", \"value\": \"webservices002103@corehr.com\"}\n,\n{\"coreHRId\":\"000950\", \"value\": \"webservices000950@corehr.com\"}\n,\n{\"coreHRId\":\"002756\", \"value\": \"webservices002756@corehr.com\"}\n,\n{\"coreHRId\":\"002652\", \"value\": \"webservices002652@corehr.com\"}\n,\n{\"coreHRId\":\"jg1234\", \"value\": \"webservicesjg1234@corehr.com\"}\n,\n{\"coreHRId\":\"DF5609\", \"value\": \"webservicesDF5609@corehr.com\"}\n,\n{\"coreHRId\":\"002289\", \"value\": \"webservices002289@corehr.com\"}\n,\n{\"coreHRId\":\"002727\", \"value\": \"webservices002727@corehr.com\"}\n,\n{\"coreHRId\":\"000179\", \"value\": \"webservices000179@corehr.com\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 100,\"hasMore\":true\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://localhost/ws/tenant/corehr/v1/contact/EMAIL/\"\n },\n {\n \"rel\": \"next\",\n \"href\": \"https://localhost/ws/tenant/corehr/v1/contact/EMAIL/?offsetby=100\"\n }\n ]\n}\n"}],"_postman_id":"bf1f79dc-0fe4-4792-b5e0-bb865ba0f8f8"},{"name":"/contact/user/:person/","id":"c87b5880-c456-4280-92fd-fd53e7f5b2a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/","description":"This web service returns all contacts for the person.
This web service returns a specific contact for an associated person and type. Refer to /contact/ for a complete list of contacts available.
This web service provides ability to create a new contact type for a user. The contact type should not already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available.
\nThe value of the contact type must be provided in the request body as JSON e.g.
\n\n\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0ec7b88a-5a22-4457-9847-01551b37d9c3","name":"400 - Bad Request - Error Code 006","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:41:20 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"006\",\"errorMessage\" :\"Validation failed. Existing contact for user, use PATCH to update\" }}\n"},{"id":"533a4286-9354-4693-a328-51abab137e74","name":"201 - Success - Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:40:49 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"},{"id":"59af9740-6f86-4b5c-bd2a-dedc4719397a","name":"400 - Bad Request - Error Code 005","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/PHONE"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:44:28 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"005\",\"errorMessage\" :\"Validation failed. Ensure contact type is allowed and has correct format\" }}\n"},{"id":"94ab7cc2-6b5e-43bf-b381-a17adf1948c6","name":"400 - Bad Request - Error Code 001","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:42:45 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"001\",\"errorMessage\" :\"Mandatory fields are missing\" }}\n"},{"id":"d92da96b-7bd5-4430-a1c9-1c242d95b107","name":"404 - Not Found - Error Code 003","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/7788/EMAIL"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:43:31 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"003\",\"errorMessage\" :\"Validation failed. User account does not exist\" }}\n"}],"_postman_id":"0b2f92d2-422c-480f-8123-19429a25617c"},{"name":"/contact/user/:person/:type","id":"9abccc42-5b14-42bb-8294-6bb26685f193","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"value\" :\"darragh.james.duffy@corehr.com\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL","description":"{\"value\" :\"darragh.james.duffy@corehr.com\"}
\n
This web service provides ability to patch / update a contact type for a user. The contact type must already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available.
\nThe value of the contact type must be provided in the request body as JSON e.g.
\n\n\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3f9a22c4-03ee-46a4-8f5e-251416394416","name":"201- Success - Created","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:45:19 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"},{"id":"844dd241-f2d5-451d-bd2c-f349c5778821","name":"404 - Not Found - Error Code 003","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/7788/EMAIL"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:47:30 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"003\",\"errorMessage\" :\"Validation failed. User account does not exist\" }}\n"},{"id":"d95e664e-272c-4f5d-82b8-6e48e0e8424d","name":"400 - Bad Request - Error Code 001","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:46:55 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"001\",\"errorMessage\" :\"Mandatory fields are missing\" }}\n"},{"id":"ea192a8c-7b9b-489d-90a3-2ebca3090d2f","name":"404 - Not Found - Error Code 002","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/Phone"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:48:16 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"002\",\"errorMessage\" :\"Validation failed. Contact does not exist\" }}\n"}],"_postman_id":"9abccc42-5b14-42bb-8294-6bb26685f193"},{"name":"/contact/user/:person/:type","id":"fd7ec5f3-5d3f-45fc-920b-10a7971fcc44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL","description":"{\"value\" :\"darragh.james.duffy@corehr.com\"}
\n
This web service provides ability to delete a contact from a users / employees profile. The contact type should already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available. All contact types are case sensitive.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"081c8bed-680b-47b5-8488-547340e5c661","name":"200 - Response OK","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 11 Nov 2016 14:46:13 GMT","name":"Date","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"fd7ec5f3-5d3f-45fc-920b-10a7971fcc44"},{"name":"/contact/missing/:type","id":"96170c57-64b8-48fe-b33a-6a21aedac74a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/missing/EMAIL","description":"This web service provides ability to list user accounts with missing contact types. For example find all users with a missing EMAIL contact.
This examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Contact module provides ability to interact with contact information associated with an account in CoreHR. Different contact types exist and can be defined by a tenant e.g EMAIL, MOBILE etc. Not all tenants have the same list of contacts i.e. each tenant can define a whitelist of contacts exposed to web services.
\nContraints, Limitations & Mandatory
\nThe contact module is case senstive, no process converts the contact type provided to upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned. Within CoreHR contact types are typically uppercase.
\nPerson is mandatory, person represents users unique CoreHR ID, this is often referenced as personnel number
Optionally
\nProvide the type of contact e.g. EMAIL to get users associated email address.
In cases where type is not specified all contact details are returned associated with employee.
In Summary contact provides ability to
\n- \n
- Enumerate users contact information \n
- Obtain a specific contact type \n
- Update / Patch an existing contact type \n
- Assign a new contact type to a user \n
Error Codes
\nNote type is case senstive, no process converts the type provided into upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned.
Convention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Mandatory fields are missing \n
- 404 / 002 Validation failed. Contact does not exist \n
- 404 / 003 Validation failed. User account does not exist \n
- 400 / 005 Validation failed. Ensure contact type is allowed and has correct format \n
- 400 / 006 Validation failed. Existing contact for user, use PATCH to update \n
- 404 / 007 Contact type does not exist for user, consider using POST to create \n
Note
\nWhere a contact exists within CoreHR, this does not mean an account in CoreHR has this contact assigned, e.g. not every account would have a mobile / cell number. Keep this in mind if you attempt to PATCH a contact type and server responds with a validation error.
\n","_postman_id":"a5cad8f8-3490-4186-afe9-5bc37c52e2de"},{"name":"Image","item":[{"name":"/image/user/","id":"633ba3c4-4bb2-47ef-ac75-bdfcd7e8cf2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"Bearer MZun_JVHkiiNm9SXgadz4A.."}],"url":"{{url}}/ws/{{schema}}/{{version}}/image/user/0890126","description":"This Web Service is used to retrieve (GET) the image profile for a CoreHR user on the system. Returns a binary image file.
\nExample cURL:
\n$ curl -o ./local_copy_of_profile.jpeg -k --request GET --url https://devapi.corehr.com/ws/frame/corehr/v1/image/user/0890126 \\\n --header 'authorization: Bearer MZun_JVHkiiNm9SXgadz4A..'\nThis command will save the binary image of CoreHR User 0890126 into the file local_copy_of_profile.jpeg. If alternatively the person did not have an image on the system then the web service would return an http code 404 with and verbose errorCode of 1008.
Example cURL:
\n$ curl --request POST --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/png' \\\n --header 'authorization: Bearer E63-fevVwKH-CV4E_TScUA..' \\\n --data-binary \"@./original_profile.png\" \nThe above cURL will insert the file original_profile.png as the binary image profile photo for the CoreHR User 0890126 where they do not have an profile image already configured on the system.
Web Service used to update the profile image for a CoreHR user on the system. This overwrites their current profile image with this new image. The image is provided as binary data in the body of the request.
\nExample cURL:
\n$ curl --request PATCH --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/jpeg' \\\n --header 'authorization: Bearer Fbbanqy44exS0Nat7Ep3oQ..' \\\n --data-binary \"@./new_profile.jpg\" \nThe above cURL will insert the file new_profile.jpg as the binary image profile photo for the CoreHR User 0890126 where they already have a profile image in CoreHR. This will over-write the existing profile image.
This Web Service is used to retrieve (GET) the image profile for a CoreHR user on the system. Returns a binary image file.
\nExample cURL:
\n$ curl -o ./local_copy_of_profile.jpeg -k --request GET --url https://devapi.corehr.com/ws/frame/corehr/v1/image/user/0890126 \\\n --header 'authorization: Bearer MZun_JVHkiiNm9SXgadz4A..'\nThis command will save the binary image of CoreHR User 0890126 into the file local_copy_of_profile.jpeg. If alternatively the person did not have an image on the system then the web service would return an http code 404 with and verbose errorCode of 1008.
Web Service used to update the profile image for a CoreHR user on the system. This overwrites their current profile image with this new image. The image is provided as binary data in the body of the request.
\nExample cURL:
\n$ curl --request PATCH --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/jpeg' \\\n --header 'authorization: Bearer Fbbanqy44exS0Nat7Ep3oQ..' \\\n --data-binary \"@./new_profile.jpg\" \nThe above cURL will insert the file new_profile.jpg as the binary image profile photo for the CoreHR User 0890126 where they already have a profile image in CoreHR. This will over-write the existing profile image.
This Web Service is used to insert a profile image for a CoreHR user on the system where none exists. The image is provided as binary data in the body of the request.
\nExample cURL:
\n$ curl --request POST --url https://api.corehr.com/ws/tenant/corehr/v1/image/user/0890126 \\\n --header \"Expect:\" \\\n --header 'content-type:image/png' \\\n --header 'authorization: Bearer E63-fevVwKH-CV4E_TScUA..' \\\n --data-binary \"@./original_profile.png\" \nThe above cURL will insert the file original_profile.png as the binary image profile photo for the CoreHR User 0890126 where they do not have an profile image already configured on the system.
The image web service provides a means for uploading and viewing a CoreHR user's profile picture.
\nConstraints, Limitations, Mandatory and Validation
\nImages uploaded can be a maximum of 500KB in size and must be provided in one of the following file formats:
\n- \n
- gif \n
- png \n
- jpeg \n
- tiff \n
Error Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 415 / 1001 Invalid content type, only image/gif, image/png, image/jpeg or image/tiff allowed \n
- 415 / 1002 n image file (gif, png, jpeg or tiff) of size greater than zero must be attached to this request. \n
- 415 / 1003 There was an issue with the supplied image being recognized as a supported image (gif, png, jpeg or tiff) please save as another supported format and re-try. \n
- 415 / 1004 The attached image exceeded the maximum allowed file size for an image. \n
- 400 / 1005 The person supplied is not currently a valid person on the system. Please check the personnel details. \n
- 400 / 1006 This person does not have an image on the system to update please change this request to POST to insert the image. \n
- 400 / 1007 This person already has an image on the system to insert please change this request to PATCH to update the image. \n
- 404 / 1008 This person does not currently have an image on the system to retrieve. \n
Use this service if you want to remove UUID's. The service can facility bulk UUID removal/purge and individual employee UUID.
\nThis is useful in cases where you have a need
\n- \n
- to remove an individuals UUID e.g. as part of a leaver process. \n
- to implement a policy requiring users to re-register, this would be similar to a password policy \n
Constraints and Limitations
\n- \n
typemust be one of the following: \n
ALL
\n- \n
id\n
must now be a valid type i.e. a valid Email address. In cases where ALL is used for type, the id should be left blank.
\nIf invalid ID provided nothing is deleted, i.e. if an invalid email address provided a status of 404 is returned. For valid email address a 200 is returned, indicating a success.
\nParameters
\n- \n
typethis must be email, username, employeeNumber or all. \"ALL\" is reserved for bulk removal, this will remove all the registered UUID's, therefore use with caution \nidthis must be a valid email address \n
CoreHR's native mobile application facilitates users registering once and then using biometric (e.g. touchID, FaceID) or PIN to unlock the application i.e. the user does not require a username / password each time they login. However a user is required to unlock the app via biometric or PIN.
\nA tenant may have a requirement to implement a different policy e.g. a user must authenticate via username / password at least once a day, week or month i.e. similar to password policies. CoreHR makes no assumptions for password policies, instead tenants can implement their own policies.
\nIn order to faciliate these requirments web services can be used. A tenant can generate a new app grant priviliges to this module and end point.
\n","_postman_id":"26aa4a78-975a-4aa7-a899-068ef3904085"}],"id":"b199c88c-52bf-4e5d-9b62-39091550278f","description":"The native module manages authentication and tokens for the CoreHR native application. These services cater for both SAML and non-SAML customers. All request will be handled via TLS.
\nThis service provides:
\n- \n
- Ability to remove / purge / reset Uses UUID's \n
Find all non provisioned accounts. This endpoint will return all users not yet provisioned.
\nThis examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Optionally provide number of days, this service is used to offset users start date. Provides ability to determine accounts not yet provisioned in CoreHR for Core|Portal self service access. This service will include employees due to start in the future.
\nAllowing the following scenario.
\n- \n
obtain user accounts to be provisioned within the last X number of days, i.e. a start date occurring in the past.
\n \nobtain user accounts to be provisioned with a future start date, i.e. users starting in the future.
\n \n
This examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Provisions a new CorePortal account; on successful completion, users will have ability to access CoreHR's self service features via CorePortal. As noted in the introduction to the provisioning module, where an IDM or third party application understands CorePortal privileges this module will accept these privileges. Example provided below includes Users Privilege.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- authType \n
This is the authentication type for the employee, the value here should be either inApplicationPassword or LDAP. For all single sign on authenticated accounts use LDAP. For non single sign on account set this value to inApplicationPassword this then requires the password attribute to be set. Leaving this parameter null indicates to CoreHR that the user account should pick up the system default authentication type, this parameter can be found in CoreHR as 'authtype'.
- \n
- password \n
This attribute is required when authType is inApplicationPassword. The value here will be validated against the password policy in CoreHR.
- \n
- privileges \n
An array, each array object contains a privilege.
\nMandatory
\n- \n
- corehrid \n
- loginid \n
- password (only when authType is inApplicationPassword) \n
Provides ability to patch (amend) an existing account. Account must have previously been provisioned, this means corehrID must previously have been generated via POST. In general this service supports Single Sign On style accounts.
It is possible to use this service with non SSO accounts, in such cases all parameters are mandatory including password and explcitly setting authType to inApplicationPassword. In cases where authType is not provided the account is assumed to be Single Sign On.
The use cases for this web service includes
\n- \n
- loginId changing \n
Where a user changes their loginId e.g. their name changes because of marriage, this web service faciliates this change of ID.
\n- \n
- privilege changing \n
executing this web service will remove all current privileges and replace with the privileges array. It is therefore possible to use this web service to revoke all privileges for a user by sending a blank array of privileges.
\nExample provided below changes both Login ID and privileges.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- authType \n
This is the authentication type for the employee, the value here should be either inApplicationPassword or LDAP. For all single sign on authenticated accounts use LDAP. For non single sign on account set this value to inApplicationPassword this then requires the password attribute to be set. In cases where this attribute is null, assumpetion is Single Sign On.
- \n
- password \n
This attribute is required when authType is inApplicationPassword. The value here will be validated against the password policy in CoreHR.
- \n
- privileges \n
An array, each array object contains a privilege. If this is blank all privs are revoked.
\nMandatory
\n- \n
- corehrid \n
- loginid \n
- password (only when authType is inApplicationPassword) \n
For Non SSO Accounts all parameters are mandatory.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","provision","user"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3aa812c6-1192-4088-9c38-9264dee7536a","name":"201 - Created - Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\n \"corehrid\" : \"002875\",\n \"loginid\" : \"jones.donovan@corehr.com\",\n \"privileges\" : [\n {\"privilege\" : \"developmentTeam\"},\n {\"privilege\" : \"VPNGroup\"}\n ]\n}\n"},"url":"{{url}}/ws/{{schema}}/{{version}}//provision/user"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 05 Oct 2016 16:42:46 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"0b4722fa-9d43-42d0-aabb-34736ac17853"},{"name":"/provision/user/status/:id","id":"0cc5d4cb-cd05-4fdc-8b98-0dfe7ee0475f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100","description":"Obtain user account status indicator; determining if an account is active or not. The parameter id can be users coreHRID or account username.
Obtain user authentication type. Response indicates either LDAP or inApplicationPassword.
The parameter id can be users coreHRID or loginID.
Provides an ability to activate or deactivate an account. Setting an account to be deactive results in a user not being allowed sign into CoreHR self Service module CorePortal. This applies irrespective of the users authentication type.
\nWhen an account is created via POST /provision/user the account is assumed to be active. You do not need to execute this web services to activate an account once it has been created. However if you execute this web services and set active to N then you must execute this web services again to re-activate the account by setting active to Y.
The id parameter can be either coreHRID or the username associated with the account. The Active parameter must be N or Y
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","provision","user","status","100"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0698a8ad-da66-4fc2-a68b-86f231b05321","name":"400 - Validation Failed","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\"active\" : \"N\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/1001"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 19:02:41 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"007\",\"errorMessage\" :\"Validation failed. Either user account does not exist or request data is invalid.\" }}\n"},{"id":"bfae72c0-08d0-45b9-a9d0-067b96458ff8","name":"200 - Account Active","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 18:04:52 GMT","name":"Date","description":""},{"key":"ETag","value":"\"L/idwKxNGWvlkQGQ4j3vC0+brkecdYNqpY2o9nJxaN5RiPktu/5d3OJrX6yJIWMlOB0ocscXHR0OVsUrx7Decw==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"{\"items\":[{\"isaccountactive\":\"Yes\"}],\"hasMore\":false,\"limit\":100,\"offset\":0,\"count\":1,\"links\":[{\"rel\":\"self\",\"href\":\"http://localhost:8585/ws/corehr/v1/provision/user/status/100\"},{\"rel\":\"describedby\",\"href\":\"http://localhost:8585/ws/corehr/metadata-catalog/v1/provision/user/status/item\"},{\"rel\":\"first\",\"href\":\"http://localhost:8585/ws/corehr/v1/provision/user/status/100\"}]}"},{"id":"d2b26496-236e-49ac-8460-9b25043a4e3b","name":"201 - Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\"active\" : \"N\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 19:02:16 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"91fdf6a6-0865-4e69-a043-6e2ce18f43c3"},{"name":"/provision/user/privilege","id":"fdab3609-45b2-4485-b801-65e1b3b28d35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"loginid\" : \"jones.donovan@corehr.com\",\n \"privilege\" : \"hrAdmin\"\n }\n"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/privilege","description":"Provisions a new privilege for a user. This service allows one new privilege to be assigned to the user account. In addition this service assumes an account has already been provisioned. Validation is performed on the account confirming existence.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- privilege \n
a new privilege for the user.
\nSpecial Usage Note
\nuse one of the following combinations, do not use all three fields. If you do an error will be returned.
\n- \n
- corehrid and a privilege \n
or
\n- \n
- loginid and a privilege \n
CoreHR v25.0.7 required
\nThis service will list all currently granted privileges associated with a user.
\nParameter
\nid can be either the users loginid or the users corehrid (personnelNumber).
CoreHR v25.0.7 required
\nProvides an ability to revoke all user privileges associated with the user account.
\nA privilege here relates to all granted menu security items i.e. feature access and not access to a specific user, while access to the user is not revoked the privilege to use the feature is revoked.
\nNB this revokes all.
\nOther attributes associated with the user Account are not affected e.g. account will still exist, authentication type will remain as is, and password for non SSO accounts remain in place etc.
\nThis service assumes an account has already been provisioned. Validation is performed on the account confirming existence. This is a simple purge request, in cases where the user has no privileges, this service will not respond with an error, instead a successful response is returned.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by using the new filter services.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\nSpecial Usage Note
\nuse one of the following combinations, do not use both fields. If you do an error will be returned.
\n- \n
- corehrid \n
or
\n- \n
- loginid \n
Provisioning facility allowing Core|Portal accounts to be provisioned. Core|Portal is the self service module within CoreHR. A employee may have a record in CoreHR, this does not automatically suggest same employee has access to self service features via CorePortal. In order to access CorePortal a self service account is required. This module provides a web service mechanism to provision an employee.
\nIn Summary provisioning provides ability to
\n- \n
- Determine accounts yet to be provisioned \n
- Determine accounts yet to be provisioned within X number of days (including future start dates) \n
- Provision a new account \n
- Provision a new account with privileges \n
- Update existing accounts privileges \n
- Add additional privilege to an account \n
- Set authentication Type in cases where a mix of Single Sign On, SAML and inApplicationPasswords exist \n
Contraints, Limitations & Mandatory
\nAccounts to be provisioned simply indicates accounts (employees) not yet provisioned. These accounts must satisfy following criteria
\n- \n
- Active Employee Record \n
indicates employees record must not have a date left.
\nDo not assume logic applies indicating certain categories of employees are allowed access and others are not allowed. No other conditions are applied. Additional attributes are possible to add to the response to help an IDM provider make this decision, CoreHR will work with an IDM provider to best determine.
\nCorePortal privileges can be assigned by the IDM using the privileges array (example below). Where an IDM can not determine privileges, this provisioning web service module integrates with the CoreHR user profile matrix, and in cases where this matrix is not configured the fall back is all users are granted a default access profile typically \"coreportal_employee\".
\nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Mandatory fields are missing \n
- 400 / 002 Validation failed. If attempting to update use PATCH method \n
- 400 / 003 Unexpected error, unable to provision account \n
- 404 / 004 Validation failed. User account does not exist \n
- 404 / 005 Validation failed. Account must first be provisioned, use POST method \n
- 400 / 006 Validation failed. Invalid fields used \n
- 400 / 007 Validation failed. Either user account does not exist or request data is invalid. \n
- 400 / 008 Validation failed. Authtype must be either LDAP or inApplicationPassword. If choosing inApplicationPassword a password is required \n
- 400 / 009 Validation failed. Supplied password has not passed password \n
- \n
- 400 / 010 Validation failed, type is mandatory (must email or all), and id should be populated when type is email, when type is all no id should be provided. The JSON keys are case sensitve, type and id should be lower case. \n
\n- \n
- 404 / 011 Nothing found for this email address. \n
\n
Get a list of registered / whitelisted referene types. Tenant has an ability to define reference types available for creating / updating. A tenant may not allow all references to be updated or created, this base URI provides the list of valid reference types. In cases where server returns validation errors, refer to this list to confirm the reference type is whitelisted.
\nThis examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Returns a list of codes and descriptions for a reference type, a reference type could be COST, DEPT etc. Reference Types are typically upper case. As already noted reference types can be whitelisted by a tenant.
For a full list of available reference types use /reference/
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","reference","type","DEPT",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"861d4e7f-fb71-4654-8ec9-727d2d06dd83","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/COST/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:35:18 GMT","name":"Date","description":""},{"key":"ETag","value":"\"ZInz0RdXlDlkFr0RxOWVt0Xe8DrUJnBC2+V/aZmUKdeVao7Vnt+tTjTY7a88qxAW/95HgOuX3zxv4wgdqSdatg==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"COST\", \"code\": \"1\", \"description\": \"Cost Centre Web Services 1\"}\n,\n{\"type\":\"COST\", \"code\": \"10\", \"description\": \"Cost Centre Web Services 10\"}\n,\n{\"type\":\"COST\", \"code\": \"100A\", \"description\": \"Cost Centre Web Services 100A\"}\n,\n{\"type\":\"COST\", \"code\": \"111\", \"description\": \"Cost Centre Web Services 111\"}\n,\n{\"type\":\"COST\", \"code\": \"123456789\", \"description\": \"Cost Centre Web Services 123456789\"}\n,\n{\"type\":\"COST\", \"code\": \"149\", \"description\": \"Cost Centre Web Services 149\"}\n,\n{\"type\":\"COST\", \"code\": \"159\", \"description\": \"Cost Centre Web Services 159\"}\n,\n{\"type\":\"COST\", \"code\": \"20\", \"description\": \"Cost Centre Web Services 20\"}\n,\n{\"type\":\"COST\", \"code\": \"200A\", \"description\": \"Cost Centre Web Services 200A\"}\n,\n{\"type\":\"COST\", \"code\": \"21\", \"description\": \"Cost Centre Web Services 21\"}\n,\n{\"type\":\"COST\", \"code\": \"22\", \"description\": \"Cost Centre Web Services 22\"}\n,\n{\"type\":\"COST\", \"code\": \"222\", \"description\": \"Cost Centre Web Services 222\"}\n,\n{\"type\":\"COST\", \"code\": \"23\", \"description\": \"Cost Centre Web Services 23\"}\n,\n{\"type\":\"COST\", \"code\": \"24\", \"description\": \"Cost Centre Web Services 24\"}\n,\n{\"type\":\"COST\", \"code\": \"25\", \"description\": \"Cost Centre Web Services 25\"}\n,\n{\"type\":\"COST\", \"code\": \"26\", \"description\": \"Cost Centre Web Services 26\"}\n,\n{\"type\":\"COST\", \"code\": \"27\", \"description\": \"Cost Centre Web Services 27\"}\n,\n{\"type\":\"COST\", \"code\": \"28\", \"description\": \"Cost Centre Web Services 28\"}\n,\n{\"type\":\"COST\", \"code\": \"29\", \"description\": \"Cost Centre Web Services 29\"}\n,\n{\"type\":\"COST\", \"code\": \"2908100\", \"description\": \"Cost Centre Web Services 2908100\"}\n,\n{\"type\":\"COST\", \"code\": \"30\", \"description\": \"Cost Centre Web Services 30\"}\n,\n{\"type\":\"COST\", \"code\": \"300A\", \"description\": \"Cost Centre Web Services 300A\"}\n,\n{\"type\":\"COST\", \"code\": \"356\", \"description\": \"Cost Centre Web Services 356\"}\n,\n{\"type\":\"COST\", \"code\": \"39\", \"description\": \"Cost Centre Web Services 39\"}\n,\n{\"type\":\"COST\", \"code\": \"40\", \"description\": \"Cost Centre Web Services 40\"}\n,\n{\"type\":\"COST\", \"code\": \"451\", \"description\": \"Cost Centre Web Services 451\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC\", \"description\": \"Cost Centre Web Services ABC\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC001\", \"description\": \"Cost Centre Web Services ABC001\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC0010\", \"description\": \"Cost Centre Web Services ABC0010\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC003\", \"description\": \"Cost Centre Web Services ABC003\"}\n,\n{\"type\":\"COST\", \"code\": \"J12345\", \"description\": \"Cost Centre Web Services J12345\"}\n,\n{\"type\":\"COST\", \"code\": \"JKL333\", \"description\": \"Cost Centre Web Services JKL333\"}\n,\n{\"type\":\"COST\", \"code\": \"PROD\", \"description\": \"Cost Centre Web Services PROD\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 33,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/reference/type/COST/\"\n }\n ]\n}\n"}],"_postman_id":"f8fd842d-bebd-4ffc-bcbb-8951989124b1"},{"name":"/reference/type/:atype/:code?","id":"780c38c5-b3eb-4d62-a9f1-300daa22521b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/DEPT/1061","description":"Returns an individual reference description associated with a reference type and code. A reference type could be COST, DEPT etc. Reference Types are typically upper case. As already noted reference types can be whitelisted by a tenant.
For a full list of available reference types use /reference/
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","reference","type","DEPT","1061"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b746b5a0-2a7f-4536-ac6c-3c9e5eaac1be","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/COST/10"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:35:39 GMT","name":"Date","description":""},{"key":"ETag","value":"\"Q3jVQU2iTQ/v0g70PelGZKl9U6wG1LV/Ns7vRxFBtB7MUyXAAgUcC+nxdBtW/mQMcQPoQhSS1jjRtrAA4a7uzQ==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"COST\", \"code\": \"10\", \"description\": \"Cost Centre Web Services 10\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/reference/type/COST/10\"\n }\n ]\n}\n"}],"_postman_id":"780c38c5-b3eb-4d62-a9f1-300daa22521b"},{"name":"/reference/type/:atype","id":"11e4917f-5799-4c3e-8af4-0c2bc4bd7edb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"value\" : \"1061\",\n\"description\" : \"Cost Centre One\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/DEPT/","description":"Add reference data based on the reference type, code and description. The reference type is expected in the URL, while the request body should include code and description
Ability to update a description associated with an existing reference code / type combination. The reference type is expected in the URL, while the request body should include code and description
Delete reference data based on the reference type, code. The reference type is expected in the URL, while the request body should include code.
Reference module provides ability to view, add and update reference related items for CoreHR e.g. Cost Centre, Department, Projects etc.
\nContraints, Limitations & Mandatory
\nThe reference module is case senstive, no process converts the type provided into upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned. Within CoreHR reference types are typically uppercase.
\nIn most cases a type is mandatory. Following are some examples, for more detail review each URI and method below.
\nFor endpoint /reference/type/aType/ aType is mandatory e.g. /reference/type/COST/. Another example /reference/type/COST/1 will return Reference Type COST where the cost centre code is 1. For /reference/types/ no type is required.
Further information per method below.
\nLimitations
\nDescription max length - 40 Characters
\nCode max length - 13 Characters
\nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Mandatory fields are missing \n
- 400 / 002 Validation failed. If attempting to update use PATCH method \n
- 404 / 003 Validation failed. Reference type does not exist \n
- 400 / 004 Validation failed. Sanitization of data failed, ensure field lengths are correct \n
- 400 / 005 Validation failed. Reference code does not exist. If attempting to add use POST method. \n
Defined below are the endpoints, sample requests and responses.
\n","_postman_id":"ff4d1c07-737f-43c8-9494-e3f956fe6cdd"},{"name":"User Defined Fields","item":[{"name":"/udf/user/:udf_type","id":"39d31cfa-4062-41aa-ac04-b34202d3abc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 9m1zDcUnJrxvkqTfEsTOfQ.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20","description":"Creating a new UDF Type Record for a user
\nAdding a new User record for a UDF Type requires the following fields. UDF Type code is mandatory and specified as part of the URL.
\nThe rest of the fields are provided as JSON in the request body. Un-used/empty fields should be left blank. Successful inserts results in a JSON Response object with success value of true. Also included in the JSON Response is the ws_id which is the unique Web Service ID that can be used to identify this specific record.
\nFields are sent in the JSON are as in the table below:
\n¹ Either personnel_no OR appointment_id are mandatory.
² Date1 and Date2 are input in the format DD-MON-RRRR.
\n³ Text1 to Text12 must ALWAYS be provided. If the field is not being used for the UDF Type use a blank value string e.g. \"\".
\n¬ Text1 to Text12 field requirements are defined by the UDF Type configuration in CoreHR. Text fields can be marked as mandatory/optional and of specific data types including:
\n- \n
- Text - to a maximum of 4000 characters long. \n
- Number - number values only \n
- Date required to be in the format DD-MON-YYYY. \n
- List - Based on the allowed list for the UDF Type as configured in CoreHR. \n
Response Object\nSample responses are shown to the right under different conditions.
\nA response objects is always provided and within success will either be true. In which case as ws_id (unique web service identifier that allows us to refer back to this record).
Alternatively, the success value can be false if this is the cause an errorCode and errorMessage are provided. Additional error details - if the error pertains to a specific value in the body - is provided in the validationError object. This will contain one or more JSON objects relating to each specific error. The param_name will contain the field the validation error relates to the field_name is the label of the field used in CoreHR and the message will contain a detailed explanation of what validation is failing.
Error Codes
\nConvention is HTTP Status Code / Verbose Code. These are shared by all these UDF endpoints and explained in the Error Codes section at the start of the UDF documentation.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","udf","user","AB20"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3d7cafe5-65cb-4a9a-9be5-f25df27fc497","name":"4. User Code example to use pre-defined data in all text fields","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 9m1zDcUnJrxvkqTfEsTOfQ.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Mon, 14 Aug 2017 12:10:39 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"f38c5093-1095-4e7e-be35-0074f4d4eb81-0000002c","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true, \"ws_id\":\"2017081471563097\"}}\n"},{"id":"4c7c9acc-afb5-466f-adae-9855cfcc720e","name":"1. Successful date fields example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer _QsnRadImZrbh8w9_4B6UA.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"1409000\",\n \"appointment_id\": \"\",\n \"text1\": \"27-JAN-2017\",\n \"text2\": \"24-FEB-2017\",\n \"text3\": \"31-MAR-2017\",\n \"text4\": \"28-APR-2017\",\n \"text5\": \"27-MAY-2017\",\n \"text6\": \"30-JUN-2017\",\n \"text7\": \"28-JUL-2017\",\n \"text8\": \"25-AUG-2017\",\n \"text9\": \"29-SEP-2017\",\n \"text10\": \"28-OCT-2017\",\n \"text11\": \"24-NOV-2017\",\n \"text12\": \"29-DEC-2017\",\n \"date1\": \"\",\n \"date2\": \"\",\n \"user_code\": \"\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Fri, 11 Aug 2017 16:05:48 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"41431680-ec3d-4690-8100-5e5ec94a3c78-00002f6a","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true, \"ws_id\":\"2017081171563091\"}}\n"},{"id":"a317c73f-2507-4bf2-8d68-01828d4a58b4","name":"3. Sanatization Fail Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer _QsnRadImZrbh8w9_4B6UA.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"1409000\",\n \"appointment_id\": \"\",\n \"text1\": \"27\",\n \"text2\": \"24\",\n \"text3\": \"31\",\n \"text4\": \"28\",\n \"text5\": \"27\",\n \"text6\": \"30\",\n \"text7\": \"28\",\n \"text8\": \"25\",\n \"text9\": \"29\",\n \"text10\": \"28\",\n \"text11\": \"24\",\n \"text12\": \"29\",\n \"date1\": \"\",\n \"date2\": \"\",\n \"user_code\": \"\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"close","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Fri, 11 Aug 2017 16:16:01 GMT","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"41431680-ec3d-4690-8100-5e5ec94a3c78-00002f6f","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[],"responseTime":null,"body":"\n\n { \"Response\": {\n \"success\" : false,\n \"errorCode\" : \"998\",\n \"errorMessage\" : \"UDF Type validation errors. Review validationError object for more details of data errors for this UDF type.\",\n \"validationError\" : [\n\n {\n \"param_name\" : \"text1\",\n \"field_name\" : \"COREHR 7600\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text2\",\n \"field_name\" : \"text2\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text3\",\n \"field_name\" : \"text3\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text4\",\n \"field_name\" : \"text4\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text5\",\n \"field_name\" : \"text5\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text6\",\n \"field_name\" : \"text6\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text7\",\n \"field_name\" : \"text7\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text8\",\n \"field_name\" : \"text8\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text9\",\n \"field_name\" : \"text9\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text10\",\n \"field_name\" : \"text10\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text11\",\n \"field_name\" : \"text11\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n,\n\n {\n \"param_name\" : \"text12\",\n \"field_name\" : \"text12\",\n \"message\" : \"Invalid date in this field. Must be in the format DD-MON-YYYY exactly and must be a valid date.\"\n }\n]\n }\n }\n"},{"id":"b827aa2d-1cf1-4bfa-8b72-4a02668248b2","name":"2. Validation Fail","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer _QsnRadImZrbh8w9_4B6UA.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"1409000\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"27-JAN-2017\",\n \"text2\": \"24-FEB-2017\",\n \"text3\": \"31-MAR-2017\",\n \"text4\": \"28-APR-2017\",\n \"text5\": \"27-MAY-2017\",\n \"text6\": \"30-JUN-2017\",\n \"text7\": \"28-JUL-2017\",\n \"text8\": \"25-AUG-2017\",\n \"text9\": \"29-SEP-2017\",\n \"text10\": \"28-OCT-2017\",\n \"text11\": \"24-NOV-2017\",\n \"text12\": \"29-DEC-2017\",\n \"date1\": \"\",\n \"date2\": \"\",\n \"user_code\": \"\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Fri, 11 Aug 2017 16:14:20 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"41431680-ec3d-4690-8100-5e5ec94a3c78-00002f6d","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"002\",\"errorMessage\" :\"Validation failed. Provide either a personnel number or an Appointment ID. It is not possible to use both.\" }}\n"}],"_postman_id":"39d31cfa-4062-41aa-ac04-b34202d3abc4"},{"name":"/udf/user/:udf_type","id":"1ca1bdf1-6b56-4fa0-a4a5-add45c44a6e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer 9m1zDcUnJrxvkqTfEsTOfQ.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20","description":"Updating existing UDF Type Record for a user
\nUpdating a user record for a UDF Type uses the personnel_no/appoinment_id, date1, date2 and the udf_type to determine if the record is an update. i.e. If there is an existing record(s) with the same person/appointment and date1 and date2 then it is an update and the existing record(s) will be patched (updated) to the new values provided in the JSON code. UDF Type is of course mandatory and specified as part of the URL.
\nThe rest of the fields are provided as JSON in the request body. Un-used/empty fields should be left blank. Successful updates result in a JSON Response object with success value of true.
\nFields are sent in the JSON are as in the table below:
\n¹ Either personnel_no OR appointment_id are mandatory.
² Date1 and Date2 are input in the format DD-MON-RRRR.
\n³ Text1 to Text12 must ALWAYS be provided. If the field is not being used for the UDF Type use a blank value string e.g. \"\".
\n¬ Text1 to Text12 field requirements are defined by the UDF Type configuration in CoreHR. Text fields can be marked as mandatory/optional and of specific data types including:
\n- \n
- Text - to a maximum of 4000 characters long. \n
- Number - number values only \n
- Date required to be in the format DD-MON-YYYY. \n
- List - Based on the allowed list for the UDF Type as configured in CoreHR. \n
Response Object\nSample responses are shown to the right under different conditions.
\nA response objects is always provided and within success will either be true. In which case as ws_id (unique web service identifier that allows us to refer back to this record).
Alternatively, the success value can be false if this is the cause an errorCode and errorMessage are provided. Additional error details - if the error pertains to a specific value in the body - is provided in the validationError object. This will contain one or more JSON objects relating to each specific error. The param_name will contain the field the validation error relates to the field_name is the label of the field used in CoreHR and the message will contain a detailed explanation of what validation is failing.
Error Codes
\nConvention is HTTP Status Code / Verbose Code. These are shared by all these UDF endpoints and explained in the Error Codes section at the start of the UDF documentation.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","udf","user","AB20"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b7a84471-8c99-4a53-91dc-ae11df0c67ef","name":"Successful update using User Code","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Bearer 0nsn4KtX5QlKF4_4q0gNcw.."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"personnel_no\": \"\",\n \"appointment_id\": \"JXXXXX-15153\",\n \"text1\": \"\",\n \"text2\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"text10\": \"\",\n \"text11\": \"\",\n \"text12\": \"\",\n \"date1\": \"14-AUG-2017\",\n \"date2\": \"\",\n \"user_code\": \"EE\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/AB20"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-credentials","key":"access-control-allow-credentials","value":"true","description":""},{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo","description":""},{"name":"access-control-expose-headers","key":"access-control-expose-headers","value":"Content-Type, Access-Control-Allow-Origin, Access-Control-Allow-Credentials, Vary","description":""},{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":""},{"name":"connection","key":"connection","value":"Keep-Alive","description":""},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":""},{"name":"date","key":"date","value":"Thu, 17 Aug 2017 15:13:29 GMT","description":""},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":""},{"name":"server","key":"server","value":"Apache","description":""},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":""},{"name":"vary","key":"vary","value":"Origin","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"e491ed87-4cb1-4174-9763-76bbe5667c2b-0000009c","description":""},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"1ca1bdf1-6b56-4fa0-a4a5-add45c44a6e4"},{"name":"/udf/user/","id":"11296120-e4ea-41a7-bfd2-875d7746fa67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/","description":"Web service to get the list of User Defined Field (UDF) records for a particular UDF Type. Mandatory search criteria include:
\n- \n
- udf_type - The UDF code. \n
- person - The CoreHR Personnel Number for whom records are to be retrieved.\nOptional criteria include: \n
- appointment_id - To search for details relating to a specific appointment. \n
- date1 - Commonly used as the Date From field. \n
- date2 - Commonly used as the Date To field. \n
A get request can return many records depending on the criteria poveded and consequently the ws_id value pair is the unique identifier that can be used with other web services to update this specific record.
Error Codes are documented at the start of the UDF documentation.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","udf","user",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"cf589685-9eec-4d95-86aa-00630f8a931b","name":"Search using all citeria","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Bearer 8N7tv3Kwt2W5_i-B72dWew.."}],"url":{"raw":"{{url}}/ws/{{schema}}/{{version}}/udf/user/?udf_type=AB20&person=1409000&appointment_id=TS0011-2594&date1=01-JAN-2017&date2=31-DEC-2017","host":["{{url}}"],"path":["ws","{{schema}}","{{version}}","udf","user",""],"query":[{"key":"udf_type","value":"AB20"},{"key":"person","value":"1409000"},{"key":"appointment_id","value":"TS0011-2594"},{"key":"date1","value":"01-JAN-2017"},{"key":"date2","value":"31-DEC-2017"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"name":"connection","key":"connection","value":"Keep-Alive","description":"Options that are desired for the connection"},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":"Custom header"},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"name":"date","key":"date","value":"Thu, 17 Aug 2017 14:27:44 GMT","description":"The date and time that the message was sent"},{"name":"etag","key":"etag","value":"\"MQgB6VKjaT8lHDgADQKxxd0zqZ1ssI3lKuh3MursJBsVKHrOsHcxUeOJWWw6Lq7KQJ4hi5sQMuu9orqF0glhNg==\"","description":"An identifier for a specific version of a resource, often a message digest"},{"name":"keep-alive","key":"keep-alive","value":"timeout=5, max=100","description":"Custom header"},{"name":"server","key":"server","value":"Apache","description":"A name for the server"},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"e491ed87-4cb1-4174-9763-76bbe5667c2b-0000008c","description":"Custom header"},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":"Custom header"},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":"Cross-site scripting (XSS) filter"}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{ \"items\" : [\n{\"udf_type\":\"AB20\",\"person\": \"1409000\",\"appointment_id\": \"TS0011-2594\",\"ws_id\": \"2017081171563091\",\"user_code\": \"AB20\",\"date1\": \"01-JAN-2017\",\"date2\": \"31-DEC-2017\",\"text1\": \"27-JAN-2017\",\"text2\": \"24-FEB-2017\",\"text3\": \"31-MAR-2017\",\"text4\": \"28-APR-2017\",\"text5\": \"27-MAY-2017\",\"text6\": \"30-JUN-2017\",\"text7\": \"28-JUL-2017\",\"text8\": \"25-AUG-2017\",\"text9\": \"29-SEP-2017\",\"text10\": \"28-OCT-2017\",\"text11\": \"24-NOV-2017\",\"text12\": \"29-DEC-2017\",\"last_update\": \"17-AUG-2017 12:46:49\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://devapi.corehr.com/ws/frame/corehr/v1/udf/user/\"\n }\n ]\n}\n"},{"id":"db5ef5f2-39d6-4208-b535-f637a6ea02f1","name":"Missing Person parameter","originalRequest":{"method":"GET","header":[{"key":"Authorization","name":"Authorization","value":"Bearer _E4Pl9nxSkcJFbic2dxD8w.."}],"url":"{{url}}/ws/{{schema}}/{{version}}/udf/user/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"max-age=0, no-cache, no-store, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"name":"connection","key":"connection","value":"close","description":"Options that are desired for the connection"},{"name":"content-security-policy","key":"content-security-policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","description":"Custom header"},{"name":"content-type","key":"content-type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"name":"date","key":"date","value":"Thu, 17 Aug 2017 11:54:53 GMT","description":"The date and time that the message was sent"},{"name":"etag","key":"etag","value":"\"hu/EykO6P9EsmiOfI5hQk+9yi5r2AxYFcmeD8ppL8ujowI4GmtSfFHQi+xgzudcWmF0pxNbJHLHEWwepH2J8/A==\"","description":"An identifier for a specific version of a resource, often a message digest"},{"name":"server","key":"server","value":"Apache","description":"A name for the server"},{"name":"transfer-encoding","key":"transfer-encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"name":"x-oracle-dms-ecid","key":"x-oracle-dms-ecid","value":"e491ed87-4cb1-4174-9763-76bbe5667c2b-00000044","description":"Custom header"},{"name":"x-oracle-dms-rid","key":"x-oracle-dms-rid","value":"0","description":"Custom header"},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":"Cross-site scripting (XSS) filter"}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"ZtfR7qZUUleahU","key":"__zlcmid"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"GA1.2.345263352.1459269949","key":"_ga"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"154209639.534d7e038246e171d1efdb1f4bc83822.1459269952833.1484837065141.1494406860445.32","key":"__hstc"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".corehr.com","path":"/","secure":false,"session":false,"value":"534d7e038246e171d1efdb1f4bc83822","key":"hubspotutk"}],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"013\",\"errorMessage\" :\"Person is a mandatory field.\" }}\n"}],"_postman_id":"11296120-e4ea-41a7-bfd2-875d7746fa67"}],"id":"7217f2b4-40c1-4ca9-9fb7-b898853fafb1","description":"The User Defined Fields (UDF) module provides ability to insert/update and view the UDF records for a CoreHR employee.
\nThe list of UDF Types available is as configured in Core Personnel in the User Defined Fields under the Employee option i.e. those UDF types that related to a specific employee/user.
\nThese UDF Types must also be white listed using the Security option in Portal to allow them to be called via this Web Service.
\nConstraints, Limitations and Validation
\nFor all calls (insert/update/get) the personnel no. and the UDF Type code must be specified at a minimum. As previously mentioned the UDF Type must have been added to the whitelist to be accessed in any way.
\nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 404 / 000 The UDF Type does not exist in Core as a valid UDF Type for an Employee/User. \n
- 400 / 001 A Personnel Number or an Appointment ID must be provided. \n
- 404 / 002 Provide either a personnel number or an Appointment ID. It is not possible to use both. \n
- 404 / 003 There is no CoreHR personnel/user account associated with the personnel number provided. \n
- 404 / 004 The Appointment ID is invalid. \n
- 404 / 006 UDF Type with these details does not exist for user, consider using POST to create. \n
- 404 / 007 This UDF Type is not whitelisted for web services. \n
- 400 / 008 When using User Reference Data - by specifying a user_code - then do not provide values in parameters text1 to text12 i.e. pass in empty values in text1..text12. \n
- 404 / 009 This User Reference Data - as specified by the user_code - is not a a valid User Code for this UDF Type. \n
- 404 / 010 There is no UDF record of this type for this person with these details to update. Use POST if you want to insert a record. \n
- 400 / 011 Date1 field when used must be provided in the date format DD-MON-YYY. \n
- 400 / 012 Date2 field when used must be provided in the date format DD-MON-YYY. \n
- 400 / 013 Person is a mandatory field in this context. \n
- 400 / 014 UDF Type is a mandatory field in this context. \n
Create a new clocking record in the clocking module for subsequent transfer into CoreTime. On successful completion, users will have submitted a new clocking record which subject subsequent CoreTime validation will be transferred into CoreTime the next time the interface runs.
\nJSON Request Body Explained
\nperson
\nIs an CoreHR employee id also known as personnel number although it is alphanumeric.
badge_no
\nIs the badge number that the CoreHR employee uses. Badge must be valid and linked to a valid CoreHR employee for the clocking to interface into CoreTime.
\nclock_date_time
\nThe Date and Time that this particular clocking is for. Required to be in YYYY-MM-DD HH24:MI TZH:TZM format. Mandatory.
\nrecord_type
\nThe Transactional event associated with the clocking. Optional but if specified must be one of:
\n- \n
B0Undefined. \nB1In. \nB2Out. \nB3Business Absence. \n
function_code
\nOptional function code but if specified must be one of:
\n- \n
CALLIN\nUNSBRK\nSTD\nTNAIN\nCALLOT\nTNAOUT\nOVERTM\nCOST\n
function_value
\nOptional function_value relating to the above code.
\ndevice_id
\nOptional free text to describe the Device ID where the clocking was recorded e.g. Main Entrance Device.
\nMandatory
\n- \n
- Either person or badge_no - if both are provided then badge_no takes precedence. \n
- clock_date_time \n
The clocking module provides ability to insert Core Time clocking records for a CoreHR employee.
\nConstraints, Limitations, Mandatory and Validation
\nThe clocking module is designed to handle a large volume of data and so validation at the point of insertion is limited to all required fields being present and the data in them being of the correct format, length and precision. \nAs such duplicate records, expired badges, invalid personnel etc.. will be received by the clocking module provided all data is in the correct format and length. The validation process is completed by the Core Time Interface.
\nFields are as in the table below:
\nNote: Clock Date Time is mandatory and either Person or Badge No must also be provided.
\nInterface to CoreTime and Validation
\nThe validation process is completed at the point of interface to CoreTime. It is during this process that duplicates are rejected and CoreTime related validation is performed. Specifically:
\n- \n
- Person does not exist as CoreHR employee \n
- Badge does not exist or is not valid \n
- Record Type is valid \n
- Function Code is valid \n
- Duplicate Clocking - defined as where a clocking already exists in CoreTime for this person at the same date/time. \n
Error Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Both badge and person fields are not populated. One must be populated. \n
- 400 / 002 clock_date_time field is not populated. \n
- 400 / 003 clock_date_time field is not in the correct format. \n
- 404 / 004 Non standard database exception inserting this clocking. \n
- 404 / 005 record_type is invalid. Must be either empty, B0, B1, B2 or B3. \n
- 400 / 006 function_code is invalid. Must be either empty, CALLIN, UNSBRK, STD, TNAIN, CALLOT, TNAOUT, OVERTM or COST. \n
- 400 / 999 Basic sanitization error. Where a filed is not the correct data type or length or the data is deemed to be unsafe for recording within the system. Details of the fields failing sanitization are returned in the sanatizeError object in the Response. \n
Get a list of registered / whitelisted contacts. Tenant has an ability to define contacts available for creating / updating. A tenant may not allow all contacts to be updated or created, this base URI provides the list of valid contact types. In cases where server returns validation errors, refer to this list.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"8ca7d6b8-97dc-4bec-ba17-ea4ab24dba32","name":"200 - Response OK","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:00:52 GMT","name":"Date","description":""},{"key":"ETag","value":"\"uwlnRwLu1teq90JMcLw3B68+EOyVApqwZ0O87dUiP4G6rHtTNS14dRJz0YaKyE8k7RmWTnrUodwqt3OwuAMICA==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"EMAIL\", \"length\": 80, \"dataType\" : \"EMAIL\"}\n,\n{\"type\":\"MOBILE\", \"length\": 20, \"dataType\" : \"MOB\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 2,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/contact/\"\n }\n ]\n}\n"}],"_postman_id":"64350711-1246-4790-b0d9-8215a0026b97"},{"name":"/contact/:type/","id":"0ef4469e-618d-4049-bce3-518be5f3cdfb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/EMAIL/","description":"Get a list of all users for a particular contact type. Typically used to get a list of all users email addresses.
This service will only return whitelisted contact types. A tenant may decide to only whitelist a subset of all contacts e.g. EMAIL is whitelisted while MOBILE is not. Only accounts where the contact type is populated are returned. To find accounts with missing contact information use the web service /contact/missing/:type
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","EMAIL",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"27b1221f-af1e-4c65-9cff-557e7f007a15","name":"404 - Invalid Contact type","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/MOB/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 15 Nov 2016 19:51:28 GMT","name":"Date","description":""},{"key":"ETag","value":"\"WIZPZbpKwxRRgssW8lwH34floeFnPJzhb0Pc1fxiiWRv2Gqy41LgVu19up1qzvTBBMK6i635jWpyDaAsi5TVnQ==-gzip\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"002\",\"errorMessage\" :\"Validation failed. Contact type does not exist\" }}\n"},{"id":"6a44bb83-4920-485a-b199-a6469d4b7004","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/EMAIL/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 15 Nov 2016 19:46:57 GMT","name":"Date","description":""},{"key":"ETag","value":"\"6iQZlpyFhjCcA3IiwUAR9L8mLF0w4tdo6M6kmFN3AV+v32sX/fFbqqgk/bMg7pMmUv2y1+9/cnGbLcj57836dw==-gzip\"","name":"ETag","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"coreHRId\":\"003676\", \"value\": \"webservices003676@corehr.com\"}\n,\n{\"coreHRId\":\"003674\", \"value\": \"webservices003674@corehr.com\"}\n,\n{\"coreHRId\":\"003332\", \"value\": \"webservices003332@corehr.com\"}\n,\n{\"coreHRId\":\"003333\", \"value\": \"webservices003333@corehr.com\"}\n,\n{\"coreHRId\":\"INT009\", \"value\": \"webservicesINT009@corehr.com\"}\n,\n{\"coreHRId\":\"INT010\", \"value\": \"webservicesINT010@corehr.com\"}\n,\n{\"coreHRId\":\"600100\", \"value\": \"webservices600100@corehr.com\"}\n,\n{\"coreHRId\":\"600101\", \"value\": \"webservices600101@corehr.com\"}\n,\n{\"coreHRId\":\"600102\", \"value\": \"webservices600102@corehr.com\"}\n,\n{\"coreHRId\":\"7777\", \"value\": \"webservices7777@corehr.com\"}\n,\n{\"coreHRId\":\"C876876\", \"value\": \"webservicesC876876@corehr.com\"}\n,\n{\"coreHRId\":\"003193\", \"value\": \"webservices003193@corehr.com\"}\n,\n{\"coreHRId\":\"003528\", \"value\": \"webservices003528@corehr.com\"}\n,\n{\"coreHRId\":\"gh1234\", \"value\": \"webservicesgh1234@corehr.com\"}\n,\n{\"coreHRId\":\"JG1234\", \"value\": \"webservicesJG1234@corehr.com\"}\n,\n{\"coreHRId\":\"002145\", \"value\": \"webservices002145@corehr.com\"}\n,\n{\"coreHRId\":\"002144\", \"value\": \"webservices002144@corehr.com\"}\n,\n{\"coreHRId\":\"002146\", \"value\": \"webservices002146@corehr.com\"}\n,\n{\"coreHRId\":\"000660\", \"value\": \"webservices000660@corehr.com\"}\n,\n{\"coreHRId\":\"002626\", \"value\": \"webservices002626@corehr.com\"}\n,\n{\"coreHRId\":\"000740\", \"value\": \"webservices000740@corehr.com\"}\n,\n{\"coreHRId\":\"000936\", \"value\": \"webservices000936@corehr.com\"}\n,\n{\"coreHRId\":\"000830\", \"value\": \"webservices000830@corehr.com\"}\n,\n{\"coreHRId\":\"000831\", \"value\": \"webservices000831@corehr.com\"}\n,\n{\"coreHRId\":\"000880\", \"value\": \"webservices000880@corehr.com\"}\n,\n{\"coreHRId\":\"1000491\", \"value\": \"webservices1000491@corehr.com\"}\n,\n{\"coreHRId\":\"000014\", \"value\": \"webservices000014@corehr.com\"}\n,\n{\"coreHRId\":\"000115\", \"value\": \"webservices000115@corehr.com\"}\n,\n{\"coreHRId\":\"000012\", \"value\": \"webservices000012@corehr.com\"}\n,\n{\"coreHRId\":\"000015\", \"value\": \"webservices000015@corehr.com\"}\n,\n{\"coreHRId\":\"000296\", \"value\": \"webservices000296@corehr.com\"}\n,\n{\"coreHRId\":\"000297\", \"value\": \"webservices000297@corehr.com\"}\n,\n{\"coreHRId\":\"000328\", \"value\": \"webservices000328@corehr.com\"}\n,\n{\"coreHRId\":\"000590\", \"value\": \"webservices000590@corehr.com\"}\n,\n{\"coreHRId\":\"000227\", \"value\": \"webservices000227@corehr.com\"}\n,\n{\"coreHRId\":\"001873\", \"value\": \"webservices001873@corehr.com\"}\n,\n{\"coreHRId\":\"000275\", \"value\": \"webservices000275@corehr.com\"}\n,\n{\"coreHRId\":\"CUT-001\", \"value\": \"webservicesCUT-001@corehr.com\"}\n,\n{\"coreHRId\":\"END-001\", \"value\": \"webservicesEND-001@corehr.com\"}\n,\n{\"coreHRId\":\"000286\", \"value\": \"webservices000286@corehr.com\"}\n,\n{\"coreHRId\":\"001987\", \"value\": \"webservices001987@corehr.com\"}\n,\n{\"coreHRId\":\"000180\", \"value\": \"webservices000180@corehr.com\"}\n,\n{\"coreHRId\":\"001993\", \"value\": \"webservices001993@corehr.com\"}\n,\n{\"coreHRId\":\"000598\", \"value\": \"webservices000598@corehr.com\"}\n,\n{\"coreHRId\":\"000601\", \"value\": \"webservices000601@corehr.com\"}\n,\n{\"coreHRId\":\"002037\", \"value\": \"webservices002037@corehr.com\"}\n,\n{\"coreHRId\":\"GH992\", \"value\": \"webservicesGH992@corehr.com\"}\n,\n{\"coreHRId\":\"000119\", \"value\": \"webservices000119@corehr.com\"}\n,\n{\"coreHRId\":\"000124\", \"value\": \"webservices000124@corehr.com\"}\n,\n{\"coreHRId\":\"000587\", \"value\": \"webservices000587@corehr.com\"}\n,\n{\"coreHRId\":\"000588\", \"value\": \"webservices000588@corehr.com\"}\n,\n{\"coreHRId\":\"000592\", \"value\": \"webservices000592@corehr.com\"}\n,\n{\"coreHRId\":\"000594\", \"value\": \"webservices000594@corehr.com\"}\n,\n{\"coreHRId\":\"002315\", \"value\": \"webservices002315@corehr.com\"}\n,\n{\"coreHRId\":\"000904\", \"value\": \"webservices000904@corehr.com\"}\n,\n{\"coreHRId\":\"002261\", \"value\": \"webservices002261@corehr.com\"}\n,\n{\"coreHRId\":\"002262\", \"value\": \"webservices002262@corehr.com\"}\n,\n{\"coreHRId\":\"CUT-012\", \"value\": \"webservicesCUT-012@corehr.com\"}\n,\n{\"coreHRId\":\"002248\", \"value\": \"webservices002248@corehr.com\"}\n,\n{\"coreHRId\":\"002249\", \"value\": \"webservices002249@corehr.com\"}\n,\n{\"coreHRId\":\"002250\", \"value\": \"webservices002250@corehr.com\"}\n,\n{\"coreHRId\":\"002367\", \"value\": \"webservices002367@corehr.com\"}\n,\n{\"coreHRId\":\"002368\", \"value\": \"webservices002368@corehr.com\"}\n,\n{\"coreHRId\":\"002369\", \"value\": \"webservices002369@corehr.com\"}\n,\n{\"coreHRId\":\"000826\", \"value\": \"webservices000826@corehr.com\"}\n,\n{\"coreHRId\":\"000897\", \"value\": \"webservices000897@corehr.com\"}\n,\n{\"coreHRId\":\"001128\", \"value\": \"webservices001128@corehr.com\"}\n,\n{\"coreHRId\":\"002629\", \"value\": \"webservices002629@corehr.com\"}\n,\n{\"coreHRId\":\"002697\", \"value\": \"webservices002697@corehr.com\"}\n,\n{\"coreHRId\":\"000934\", \"value\": \"webservices000934@corehr.com\"}\n,\n{\"coreHRId\":\"002624\", \"value\": \"webservices002624@corehr.com\"}\n,\n{\"coreHRId\":\"000290\", \"value\": \"webservices000290@corehr.com\"}\n,\n{\"coreHRId\":\"000837\", \"value\": \"webservices000837@corehr.com\"}\n,\n{\"coreHRId\":\"002444\", \"value\": \"webservices002444@corehr.com\"}\n,\n{\"coreHRId\":\"002685\", \"value\": \"webservices002685@corehr.com\"}\n,\n{\"coreHRId\":\"002227\", \"value\": \"webservices002227@corehr.com\"}\n,\n{\"coreHRId\":\"002169\", \"value\": \"webservices002169@corehr.com\"}\n,\n{\"coreHRId\":\"000849\", \"value\": \"webservices000849@corehr.com\"}\n,\n{\"coreHRId\":\"000808\", \"value\": \"webservices000808@corehr.com\"}\n,\n{\"coreHRId\":\"002091\", \"value\": \"webservices002091@corehr.com\"}\n,\n{\"coreHRId\":\"1010101010\", \"value\": \"webservices1010101010@corehr.com\"}\n,\n{\"coreHRId\":\"20202020\", \"value\": \"webservices20202020@corehr.com\"}\n,\n{\"coreHRId\":\"GM967\", \"value\": \"webservicesGM967@corehr.com\"}\n,\n{\"coreHRId\":\"GM969\", \"value\": \"webservicesGM969@corehr.com\"}\n,\n{\"coreHRId\":\"DB678\", \"value\": \"webservicesDB678@corehr.com\"}\n,\n{\"coreHRId\":\"002651\", \"value\": \"webservices002651@corehr.com\"}\n,\n{\"coreHRId\":\"gh23\", \"value\": \"webservicesgh23@corehr.com\"}\n,\n{\"coreHRId\":\"6633228\", \"value\": \"webservices6633228@corehr.com\"}\n,\n{\"coreHRId\":\"250\", \"value\": \"webservices250@corehr.com\"}\n,\n{\"coreHRId\":\"260\", \"value\": \"webservices260@corehr.com\"}\n,\n{\"coreHRId\":\"002705\", \"value\": \"webservices002705@corehr.com\"}\n,\n{\"coreHRId\":\"002103\", \"value\": \"webservices002103@corehr.com\"}\n,\n{\"coreHRId\":\"000950\", \"value\": \"webservices000950@corehr.com\"}\n,\n{\"coreHRId\":\"002756\", \"value\": \"webservices002756@corehr.com\"}\n,\n{\"coreHRId\":\"002652\", \"value\": \"webservices002652@corehr.com\"}\n,\n{\"coreHRId\":\"jg1234\", \"value\": \"webservicesjg1234@corehr.com\"}\n,\n{\"coreHRId\":\"DF5609\", \"value\": \"webservicesDF5609@corehr.com\"}\n,\n{\"coreHRId\":\"002289\", \"value\": \"webservices002289@corehr.com\"}\n,\n{\"coreHRId\":\"002727\", \"value\": \"webservices002727@corehr.com\"}\n,\n{\"coreHRId\":\"000179\", \"value\": \"webservices000179@corehr.com\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 100,\"hasMore\":true\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"https://localhost/ws/tenant/corehr/v1/contact/EMAIL/\"\n },\n {\n \"rel\": \"next\",\n \"href\": \"https://localhost/ws/tenant/corehr/v1/contact/EMAIL/?offsetby=100\"\n }\n ]\n}\n"}],"_postman_id":"0ef4469e-618d-4049-bce3-518be5f3cdfb"},{"name":"/contact/user/:person/","id":"34df58df-1127-49a9-a59d-167e00c2bfbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/","description":"This web service returns all contacts for the person.
This web service returns a specific contact for an associated person and type. Refer to /contact/ for a complete list of contacts available.
This web service provides ability to create a new contact type for a user. The contact type should not already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available.
\nThe value of the contact type must be provided in the request body as JSON e.g.
\n\n\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"33be61ea-5352-4fb7-b248-ca4580dd21c3","name":"400 - Bad Request - Error Code 006","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:41:20 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"006\",\"errorMessage\" :\"Validation failed. Existing contact for user, use PATCH to update\" }}\n"},{"id":"7e2e605a-c04e-4f0b-86f0-878a749108bc","name":"400 - Bad Request - Error Code 005","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/PHONE"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:44:28 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"005\",\"errorMessage\" :\"Validation failed. Ensure contact type is allowed and has correct format\" }}\n"},{"id":"84c32f04-1f0a-4edf-91e4-57a0ef12d0f4","name":"404 - Not Found - Error Code 003","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/7788/EMAIL"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:43:31 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"003\",\"errorMessage\" :\"Validation failed. User account does not exist\" }}\n"},{"id":"a28450bb-eb5c-48a9-a71b-cd08373129cd","name":"400 - Bad Request - Error Code 001","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:42:45 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"001\",\"errorMessage\" :\"Mandatory fields are missing\" }}\n"},{"id":"e2a69a84-d9ea-4234-86fa-4170ebe18eb7","name":"201 - Success - Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.james.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 30 Sep 2016 19:40:49 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"b7662db3-1c6c-41d0-ba36-0a172acb61d9"},{"name":"/contact/user/:person/:type","id":"b6174b3a-fd8a-4941-861c-ddf1bd326722","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"value\" :\"darragh.james.duffy@corehr.com\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL","description":"{\"value\" :\"darragh.james.duffy@corehr.com\"}
\n
This web service provides ability to patch / update a contact type for a user. The contact type must already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available.
\nThe value of the contact type must be provided in the request body as JSON e.g.
\n\n\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3d332aa6-6225-4bd9-b8d1-56f0d10199c6","name":"400 - Bad Request - Error Code 001","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:46:55 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"001\",\"errorMessage\" :\"Mandatory fields are missing\" }}\n"},{"id":"84659352-21f5-45cc-9c30-d0dfec425565","name":"201- Success - Created","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:45:19 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"},{"id":"86d107d7-2a68-411f-ab04-1abe886ce474","name":"404 - Not Found - Error Code 002","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/Phone"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:48:16 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"002\",\"errorMessage\" :\"Validation failed. Contact does not exist\" }}\n"},{"id":"abed0c67-263e-4036-ba81-3036f23fb817","name":"404 - Not Found - Error Code 003","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\"value\" :\"darragh.michael.duffy@corehr.com\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/7788/EMAIL"},"status":"Not Found","code":404,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 30 Sep 2016 19:47:30 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"003\",\"errorMessage\" :\"Validation failed. User account does not exist\" }}\n"}],"_postman_id":"b6174b3a-fd8a-4941-861c-ddf1bd326722"},{"name":"/contact/user/:person/:type","id":"4b6b2429-265a-4649-9a25-6793f8dd8f86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL","description":"{\"value\" :\"darragh.james.duffy@corehr.com\"}
\n
This web service provides ability to delete a contact from a users / employees profile. The contact type should already exist for this account. As previously noted a tenant may whitelist contact types. Refer to /contact/ for a complete list of contacts available. All contact types are case sensitive.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","contact","user","100","EMAIL"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"5033ae86-474e-4237-b5d7-728dd1288a03","name":"200 - Response OK","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ws/{{schema}}/{{version}}/contact/user/100/EMAIL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate","name":"Cache-Control","description":""},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Security-Policy","value":"default-src 'none'; script-src 'none'; img-src 'self'; style-src 'self';","name":"Content-Security-Policy","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 11 Nov 2016 14:46:13 GMT","name":"Date","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"4b6b2429-265a-4649-9a25-6793f8dd8f86"},{"name":"/contact/missing/:type","id":"eb7323b8-8aca-4cde-86b2-76411703fda1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/contact/missing/EMAIL","description":"This web service provides ability to list user accounts with missing contact types. For example find all users with a missing EMAIL contact.
This examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Contact module provides ability to interact with contact information associated with an account in CoreHR. Different contact types exist and can be defined by a tenant e.g EMAIL, MOBILE etc. Not all tenants have the same list of contacts i.e. each tenant can define a whitelist of contacts exposed to web services.
\nContraints, Limitations & Mandatory
\nThe contact module is case senstive, no process converts the contact type provided to upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned. Within CoreHR contact types are typically uppercase.
\nPerson is mandatory, person represents users unique CoreHR ID, this is often referenced as personnel number
Optionally
\nProvide the type of contact e.g. EMAIL to get users associated email address.
In cases where type is not specified all contact details are returned associated with employee.
In Summary contact provides ability to
\n- \n
- Enumerate users contact information \n
- Obtain a specific contact type \n
- Update / Patch an existing contact type \n
- Assign a new contact type to a user \n
Error Codes
\nNote type is case senstive, no process converts the type provided into upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned.
Convention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Mandatory fields are missing \n
- 404 / 002 Validation failed. Contact does not exist \n
- 404 / 003 Validation failed. User account does not exist \n
- 400 / 005 Validation failed. Ensure contact type is allowed and has correct format \n
- 400 / 006 Validation failed. Existing contact for user, use PATCH to update \n
- 404 / 007 Contact type does not exist for user, consider using POST to create \n
Note
\nWhere a contact exists within CoreHR, this does not mean an account in CoreHR has this contact assigned, e.g. not every account would have a mobile / cell number. Keep this in mind if you attempt to PATCH a contact type and server responds with a validation error.
\n","_postman_id":"b621468f-00ff-4eb0-a73c-e762da0e2b48"},{"name":"Provision","item":[{"name":"/provision/not/","id":"adb93bfe-a006-427b-baa1-63f7041b3d55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/provision/not/","description":"Find all non provisioned accounts. This endpoint will return all users not yet provisioned.
\nThis examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Optionally provide number of days, this service is used to offset users start date. Provides ability to determine accounts not yet provisioned in CoreHR for Core|Portal self service access. This service will include employees due to start in the future.
\nAllowing the following scenario.
\n- \n
obtain user accounts to be provisioned within the last X number of days, i.e. a start date occurring in the past.
\n \nobtain user accounts to be provisioned with a future start date, i.e. users starting in the future.
\n \n
This examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Provisions a new CorePortal account; on successful completion, users will have ability to access CoreHR's self service features via CorePortal. As noted in the introduction to the provisioning module, where an IDM or third party application understands CorePortal privileges this module will accept these privileges. Example provided below includes Users Privilege.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- authType \n
This is the authentication type for the employee, the value here should be either inApplicationPassword or LDAP. For all single sign on authenticated accounts use LDAP. For non single sign on account set this value to inApplicationPassword this then requires the password attribute to be set. Leaving this parameter null indicates to CoreHR that the user account should pick up the system default authentication type, this parameter can be found in CoreHR as 'authtype'.
- \n
- password \n
This attribute is required when authType is inApplicationPassword. The value here will be validated against the password policy in CoreHR.
- \n
- privileges \n
An array, each array object contains a privilege.
\nMandatory
\n- \n
- corehrid \n
- loginid \n
- password (only when authType is inApplicationPassword) \n
Provides ability to patch (amend) an existing account. Account must have previously been provisioned, this means corehrID must previously have been generated via POST. In general this service supports Single Sign On style accounts.
It is possible to use this service with non SSO accounts, in such cases all parameters are mandatory including password and explcitly setting authType to inApplicationPassword. In cases where authType is not provided the account is assumed to be Single Sign On.
The use cases for this web service includes
\n- \n
- loginId changing \n
Where a user changes their loginId e.g. their name changes because of marriage, this web service faciliates this change of ID.
\n- \n
- privilege changing \n
executing this web service will remove all current privileges and replace with the privileges array. It is therefore possible to use this web service to revoke all privileges for a user by sending a blank array of privileges.
\nExample provided below changes both Login ID and privileges.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- authType \n
This is the authentication type for the employee, the value here should be either inApplicationPassword or LDAP. For all single sign on authenticated accounts use LDAP. For non single sign on account set this value to inApplicationPassword this then requires the password attribute to be set. In cases where this attribute is null, assumpetion is Single Sign On.
- \n
- password \n
This attribute is required when authType is inApplicationPassword. The value here will be validated against the password policy in CoreHR.
- \n
- privileges \n
An array, each array object contains a privilege. If this is blank all privs are revoked.
\nMandatory
\n- \n
- corehrid \n
- loginid \n
- password (only when authType is inApplicationPassword) \n
For Non SSO Accounts all parameters are mandatory.
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","provision","user"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0b41976c-c635-413e-afc6-f8582e7e6c69","name":"201 - Created - Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\n \"corehrid\" : \"002875\",\n \"loginid\" : \"jones.donovan@corehr.com\",\n \"privileges\" : [\n {\"privilege\" : \"developmentTeam\"},\n {\"privilege\" : \"VPNGroup\"}\n ]\n}\n"},"url":"{{url}}/ws/{{schema}}/{{version}}//provision/user"},"status":"Created","code":201,"_postman_previewlanguage":"javascript","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 05 Oct 2016 16:42:46 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"}],"_postman_id":"076a6b58-29ac-416d-af58-79dab8032530"},{"name":"/provision/user/status/:id","id":"82b334cd-2b4d-4e7e-8512-df3eca27ec20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100","description":"Obtain user account status indicator; determining if an account is active or not. The parameter id can be users coreHRID or account username.
Obtain user authentication type. Response indicates either LDAP or inApplicationPassword.
The parameter id can be users coreHRID or loginID.
Provides an ability to activate or deactivate an account. Setting an account to be deactive results in a user not being allowed sign into CoreHR self Service module CorePortal. This applies irrespective of the users authentication type.
\nWhen an account is created via POST /provision/user the account is assumed to be active. You do not need to execute this web services to activate an account once it has been created. However if you execute this web services and set active to N then you must execute this web services again to re-activate the account by setting active to Y.
The id parameter can be either coreHRID or the username associated with the account. The Active parameter must be N or Y
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","provision","user","status","100"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"088f6732-03cd-4573-bf9d-31ac2c7bba31","name":"201 - Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\"active\" : \"N\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 19:02:16 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\" : {\"success\":true}}\n"},{"id":"44c2e238-3b98-4f05-87b5-37554662619c","name":"400 - Validation Failed","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\"active\" : \"N\"}"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/1001"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 19:02:41 GMT","name":"Date","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{\"Response\":{\"success\":false, \"errorCode\" : \"007\",\"errorMessage\" :\"Validation failed. Either user account does not exist or request data is invalid.\" }}\n"},{"id":"d24b07e6-8c40-4a6b-a6d3-8fdd00986b5b","name":"200 - Account Active","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/status/100"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Sat, 22 Oct 2016 18:04:52 GMT","name":"Date","description":""},{"key":"ETag","value":"\"L/idwKxNGWvlkQGQ4j3vC0+brkecdYNqpY2o9nJxaN5RiPktu/5d3OJrX6yJIWMlOB0ocscXHR0OVsUrx7Decw==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"{\"items\":[{\"isaccountactive\":\"Yes\"}],\"hasMore\":false,\"limit\":100,\"offset\":0,\"count\":1,\"links\":[{\"rel\":\"self\",\"href\":\"http://localhost:8585/ws/corehr/v1/provision/user/status/100\"},{\"rel\":\"describedby\",\"href\":\"http://localhost:8585/ws/corehr/metadata-catalog/v1/provision/user/status/item\"},{\"rel\":\"first\",\"href\":\"http://localhost:8585/ws/corehr/v1/provision/user/status/100\"}]}"}],"_postman_id":"eb589c3e-e71a-4870-bddf-68bbef48c5f0"},{"name":"/provision/user/privilege","id":"b6bec2dc-a00d-47f7-882e-4f34e2d8c7a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"loginid\" : \"jones.donovan@corehr.com\",\n \"privilege\" : \"hrAdmin\"\n }\n"},"url":"{{url}}/ws/{{schema}}/{{version}}/provision/user/privilege","description":"Provisions a new privilege for a user. This service allows one new privilege to be assigned to the user account. In addition this service assumes an account has already been provisioned. Validation is performed on the account confirming existence.
\nJSON Request Body Explained
\n- \n
- corehrid \n
Is an employees unique attribute in CoreHR also known as personnel number. Can be determined by the /provision/not/ web service.
- \n
- loginid \n
LoginId is the users account username, typically email address, sAMAccountName, userPrincipleName etc.
\n- \n
- privilege \n
a new privilege for the user.
\nSpecial Usage Note
\nuse one of the following combinations, do not use all three fields. If you do an error will be returned.
\n- \n
- corehrid and a privilege \n
or
\n- \n
- loginid and a privilege \n
Provisioning facility allowing Core|Portal accounts to be provisioned. Core|Portal is the self service module within CoreHR. A employee may have a record in CoreHR, this does not automatically suggest same employee has access to self service features via CorePortal. In order to access CorePortal a self service account is required. This module provides a web service mechanism to provision an employee.
\nIn Summary provisioning provides ability to
\n- \n
- Determine accounts yet to be provisioned \n
- Determine accounts yet to be provisioned within X number of days (including future start dates) \n
- Provision a new account \n
- Provision a new account with privileges \n
- Update existing accounts privileges \n
- Add additional privilege to an account \n
- Set authentication Type in cases where a mix of Single Sign On, SAML and inApplicationPasswords exist \n
Contraints, Limitations & Mandatory
\nAccounts to be provisioned simply indicates accounts (employees) not yet provisioned. These accounts must satisfy following criteria
\n- \n
- Active Employee Record \n
indicates employees record must not have a date left.
\nDo not assume logic applies indicating certain categories of employees are allowed access and others are not allowed. No other conditions are applied. Additional attributes are possible to add to the response to help an IDM provider make this decision, CoreHR will work with an IDM provider to best determine.
\nCorePortal privileges can be assigned by the IDM using the privileges array (example below). Where an IDM can not determine privileges, this provisioning web service module integrates with the CoreHR user profile matrix, and in cases where this matrix is not configured the fall back is all users are granted a default access profile typically \"coreportal_employee\".
\nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Mandatory fields are missing \n
- 400 / 002 Validation failed. If attempting to update use PATCH method \n
- 400 / 003 Unexpected error, unable to provision account \n
- 404 / 004 Validation failed. User account does not exist \n
- 404 / 005 Validation failed. Account must first be provisioned, use POST method \n
- 400 / 006 Validation failed. Invalid fields used \n
- 400 / 007 Validation failed. Either user account does not exist or request data is invalid. \n
- 400 / 008 Validation failed. Authtype must be either LDAP or inApplicationPassword. If choosing inApplicationPassword a password is required \n
- 400 / 009 Validation failed. Supplied password has not passed password \n
Get a list of registered / whitelisted referene types. Tenant has an ability to define reference types available for creating / updating. A tenant may not allow all references to be updated or created, this base URI provides the list of valid reference types. In cases where server returns validation errors, refer to this list to confirm the reference type is whitelisted.
\nThis examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Returns a list of codes and descriptions for a reference type, a reference type could be COST, DEPT etc. Reference Types are typically upper case. As already noted reference types can be whitelisted by a tenant.
For a full list of available reference types use /reference/
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","reference","type","DEPT",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"798a4d6e-5d7d-4761-b74c-75ee91b75ba2","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/COST/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:35:18 GMT","name":"Date","description":""},{"key":"ETag","value":"\"ZInz0RdXlDlkFr0RxOWVt0Xe8DrUJnBC2+V/aZmUKdeVao7Vnt+tTjTY7a88qxAW/95HgOuX3zxv4wgdqSdatg==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"COST\", \"code\": \"1\", \"description\": \"Cost Centre Web Services 1\"}\n,\n{\"type\":\"COST\", \"code\": \"10\", \"description\": \"Cost Centre Web Services 10\"}\n,\n{\"type\":\"COST\", \"code\": \"100A\", \"description\": \"Cost Centre Web Services 100A\"}\n,\n{\"type\":\"COST\", \"code\": \"111\", \"description\": \"Cost Centre Web Services 111\"}\n,\n{\"type\":\"COST\", \"code\": \"123456789\", \"description\": \"Cost Centre Web Services 123456789\"}\n,\n{\"type\":\"COST\", \"code\": \"149\", \"description\": \"Cost Centre Web Services 149\"}\n,\n{\"type\":\"COST\", \"code\": \"159\", \"description\": \"Cost Centre Web Services 159\"}\n,\n{\"type\":\"COST\", \"code\": \"20\", \"description\": \"Cost Centre Web Services 20\"}\n,\n{\"type\":\"COST\", \"code\": \"200A\", \"description\": \"Cost Centre Web Services 200A\"}\n,\n{\"type\":\"COST\", \"code\": \"21\", \"description\": \"Cost Centre Web Services 21\"}\n,\n{\"type\":\"COST\", \"code\": \"22\", \"description\": \"Cost Centre Web Services 22\"}\n,\n{\"type\":\"COST\", \"code\": \"222\", \"description\": \"Cost Centre Web Services 222\"}\n,\n{\"type\":\"COST\", \"code\": \"23\", \"description\": \"Cost Centre Web Services 23\"}\n,\n{\"type\":\"COST\", \"code\": \"24\", \"description\": \"Cost Centre Web Services 24\"}\n,\n{\"type\":\"COST\", \"code\": \"25\", \"description\": \"Cost Centre Web Services 25\"}\n,\n{\"type\":\"COST\", \"code\": \"26\", \"description\": \"Cost Centre Web Services 26\"}\n,\n{\"type\":\"COST\", \"code\": \"27\", \"description\": \"Cost Centre Web Services 27\"}\n,\n{\"type\":\"COST\", \"code\": \"28\", \"description\": \"Cost Centre Web Services 28\"}\n,\n{\"type\":\"COST\", \"code\": \"29\", \"description\": \"Cost Centre Web Services 29\"}\n,\n{\"type\":\"COST\", \"code\": \"2908100\", \"description\": \"Cost Centre Web Services 2908100\"}\n,\n{\"type\":\"COST\", \"code\": \"30\", \"description\": \"Cost Centre Web Services 30\"}\n,\n{\"type\":\"COST\", \"code\": \"300A\", \"description\": \"Cost Centre Web Services 300A\"}\n,\n{\"type\":\"COST\", \"code\": \"356\", \"description\": \"Cost Centre Web Services 356\"}\n,\n{\"type\":\"COST\", \"code\": \"39\", \"description\": \"Cost Centre Web Services 39\"}\n,\n{\"type\":\"COST\", \"code\": \"40\", \"description\": \"Cost Centre Web Services 40\"}\n,\n{\"type\":\"COST\", \"code\": \"451\", \"description\": \"Cost Centre Web Services 451\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC\", \"description\": \"Cost Centre Web Services ABC\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC001\", \"description\": \"Cost Centre Web Services ABC001\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC0010\", \"description\": \"Cost Centre Web Services ABC0010\"}\n,\n{\"type\":\"COST\", \"code\": \"ABC003\", \"description\": \"Cost Centre Web Services ABC003\"}\n,\n{\"type\":\"COST\", \"code\": \"J12345\", \"description\": \"Cost Centre Web Services J12345\"}\n,\n{\"type\":\"COST\", \"code\": \"JKL333\", \"description\": \"Cost Centre Web Services JKL333\"}\n,\n{\"type\":\"COST\", \"code\": \"PROD\", \"description\": \"Cost Centre Web Services PROD\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 33,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/reference/type/COST/\"\n }\n ]\n}\n"}],"_postman_id":"11a32481-cb9e-46e3-9523-2152d8308239"},{"name":"/reference/type/:atype/:code?","id":"6ebe68d5-eeef-4103-8d9f-a526063adb07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/DEPT/1061","description":"Returns an individual reference description associated with a reference type and code. A reference type could be COST, DEPT etc. Reference Types are typically upper case. As already noted reference types can be whitelisted by a tenant.
For a full list of available reference types use /reference/
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","reference","type","DEPT","1061"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"31ceaf97-fe47-4bb6-8585-0e79724e5ab2","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/COST/10"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 08 Nov 2016 20:35:39 GMT","name":"Date","description":""},{"key":"ETag","value":"\"Q3jVQU2iTQ/v0g70PelGZKl9U6wG1LV/Ns7vRxFBtB7MUyXAAgUcC+nxdBtW/mQMcQPoQhSS1jjRtrAA4a7uzQ==\"","name":"ETag","description":""},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"\n{ \"items\" : [\n{\"type\":\"COST\", \"code\": \"10\", \"description\": \"Cost Centre Web Services 10\"}\n]\n,\"limit\":100,\"offsetby\" : 0,\"count\" : 1,\"hasMore\":false\n,\"links\" : [\n {\n \"rel\": \"first\",\n \"href\": \"http://localhost:8585/ws/corehr/v1/reference/type/COST/10\"\n }\n ]\n}\n"}],"_postman_id":"6ebe68d5-eeef-4103-8d9f-a526063adb07"},{"name":"/reference/type/:atype","id":"22dd0051-7a25-41b8-880d-1397923a9cae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"value\" : \"1061\",\n\"description\" : \"Cost Centre One\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/DEPT/","description":"Add reference data based on the reference type, code and description. The reference type is expected in the URL, while the request body should include code and description
Ability to update a description associated with an existing reference code / type combination. The reference type is expected in the URL, while the request body should include code and description
Delete reference data based on the reference type, code. The reference type is expected in the URL, while the request body should include code.
Add reference data based on the reference type, code and description. The reference type is expected in the URL, while the request body should include code and description
Get a list of registered / whitelisted referene types. Tenant has an ability to define reference types available for creating / updating. A tenant may not allow all references to be updated or created, this base URI provides the list of valid reference types. In cases where server returns validation errors, refer to this list to confirm the reference type is whitelisted.
\nThis examples demonstrates pagination, as previously noted each request is limited to 100, where more data exists hasMore will be true, the links array will contain the next page of records using the offsetby parameter.
Returns a list of codes and descriptions for a reference type, a reference type could be COST, DEPT etc. Reference Types are typically upper case. As already noted reference types can be whitelisted by a tenant.
For a full list of available reference types use /reference/
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","reference","type","DEPT",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2971d42a-2d9e-4816-afae-d07b3be1da04"},{"name":"/reference/type/:atype","id":"fa1f623d-6da1-47ee-9b7b-babf2b0e844b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"value\" : \"1\",\n\"description\" : \"Department One Data Updated\"\n}"},"url":"{{url}}/ws/{{schema}}/{{version}}/reference/type/DEPT/","description":"Ability to update a description associated with an existing reference code / type combination. The reference type is expected in the URL, while the request body should include code and description
Delete reference data based on the reference type, code. The reference type is expected in the URL, while the request body should include code.
Returns an individual reference description associated with a reference type and code. A reference type could be COST, DEPT etc. Reference Types are typically upper case. As already noted reference types can be whitelisted by a tenant.
For a full list of available reference types use /reference/
\n","urlObject":{"path":["ws","{{schema}}","{{version}}","reference","type","DEPT","1061"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"06842830-5b35-4bbd-b49d-6c67ae5121d6"}],"id":"c6b5f1bf-c7a4-4330-a3e1-b1ee636dbd6d","description":"Reference module provides ability to view, add and update reference related items for CoreHR e.g. Cost Centre, Department, Projects etc.
\nContraints, Limitations & Mandatory
\nThe reference module is case senstive, no process converts the type provided into upper or lower case. You must ensure you have set the case correctly, otherwise no data will be returned. Within CoreHR reference types are typically uppercase.
\nIn most cases a type is mandatory. Following are some examples, for more detail review each URI and method below.
\nFor endpoint /reference/type/aType/ aType is mandatory e.g. /reference/type/COST/. Another example /reference/type/COST/1 will return Reference Type COST where the cost centre code is 1. For /reference/types/ no type is required.
Further information per method below.
\nLimitations
\nDescription max length - 40 Characters
\nCode max length - 13 Characters
\nError Codes
\nConvention is HTTP Status Code / Verbose Code
\n- \n
- 400 / 001 Mandatory fields are missing \n
- 400 / 002 Validation failed. If attempting to update use PATCH method \n
- 404 / 003 Validation failed. Reference type does not exist \n
- 400 / 004 Validation failed. Sanitization of data failed, ensure field lengths are correct \n
- 400 / 005 Validation failed. Reference code does not exist. If attempting to add use POST method. \n
Defined below are the endpoints, sample requests and responses.
\n","_postman_id":"c6b5f1bf-c7a4-4330-a3e1-b1ee636dbd6d"}],"id":"2319e5e6-499c-41c2-915e-4984b7833998","_postman_id":"2319e5e6-499c-41c2-915e-4984b7833998","description":""}],"event":[{"listen":"prerequest","script":{"id":"1516d8e5-f89b-451c-a106-f3661a601c81","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e10067c4-d1cd-4a93-83d2-cd8a7c742782","type":"text/javascript","exec":[""]}}]}