Job Posting API Specification

Overview

The Job Posting API provides access to the Gnosis Job Posting functionality for the OrgAdmin role (organizations posting jobs) and GnosisPerson role (person seeking job information). 

API Endpoint Documentation

The API documentation and interactive test options are available in a Swagger Explorer implementation.  This provides the option to show sample data structures and make calls to each endpoint.  To view the sample data and parameter specifications for each endpoint, click on the 'Show Samples' link at the top right of the page then clicking on each of the following headings reveals its content:

• BODY SAMPLE: Provides a JSON formatted sample structure of the body.  
• BODY SCHEMA: Provides a definition of each of the parameters/fields used in the body.
• RESPONSE SAMPLE: Provides sample JSON for the expected response.
• RESPONSE SCHEMA: Provides a definition of each of the fields in the response.

The API endpoint documentation is located on the Gnosis portal site as follows: (Note, there are many undocumented endpoints in the Gnosis API set that show up in the Swagger Explorer.  The endpoints below are the only ones needed to manage job posting data)

• Authentication (JWTAuth)
  Handles authentication by requesting an authentication token that then must be used for all API operations for the currently logged in user.
  
  • https://waw.gnosishosting.net/connect4/apidoc/#!/JWTAuth/JWTAuth_GetToken 
  • https://waw.gnosishosting.net/connect4/apidoc/#!/JWTAuth/JWTAuth_invalidateToken
  • https://waw.gnosishosting.net/connect4/apidoc/#!/JWTAuth/JWTAuth_isTokenValid 
     
• Job Posting Admin (JobPostingAdmin)
  Handles List, Update, Add, Delete functions for administrative management of job listings by the posting employer
  
  • https://waw.gnosishosting.net/connect4/apidoc/#!/JobPostingAdmin/JobPostingAdmin_listJobs 
  • https://waw.gnosishosting.net/connect4/apidoc/#!/JobPostingAdmin/JobPostingAdmin_addJob
  • https://waw.gnosishosting.net/connect4/apidoc/#!/JobPostingAdmin/JobPostingAdmin_updateJob 
  • Admin_getJob - This endpoint will be posted on 9/24/2020
     
• Job Posting Attribute List (JobPostingAttributeAdmin)
  Returns data on all of the optional job posting attributes that can be used in a job posting by an OrgAdmin.
  
  • This endpoint will be posted on 9/24/2020
     
• Admin User's Organization Info
  Returns organization name and address information for the currently logged in OrgAdmin
  
  • https://waw.gnosishosting.net/connect4/apidoc/#!/Organization/Organization_getMyOrgInfo 
     
• Job List Options Reference Data
  Returns a JSON structure of all list options for 'select from list' fields in the Job Posting schema (Sectors, Classifications, ContractTypes, WorkPeriodTypes)
  
  • https://waw.gnosishosting.net/connect4/apidoc/#!/ReferenceData/ReferenceData_jobAdminRefData 
     

Other EndPoints Not Yet Published

The following endpoints will be published over the next few days

ApplicationAdmin

/ listApplications (JPID int, pagingSize int, pageNumber int)

/ getApplication (APID int)

/ deleteApplication (APID int)

/ processApplication(APID int, newStatus [Pending, Actioned, Rejected, Flagged], adviseApplicant bit, notes varchar(max))

 

JobSearch

/ getJob (JPID int)

/ listJobs (pagingSize int, pageNumber int, favorites bit, applied bit, matched bit, showHidden bit)

/ searchJobs (pagingSize int, pageNumber int, [SearchParamAry])

/ setJobAsFavorite(JPID int)

/ clearJob(JPID int) {sets hide if it was a match/applied}

/ applyJob(JPID int, Cover varChar(max))