{"info":{"_postman_id":"30d267b0-1182-6bac-17d6-403f1de05bdb","name":"Account Provisioning","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"221349","collectionId":"30d267b0-1182-6bac-17d6-403f1de05bdb","publishedId":"7TT8V4b","public":true,"customColor":{"top-bar":"682673","right-sidebar":"414042","highlight":"05929B"},"publishDate":"2018-04-03T23:07:21.000Z"},"item":[{"name":"Outbound","item":[{"name":"ClientApp Auth","event":[{"listen":"test","script":{"type":"text/javascript","exec":["postman.setEnvironmentVariable(\"clientapp-access-token\", responseBody);","","tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"3810d855-11b7-a81a-75c8-258308051b18","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{clientapp-api-key}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://integrate.elluciancloud.com/auth","urlObject":{"protocol":"https","path":["auth"],"host":["integrate","elluciancloud","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3810d855-11b7-a81a-75c8-258308051b18"},{"name":"ClientApp Consume","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;",""]}}],"id":"d37ba685-4c28-52e2-a653-2056afb2ba88","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{clientapp-access-token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://integrate.elluciancloud.com/consume","urlObject":{"protocol":"https","path":["consume"],"host":["integrate","elluciancloud","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d37ba685-4c28-52e2-a653-2056afb2ba88"}],"id":"e4ef429c-a191-7c6c-f60d-57690059eecb","_postman_id":"e4ef429c-a191-7c6c-f60d-57690059eecb","description":""},{"name":"Inbound","item":[{"name":"ClientApp Auth","event":[{"listen":"test","script":{"type":"text/javascript","exec":["postman.setEnvironmentVariable(\"clientapp-access-token\", responseBody);","","tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"d5b02139-fd82-f0d2-d388-39e043083517","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{clientapp-api-key}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://integrate.elluciancloud.com/auth","urlObject":{"protocol":"https","path":["auth"],"host":["integrate","elluciancloud","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5b02139-fd82-f0d2-d388-39e043083517"},{"name":"ClientApp GET all persons v12","event":[{"listen":"test","script":{"id":"fa836607-b070-4d7e-b823-75274c820863","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","//parse the response","var jsonData = JSON.parse(responseBody);","","//test that there's 1 object in the response","tests[\"1 object in the response\"] = jsonData.length == 1;","","//test that the response object has an id","tests[\"Response has an ID\"] = jsonData[0].id !== undefined;","","//set section-registration environment variables for use in change-notification /publish","postman.setEnvironmentVariable(\"user-guid\", jsonData[0].id);",""],"type":"text/javascript"}}],"id":"4e3851e8-11cf-445a-9928-2afcc68bb367","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{clientapp-access-token}}"},{"key":"Accept","value":"application/vnd.hedtech.integration.v12+json"}],"url":"{{url}}/api/persons","description":"

Use this API call to get a person.id using a known, system-visible person identifier. In Banner, this will be the person's \"SPRIDENID\", known in Ethos as the \"bannerId\". In Collegue, this will be the person's XXX.

{{url}}/api/persons?criteria={\"credential\":{\"type\":\"bannerId\",\"value\":\"[enter the visible person identifier - SPRIDENID]\"}\n{{url}}/api/persons?criteria={\"credential\":{\"type\":\"bannerId\",\"value\":\"[enter the visible person identifier - SPRIDENID]\"}

\n","urlObject":{"path":["api","persons"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e3851e8-11cf-445a-9928-2afcc68bb367"},{"name":"ClientApp GET specific instance of persons v8 using bannerId","event":[{"listen":"test","script":{"id":"02f96115-fcc5-4b1c-9d30-2badf0a4fb81","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","//parse the response","var jsonData = JSON.parse(responseBody);","","//test that there's 1 object in the response","tests[\"1 object in the response\"] = jsonData.length == 1;","","//test that the response object has an id","tests[\"Response has an ID\"] = jsonData[0].id !== undefined;","","//set section-registration environment variables for use in change-notification /publish","postman.setEnvironmentVariable(\"user-guid\", jsonData[0].id);",""],"type":"text/javascript"}}],"id":"06179680-fbb7-a9d6-288c-17d86a7738c6","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{clientapp-access-token}}"},{"key":"Accept","value":"application/vnd.hedtech.integration.v8+json"}],"url":"{{url}}/api/persons?criteria={\"credential\":{\"type\":\"bannerId\",\"value\":\"LABUSR01\"}}","description":"

\n","urlObject":{"path":["api","persons"],"host":["{{url}}"],"query":[{"key":"criteria","value":"{\"credential\":{\"type\":\"bannerId\",\"value\":\"LABUSR01\"}}"}],"variable":[]}},"response":[],"_postman_id":"06179680-fbb7-a9d6-288c-17d86a7738c6"},{"name":"ClientApp GET specific instance of persons v12 using bannerId","event":[{"listen":"test","script":{"id":"fa836607-b070-4d7e-b823-75274c820863","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","",""],"type":"text/javascript"}}],"id":"63c50cca-ca11-4164-933f-31b93c7eaa82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{clientapp-access-token}}"},{"key":"Accept","value":"application/vnd.hedtech.integration.v12+json"}],"url":"{{url}}/api/persons?criteria={\"credentials\":[{\"type\":\"bannerUserName\",\"value\":\"A00038136\"}]}","description":"

