Overview

Provides access to Account related data and Workbench User data.

Endpoints

The resources available in this module.

AccountApi

Provides API access to logged in user information.

/api/AccountApi

/api/AccountApi
Method	Performed As	Request Query	Request Body	Response
GET Retrieve the current logged in user.	Logged in User	-	-	AccountApiModel

PeopleListApi

Provides API access to the List of People (#/General/PersonList.aspx) Web Workbench screen.

/api/PeopleListApi

/api/PeopleListApi
Method	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 detail (#/General/PersonList.aspx) dialog Web Workbench screen.

/api/PeopleDetailApi

/api/PeopleDetailApi
Method	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

Property	Type	Length	Description

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

Back to top

PersonKey

Property	Type	Length	Description

Property	Type	Length	Description
PersonID	Integer	50	The unique Person ID of the Person

Back to top

PersonLine

Property	Type	Length	CellData	Description

Property	Type	Length	CellData	Description
Key	PersonKey			The unique key for the line
PersonId	Integer	50	PersonIdValue.CellValue	The unique ID of the Person
DisplayName	String	255
Surname	String	50	Surname.CellValue	Family name
FirstName	String	50	FirstNameValue.CellValue	First name
Company	String		CompanyValue.CellValue	The company nam of this person.
CompanyId	Integer		CompanyValue.CellId	The Company code of this person
Role	String		RoleValue.CellValue	The role of this person
JobTitle	String	50	JobTitleValue.CellValue	User's official title.
EmailAddress	String	250	EmailAddressValue.CellValue	Email address .
MobilePhone	String	50	MobilePhoneValue.CellValue	Mobile number
BusinessPhone	String	50	BusinessPhone.CellValue	Working phone number
IsEmployee	Boolean			The person is an employee or not.
IsActive	Boolean			The account is active or not.
IsInactive	Boolean			The account is inactive or not.
IsBillingContact	Boolean			The person is the billing contact or not.
IsSiteContact	Boolean			The person is the primary project contact or not.
IsCommercialContact	Boolean			The person is the Site Contact or not.
EmployeeNo	String	50		Employee code
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

Back to top

PeopleApiModel

Property	Type	Description

Property	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.

Back to top

PersonMainFields

Property	Type	Length	Description

Property	Type	Length	Description
Surname	StringViewData	50	Surname
FirstName	StringViewData	50	First name
FullName	StringViewData	50	Full name
PersonIdNum	StringViewData	50	The unique Person ID of the Person
Title	StringViewData	50	The name prefix for this user.
Company	StringViewData	100	Company of the person.
JobTitle	StringViewData	50	Official position of the person.
Salutation	StringViewData	50	how the person is addressed in correspondence.
EmailAddress	StringViewData	250	Email address.
EmailAddress2	StringViewData	250	Second email address.
MobilePhone	StringViewData	50	Mobile Phone number.
BusinessPhone	StringViewData	50	Business Phone number.
CompanyPhone	StringViewData	50	Company phone number
HomePhone	StringViewData	50	Home phone number
Fax	StringViewData	50	Fax number
PersonalReference	StringViewData	50	Free text as reference
PersonalAddress	StringViewData	200	Person address
BillingContact	BoolViewData		Indicate this person is the primary contact for billing purposes for the company.
SiteContact	BoolViewData		Indicate this person is the primary project contact.
CommercialContact	BoolViewData		Indicate this person is the primary contact for commercial purposes for the company.
Inactive	BoolViewData		Indicate the status of this account.

Back to top

Examples

Get the logged in user

Request

AccountApiModel {
PersonID (integer, optional),
FullName (string, optional),
FinCoCode (string, optional)
}

Response

{
  "PersonID": 0,
  "FullName": "string",
  "FinCoCode": "string"
}

Response sample

{
  "PersonID": 320,
  "FullName": "Peter Norton",
  "FinCoCode": "01"
}

Get a filtered and sorted list of people

Request

Response

Response Sample

Create a new person

Request

Response

Response Sample

Back to top

On this page

1 Overview
2 Endpoints
- 2.1 AccountApi
- 2.2 PeopleListApi
- 2.3 PeopleDetailApi
3 Models
- 3.1 AccountApiModel
- 3.2 PersonKey
- 3.3 PersonLine
- 3.4 PeopleApiModel
- 3.5 PersonMainFields
4 Examples