POST v1/entities({CompanyId})/lockReasons

Post a Lock Reason for a Company

Information:

Use this request to define a reason why a user might be locked.

The names and descriptions for lock reasons are completely configurable to accommodate your company’s business practices.

The system generates numeric identifiers in the order in which the reason is defined.

Base URL:

https://api.covasoft.net/usermanager

Example of a call would be:

https://api.covasoft.net/usermanager/v1/entities({CompanyId})/lockReasons

Example of the Body of the Call:

{ "Name": "FMLA", "Description": "Your account has been locked due to being on FMLA. Please contact your supervisor with any questions." }

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CompanyId

The unique Company Id that was provided in your onboarding pacakage

 integer

Required

Body Parameters

The Lock Reason Name and Description - see example above

PostALockReasonPost
NameDescriptionTypeAdditional information
Name

string

None.
Description

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "Description": "sample string 2"
}

Response Information

Resource Description

Created Lock Reason with Id

PostALockReasonReturn
NameDescriptionTypeAdditional information
Id

integer

None.
Name

string

None.
Description

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Name": "sample string 2",
  "Description": "sample string 3"
}