\n","urlObject":{"path":["api","persons"],"host":["{{url}}"],"query":[{"key":"criteria","value":"{\"credentials\":[{\"type\":\"bannerUserName\",\"value\":\"A00038136\"}]}"}],"variable":[]}},"response":[],"_postman_id":"63c50cca-ca11-4164-933f-31b93c7eaa82"},{"name":"ClientApp GET persons with role=employees v8","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"87b5d4f1-0618-3950-228e-598765735ef6","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{clientapp-access-token}}","description":"

Use the Access Token received from the /auth request

\n"},{"key":"Accept","value":"application/vnd.hedtech.integration.v8+json"},{"key":"Content-Type","value":"application/vnd.hedtech.integration.v8+json"}],"body":{"mode":"raw","raw":" {\r\n \"citizenshipStatus\": {\r\n \"category\": \"nonCitizen\",\r\n \"detail\": {\r\n \"id\": \"89095bd4-fcf4-4ee3-9281-f05046fcd709\"\r\n }\r\n },\r\n \"dateOfBirth\": \"1996-09-02\",\r\n \"gender\": \"female\",\r\n \"names\": [\r\n {\r\n \"firstName\": \"Linda\",\r\n \"fullName\": \"Linda Adams\",\r\n \"lastName\": \"Adams\",\r\n \"preference\": \"preferred\",\r\n \"type\": {\r\n \"category\": \"personal\"\r\n }\r\n }\r\n ],\r\n \"privacyStatus\": {\r\n \"privacyCategory\": \"unrestricted\"\r\n },\r\n },"},"url":"{{url}}/api/persons?criteria={\"role\":\"employee\"}","description":"

Validation that the person was created and is accessible.

Use the Access Token received from the /auth request

Validation that the person was created and is accessible.

\n","urlObject":{"path":["api","persons"],"host":["{{url}}"],"query":[{"key":"criteria","value":"{\"role\":\"employee\"}"}],"variable":[]}},"response":[],"_postman_id":"330c92a1-1be6-4ec2-afbc-d485fdf11edc"},{"name":"ClientApp GET persons v8 using credential (bannerId)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","tests[\"X-Total Count is 1\"] = postman.getResponseHeader(\"X-Total-Count\") === 1;"]}}],"id":"85c4ab86-1afe-2b5e-c4d6-132b797e7809","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{clientapp-access-token}}"},{"key":"Accept","value":"application/vnd.hedtech.integration.v8+json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/api/persons?criteria={\"credentialType\":\"bannerId\",\"credentialValue\":\"A00012303\"}","urlObject":{"path":["api","persons"],"host":["{{url}}"],"query":[{"key":"criteria","value":"{\"credentialType\":\"bannerId\",\"credentialValue\":\"A00012303\"}"}],"variable":[]}},"response":[],"_postman_id":"85c4ab86-1afe-2b5e-c4d6-132b797e7809"},{"name":"Create persons v8","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"person-id\", jsonData.id);","","tests[\"Successful POST request\"] = responseCode.code === 201 || responseCode.code === 202;"]}}],"id":"540e3540-6ded-23ff-73aa-eba34fad5ef4","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{clientapp-access-token}}","description":"

