Exploring the Graviti api
Get api v1 members employments by id
Get employments records of members using the employments record id that is available on the administration portal
GET/api/v1/Members/employments/{id}
Get a record of a member’s employment record by employment record ID that is available on the administration portal
REQUEST INFORMATION
Parameters
|
Name |
Type |
Additional information |
|
Id |
String |
Required |
|
x-api-key |
Header |
Required |
|
x-api-secret |
Header |
Required |
RESPONSE INFORMATION
- Code: 200
- Description: successful
- Media type: text/plain; application/json; text/json
- Links: no links
Example value|Schema
{
"id": "string",
"employerName": "string",
"employerTypeId": "string",
"position": "string",
"startDate": "2023-12-08T08:00:57.551Z",
"endDate": "2023-12-08T08:00:57.551Z",
"contactPerson": "string",
"memberOrganizationId": "string",
"created": "2023-12-08T08:00:57.551Z",
"updated": "2023-12-08T08:00:57.551Z",
"user": "string",
"employerType": "string"
}
|
Field |
Type |
Description |
|
Id |
String |
Member employment record id to identify the employment record |
|
Employer name |
String |
Name of the employer |
|
Employer type id |
String |
Employer type id to identify the employer type |
|
Position |
String |
Position held by the employer |
|
Start date |
Datetime |
Datetime when a member’s employment period started |
|
End date |
Datetime |
Datetime when a member’s employment ended |
|
Contact person |
String |
Contact person |
|
Member organization id |
String |
Member organization id to identify the member |
|
Created |
Datetime |
Datetime when the Member employment record was created in the system |
|
Updated |
Datetime |
Datetime when the Member employment record was last updated. |
|
User |
String |
Name of the user |
|
Employer type |
String |
Employer type |
Related topics