Overview

Provides access to 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 the current logged in user	Logged in User	-	-	AccountApiModel

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	PersonKey	-	PeopleApiModel
POST	Update a Person	Admin User	-	PeopleApiModel	PeopleApiModel

Models

The definitions of models specific to endpoints in this module.

AccountApiModel

Field	Type	Description
PersonID	Integer	The unique Person ID of the Logged in User
FullName	String	The Full Name of the Logged in User
FinCoCode	String	The Code of the Financial Company the Logged in User belongs to

PersonKey

Field	Type	Description
PersonID	Integer	The unique Person ID of the Person

PersonLine

Field	Type	CellData	Description
Key	PersonKey		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 Attribute Category filter
Group2	String		The Attribute Group of the second Attribute Category filter
Group3	String		The Attribute Group of the third Attribute Category filter
UpdatedDate	DateTime		The Date this record was last updated
Delete	CellData

PeopleApiModel

Field	Type	Description
Key	PersonKey	The unique key of the Person
Main	PersonMainFields	General data associated with the Person
Attributes.Rows	Array<AttributeLine>	Attributes associated with the Person
Notes.Rows	Array<NoteLine>	Notes associated with the Person
ToDoItems.Rows	Array<ToDoLine>	To Do Items associated with the Person

PersonMainFields

Field	Type	Description
Surname	StringViewData
FirstName	StringViewData
FullName	StringViewData
PersonIdNum	StringViewData
Title	StringViewData
Company	StringViewData
JobTitle	StringViewData
Salutation	StringViewData
EmailAddress	StringViewData
EmailAddress2	StringViewData
MobilePhone	StringViewData
BusinessPhone	StringViewData
CompanyPhone	StringViewData
HomePhone	StringViewData
Fax	StringViewData
PersonalReference	StringViewData
PersonalAddress	StringViewData
BillingContact	BoolViewData
SiteContact	BoolViewData
CommercialContact	BoolViewData
Inactive	BoolViewData

Examples

Get the Logged in User

TODO

Get a Filtered and Sorted List of People

TODO

Create a New Person

TODO

On this page

Unable to render {include} The included page could not be found.

Account Module

Overview

Endpoints

AccountApi

PeopleListApi

PeopleDetailApi

Models

AccountApiModel

PersonKey

PersonLine

PeopleApiModel

PersonMainFields

Examples

Get the Logged in User

Get a Filtered and Sorted List of People

Create a New Person