Exploring the Graviti api
Get api v1 organizations chapters by organizations id
Get a list of the chapters within the organization by using organization id
GET/api/v1/Organizations/{id}/chapters
Get a list of the chapters within the organization, by organization ID
REQUEST INFORMATION
Parameters
|
Name |
Type |
Additional information |
|
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",
"name": "string",
"organizationId": "string",
"managedByFirstName": "string",
"managedByLastName": "string",
"managedByMiddleName": "string",
"contactPersonMiddleName": "string",
"contactNumber": "string",
"contactEmail": "string",
"city": "string",
"region": "string",
"countryId": "string",
"managingPersonTitleId": 0,
"created": "2023-12-08T09:08:31.422Z",
"updated": "2023-12-08T09:08:31.422Z",
"user": "string",
"contactPersonFirstName": "string",
"contactPersonLastName": "string",
"organization": "string",
"country": "string",
"managingTitle": "string",
"members": 0
}
],
"totalPages": 0,
"hasPreviousPage": true,
"hasNextPage": true,
"nextPageNumber": 0,
"previousPageNumber": 0
}|
Field |
Type |
Description |
|
Id |
String |
Internal id to identify the organization chapter |
|
Name |
String |
Name of the organization chapter |
|
Organization id |
String |
Organization id number |
|
managed by first name |
String |
Name of the person managing the organization chapter |
|
Managed by last name |
String |
Last name of the person managing the organization chapter |
|
Managed by middle name |
String |
Middle name of the person managing the organization chapter |
|
Contact personal middle name |
String |
Middle name of the contact person managing the organization chapter |
|
Contact number |
String |
Contact number of the person managing the organization chapter |
|
Contact email |
String |
Contact email of the person managing the organization chapter |
|
City |
String |
City where the organization chapter is located |
|
Region |
String |
Region where the organization chapter is located |
|
Country id |
String |
Country id where the organization chapter is located |
|
Managing person title id |
Integer |
Managing person title id |
|
Created |
Datetime |
Datetime when the chapter was created in the system |
|
Updated |
Datetime |
Datetime when the chapter was last updated. |
|
User |
String |
Name of the user |
|
Contact person first name |
String |
Contact person first name |
|
Contact person last name |
String |
Contact person last name |
|
Organization |
String |
Name of the organization |
|
Country |
String |
Name of the country |
|
Managing title |
String |
Managing title |
|
Members |
Integer |
Members within the chapter |
Related topics