SG Developers Data structures
ApplicantDataDTO
Used to create an applicant account.
|
1 2 3 4 5 6 7 8 9 10 11 12 |
{ "salutation": "0", // Yes, its a String. 0 = n/a, 1 = Mr., 2 = Mrs. "firstname": "Joe", "lastname": "Doe", "email": "joe.doe@foo.bar", "workEmail": "joe.doe@acme.com", // Has to be set when you want to create an internal applicant account "username": "joe.doe@acme.com", // We recommend using the e-mail, has to be set, may not be empty or longer than 250 characters, may only contain letters A-Z, a-z, numbers and @.-_+ "password": "supersecurepassword", "locale": "en", // ISO 639-1 locale tag "internal": true, // Flag if the applicant should be internal or not "dataPrivacyAccepted": true // You need to ask the applicant to accept the data privacy policy } |
ApplicationProfileDTO
Used to send application profiles to and request them from the API. To look up the possible catalog values for the fields respectively getting their clear text value depending on the selected language, have a look on these pages.
Requesting data:
|
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 93 |
{ "applicationId" : "dgdsb0-a0e8-4fsf4-b8e8-wgeg20dc503", "status" : "ACTIVE", // Can be DRAFT, ACTIVE, WITHDRAWN "applicationEditable" : false, // Application is only editable, if it is a draft. "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, // JobDbId "jobName" : "Some Test Job", "firstname" : "Joe", "lastname" : "Doe", "sex" : "1", // Equivalent to salutation 1 = male, 2 = female, 0 = n/a "academictitle" : "Prof. Dr.", // This is a resolved catalog value "email" : "joe.doe@foo.bar", "externalProfileUrl": "http://www.xing.com/users/bla", // Some profile like xing or linkedin "locale" : "en", // ISO 639-1 locale tag "street" : "1521 Randomstreet", "zip" : "01234", "city" : "Randomtown", "country" : "Germany", "nationality" : "German", // Resolved catalog value "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", // This is a resolved catalog value "title" : "Worker", "status" : "Publicly held corporation", // Status of the company, resolved catalog value "careerLevel" : "Student/Intern", // This is a resolved catalog value "companySize" : "0-10 employees", // This is a resolved catalog value "url" : "http://www.acme.com", "type" : "Full time employee", // This is a resolved catalog value "startDate" : "2012-03-31T22:00:00.000+0000", // value is only present when not null "endDate" : "2018-10-30T23:00:00.000+0000", // value is only present when not null "description" : "Imagine some job description here", "additional" : "And some more additional information" }, {...}, ... ], "educations" : [ { "startDate": "2001-10-30T23:00:00.000+0000", // only present if not null "endDate" : "2008-10-30T23:00:00.000+0000", // only present if not null "university" : "ACME University Texas", "field" : "Computer science", "degree" : "Bachelor", "specialization" : "Psychology" }, {...}, ... ], "languages" : [ { "locale" : "de", "skill" : "First language" // resolved catalog value }, { "locale" : "en", "skill" : "", // Skill not specified in this case }, ... ], "answers" : [ { "questionId" : 11019, "answer" : "I really like potatoes" }, { "questionId" : 11021, "answer" : "ja" // example for an answer to a catalog question }, ... ], "photo" : { // Specific profile image attachment "id" : "ed747f6a-b9d9-4835-9d1f-de90c2cb9d40", // Attachment ID "name" : "mypic.png", "type" : "image/png", "fileSize" : 431056, "content" : null // Content is only provided if you make a request to the specific attachment API endpoint }, "cv" : { // Specific cv attachment "id" : "d96cb50d-24a2-414b-9f03-f112dc746a78", // Attachment ID "name" : "myCV.pdf", "type" : "application/pdf", "fileSize" : 162463, "content" : null // Content is only provided if you make a request to the specific attachment API endpoint }, "attachments" : [ { // Additional attachments "id" : "e7de6dc9-6cc9-4106-9c7f-b4ec9231edc6", // Attachment ID "name" : "nice_sample_picture.png", "type" : "image/png", "fileSize" : 366426, "content" : null // Content is only provided if you make a request to the specific attachment API endpoint }, ... ], "imported" : "NONE" // Set when profile was imported from XING or Linkedin, "applicationSource" : { // only present if not null "id" : "e87d0c29-0feb-467f-b695-0931c6fb43b5", "value" : "LinkedIn" }, "applicationSourceOptions" : [ { // List of configured options for application source "id" : "e87d0c29-0feb-467f-b695-0931c6fb43b5", "value" : "LinkedIn" }, ... ] } |
Submitting data:
|
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 |
{ "firstname":"Joe", "lastname":"Doe", "sex":"1", // Equivalent to salutation 1 = male, 2 = female, 0 = n/a "academictitle":"Prof. Dr.", // Resolved catalog value "email":"joe.doe@foo.bar", "locale":"en", // ISO 639-1 language tag "street":"Randomstreet 101", "zip":"66113", "city":"Saarbrücken", "country":"Deutschland", // Resolved catalog value "nationality":"Deutsch", // Resolved catalog value "phone":"+49 17620590145", "dateofbirth":"1905-04-01T00:00:00.000+0000", // Format yyyy-MM-dd'T'HH:mm:ss.SSSZ "coverLetterText" : "This is some coverletter text", "region":"Saarland", "experiences":[ { "company":"Acme Inc.", "industry":"Agrarwirtschaft", // Resolved catalog value "title":"Mitarbeiter im Vertrieb", "status":"", // Not Used "careerLevel":"Berufseinsteiger", // Resolved catalog value "companySize":"1-10 Mitarbeiter", // Resolved catalog value "type":"", // Not used "startDate":"2012-04-01T12:00:00.000+0000", // Format yyyy-MM-dd'T'HH:mm:ss.SSSZ "endDate":"2018-11-01T12:00:00.000+0000", // Format yyyy-MM-dd'T'HH:mm:ss.SSSZ "description":"Some description text" } ], "educations":[ { "startDate": "2000-04-01T12:00:00.000+0000", // Format yyyy-MM-dd'T'HH:mm:ss.SSSZ "endDate":"2008-10-31T12:00:00.000+0000", // Format yyyy-MM-dd'T'HH:mm:ss.SSSZ "university":"ACME College", "field":"Maschinenbau", "degree":"Bachelor", "specialization":"Tiefenpsychologie" } ], "languages":[ { "locale":"de", "skill":"Muttersprache" // Resolved catalog value } ], "answers":[ { "questionId": 815, "answer":"Vielleicht" } ], "imported":"NONE", "applicationSource" : { "id" : "e87d0c29-0feb-467f-b695-0931c6fb43b5", "value" : "" // Not used, only id is relevant for setting the application source } } |
JobDTO
To look up the possible catalog values for the fields respectively getting their clear text value depending on the selected language, have a look on these pages.
|
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 |
{ "jobDbId" : 4711, // Identfier of you jobposting on a specific channel. Numeric. "externalPostingName" : "Your Testjob", "internalPostingName" : "Your Testjob", "applyOnlineLink" : "https://jobdb.softgarden.de/jobdb/public/jobposting/applyonline/click?jp=4711&ADP", "jobCategories" : [ "sam42_administration" ], // Categories your job was assigned to. Usually this is one value. Catalog value. "audiences" : [ "3a3b1f6e7f000002010ad492e7837dd6" ], // Target audience for your job. Usually this is one value. Catalog value. "employmentTypes" : [ "2" ], // The employment type of this job. Usually this is one value. Catalog value. "workTimes" : [ "799eb9d2c0bc4e7490fde05f847b331a" ], // The worktime definition of this job. Usually this is one value. Catalog value. "industries" : [ "2" ], // The industry of this job. Usually this is one value. Catalog value "workExperiences" : [ "12df74fc98fc48aba84b99927db3d82d" ], // The requested work experience of this job. Usually this is one value. Catalog value. "geo_lat" : "47.8532661", // Latitude information of this job's location "geo_long" : "13.9562437", // Longitude information of this job's location "geo_name" : "Tauentzienstraße 14, 10789 Berlin, Deutschland", // Display name of this job's location "geo_country" : "Deutschland", "geo_state" : "Berlin", "geo_city" : "Berlin", "geo_zip" : "12047", "geo_street" : "Tauentzienstraße 14", "jobAdText" : "<p>The HTML of the Jobad you've entered in the wizard</p>", // The jobposting ad test you've entered in the jobposting wizard. "jobStartDate" : 1540558789937, // Date of the first publishing of the jobposting as a timestamp in miliseconds. "jobEndDate" : 1671328894013, "postingLastUpdatedDate" : 1540558789937, // Date of the last update of the jobposting as a timestamp in miliseconds "job_owner_salutation" : "", // The following fields contain information about contact person for the job "job_owner_title" : "", "job_owner_firstname" : "Max", "job_owner_lastname" : "Mustermann", "job_owner_street" : "Musterstraße 1", "job_owner_city" : "Musterstadt", "job_owner_zip" : "123456", "job_owner_phone" : "01234567890", "job_owner_email" : "max@mustermann.de", "job_owner_avatarurl" : "https://app.staging.softgarden.io/assets/public/media/get/2aaf62b4-92c3-4758-adb3-21c3c3d259d6/1548756914270/profile.jpg", "job_owner_function" : "Geschäftsführer", "job_ad_url" : "https://short.sg/j/4711", // URL of the job ad "company_name" : "Musterfirma", // Name of the company that posted the job "company_id" : "6c588ddd-d926-46b9-81c1-4ae1dfd50c3b", // Public id of the company that posted the job "project_number" : "76470", // Project number of the job "internal_reference_id" : "", // Internal reference ID of the job "locale" : "en", // Locale of the job "layoutId" : "c9cde59b631646e48ed4f457d714d078", "layoutName" : "Muster Layout", "keywords" : "", // Keywords for the job "salary" : { "min_value" : "40000.0", "max_value" : "50000.0", "currency" : "EUR", "period" : "year" }, "customApplicationProviders" : [ // field is only available if custom provider is configured { "providerName" : "PITCHYOU", "active" : true, // false if not used "url" : "https://{configuredDomain}.pitchyou.de/go/76470?jobId=4711" // emptyString "" if not used } ] } |