Use the Access Token received from the /auth request

\n"},{"key":"Accept","value":"application/vnd.hedtech.integration.v8+json","description":"

Using v8 of persons

\n"},{"key":"Content-Type","value":"application/vnd.hedtech.integration.v8+json","description":"

Using v8 of persons

\n"}],"body":{"mode":"raw","raw":" {\r\n \"citizenshipStatus\": {\r\n \"category\": \"nonCitizen\",\r\n \"detail\": {\r\n \"id\": \"89095bd4-fcf4-4ee3-9281-f05046fcd709\"\r\n }\r\n },\r\n \"dateOfBirth\": \"1996-09-02\",\r\n \"gender\": \"female\",\r\n \"names\": [\r\n {\r\n \"firstName\": \"Linda\",\r\n \"fullName\": \"Linda Adams\",\r\n \"lastName\": \"Adams\",\r\n \"preference\": \"preferred\",\r\n \"type\": {\r\n \"category\": \"personal\"\r\n }\r\n }\r\n ],\r\n \"privacyStatus\": {\r\n \"privacyCategory\": \"unrestricted\"\r\n },\r\n },"},"url":"{{url}}/api/persons","description":"

Use POST against /api/persons to create a new person in the Ellucian ERP

\n","urlObject":{"path":["api","persons"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"540e3540-6ded-23ff-73aa-eba34fad5ef4"},{"name":"Validate created person v8","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"person-id\", jsonData.id);","","tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"e56cd390-5d9f-d775-84db-9d6a35d36940","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{clientapp-access-token}}","description":"

Use the Access Token received from the /auth request

Validation that the person was created and is accessible.

