Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Provides access to the logged in User Account related data and Workbench User data.
Endpoints
The resources available in this module.
AccountApi
Provides access to logged in user info.
/api/AccountApi | |||||
|---|---|---|---|---|---|
Method | Description | Performed As | Request Query | Request Body | Response |
GET | Retrieve current logged in user | Logged in User | - | - | |
PeopleListApi
Provides API access to the “People“ (#/General/PersonList.aspx) Web Workbench screen.
/api/PeopleListApi | |||||
|---|---|---|---|---|---|
Method | Description | Performed As | Request Query | Request Body | Response |
POST | Retrieve a filtered list of people | Logged in User | - | GridRequestParametersApi | GridResult<PersonLine> |
PeopleDetailApi
Provides API access to the “People“ (#/General/PersonList.aspx) dialog Web Workbench screen.
/api/PeopleDetailApi | |||||
|---|---|---|---|---|---|
Method | Description | Performed As | Request Query | Request Body | Response |
GET | Retrieve a specific Person | Admin User | - | ||
POST | Update a Person | Admin User | - | ||
Models
The definitions of models specific to endpoints in this module.
AccountApiModel
Field | Type | Description |
|---|---|---|
PersonID | Integer | The unique PersonID of the Logged in User |
FullName | String | The full name of the Logged in User |
FinCoCode | String | The Financial Company Code the Logged in User belongs to |
PersonKey
Field | Type | Description |
|---|---|---|
PersonID | Integer | The unique PersonID of the Logged in UserPerson |
PersonLine
Field | Type | CellData | Description |
|---|---|---|---|
Key | The unique Key for the line | ||
PersonId | Integer | PersonIdValue.CellValue | The unique ID of the Person |
DisplayName | String | ||
Surname | String | Surname.CellValue | |
FirstName | String | FirstNameValue.CellValue | |
Company | String | CompanyValue.CellValue | The name of the Company this Person belongs to |
CompanyId | Integer | CompanyValue.CellId | The ID of the Company this Person belongs to |
Role | String | RoleValue.CellValue | the Purchase Requisition Role of this Person |
JobTitle | String | JobTitleValue.CellValue | |
EmailAddress | String | EmailAddressValue.CellValue | |
MobilePhone | String | MobilePhoneValue.CellValue | |
BusinessPhone | String | BusinessPhone.CellValue | |
IsEmployee | Boolean | ||
IsActive | Boolean | ||
IsInactive | Boolean | ||
IsBillingContact | Boolean | Billing Contact of the Company | |
IsSiteContact | Boolean | Site Contact of the Company | |
IsCommercialContact | Boolean | Commercial Contact of the Company | |
EmployeeNo | String | ||
Group1 | String | The Attribute Group of the first Category filter | |
Group2 | String | The Attribute Group of the second Category filter | |
Group3 | String | The Attribute Group of the third Category filter | |
UpdatedDate | DateTime | The DateTime this record was last updated | |
Delete | CellData |
PeopleApiModel
Field | Type | Description |
|---|---|---|
PersonID | Integer | The unique PersonID of the Logged in User |
FullName | String | The full name of the Logged in User |
FinCoCode | String | The Financial Company Code the Logged in User belongs to |
On this page
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|