Schema Dictionary

The following list shows the supported fields in the SDEP schema and their corresponding description

Interactive Schema

We use Graphql for our API design, as such, you can view our live schema docs directly from Apollo playground. Just open the playground and add the SDEP staging URL.

Data Fields and Types Comment

User

User can refer to job Applicant, Employer or Admin

• id: ID UNIQ; Each user must have a unique identifier

• firstName: String user first name

• lastName: String user last name

• avatarUrl: String url to user avatar

• email: String user email

• companyName: String user company of work

• createdAt: Date

• updatedAt: Date

• verified: Boolean if the user account is verified or not

• role: Role enum which could be applicant, employer, admin

• plan: Plan enum which could be free, basic or pro

• country: String User country

Org

Org are the different organisations that an employer can belong to

• id: ID UNIQ; Each org must have a unique identifier

• orgName: String! Organisation name

• address: String! Organisation address

• orgWebsite: String! Organisation website

• createdAt: Date date created on the platform

• updatedAt: Date date updated on the platform

Company

Employer's Company details. i.e The company for which the employee works.

• id: ID UNIQ; Each company must have a unique identifier

• companyName: String! The name of the company

• officeLogoUrl: String The URL to the office logo saved in a storage

• officePhoneNumber: String The company phone details

• mobilePhoneNumber: String The mobile phone details of the company

• jobDescription: String! The Employer's job description

• industry: Industry! The industry in which the company is categorised

• location: String! The address of the company

• recruiterDetails: RecruiterDetails! The company's recruiter details

RecruiterDetails

The company recruiter details

• id: ID Unique id for each recruiter details

• firstName: String The recruiter's first name

• lastName: String The recruiter's last name

• phoneNumber: String Recruiter phone number

• email: String Recruiter email address

• jobTitle: String Recruiter job title

DashboardDeatils

This entity contains all the data needed to be in the analytics dashboard of the employer account

• numberOfJobListing: Int Total number of jobs listed by the employer

• numberOfApplication: Int Total number of applications submitted to the employer

• numberOfAccepted: Int Total number of accepted jobs by employer

• numberOfRejected: Int Total number of rejected jobs employer

• jobListings: Job List of all the job details listed by the employer

• allApplications: Application List of all the applications made to the employer

• pendingApplications: Application List of all the applications pending for the employer's review

• acceptedApplication: Application List of all the accepted applications made to the employer

• rejectedApplication: Application List of all the rejected applications made to the employer

Job

The job entity contains all the necessary details that make up the job.

• id: ID Unique id for each job

• jobTitle: String! Job title

• jobDescription: String! Job description

• workMode: enum [Remote, Hybrid, InPerson] The mode of working

• skillRequirement: String! The list of required skills

• experienceLevel: String! A minimum level of experience requirement

• certificates: String List of required certificates

• acceptBackgroundChecks: String List of acceptable background criteria

• rejectBackgroundChecks: String List of rejectable background criteria

• requireDocumentUrl: String List of required documents to be submitted

• deadline: Date! : Job application deadline

• location: String! Job location

• minCompensation: String minimum compensation for the job

• maxCompensation: String maximum compensation for the job

• publicizeSalary: Boolean shows compensations for the job listing or not

• Status: enum[Active, Achieve] To categorize the job between active and archive

Application

This entity constitutes the job application made by an applicant to a particular job. This is accessible by the applicant and also the employer.

• id: ID Unique id of each application

• applicant: User(Applicant) The applicant details

• job: Job The job details

• status: ApplicationStatus [pending, accepted, rejected, interview, withdrawn]

• note: String Recruiter's note on the application

• meetingScheduleDate: Date Meeting schedule between applicant and employer

• meetingScheduleTime: TimeObject Meeting schedule between applicant and employer