\n","urlObject":{"path":["api","persons","{{person-id}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e56cd390-5d9f-d775-84db-9d6a35d36940"}],"id":"9e11a1a7-409c-aa8b-53ba-d38b3cbf5b67","_postman_id":"9e11a1a7-409c-aa8b-53ba-d38b3cbf5b67","description":""},{"name":"GET persons-credentials","item":[{"name":"ClientApp Auth","event":[{"listen":"test","script":{"type":"text/javascript","exec":["postman.setEnvironmentVariable(\"clientapp-access-token\", responseBody);","","tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"bbaf2954-f42c-4870-8894-c9d4049b8b20","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{clientapp-api-key}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://integrate.elluciancloud.com/auth","urlObject":{"protocol":"https","path":["auth"],"host":["integrate","elluciancloud","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bbaf2954-f42c-4870-8894-c9d4049b8b20"},{"name":"ClientApp GET persons v8 using credential (bannerId)","event":[{"listen":"test","script":{"id":"f05347ac-9fc9-403d-9f98-cf77c65e5bb0","type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","//test that there's 1 object in the response","tests[\"X-Total Count is 1\"] = postman.getResponseHeader(\"x-total-count\") === 1;","","var response = JSON.parse(responseBody),"," credentials = [];","","response.forEach(function (obj) {"," obj.credentials.forEach(function (credential) {"," for (var key in credential) {"," if(key == 'bannerSourcedId'){"," postman.setEnvironmentVariable(\"bannerSourcedId\", credential.value);"," }"," }"," "," });","});","","","//set persons-credentials environment variables for use in change-notification /publish","//postman.setEnvironmentVariable(\"bannerSourcedId\", jsonData[0].credentials[0].value);","//postman.setEnvironmentVariable(\"bannerUserName\", JSON.stringify(jsonData[0]));","//postman.setEnvironmentVariable(\"bannerUdcId\", jsonData[1].guid);","//postman.setEnvironmentVariable(\"bannerId\", JSON.stringify(jsonData[1]));","//postman.setEnvironmentVariable(\"section-registrations-2-id\", jsonData[2].guid);","//postman.setEnvironmentVariable(\"section-registrations-2\", JSON.stringify(jsonData[2]));","//postman.setEnvironmentVariable(\"section-registrations-3-id\", jsonData[3].guid);","//postman.setEnvironmentVariable(\"section-registrations-3\", JSON.stringify(jsonData[3]));","",""]}}],"id":"621bcad0-3816-49b1-b87b-b016b3d22ad9","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{clientapp-access-token}}"},{"key":"Accept","value":"application/vnd.hedtech.integration.v8+json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/api/persons?criteria={\"credentialType\":\"bannerId\",\"credentialValue\":\"LABUSR01\"}","urlObject":{"path":["api","persons"],"host":["{{url}}"],"query":[{"key":"criteria","value":"{\"credentialType\":\"bannerId\",\"credentialValue\":\"LABUSR01\"}"}],"variable":[]}},"response":[],"_postman_id":"621bcad0-3816-49b1-b87b-b016b3d22ad9"},{"name":"ClientApp GET persons-credentials v11 using credential (bannerId)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","tests[\"X-Total Count is 1\"] = postman.getResponseHeader(\"X-Total-Count\") === 1;"]}}],"id":"cd20b15b-1cd0-41e6-92a3-30926e2c64fc","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{clientapp-access-token}}"},{"key":"Accept","value":"application/vnd.hedtech.integration.v11+json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/api/persons-credentials?criteria={\"credentials\":[{\"type\":\"bannerId\",\"value\":\"LABUSR01\"}]}","urlObject":{"path":["api","persons-credentials"],"host":["{{url}}"],"query":[{"key":"criteria","value":"{\"credentials\":[{\"type\":\"bannerId\",\"value\":\"LABUSR01\"}]}"}],"variable":[]}},"response":[],"_postman_id":"cd20b15b-1cd0-41e6-92a3-30926e2c64fc"},{"name":"ClientApp GET alternative-credential-types","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","tests[\"X-Total Count is 1\"] = postman.getResponseHeader(\"X-Total-Count\") === 1;"]}}],"id":"681cd32f-1644-4c52-b682-31bd8906453d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{clientapp-access-token}}"},{"key":"Accept","value":"application/vnd.hedtech.integration.v11+json"}],"url":"{{url}}/api/persons-credentials?criteria={\"credentials\":[{\"type\":\"bannerId\",\"value\":\"LABUSR01\"}]}","urlObject":{"path":["api","persons-credentials"],"host":["{{url}}"],"query":[{"key":"criteria","value":"{\"credentials\":[{\"type\":\"bannerId\",\"value\":\"LABUSR01\"}]}"}],"variable":[]}},"response":[],"_postman_id":"681cd32f-1644-4c52-b682-31bd8906453d"},{"name":"ClientApp PUT","id":"42906bcc-8378-4ba2-adbe-a4dd71803c5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{clientapp-access-token}}","type":"text"},{"key":"Content-Type","value":"application/vnd.hedtech.integration.v11+json","type":"text"},{"key":"Accept","value":"application/vnd.hedtech.integration.v11+json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"credentials\": [\r\n {\r\n \"type\": \"bannerSourcedId\",\r\n \"value\": \"48335\"\r\n },\r\n {\r\n \"type\": \"bannerUserName\",\r\n \"value\": \"labusr01\"\r\n },\r\n {\r\n \"type\": \"bannerUdcId\",\r\n \"value\": \"4D37E7B423C585A3B56989B237B17281\"\r\n },\r\n {\r\n \"type\": \"bannerId\",\r\n \"value\": \"LABUSR01\"\r\n }\r\n ],\r\n \"alternativeCredentials\": [\r\n {\r\n \"type\": {\r\n \"id\": \"e2a37c39-798d-485e-8817-da88dbeb7c87\"\r\n },\r\n \"value\": \"MMB-WAS-HERE\"\r\n }\r\n ],\r\n \"id\": \"08e3b8e8-92f3-4d81-bb6b-d8078b6c9129\"\r\n }\r\n]"},"url":"{{url}}/api/persons-credentials/08e3b8e8-92f3-4d81-bb6b-d8078b6c9129","urlObject":{"path":["api","persons-credentials","08e3b8e8-92f3-4d81-bb6b-d8078b6c9129"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"42906bcc-8378-4ba2-adbe-a4dd71803c5c"}],"id":"5663b111-986f-46dc-bbe6-3fcc47ab3c5e","_postman_id":"5663b111-986f-46dc-bbe6-3fcc47ab3c5e","description":""}]}