Zentry.Employers.Api v1.0

Base URLs:

Authentication

API Key (API_KEY)
- Parameter Name: Api-Key Authentication, in: header.

Admin

AddUserRole

POST /Admin/role

{
  "contact": {
    "name": "John Smith",
    "email": "johnsmith@zentrypass.com",
    "phone": "5555555555"
  },
  "role": "EmployeeAdmin",
  "employerId": "686d3163ee1ffbbdb38b6a74"
}

Parameters

Name	In	Type	Required	Description
body	body	AddUserRoleRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

RemoveUserRole

DELETE /Admin/role

{
  "email": "johnsmit@zentrypass.com",
  "role": "EmployeeAdmin",
  "employerId": "686d3163ee1ffbbdb38b6a74"
}

Parameters

Name	In	Type	Required	Description
body	body	RemoveUserRoleRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

GetUsersWithRole

GET /Admin/{tenantId}/role/{role}

Parameters

Name	In	Type	Required	Description
getUsersWithRoleRequest	header	GetUsersWithRoleRequest	false	none
tenantId	path	string	true	none
role	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	UserIPagedResponse

Application

CreateApplication

POST /Application/create

{
  "name": "string",
  "contact": {
    "name": "John Smith",
    "email": "johnsmith@zentrypass.com",
    "phone": "5555555555"
  },
  "description": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

GetApplications

POST /Application

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "ownerIds": [
    "string"
  ],
  "statuses": [
    "Inquiry"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetApplicationsRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	ApplicationIPagedResponse

UpdateApplication

PUT /Application/{id}

{
  "name": "string",
  "description": "string",
  "address": {
    "line1": "11 N 4th St",
    "line2": "APT 101",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  }
}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none
body	body	UpdateApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

ApproveApplicationInquiry

PUT /Application/approve-inquiry

{
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ApproveApplicationInquiryRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

SubmitApplication

PUT /Application/submit

{
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	SubmitApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

DenyApplication

PUT /Application/deny

{
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	DenyApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

ApproveApplication

PUT /Application/approve

{
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ApproveApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Employer

SendApplicationReminder

POST /Application/remind

{
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	SendApplicationReminderRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

Employee

CreateEmployee

POST /Employee/create

{
  "contact": {
    "name": "John Smith",
    "email": "johnsmith@zentrypass.com",
    "phone": "5555555555"
  },
  "employerId": "686d3163ee1ffbbdb38b6a74",
  "employerUserId": "[AN ID IN YOUR SYSTEM]"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateEmployeeRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Employee

GetEmployees

POST /Employee

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "userIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "employerUserIds": [
    "AN ID IN YOUR SYSTEM"
  ],
  "statuses": [
    "Active"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetEmployeesRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	EmployeeIPagedResponse

UpdateEmployeeStatus

PUT /Employee/status

{
  "employerId": "514d3163ee1ffbbdb38b6c51",
  "userId": "686d3163ee1ffbbdb38b6a74",
  "status": "Active"
}

Parameters

Name	In	Type	Required	Description
body	body	UpdateEmployeeStatusRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Employee

EmployeeInquiry

CreateEmployeeInquiry

POST /EmployeeInquiry/create

{
  "companyName": "string",
  "employeeName": "string",
  "email": "string",
  "title": "string",
  "referralContact": {
    "name": "string",
    "email": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	CreateEmployeeInquiryRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	EmployeeInquiry

Employer

GetEmployers

POST /Employer

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetEmployersRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	EmployerIPagedResponse

Schemas

AddUserRoleRequest

{
  "contact": {
    "name": "John Smith",
    "email": "johnsmith@zentrypass.com",
    "phone": "5555555555"
  },
  "role": "EmployeeAdmin",
  "employerId": "686d3163ee1ffbbdb38b6a74"
}

Name	Type	Required	Restrictions	Description
contact	Contact	true	none	Information about the employee
role	string	true	none	The name of the role to add
employerId	string	true	none	Zentry Pass Employer Id

Address

{
  "line1": "11 N 4th St",
  "line2": "APT 101",
  "state": "Missouri",
  "city": "St. Louis",
  "zipCode": "63102"
}

Name	Type	Required	Restrictions	Description
line1	string¦null	false	none	The main address
line2	string¦null	false	none	The secondary address
state	string¦null	false	none	The state
city	string¦null	false	none	The city
zipCode	string¦null	false	none	The zip code

Application

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "status": "Inquiry",
  "name": "string",
  "contact": {
    "name": "John Smith",
    "email": "johnsmith@zentrypass.com",
    "phone": "5555555555"
  },
  "description": "string",
  "address": {
    "line1": "11 N 4th St",
    "line2": "APT 101",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  },
  "ownerId": "string",
  "ownerEmail": "string",
  "employerId": "string"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
status	ApplicationStatus	true	none	none
name	string	true	none	none
contact	Contact	true	none	Information about the employee
description	string	true	none	none
address	Address	false	none	none
ownerId	string¦null	false	none	none
ownerEmail	string¦null	false	none	none
employerId	string¦null	false	none	none

ApplicationIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "status": "Inquiry",
      "name": "string",
      "contact": {
        "name": "John Smith",
        "email": "johnsmith@zentrypass.com",
        "phone": "5555555555"
      },
      "description": "string",
      "address": {
        "line1": "11 N 4th St",
        "line2": "APT 101",
        "state": "Missouri",
        "city": "St. Louis",
        "zipCode": "63102"
      },
      "ownerId": "string",
      "ownerEmail": "string",
      "employerId": "string"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[Application]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

ApplicationQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "ownerIds": [
    "string"
  ],
  "statuses": [
    "Inquiry"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
ids	[string]¦null	false	none	none
ownerIds	[string]¦null	false	none	none
statuses	[ApplicationStatus]¦null	false	none	none

ApplicationStatus

"Inquiry"

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Inquiry
anonymous	Pending
anonymous	Submitted
anonymous	Approved
anonymous	Denied

ApproveApplicationInquiryRequest

{
  "applicationId": "string"
}

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	none

ApproveApplicationRequest

{
  "applicationId": "string"
}

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	none

Contact

{
  "name": "John Smith",
  "email": "johnsmith@zentrypass.com",
  "phone": "5555555555"
}

Information about the employee

Name	Type	Required	Restrictions	Description
name	string	true	none	Should be the First and Last name
email	string	true	none	The employee's email
phone	string¦null	false	none	The employee's phone number. Optional.

CreateApplicationRequest

{
  "name": "string",
  "contact": {
    "name": "John Smith",
    "email": "johnsmith@zentrypass.com",
    "phone": "5555555555"
  },
  "description": "string"
}

Name	Type	Required	Restrictions	Description
name	string	true	none	none
contact	Contact	true	none	Information about the employee
description	string	true	none	none

CreateEmployeeInquiryRequest

{
  "companyName": "string",
  "employeeName": "string",
  "email": "string",
  "title": "string",
  "referralContact": {
    "name": "string",
    "email": "string"
  }
}

Name	Type	Required	Restrictions	Description
companyName	string	true	none	none
employeeName	string	true	none	none
email	string	true	none	none
title	string	true	none	none
referralContact	Referral	false	none	none

CreateEmployeeRequest

{
  "contact": {
    "name": "John Smith",
    "email": "johnsmith@zentrypass.com",
    "phone": "5555555555"
  },
  "employerId": "686d3163ee1ffbbdb38b6a74",
  "employerUserId": "[AN ID IN YOUR SYSTEM]"
}

Name	Type	Required	Restrictions	Description
contact	Contact	true	none	Information about the employee
employerId	string	true	none	Zentry Pass Employer Identifier
employerUserId	string¦null	false	none	This is an identifier from the Employer's source system. Used to identify employees more easily. Default value is the provided email.

DenyApplicationRequest

{
  "applicationId": "string"
}

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	none

Employee

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "employerId": "514d3163ee1ffbbdb38b6c51",
  "userId": "686d3163ee1ffbbdb38b6a74",
  "employerUserId": "johnsmith@zentrypass.com",
  "status": "Active",
  "statusUpdatedDate": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
employerId	string	true	none	A Zentry Pass Employer Identifier.
userId	string	true	none	Zentry Pass User Identifier.
employerUserId	string	true	none	This is an identifier from the Employer's source system. Used to identify employees more easily. Default value is the employee's email.
status	EmployeeStatus	true	none	none
statusUpdatedDate	string(date-time)	true	none	The last time the employee's status was updated

EmployeeIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "employerId": "514d3163ee1ffbbdb38b6c51",
      "userId": "686d3163ee1ffbbdb38b6a74",
      "employerUserId": "johnsmith@zentrypass.com",
      "status": "Active",
      "statusUpdatedDate": "2019-08-24T14:15:22Z"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[Employee]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

EmployeeInquiry

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "companyName": "string",
  "employeeName": "string",
  "email": "string",
  "title": "string",
  "referralContact": {
    "name": "string",
    "email": "string"
  }
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
companyName	string	true	none	none
employeeName	string	true	none	none
email	string	true	none	none
title	string	true	none	none
referralContact	Referral	false	none	none

EmployeeQuery

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "userIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "employerUserIds": [
    "AN ID IN YOUR SYSTEM"
  ],
  "statuses": [
    "Active"
  ]
}

Get employees

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
employerIds	[string]¦null	false	none	A list of Zentry Pass Employer Identifiers
userIds	[string]¦null	false	none	A list of Zentry Pass User Identifiers
employerUserIds	[string]¦null	false	none	These are identifiers from the Employer's source system
statuses	[EmployeeStatus]¦null	false	none	A list of statuses

EmployeeStatus

"Active"

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Active
anonymous	Inactive

Employer

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "name": "Zentry Pass",
  "address": {
    "line1": "11 N 4th St",
    "line2": "APT 101",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  },
  "email": "employer@zentrypass.com"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
name	string	true	none	The name of this employer
address	Address	true	none	none
email	string	true	none	The email used for communicating with this employer

EmployerIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "name": "Zentry Pass",
      "address": {
        "line1": "11 N 4th St",
        "line2": "APT 101",
        "state": "Missouri",
        "city": "St. Louis",
        "zipCode": "63102"
      },
      "email": "employer@zentrypass.com"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[Employer]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

EmployerQuery

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
employerIds	[string]¦null	false	none	none

GetApplicationsRequest

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "ownerIds": [
    "string"
  ],
  "statuses": [
    "Inquiry"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	ApplicationQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetEmployeesRequest

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "userIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "employerUserIds": [
    "AN ID IN YOUR SYSTEM"
  ],
  "statuses": [
    "Active"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	EmployeeQuery	false	none	Get employees

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetEmployersRequest

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	EmployerQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetUsersWithRoleRequest

{
  "role": "string",
  "tenantId": "string"
}

Name	Type	Required	Restrictions	Description
role	string	true	none	none
tenantId	string	true	none	none

IPagedRequest

{
  "offset": 0,
  "limit": 25
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	read-only	How far to skip into a collection
limit	integer(int32)	true	read-only	How many results to return

Referral

{
  "name": "string",
  "email": "string"
}

Name	Type	Required	Restrictions	Description
name	string	true	none	none
email	string	true	none	none

RemoveUserRoleRequest

{
  "email": "johnsmit@zentrypass.com",
  "role": "EmployeeAdmin",
  "employerId": "686d3163ee1ffbbdb38b6a74"
}

Name	Type	Required	Restrictions	Description
email	string	true	none	The email of the admin
role	string	true	none	The name of the role to remove
employerId	string	true	none	Zentry Pass Employer Id

SendApplicationReminderRequest

{
  "applicationId": "string"
}

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	none

SubmitApplicationRequest

{
  "applicationId": "string"
}

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	none

UpdateApplicationRequest

{
  "name": "string",
  "description": "string",
  "address": {
    "line1": "11 N 4th St",
    "line2": "APT 101",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  }
}

Name	Type	Required	Restrictions	Description
name	string	true	none	none
description	string	true	none	none
address	Address	true	none	none

UpdateEmployeeStatusRequest

{
  "employerId": "514d3163ee1ffbbdb38b6c51",
  "userId": "686d3163ee1ffbbdb38b6a74",
  "status": "Active"
}

Name	Type	Required	Restrictions	Description
employerId	string	true	none	Zentry Pass Employer Identifier.
userId	string	true	none	Zentry Pass User Identifier.
status	EmployeeStatus	true	none	none

User

{
  "id": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "pictureUrl": "string"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	none
email	string	true	none	none
firstName	string	true	none	none
lastName	string	true	none	none
pictureUrl	string¦null	false	none	none

UserIPagedResponse

{
  "data": [
    {
      "id": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "pictureUrl": "string"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[User]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

Zentry.Employers.Api v1.0

Admin​

AddUserRole​

Parameters

Responses

RemoveUserRole​

Parameters

Responses

GetUsersWithRole​

Parameters

Responses

Application​

CreateApplication​

Parameters

Responses

GetApplications​

Parameters

Responses

UpdateApplication​

Parameters

Responses

ApproveApplicationInquiry​

Parameters

Responses

SubmitApplication​

Parameters

Responses

DenyApplication​

Parameters

Responses

ApproveApplication​

Parameters

Responses

SendApplicationReminder​

Parameters

Responses

Employee​

CreateEmployee​

Parameters

Responses

GetEmployees​

Parameters

Responses

UpdateEmployeeStatus​

Parameters

Responses

EmployeeInquiry​

CreateEmployeeInquiry​

Parameters

Responses

Employer​

GetEmployers​

Parameters

Responses

Schemas​

AddUserRoleRequest​

Address​

Application​

ApplicationIPagedResponse​

ApplicationQuery​

ApplicationStatus​

Enumerated Values​

ApproveApplicationInquiryRequest​

ApproveApplicationRequest​

Contact​

CreateApplicationRequest​

CreateEmployeeInquiryRequest​

CreateEmployeeRequest​

DenyApplicationRequest​

Employee​

EmployeeIPagedResponse​

EmployeeInquiry​

EmployeeQuery​

EmployeeStatus​

Enumerated Values​

Employer​

EmployerIPagedResponse​

EmployerQuery​

GetApplicationsRequest​

GetEmployeesRequest​

Admin

AddUserRole

RemoveUserRole

GetUsersWithRole

Application

CreateApplication

GetApplications

UpdateApplication

ApproveApplicationInquiry

SubmitApplication

DenyApplication

ApproveApplication

SendApplicationReminder

Employee

CreateEmployee

GetEmployees

UpdateEmployeeStatus

EmployeeInquiry

CreateEmployeeInquiry

Employer

GetEmployers

Schemas

AddUserRoleRequest

Address

Application

ApplicationIPagedResponse

ApplicationQuery

ApplicationStatus

Enumerated Values

ApproveApplicationInquiryRequest

ApproveApplicationRequest

Contact

CreateApplicationRequest

CreateEmployeeInquiryRequest

CreateEmployeeRequest

DenyApplicationRequest

Employee

EmployeeIPagedResponse

EmployeeInquiry

EmployeeQuery

EmployeeStatus

Enumerated Values

Employer

EmployerIPagedResponse

EmployerQuery

GetApplicationsRequest

GetEmployeesRequest

GetEmployersRequest

GetUsersWithRoleRequest

IPagedRequest

Referral

RemoveUserRoleRequest

SendApplicationReminderRequest

SubmitApplicationRequest

UpdateApplicationRequest

UpdateEmployeeStatusRequest

User

UserIPagedResponse