SG Developers Request a specific Application
You can retrieve the
HTTP-Method
GET
Path
/api/rest/v3/frontend/applications/{applicationId}
Authentification
User Access Token
Path Parameter
applicationId
Query Parameter
- fields (optional):The parameters defines which fields of the response DTO should be returned. You have the choice of all direct fields of the ApplicationProfileDTO but you cannot select the nested fields.
field=* returns all fields. If the fields parameter is not provided a subset of possible fields is returned as a default. These are all fields except experiences, educations, languages, answers, attachments. Please als see the example calls. The imported field is always returned. Please use that parameter as described below: comma separated field names, no spaces
Responses
| Action | Response | Description |
|---|---|---|
| success | 200 – ein ApplicationProfileDTO | |
| error | 400 – { “code”: “project_not_applicable”, “message”: “Applications for this project are not possible. Maybe the job was closed in the meanwhile or is not available for other reasons.” } | The jobposting was unposted in the meanwhile. Already started but not finalized applications can’t be continued. This is relevant for the case you want to edit an application and tried to fetch the already stored data in this endpoint. |
| authorization error | 401 / 403 | See here and here for details. |
Example call with curl and user access token
Without fields parameter, falling back to default.
|
1 |
curl -i -H "Authorization: Bearer 31cb2exx-001e-4b59-babc-f0815tdad47d" -H "Content-Type: application/json" -X GET "https://api.softgarden.io/api/rest/v3/frontend/applications/70000006c-99b5-45g-arh-b59exxx4a46" |
Response:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
{ "applicationId" : "70000006c-99b5-45g-arh-b59exxx4a46", "status" : "ACTIVE", "applicationEditable" : false, "createdOn" : "2018-10-30T10:05:21.258+0000", "lastChangedOn" : "2018-10-30T14:34:08.126+0000", "submittedOn" : "2018-10-30T10:06:07.149+0000", "jobId" : 4711, "jobName" : "Testjob", "firstname" : "Joe", "lastname" : "Doe", "sex" : "1", "academictitle" : "", "email" : "joe.doe@foo.bar", "locale" : "de", "street" : "Randomstreet 15", "zip" : "66113", "city" : "Saarbrücken", "country" : "Germany", "nationality" : "German", "phone" : "555-1234", "mobilePhone" : "", "dateofbirth" : "1965-05-05T00:00:00.000+0000", "coverLetterText" : "Some Text", "region" : "Saarland", "imported" : "NONE", } |
Example call with curl and user access token
All fields returned
|
1 |
curl -i -H "Authorization: Bearer 31cb2exx-001e-4b59-babc-f0815tdad47d" -H "Content-Type: application/json" -X GET "https://api.softgarden.io/api/rest/v3/frontend/applications/dgdsb0-a0e8-4fsf4-b8e8-wgeg20dc503?fields=*" |
Response:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
{ "applicationId" : "dgdsb0-a0e8-4fsf4-b8e8-wgeg20dc503", "status" : "ACTIVE", "applicationEditable" : false, "createdOn" : "2018-10-30T13:17:15.761+0000", "lastChangedOn" : "2018-10-30T14:07:30.675+0000", "submittedOn" : "2018-10-30T13:18:14.794+0000", "jobId" : 2797227, "jobName" : "Some Test Job", "firstname" : "Joe", "lastname" : "Doe", "sex" : "1", "academictitle" : "Prof. Dr.", "email" : "joe.doe@foo.bar", "locale" : "en", "street" : "1521 Randomstreet", "zip" : "01234", "city" : "Randomtown", "country" : "Germany", "nationality" : "German", "phone" : "555-4321", "mobilePhone" : "555-1234", "dateofbirth" : "1975-04-07T00:00:00.000+0000", "coverLetterText" : "This is some coverletter text", "region" : "Berlin", "experiences" : [ { "company" : "ACME Inc", "industry" : "Agriculture", "title" : "Worker", "status" : "Publicly held corporation", "careerLevel" : "Student/Intern", "companySize" : "0-10 employees", "url" : "http://www.acme.com", "type" : "Full time employee", "startDate" : "2012-03-31T22:00:00.000+0000", "endDate" : "2018-10-30T23:00:00.000+0000", "description" : "Imagine some job description here", "additional" : "And some more additional information" }, {...}, ... ], "educations" : [ { "startDate": "2001-10-30T23:00:00.000+0000", "endDate" : "2008-10-30T23:00:00.000+0000", "university" : "ACME University Texas", "field" : "Computer science", "degree" : "Bachelor", "specialization" : "Psychology" }, {...}, ... ], "languages" : [ { "locale" : "de", "skill" : "First language" }, { "locale" : "en", "skill" : "", }, ... ], "answers" : [ { "questionId" : 11019, "answer" : "I really like potatoes" }, { "questionId" : 11021, "answer" : "2900100" }, ... ], "photo" : { "id" : "ed747f6a-b9d9-4835-9d1f-de90c2cb9d40", "name" : "mypic.png", "type" : "image/png", "fileSize" : 431056, "content" : null }, "cv" : { "id" : "d96cb50d-24a2-414b-9f03-f112dc746a78", "name" : "myCV.pdf", "type" : "application/pdf", "fileSize" : 162463, "content" : null }, "attachments" : [ { "id" : "e7de6dc9-6cc9-4106-9c7f-b4ec9231edc6", "name" : "nice_sample_picture.png", "type" : "image/png", "fileSize" : 366426, "content" : null }, ... ], "imported" : "NONE", "applicationSource" : { "applicationSourceCatalogValueId" : "e87d0c29-0feb-467f-b695-0931c6fb43b5", "applicationSourceText" : "LinkedIn" }, "applicationSourceOptions" : [ { "applicationSourceCatalogValueId" : "e87d0c29-0feb-467f-b695-0931c6fb43b5", "applicationSourceText" : "LinkedIn" }, ... ] } |
Example call with curl and user access token
Only some fields are requested
|
1 |
curl -i -H "Authorization: Bearer 31cb2exx-001e-4b59-babc-f0815tdad47d" -H "Content-Type: application/json" -X GET "https://api.softgarden.io/api/rest/v3/frontend/applications/70000006c-99b5-45g-arh-b59exxx4a46?fields=applicationId,firstname,lastname,email" |
Antwort:
|
1 2 3 4 5 6 7 |
{ "applicationId" : "70000006c-99b5-45g-arh-b59exxx4a46", "firstname" : "Joe", "lastname" : "Doe", "email" : "joe.doe@foo.bar", "imported" : "NONE" } |