Exploring the Graviti api
Get api v1 members employments by members id
Get member employment records by using member id that is available on the administration portal
GET/api/v1/Members/{id}/employments
Get a list of the employment records of a member, by member record ID.
REQUEST INFORMATION
Parameters
Name |
Type |
Additional information |
Employment Type Id |
Integer |
|
Key |
String |
|
Entity Id |
String |
|
Page Size |
Integer |
|
Page |
Integer |
|
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
{
"totalItems": 0,
"pageNumber": 0,
"pageSize": 0,
"data": [
{
"id": "string",
"employerName": "string",
"employerTypeId": "string",
"position": "string",
"startDate": "2023-12-08T08:23:27.743Z",
"endDate": "2023-12-08T08:23:27.743Z",
"contactPerson": "string",
"memberOrganizationId": "string",
"created": "2023-12-08T08:23:27.743Z",
"updated": "2023-12-08T08:23:27.743Z",
"user": "string",
"employerType": "string"
}
],
"totalPages": 0,
"hasPreviousPage": true,
"hasNextPage": true,
"nextPageNumber": 0,
"previousPageNumber": 0
}
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