Employer

The Employer feature allows the user to view, add, modify or delete employers for the practice.

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Endpoints

Create new employee record
POST
/v1/{practiceid}/employers

Creates a record for an employer

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
Content-Type string Content type of the payload

❙ Request Body

Expand all
address string The address of the employer.
city string The city of the employer.
countryid integer The country ID of the employer.
fax string The fax number of the employer.
name string The name of the employer.
phone string The phone number of the employer.
state string The state of the employer.
zip string The zip code of the employer.

Output Parameters

Expand all
employerid integer The ID of the employer created.
Example Code
Delete an employee record
DELETE
/v1/{practiceid}/employers/{employerid}

Deletes the record of a specified employer

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

❙ required

employerid integer employerid
practiceid integer practiceid

Output Parameters

Expand all
success string Returns true/false if the operation was successful.
Example Code
Update specific employee record
PUT
/v1/{practiceid}/employers/{employerid}

Modifies information of a specific employer

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

❙ required

employerid integer employerid
practiceid integer practiceid
Content-Type string Content type of the payload

❙ Request Body

Expand all
address string The address of the employer.
city string The city of the employer.
countryid integer The country ID of the employer.
fax string The fax number of the employer.
name string The name of the employer.
phone string The phone number of the employer.
state string The state of the employer.
zip string The zip code of the employer.

Output Parameters

Expand all
success string Returns true/false if the operation was successful.
Example Code
Undelete specific employee record
PUT
/v1/{practiceid}/employers/{employerid}/undelete

Re-active a deleted the record of a specified employer

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

❙ required

employerid integer employerid
practiceid integer practiceid
Content-Type string Content type of the payload

Output Parameters

Expand all
success string Returns true/false if the operation was successful.
Example Code