{"info":{"_postman_id":"0c958a32-0724-4da4-ba8f-9a1d56d4be19","name":"ReloTalent Master APIs","description":"<html><head></head><body><h1 id=\"relotalent-master-api-documentation\"><strong>Relotalent Master API Documentation</strong></h1>\n<p>This documentation has for scope to introduce users to Relotalent Master API functionalities.</p>\n<p>Master APIs allow users to perform activitites usually reserved to ReloTalent MasterAdmin users, its use is stricly reserved for internal or group activities, the present documentation has to be considered confidential and shall not be shared with external actors unless previous authorisation is granted.</p>\n<h2 id=\"equus-ecosystem\"><strong>Equus Ecosystem</strong></h2>\n<p>The main purpose of the following documentation is to allow the connectivity between ReloTalent and the Equus (the Group) ecosystem, in order to enable ReloTalent accounts to be available for Equus accounts as providers.</p>\n<h2 id=\"authentication\"><strong>Authentication</strong></h2>\n<p>Master APIs allow access only by using Access Token Authentication method.</p>\n<ul>\n<li><p><strong>To use Master APIs, you will need to refer to:</strong> <b>getMasterToken API in order to get the {{Authorization}} credentials.</b></p>\n</li>\n<li><p><strong>To receive your MasterToken Keys please contact ReloTalent team.</strong></p>\n</li>\n</ul>\n<h2 id=\"headers\"><strong>Headers</strong></h2>\n<p>Once you got the MasterToken Keys you will need to use the following headers for Authentication:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Language-Key</td>\n<td>Yes</td>\n<td>String</td>\n<td>Code of Language (en/fr/it/es)</td>\n</tr>\n<tr>\n<td>Timezone-Offset</td>\n<td>Yes</td>\n<td>String</td>\n<td>Offset of current Timezone</td>\n</tr>\n<tr>\n<td>Timezone</td>\n<td>Yes</td>\n<td>String</td>\n<td>Name of current Timezone</td>\n</tr>\n<tr>\n<td>Format</td>\n<td>Yes</td>\n<td>String</td>\n<td>Format of Api Response (json or xml)</td>\n</tr>\n</tbody>\n</table>\n</div></body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Relotalent Master API Documentation","slug":"relotalent-master-api-documentation"}],"owner":"8345454","collectionId":"0c958a32-0724-4da4-ba8f-9a1d56d4be19","publishedId":"2s935itkxi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0098ff"},"publishDate":"2023-03-02T03:40:25.000Z"},"item":[{"name":"Master APIs","item":[{"name":"Accounts","item":[{"name":"getMarketPlaceProviders","id":"77cc30a7-a955-4489-84d0-0f8628f8146a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/account/getMarketPlaceProviders","description":"<p>Get the list of all Providers being flagged as being authorised to be visible in Marketplace.</p>\n<p>This API is meant to be used to display a list of all Providers available to provide services.</p>\n<p>To be visible in Marketplace a Provider (DSP) must have given express consent and be flagged as Marketplace = TRUE in ReloTalent MasterAdmin.</p>\n","urlObject":{"path":["business-api-master","account","getMarketPlaceProviders"],"host":["{{hostMaster}}"],"query":[{"disabled":true,"key":"page","value":"2"},{"disabled":true,"key":"limit","value":"1"}],"variable":[]}},"response":[],"_postman_id":"77cc30a7-a955-4489-84d0-0f8628f8146a"},{"name":"getMarketPlaceProviderDetails","id":"668e0a92-172d-446a-9a62-93dd6a667fdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/account/getMarketPlaceProviderDetails/:uuid","description":"<p>Get details of Provider which is visible to Marketplace</p>\n<p>Get the details of a Provider being flagged as being authorised to be visible in Marketplace.</p>\n<p>This API is meant to be used to display the details of a Providers available to provide services.</p>\n<h3 id=\"parameters\">Parameters</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>uuid</td>\n<td>Yes</td>\n<td>String</td>\n<td>Provider uuid</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["business-api-master","account","getMarketPlaceProviderDetails",":uuid"],"host":["{{hostMaster}}"],"query":[],"variable":[{"type":"any","value":"debe4898-5b26-4929-aa0b-ba6daf1348f2","key":"uuid"}]}},"response":[],"_postman_id":"668e0a92-172d-446a-9a62-93dd6a667fdf"},{"name":"getAllowedHRAccountList","id":"3a4d6329-bfd6-4d25-84ff-85a13a041671","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/account/getAllowedHRAccountList","description":"<p>Get the list of all ReloTalent HR accounts being flagged as being HR accounts part of Equus ecosystem.</p>\n<p>This API is meant to be used to fetch a list of all HRs coming from Equus ecosystem that will interact with ReloTalent DSP (provider) accounts.</p>\n","urlObject":{"path":["business-api-master","account","getAllowedHRAccountList"],"host":["{{hostMaster}}"],"query":[{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"limit","value":"3"}],"variable":[]}},"response":[],"_postman_id":"3a4d6329-bfd6-4d25-84ff-85a13a041671"},{"name":"createHrAccount","id":"2880b4c7-0e4e-441e-b87b-a1a1fd48cf20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"Okuneva - Hyatt\",\n    \"email\": \"random_pro_email_870@relotest.com\",\n    \"city\": \"East Davonteton\",\n    \"country_iso_code\": \"FJ\",\n    \"telephone\": \"625-821-6171\",\n    \"address\": \"976 Bud Motorway\",\n    \"street\": \"Ciara Roads\",\n    \"zipcode\": \"815686467m\",\n    \"state_county\": \"guillermo\",\n    \"comments\" : \"Veritatis quo aliquid et quia vero qui vel. Rerum laudantium officia occaecati velit maiores ut ipsam laboriosam molestias. Voluptatem iste aspernatur nesciunt voluptatem dicta doloribus quidem. Id error architecto cum aut nulla saepe consequatur ipsum. Sit non fugiat sint officiis. Quaerat ipsam omnis modi eveniet magnam.\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/account/createHrAccount","description":"<p>Create an HR account in ReloTalent.</p>\n<p>This API is meant to be used to create a new HR account coming from Equus ecosystem.</p>\n<p><strong>This API will automatically create only accounts being flagged as being part of Equus ecosystem, there is no need to pass a parameter for this.</strong></p>\n<h3 id=\"parameters\">Parameters</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>name</td>\n<td>Yes</td>\n<td>String</td>\n<td>HR company name</td>\n</tr>\n<tr>\n<td>email</td>\n<td>Yes</td>\n<td>String</td>\n<td>HR company email; Email must be unique</td>\n</tr>\n<tr>\n<td>city</td>\n<td>Yes</td>\n<td>String</td>\n<td>City of HR company</td>\n</tr>\n<tr>\n<td>country_iso_code</td>\n<td>No</td>\n<td>String</td>\n<td>Country Alpha-2 code</td>\n</tr>\n<tr>\n<td>telephone</td>\n<td>No</td>\n<td>Integer</td>\n<td>Phone number must contain at least 6 characters</td>\n</tr>\n<tr>\n<td>address</td>\n<td>No</td>\n<td>String</td>\n<td>Company address</td>\n</tr>\n<tr>\n<td>street</td>\n<td>No</td>\n<td>String</td>\n<td>Company address street</td>\n</tr>\n<tr>\n<td>zipcode</td>\n<td>No</td>\n<td>String</td>\n<td>Company address zipcode</td>\n</tr>\n<tr>\n<td>state_county</td>\n<td>No</td>\n<td>String</td>\n<td>Company address state_county</td>\n</tr>\n<tr>\n<td>comments</td>\n<td>No</td>\n<td>String</td>\n<td>Comment of Company</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["business-api-master","account","createHrAccount"],"host":["{{hostMaster}}"],"query":[],"variable":[]}},"response":[{"id":"19b048f4-e3cb-4e50-b9dc-e0c53774ed3d","name":"createHrAccount PASS","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"APro HR Account\",\n    \"email\": \"thomas@relotest.com\",\n    \"city\": \"New York\",\n    \"country_iso_code\": \"US\",\n    \"telephone\": \"123456789\",\n    \"address\": \"13th Street. 47 W 13th St, New York, NY 10011, USA\",\n    \"street\": \"13th Street\",\n    \"zipcode\": \"10005\",\n    \"state_county\": \"Bronx County\",\n    \"comments\" : \"this is the sample for a successful HR account creation\",\n    \"gms_company_uuid\" : \"07b4f749-b8a4-4444-bb53-3cf83e67afa5\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/account/createHrAccount"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"eb45229e-39d5-41bd-9d83-47936bc9d2d6","name":"createHrAccount FAIL because the body includes existing email, wrong country_iso_code and invalid telephone","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"New HR Account\",\n    \"email\": \"thomas@relotest.com\",\n    \"city\": \"New York\",\n    \"country_iso_code\": \"US124\",\n    \"telephone\": \"telephone\",\n    \"address\": \"13th Street. 47 W 13th St, New York, NY 10011, USA\",\n    \"street\": \"13th Street\",\n    \"zipcode\": \"10005\",\n    \"state_county\": \"Bronx County\",\n    \"comments\" : \"this is the sample for a FAIL HR account creation because the body includes existing email, wrong country_iso_code and invalid telephone\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/account/createHrAccount"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"2880b4c7-0e4e-441e-b87b-a1a1fd48cf20"},{"name":"createHrAccountApplication","id":"dd9c7873-4ef5-46b7-89b3-d3778e31b3f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"},{"key":"format","value":"{{format}}","type":"text"}],"url":"{{hostMaster}}/business-api-master/account/createHrAccountApplication/:uuid","description":"<p>Create ReloTalent Application for an HR account.</p>\n<p>HR Accounts in ReloTalent can be silent or having an actual App, for further purpose (such as create HR user, generate Authentication key, etc.) an HR account must receive its own App.</p>\n<p><strong>This API will only create Apps for accounts being flagged as part of Equus ecosystem, there is no need to pass a parameter for this.</strong></p>\n","urlObject":{"path":["business-api-master","account","createHrAccountApplication",":uuid"],"host":["{{hostMaster}}"],"query":[],"variable":[{"type":"any","value":"65e92644-285d-4f6a-828e-a016889e2ec0","key":"uuid"}]}},"response":[],"_postman_id":"dd9c7873-4ef5-46b7-89b3-d3778e31b3f8"}],"id":"68bf27b7-e0d7-4090-b1d3-da9f37d85727","description":"<p>The <strong>Accounts</strong> section details the APIs available to manage ReloTalent accounts, this includes:</p>\n<ul>\n<li>list of DSP (Provider) accounts available,</li>\n<li>details of DSP (Provider) accounts available,</li>\n<li>list of HR accounts available.</li>\n</ul>\n","_postman_id":"68bf27b7-e0d7-4090-b1d3-da9f37d85727"},{"name":"Users","item":[{"name":"createHrAdminUser","event":[{"listen":"prerequest","script":{"id":"c04387bf-d4d3-4ff1-9337-0e76d3269114","exec":["pm.variables.set('sex_local', 1);","pm.variables.set('user_group_id_local', 2); //can be admin = 2/manager = 4/member = 5","","//thinhdev local","if(pm.environment.name == 'Relotalent-App-DucDev-Local'){","    pm.variables.set('hr_account_uuid_local', '52a91c7a-01aa-469b-b5b0-48dc147be3c5'); //thinhdev local","}","","if(pm.environment.name == '[ThuTest] Relotalent-App-Thinhdev'){","    pm.variables.set('hr_account_uuid_local','@@@@');","}"],"type":"text/javascript"}}],"id":"9ec645c0-25ed-44f4-99b2-4770c2eb707b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"hr_company_uuid\" : \"de79c943-a177-48f0-b289-4b416dd8a5ba\",\n    \"firstname\": \"Turner\",\n    \"lastname\": \"Blick\",\n    \"jobtitle\": \"Principal Factors Architect\",\n    \"phonework\": \"898-917-6263\",\n    \"workemail\": \"thinhdev_Margarita_Smitham12@relotest.com\",\n    \"privateemail\": \"thinhdev_privateShawna_Funk37@relotest.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/user/createHrAdminUser","description":"<p>Create HR Admin user for HR Account.</p>\n<p>An account being created and having its own related App can receive users, as a convention, the first user created for an account will be its first Admin.</p>\n<p>This API is meant to be used to create a new Admin user for accounts part of Equus ecosystem.</p>\n<p><strong>This API will automatically create only Admin users for accounts being flagged as being part of Equus ecosystem, there is no need to pass a parameter for this.</strong></p>\n<h3 id=\"parameters\">Parameters</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>hr_company_uuid</td>\n<td>Yes</td>\n<td>String</td>\n<td>Unique uuid of HR Account which is created by MasterAPI</td>\n</tr>\n<tr>\n<td>firstname</td>\n<td>Yes</td>\n<td>String</td>\n<td>HR user firstname</td>\n</tr>\n<tr>\n<td>lastname</td>\n<td>Yes</td>\n<td>String</td>\n<td>HR user lastname</td>\n</tr>\n<tr>\n<td>jobtitle</td>\n<td>Yes</td>\n<td>String</td>\n<td>HR user job title</td>\n</tr>\n<tr>\n<td>phonework</td>\n<td>No</td>\n<td>integer</td>\n<td>HR user work phone number</td>\n</tr>\n<tr>\n<td>workemail</td>\n<td>Yes</td>\n<td>String</td>\n<td>HR user work email</td>\n</tr>\n<tr>\n<td>privateemail</td>\n<td>No</td>\n<td>String</td>\n<td>HR user private email</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["business-api-master","user","createHrAdminUser"],"host":["{{hostMaster}}"],"query":[],"variable":[]}},"response":[{"id":"6fe5fa81-8c31-47a9-af0e-f1f44be2cf19","name":"createHrAdminUser PASS","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"hr_company_uuid\" : \"65e92644-285d-4f6a-828e-a016889e2ec0\",\n    \"firstname\": \"Savannah\",\n    \"lastname\": \"Booker\",\n    \"jobtitle\": \"salesman\",\n    \"phonework\": \"3902834900\",\n    \"workemail\": \"savannah@newhracount.com\",\n    \"privateemail\": \"savannah_private@gmail.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/user/createHrAdminUser"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"9f09eb8c-6a5f-4783-95fa-a8061facf56d","name":"createHrAdminUser FAIL because the body includes null lastname and invalid workemail","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"hr_company_uuid\" : \"65e92644-285d-4f6a-828e-a016889e2ec0\",\n    \"firstname\": \"Savannah\",\n    \"lastname\": \"\",\n    \"jobtitle\": \"salesman\",\n    \"phonework\": \"3902834900\",\n    \"workemail\": \"savannah\",\n    \"privateemail\": \"savannah_private@gmail.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/user/createHrAdminUser"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"9ec645c0-25ed-44f4-99b2-4770c2eb707b"},{"name":"createHrAdminUserLogin","event":[{"listen":"prerequest","script":{"id":"c04387bf-d4d3-4ff1-9337-0e76d3269114","exec":["pm.variables.set('sex_local', 1);","pm.variables.set('user_group_id_local', 2); //can be admin = 2/manager = 4/member = 5","","//thinhdev local","if(pm.environment.name == 'Relotalent-App-DucDev-Local'){","    pm.variables.set('hr_account_uuid_local', '52a91c7a-01aa-469b-b5b0-48dc147be3c5'); //thinhdev local","}","","if(pm.environment.name == '[ThuTest] Relotalent-App-Thinhdev'){","    pm.variables.set('hr_account_uuid_local','@@@@');","}"],"type":"text/javascript"}}],"id":"3e4e490a-7e66-4f7a-a6b6-c47edfdeac8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/user/createHrAdminUserLogin/:uuid","description":"<p>Activate HR Admin user to enable accessing ReloTalent.</p>\n<p>A new user being created can be silent and will require a login to be able to access the system. ReloTalent logins are stored in AWS Cognito and secured by AWS.</p>\n<p>This API is meant to be used to create a login for Admin users of accounts part of Equus ecosystem.</p>\n<h1 id=\"parameter\">Parameter</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>uuid</td>\n<td>Yes</td>\n<td>String</td>\n<td>Unique uuid of HR Admin user</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["business-api-master","user","createHrAdminUserLogin",":uuid"],"host":["{{hostMaster}}"],"query":[],"variable":[{"type":"any","value":"93721414-2af5-4656-8ffe-9b96d601af0e","key":"uuid"}]}},"response":[],"_postman_id":"3e4e490a-7e66-4f7a-a6b6-c47edfdeac8c"},{"name":"generateHrUserApiKey","event":[{"listen":"prerequest","script":{"id":"c04387bf-d4d3-4ff1-9337-0e76d3269114","exec":["pm.variables.set('user_profile_uuid', '1153cd4d-c483-419c-ac9e-e2979a0858b9');",""],"type":"text/javascript"}}],"id":"08a750f6-640b-4680-9176-500c4bbbe474","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/user/generateHrUserApiKey/:uuid","description":"<p>Generate API keys for HR Admin user in order to enable calling HR Public APIs which require Authentication Keys to be run.</p>\n<p>This API is meant to be used to generate Authentication keys for Admin users of accounts part of Equus ecosystem.</p>\n<h3 id=\"parameters\">Parameters</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>uuid</td>\n<td>Yes</td>\n<td>String</td>\n<td>Unique uuid of HR Admin user</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["business-api-master","user","generateHrUserApiKey",":uuid"],"host":["{{hostMaster}}"],"query":[],"variable":[{"type":"any","value":"2bfc8bb8-b5b7-40dd-9902-340464d06baa","key":"uuid"}]}},"response":[],"_postman_id":"08a750f6-640b-4680-9176-500c4bbbe474"},{"name":"getHrUserApiKey","event":[{"listen":"prerequest","script":{"id":"a35942cb-acdf-497f-8e42-f6648ffb9dd5","exec":["pm.variables.set('user_profile_uuid', '1153cd4d-c483-419c-ac9e-e2979a0858b9');",""],"type":"text/javascript"}}],"id":"5c1c47ca-7fe7-4aac-a623-aa47b2e86373","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/user/getHrUserApiKey/:uuid","description":"<p>Get/retrieve API keys for HR Admin users.</p>\n<p>This API is meant to be used to retrieve Authentication keys for Admin users of accounts part of Equus ecosystem.</p>\n","urlObject":{"path":["business-api-master","user","getHrUserApiKey",":uuid"],"host":["{{hostMaster}}"],"query":[],"variable":[{"type":"any","value":"bc9988b5-e18a-4b82-a4a0-4c9a498dd1bf","key":"uuid"}]}},"response":[],"_postman_id":"5c1c47ca-7fe7-4aac-a623-aa47b2e86373"},{"name":"generateHrUserApiKeyPair","event":[{"listen":"prerequest","script":{"id":"c04387bf-d4d3-4ff1-9337-0e76d3269114","exec":["pm.variables.set('user_profile_uuid', '1153cd4d-c483-419c-ac9e-e2979a0858b9');",""],"type":"text/javascript"}}],"id":"d4606209-3489-4786-8f6c-b757d8df2839","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/user/generateHrUserApiKeyPair/:uuid","description":"<p>Generate API key pair <strong>including Client ID and Client Secret Key</strong> for HR Admin user in order <strong>to allow getting Authentication Token.</strong></p>\n<h3 id=\"parameters\">Parameters</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>uuid</td>\n<td>Yes</td>\n<td>String</td>\n<td>Unique uuid of HR Admin user</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["business-api-master","user","generateHrUserApiKeyPair",":uuid"],"host":["{{hostMaster}}"],"query":[],"variable":[{"type":"any","value":"93721414-2af5-4656-8ffe-9b96d601af0g","key":"uuid"}]}},"response":[],"_postman_id":"d4606209-3489-4786-8f6c-b757d8df2839"},{"name":"getHrUserApiKeyPair","event":[{"listen":"prerequest","script":{"id":"a35942cb-acdf-497f-8e42-f6648ffb9dd5","exec":["pm.variables.set('user_profile_uuid', '1153cd4d-c483-419c-ac9e-e2979a0858b9');",""],"type":"text/javascript"}}],"id":"2bbd392c-bb44-456e-8df7-709e29c0d41e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/user/getHrUserApiKeyPair/:uuid","description":"<p>Get/retrieve API key pair <strong>including Client ID and Client Secret Key</strong> for HR Admin user in order <strong>to allow getting Authentication Token.</strong></p>\n","urlObject":{"path":["business-api-master","user","getHrUserApiKeyPair",":uuid"],"host":["{{hostMaster}}"],"query":[],"variable":[{"type":"any","value":"","key":"uuid"}]}},"response":[],"_postman_id":"2bbd392c-bb44-456e-8df7-709e29c0d41e"},{"name":"getHrAdminUsers","event":[{"listen":"prerequest","script":{"id":"c04387bf-d4d3-4ff1-9337-0e76d3269114","exec":["pm.variables.set('user_profile_uuid', '1153cd4d-c483-419c-ac9e-e2979a0858b9');",""],"type":"text/javascript"}}],"id":"12d2cd38-32c6-4cce-a5dc-8321a7287b95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/user/getHrAdminUsers/:uuid","description":"<p>Get the list of all Admin users for an account being flagged as being part of Equus ecosystem.</p>\n<p>This API is meant to be used to fetch a list of all HRs users with role = Admin for Equus ecosystem accounts.</p>\n","urlObject":{"path":["business-api-master","user","getHrAdminUsers",":uuid"],"host":["{{hostMaster}}"],"query":[{"disabled":true,"key":"page","value":"2"},{"disabled":true,"key":"limit","value":"3"}],"variable":[{"type":"any","value":"44b6ff35-11ac-4b49-ae79-5d9723d529fb","key":"uuid"}]}},"response":[],"_postman_id":"12d2cd38-32c6-4cce-a5dc-8321a7287b95"}],"id":"bdcc1860-ee63-4ed2-b22f-a363094a1c14","_postman_id":"bdcc1860-ee63-4ed2-b22f-a363094a1c14","description":""},{"name":"Tools","item":[{"name":"Utilities: createAnonymousEmail","id":"6e99ef57-9490-48cc-8fd8-5d1f584c3823","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/utilities/getAnonymousEmail","urlObject":{"path":["business-api-master","utilities","getAnonymousEmail"],"host":["{{hostMaster}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e99ef57-9490-48cc-8fd8-5d1f584c3823"}],"id":"5d60e6b4-af7c-49ba-a59d-cade298d9182","_postman_id":"5d60e6b4-af7c-49ba-a59d-cade298d9182","description":""},{"name":"Subscription","item":[{"name":"Subscription:applyPlanToAccount","event":[{"listen":"prerequest","script":{"id":"c04387bf-d4d3-4ff1-9337-0e76d3269114","exec":["pm.variables.set('sex_local', 1);","pm.variables.set('user_group_id_local', 2); //can be admin = 2/manager = 4/member = 5","","//thinhdev local","if(pm.environment.name == 'Relotalent-App-DucDev-Local'){","    pm.variables.set('hr_account_uuid_local', '52a91c7a-01aa-469b-b5b0-48dc147be3c5'); //thinhdev local","}","","if(pm.environment.name == '[ThuTest] Relotalent-App-Thinhdev'){","    pm.variables.set('hr_account_uuid_local','@@@@');","}"],"type":"text/javascript"}}],"id":"40e9df92-96e3-4462-adce-9d2df2d2fb2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"plan_uuid\" : \"064d32b9-dbfe-430d-9bd5-df1688899c68\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/subscription/applyPlanToAccount/{{hr_account_uuid}}","description":"<p>Add Subscription plan to HR Account as a pre-condition to add API Add-on to HR Account</p>\n<h3 id=\"parameters\">Parameters</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>hr_account_uuid</td>\n<td>Yes</td>\n<td>String</td>\n<td>Unique uuid of HR Account</td>\n</tr>\n<tr>\n<td>plan_uuid</td>\n<td>Yes</td>\n<td>String</td>\n<td>Pls add the uuid of the plan here</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["business-api-master","subscription","applyPlanToAccount","{{hr_account_uuid}}"],"host":["{{hostMaster}}"],"query":[],"variable":[]}},"response":[{"id":"225f94d7-c613-450a-bb6b-13a581602c70","name":"Subscription:applyPlanToAccount PASS","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"plan_uuid\" : \"335928b8-d3a1-46c9-8c8a-46dbafb1f2d3\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/subscription/applyPlanToAccount/{{plan_uuid}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"03e882f6-49ff-4bcb-9933-6fb7834782d8","name":"Subscription:applyPlanToAccount FAIL because of missing plan_uuid","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"plan_uuid\" : \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/subscription/applyPlanToAccount/{{plan_uuid}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"40e9df92-96e3-4462-adce-9d2df2d2fb2b"},{"name":"Subscription: applyAddonToAccount","event":[{"listen":"prerequest","script":{"id":"c04387bf-d4d3-4ff1-9337-0e76d3269114","exec":["pm.variables.set('sex_local', 1);","pm.variables.set('user_group_id_local', 2); //can be admin = 2/manager = 4/member = 5","","//thinhdev local","if(pm.environment.name == 'Relotalent-App-DucDev-Local'){","    pm.variables.set('hr_account_uuid_local', '52a91c7a-01aa-469b-b5b0-48dc147be3c5'); //thinhdev local","}","","if(pm.environment.name == '[ThuTest] Relotalent-App-Thinhdev'){","    pm.variables.set('hr_account_uuid_local','@@@@');","}"],"type":"text/javascript"}}],"id":"abd94a70-99da-4924-b61f-613f672b2f9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"addon_code\" : \"PUBLIC_API\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/subscription/applyAddonToAccount/{{hr_account_uuid}}","description":"<p>Add Add-on (Webhook, Public API) to HR Account</p>\n<h3 id=\"parameters\">Parameters</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>hr_account_uuid</td>\n<td>Yes</td>\n<td>String</td>\n<td>Unique uuid of HR Account</td>\n</tr>\n<tr>\n<td>addon_code</td>\n<td>Yes</td>\n<td>String</td>\n<td>PUBLIC_API = public API, WEBHOOK = webhook</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["business-api-master","subscription","applyAddonToAccount","{{hr_account_uuid}}"],"host":["{{hostMaster}}"],"query":[],"variable":[]}},"response":[{"id":"1ba15a5c-a7c9-49cd-b738-f189651cabdc","name":"Subscription: applyAddonToAccount PASS","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"addon_code\" : \"PUBLIC_API\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/subscription/applyAddonToAccount/{{hr_account_uuid}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"dddf65d7-6e7c-4fac-8de7-672e7f82cbb2","name":"Subscription: applyAddonToAccount FAIL because of wrong addon_code","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"addon_code\" : \"public api\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/subscription/applyAddonToAccount/{{hr_account_uuid}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"abd94a70-99da-4924-b61f-613f672b2f9e"}],"id":"bbdf8b8d-9f4e-438c-abb4-a6b62b6fb483","_postman_id":"bbdf8b8d-9f4e-438c-abb4-a6b62b6fb483","description":""},{"name":"Contract","item":[{"name":"Contract:create","id":"35922247-760b-433e-82ba-0544448bfc3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"hr_company_uuid\": \"3af15edb-57ad-4274-a620-ecfb979de1d0\",\n    \"gms_company_uuid\" : \"d63def8c-5b54-4eaf-9640-4f4ec27886e7\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/contract/create","description":"<p>Create a Contract between Equus HR account and Provider which is visible on Market place for further collaboration like sending Initiation, creating Assignee/Assignment and so on.</p>\n<h3 id=\"parameters\">Parameters</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>hr_company_uuid</td>\n<td>Yes</td>\n<td>String</td>\n<td>Unique uuid of HR Account</td>\n</tr>\n<tr>\n<td>gms_company_uuid</td>\n<td>Yes</td>\n<td>String</td>\n<td>Unique uuid of Provider with is_visible_marketplace = yes</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["business-api-master","contract","create"],"host":["{{hostMaster}}"],"query":[],"variable":[]}},"response":[{"id":"bba974fd-8590-4f51-bc33-839826ee9375","name":"Contract:create PASS","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"hr_company_uuid\": \"3af15edb-57ad-4274-a620-ecfb979de1d0\",\n    \"gms_company_uuid\" : \"d63def8c-5b54-4eaf-9640-4f4ec27886e7\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/contract/create"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"4b132948-b45a-42d3-89bf-d6b1ce6cf5f6","name":"Contract:create FAIL because of invalid uuid (uuid should have 32 digits)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"hr_company_uuid\": \"3af15edb-57ad-4274-a620-ecfb979de1d0dsdsaas\",\n    \"gms_company_uuid\" : \"d63def8c-5b54-4eaf-9640-4f4ec27886e7dfefe\"\n}","options":{"raw":{"language":"json"}}},"url":"{{hostMaster}}/business-api-master/contract/create"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"35922247-760b-433e-82ba-0544448bfc3e"}],"id":"34d6f656-f6b6-42b3-95a2-7e16b798f58d","_postman_id":"34d6f656-f6b6-42b3-95a2-7e16b798f58d","description":""}],"id":"27c401e0-12b3-4f71-a9ee-842abff0c9d5","description":"<p>This section details the MasterAPIs available.</p>\n<p><strong>To connect please replace {{hostMaster}} by the following HOST:</strong> <a href=\"https://master-api.relotalent.com\"><strong>https://master-api.relotalent.com</strong></a></p>\n","_postman_id":"27c401e0-12b3-4f71-a9ee-842abff0c9d5"},{"name":"GetToken","item":[{"name":"getMasterToken","id":"e8d2e0bd-f43e-44c0-a39e-40c2d4c4ccfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":"<value>"}]},"isInherited":false},"method":"GET","header":[{"key":"client-id","value":"{{clientIdMaster}}","type":"text"},{"key":"client-secret","value":"{{clientSecretMaster}}","type":"text"}],"url":"{{hostMasterToken}}/business-api-oauth/auth/getMasterToken","description":"<p>Master APIs allow access only by using Access Token Authentication method.</p>\n<ul>\n<li><strong>To use Master APIs, you will need to refer to:</strong> getMasterToken API.</li>\n<li><strong>To receive your MasterToken Keys please contact ReloTalent team.</strong></li>\n</ul>\n<p><b>Please note:<br /></b></p>\n<p><b>Token lifespan is 1 hour and will need to be regenerated regularly.</b></p>\n","urlObject":{"path":["business-api-oauth","auth","getMasterToken"],"host":["{{hostMasterToken}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e8d2e0bd-f43e-44c0-a39e-40c2d4c4ccfa"}],"id":"3b5d15bf-257c-4246-bc11-65f73c5adae7","description":"<p><strong>To connect please replace {{hostMasterToken}} by the following HOST:</strong> <a href=\"https://api.relotalent.com\"><strong>https://api.relotalent.com</strong></a></p>\n","_postman_id":"3b5d15bf-257c-4246-bc11-65f73c5adae7"}]}