Create Employee Credential
POST {{base_url}}/employee/:Employee/credentials
Use this endpoint to create a new credential for each professional achievement of an employee in the Employees hub.
Include all other fields with at least the default values in the request body by checking the employee metadata against your instance of Vantagepoint. The metadata will have the most up to date details for your instance of Vantagepoint when calling the API using your authenticated environment.
Response
A successful call status of 201 returns the JSON representation for the newly created credential for the specified employee.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
requiredFieldValidation | string | Optional. |
The flag that indicates whether or not the validation for required screen designer fields is needed.
Use "N" if you want to bypass the validation. Otherwise, the default is "Y," which enforces the validation.
NOTE: This does not apply to required system fields. |
| startWorkflow | string | | Optional.
The flag that indicates whether or not the trigger for a workflow is initiated.
Use "N" if you want to bypass the trigger. Otherwise, the default is "Y," which initiates the workflow. |
Request Body
[{"name"=>"Seq", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"Employee", "value"=>"Employee", "datatype"=>"string"}, {"name"=>"Registration", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"RegistrationType", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"DateEarned", "value"=>"Date", "datatype"=>"string"}, {"name"=>"StateRegistered", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"CountryRegistered", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"RegistrationNo", "value"=>"String", "datatype"=>"string"}, {"name"=>"DateExpires", "value"=>"Date", "datatype"=>"string"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | Required. |
The type of content supported by the API endpoint. |
| Authorization | string | | Required.
The type of authorization supported by the API endpoint. |
RESPONSES
status: Created
[{"RecordID":"RECORDID92654EAFAE385E3B81004CB4","Seq":8,"Employee":"EMPLOYEE1234567889","Registration":"AIA","RegistrationDescription":"American Institute of Architects","RegistrationType":"","TypeDescription":"","DateEarned":"1988-05-16T00:00:00.000","StateRegistered":"MA","StateRegisteredDescription":"Massachusetts","CountryRegistered":"US","CountryRegisteredDescription":"United States","RegistrationNo":"465464.54","DateExpires":"2018-07-06T00:00:00.000","LastRenewed":"","IncludeInProposal":"Y","StatusDescription":"Active"}]