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 List of 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 detail (#/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	Family name
FirstName	String	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	JobTitleValue.CellValue	User's official title.
EmailAddress	String	EmailAddressValue.CellValue	Email address .
MobilePhone	String	MobilePhoneValue.CellValue	Mobile number
BusinessPhone	String	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		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

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	Surname
FirstName	StringViewData	First name
FullName	StringViewData	Full name
PersonIdNum	StringViewData	ID number?The unique Person ID of the Person
Title	StringViewData	The name prefix for this user.
Company	StringViewData	Company of the person.
JobTitle	StringViewData	Official position of the person.
Salutation	StringViewData	how the person is addressed in correspondence.
EmailAddress	StringViewData	Email address.
EmailAddress2	StringViewData	Second email address.
MobilePhone	StringViewData	Mobile Phone number.
BusinessPhone	StringViewData	Business Phone number.
CompanyPhone	StringViewData	Company phone number
HomePhone	StringViewData	Home phone number
Fax	StringViewData	Fax number
PersonalReference	StringViewData	Free text as reference
PersonalAddress	StringViewData	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.

Examples

Get the logged in user

Expand

title	Click to view

Request

Code Block

language	json

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

Response

Code Block

language	json

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

Response sample

Code Block

language	json

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

Get a filtered and sorted list of people

Expand

title	Click to view

Request

Code Block

language	json

{
  "predicate": {
    "PredicateRows": [
      {
        "LeftOperand": "DisplayName",
        "Operator": "Like",
        "RightOperand": [
          ""
        ],
        "Display": true
      }
    ],
    "IsOr": false
  },
  "sidx": "DisplayName",
  "sord": "asc",
  "page": 1,
  "rows": 20,
  "functionalCode": "General",
  "IntValue": 0,
  "BoolValue": false
}

Response

Code Block

language	json

GridResult_GeneralPersonLine {
total (integer, optional),
page (integer, optional),
records (integer, optional),
rows (Array[GeneralPersonLine], optional),
form (object, optional),
widgets (Array[ViewData_GridWidget], optional)
}
GeneralPersonLine {
PersonId (integer, optional),
DisplayName (string, optional),
Surname (string, optional),
FirstName (string, optional),
CompanyId (integer, optional),
Company (string, optional),
Role (string, optional),
JobTitle (string, optional),
EmailAddress (string, optional),
MobilePhone (string, optional),
BusinessPhone (string, optional),
IsEmployee (boolean, optional),
IsActive (boolean, optional),
Inactive (boolean, optional),
IsBillingContact (boolean, optional),
IsSiteContact (boolean, optional),
IsCommercialContact (boolean, optional),
EmployeeNo (string, optional),
SelectId (string, optional) = ['PersonId', 'DisplayName'],
SelectTag (string, optional) = ['DisplayName', 'EmailAddress'],
Select (CellData, optional, read only),
PersonIdValue (CellData, optional),
SurnameValue (CellData, optional),
FirstNameValue (CellData, optional),
CompanyValue (CellData, optional),
RoleValue (CellData, optional),
JobTitleValue (CellData, optional),
EmailAddressValue (CellData, optional),
MobilePhoneValue (CellData, optional),
BusinessPhoneValue (CellData, optional),
Delete (CellData, optional),
Group1 (string, optional),
Group2 (string, optional),
Group3 (string, optional),
UpdatedDate (string, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (GeneralPersonKey, optional),
CurrentKey (GeneralPersonKey, optional),
Key (GeneralPersonKey, optional),
Index (integer, optional)
}
ViewData_GridWidget {
WidgetId (integer, optional),
LayoutCode (string, optional),
Name (string, optional),
Colour (string, optional),
BGColour (string, optional),
Icon (string, optional),
Type (string, optional),
Visible (boolean, optional),
Order (integer, optional),
Count (integer, optional),
WidgetLines (Array[ViewData_GridWidgetLine], optional)
}
CellData {
CellId (string, optional),
CellValue (string, optional),
CellNumValue (number, optional),
CellBoolValue (boolean, optional),
CellTag (string, optional),
CellValueDate (string, optional),
CellValueInt (integer, optional)
}
GeneralPersonKey {
PersonId (integer, optional)
}
ViewData_GridWidgetLine {
WidgetLineId (integer, optional),
WidgetId (integer, optional),
Name (string, optional),
Predicate (string, optional),
Order (integer, optional),
Count (integer, optional)
}

Response Sample

Code Block

language	json

{
  "total": 13,
  "page": 2,
  "records": 242,
  "rows": [
    {
      "PersonId": 352,
      "DisplayName": "Bob Cates",
      "Surname": "Cates",
      "FirstName": "Bob",
      "CompanyId": 584,
      "Company": "CATES BROS LTD",
      "JobTitle": "",
      "EmailAddress": "demo@wbi.co.nz",
      "MobilePhone": "",
      "BusinessPhone": "",
      "IsEmployee": false,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "352",
        "CellValue": "Cates",
        "CellTag": "Bob Cates"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "352"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Cates"
      },
      "FirstNameValue": {
        "CellValue": "Bob"
      },
      "CompanyValue": {
        "CellId": "584",
        "CellValue": "CATES BROS LTD"
      },
      "RoleValue": {},
      "JobTitleValue": {
        "CellValue": ""
      },
      "EmailAddressValue": {
        "CellValue": "demo@wbi.co.nz"
      },
      "MobilePhoneValue": {
        "CellValue": ""
      },
      "BusinessPhoneValue": {
        "CellValue": ""
      },
      "UpdatedDate": "2019-12-05T21:22:14.9618063+00:00",
      "OriginalKey": {
        "PersonId": 352
      },
      "CurrentKey": {
        "PersonId": 352
      },
      "Key": {
        "PersonId": 352
      },
      "Index": 0
    },
    {
      "PersonId": 394,
      "DisplayName": "Bob Partridge",
      "Surname": "Partridge",
      "FirstName": "Bob",
      "CompanyId": 650,
      "Company": "Bayside Club",
      "EmailAddress": "secretarybob@bsclub.co",
      "IsEmployee": false,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": true,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "394",
        "CellValue": "Partridge",
        "CellTag": "Bob Partridge"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "394"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Partridge"
      },
      "FirstNameValue": {
        "CellValue": "Bob"
      },
      "CompanyValue": {
        "CellId": "650",
        "CellValue": "Bayside Club"
      },
      "RoleValue": {},
      "JobTitleValue": {},
      "EmailAddressValue": {
        "CellValue": "secretarybob@bsclub.co"
      },
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {},
      "UpdatedDate": "2023-04-05T04:33:01.143+00:00",
      "OriginalKey": {
        "PersonId": 394
      },
      "CurrentKey": {
        "PersonId": 394
      },
      "Key": {
        "PersonId": 394
      },
      "Index": 0
    },
    {
      "PersonId": 399,
      "DisplayName": "Bob Partridge",
      "Surname": "Partridge",
      "FirstName": "Bob",
      "CompanyId": 691,
      "Company": "Bayside Club",
      "EmailAddress": "secretarybob@bsclub.co",
      "IsEmployee": false,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": true,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "399",
        "CellValue": "Partridge",
        "CellTag": "Bob Partridge"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "399"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Partridge"
      },
      "FirstNameValue": {
        "CellValue": "Bob"
      },
      "CompanyValue": {
        "CellId": "691",
        "CellValue": "Bayside Club"
      },
      "RoleValue": {},
      "JobTitleValue": {},
      "EmailAddressValue": {
        "CellValue": "secretarybob@bsclub.co"
      },
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {},
      "UpdatedDate": "2023-04-05T05:09:18.59+00:00",
      "OriginalKey": {
        "PersonId": 399
      },
      "CurrentKey": {
        "PersonId": 399
      },
      "Key": {
        "PersonId": 399
      },
      "Index": 0
    },
    {
      "PersonId": 9,
      "DisplayName": "Bob Steelsmith",
      "Surname": "Steelsmith",
      "FirstName": "Bob",
      "CompanyId": 6,
      "Company": "ABC RESOURCE COMP LTD",
      "JobTitle": "Managing Director",
      "EmailAddress": "demo@wbi.co.nz",
      "MobilePhone": "+61425636988",
      "BusinessPhone": "+61396546989",
      "IsEmployee": false,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": true,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "9",
        "CellValue": "Steelsmith",
        "CellTag": "Bob Steelsmith"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "9"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Steelsmith"
      },
      "FirstNameValue": {
        "CellValue": "Bob"
      },
      "CompanyValue": {
        "CellId": "6",
        "CellValue": "ABC RESOURCE COMP LTD"
      },
      "RoleValue": {},
      "JobTitleValue": {
        "CellValue": "Managing Director"
      },
      "EmailAddressValue": {
        "CellValue": "demo@wbi.co.nz"
      },
      "MobilePhoneValue": {
        "CellValue": "+61425636988"
      },
      "BusinessPhoneValue": {
        "CellValue": "+61396546989"
      },
      "UpdatedDate": "2022-09-13T21:56:21.583327+00:00",
      "OriginalKey": {
        "PersonId": 9
      },
      "CurrentKey": {
        "PersonId": 9
      },
      "Key": {
        "PersonId": 9
      },
      "Index": 0
    },
    {
      "PersonId": 444,
      "DisplayName": "Bua Ko",
      "Surname": "Ko",
      "FirstName": "Bua",
      "CompanyId": 2,
      "Company": "Workbench International Ltd",
      "EmailAddress": "buak@wbi.co.nz",
      "IsEmployee": false,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "444",
        "CellValue": "Ko",
        "CellTag": "Bua Ko"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "444"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Ko"
      },
      "FirstNameValue": {
        "CellValue": "Bua"
      },
      "CompanyValue": {
        "CellId": "2",
        "CellValue": "Workbench International Ltd"
      },
      "RoleValue": {},
      "JobTitleValue": {},
      "EmailAddressValue": {
        "CellValue": "buak@wbi.co.nz"
      },
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {},
      "UpdatedDate": "2023-12-05T22:09:24.896181+00:00",
      "OriginalKey": {
        "PersonId": 444
      },
      "CurrentKey": {
        "PersonId": 444
      },
      "Key": {
        "PersonId": 444
      },
      "Index": 0
    },
    {
      "PersonId": 317,
      "DisplayName": "Campbell Mackay",
      "Surname": "Mackay",
      "FirstName": "Campbell",
      "CompanyId": 2,
      "Company": "Workbench International Ltd",
      "JobTitle": "Web Developer",
      "EmailAddress": "demo@wbi.co.nz",
      "BusinessPhone": "+64 9 360 9450",
      "IsEmployee": true,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "EmployeeNo": "CM001",
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "317",
        "CellValue": "Mackay",
        "CellTag": "Campbell Mackay"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "317"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Mackay"
      },
      "FirstNameValue": {
        "CellValue": "Campbell"
      },
      "CompanyValue": {
        "CellId": "2",
        "CellValue": "Workbench International Ltd"
      },
      "RoleValue": {},
      "JobTitleValue": {
        "CellValue": "Web Developer"
      },
      "EmailAddressValue": {
        "CellValue": "demo@wbi.co.nz"
      },
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {
        "CellValue": "+64 9 360 9450"
      },
      "UpdatedDate": "2023-10-09T21:40:19.2620044+00:00",
      "OriginalKey": {
        "PersonId": 317
      },
      "CurrentKey": {
        "PersonId": 317
      },
      "Key": {
        "PersonId": 317
      },
      "Index": 0
    },
    {
      "PersonId": 302,
      "DisplayName": "Cassi Commander",
      "Surname": "Commander",
      "FirstName": "Cassi",
      "CompanyId": 1,
      "Company": "ASIA / PACIFIC CIVIL",
      "JobTitle": "Operator/Construction Worker",
      "IsEmployee": true,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "EmployeeNo": "COM001",
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "302",
        "CellValue": "Commander",
        "CellTag": "Cassi Commander"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "302"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Commander"
      },
      "FirstNameValue": {
        "CellValue": "Cassi"
      },
      "CompanyValue": {
        "CellId": "1",
        "CellValue": "ASIA / PACIFIC CIVIL"
      },
      "RoleValue": {},
      "JobTitleValue": {
        "CellValue": "Operator/Construction Worker"
      },
      "EmailAddressValue": {},
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {},
      "UpdatedDate": "2018-06-13T01:55:02.337+00:00",
      "OriginalKey": {
        "PersonId": 302
      },
      "CurrentKey": {
        "PersonId": 302
      },
      "Key": {
        "PersonId": 302
      },
      "Index": 0
    },
    {
      "PersonId": 376,
      "DisplayName": "Casual Worker",
      "Surname": "Worker",
      "FirstName": "Casual",
      "CompanyId": 2,
      "Company": "Workbench International Ltd",
      "JobTitle": "Tester",
      "EmailAddress": "nehas@wbi.co.nz",
      "BusinessPhone": "+64 9 360 9450",
      "IsEmployee": true,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "EmployeeNo": "1001",
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "376",
        "CellValue": "Worker",
        "CellTag": "Casual Worker"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "376"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Worker"
      },
      "FirstNameValue": {
        "CellValue": "Casual"
      },
      "CompanyValue": {
        "CellId": "2",
        "CellValue": "Workbench International Ltd"
      },
      "RoleValue": {},
      "JobTitleValue": {
        "CellValue": "Tester"
      },
      "EmailAddressValue": {
        "CellValue": "nehas@wbi.co.nz"
      },
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {
        "CellValue": "+64 9 360 9450"
      },
      "UpdatedDate": "2024-01-16T21:30:29.7209346+00:00",
      "OriginalKey": {
        "PersonId": 376
      },
      "CurrentKey": {
        "PersonId": 376
      },
      "Key": {
        "PersonId": 376
      },
      "Index": 0
    },
    {
      "PersonId": 287,
      "DisplayName": "Cecily Sever (Inactive)",
      "Surname": "Sever",
      "FirstName": "Cecily",
      "CompanyId": 1,
      "Company": "ASIA / PACIFIC CIVIL",
      "JobTitle": "Site Manager",
      "IsEmployee": true,
      "IsActive": false,
      "Inactive": true,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "EmployeeNo": "SEV001",
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "287",
        "CellValue": "Sever (Inactive)",
        "CellTag": "Cecily Sever (Inactive)"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "287"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Sever"
      },
      "FirstNameValue": {
        "CellValue": "Cecily"
      },
      "CompanyValue": {
        "CellId": "1",
        "CellValue": "ASIA / PACIFIC CIVIL"
      },
      "RoleValue": {},
      "JobTitleValue": {
        "CellValue": "Site Manager"
      },
      "EmailAddressValue": {},
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {},
      "UpdatedDate": "2018-06-13T01:55:02.337+00:00",
      "OriginalKey": {
        "PersonId": 287
      },
      "CurrentKey": {
        "PersonId": 287
      },
      "Key": {
        "PersonId": 287
      },
      "Index": 0
    },
    {
      "PersonId": 301,
      "DisplayName": "Chas Deming (Inactive)",
      "Surname": "Deming",
      "FirstName": "Chas",
      "CompanyId": 1,
      "Company": "ASIA / PACIFIC CIVIL",
      "JobTitle": "Operator/Construction Worker",
      "IsEmployee": true,
      "IsActive": false,
      "Inactive": true,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "EmployeeNo": "DEM001",
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "301",
        "CellValue": "Deming (Inactive)",
        "CellTag": "Chas Deming (Inactive)"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "301"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Deming"
      },
      "FirstNameValue": {
        "CellValue": "Chas"
      },
      "CompanyValue": {
        "CellId": "1",
        "CellValue": "ASIA / PACIFIC CIVIL"
      },
      "RoleValue": {},
      "JobTitleValue": {
        "CellValue": "Operator/Construction Worker"
      },
      "EmailAddressValue": {},
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {},
      "UpdatedDate": "2018-06-13T01:55:02.337+00:00",
      "OriginalKey": {
        "PersonId": 301
      },
      "CurrentKey": {
        "PersonId": 301
      },
      "Key": {
        "PersonId": 301
      },
      "Index": 0
    },
    {
      "PersonId": 223,
      "DisplayName": "Chase Estep",
      "Surname": "Estep",
      "FirstName": "Chase",
      "CompanyId": 1,
      "Company": "ASIA / PACIFIC CIVIL",
      "JobTitle": "Operator/Construction Worker",
      "IsEmployee": true,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "EmployeeNo": "EST001",
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "223",
        "CellValue": "Estep",
        "CellTag": "Chase Estep"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "223"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Estep"
      },
      "FirstNameValue": {
        "CellValue": "Chase"
      },
      "CompanyValue": {
        "CellId": "1",
        "CellValue": "ASIA / PACIFIC CIVIL"
      },
      "RoleValue": {},
      "JobTitleValue": {
        "CellValue": "Operator/Construction Worker"
      },
      "EmailAddressValue": {},
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {},
      "UpdatedDate": "2022-12-07T23:14:39.2449205+00:00",
      "OriginalKey": {
        "PersonId": 223
      },
      "CurrentKey": {
        "PersonId": 223
      },
      "Key": {
        "PersonId": 223
      },
      "Index": 0
    },
    {
      "PersonId": 447,
      "DisplayName": "Chris Parkinson",
      "Surname": "Parkinson",
      "FirstName": "Chris",
      "CompanyId": 2,
      "Company": "Workbench International Ltd",
      "BusinessPhone": "+64 9 360 9450",
      "IsEmployee": true,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "EmployeeNo": "CP",
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "447",
        "CellValue": "Parkinson",
        "CellTag": "Chris Parkinson"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "447"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Parkinson"
      },
      "FirstNameValue": {
        "CellValue": "Chris"
      },
      "CompanyValue": {
        "CellId": "2",
        "CellValue": "Workbench International Ltd"
      },
      "RoleValue": {},
      "JobTitleValue": {},
      "EmailAddressValue": {},
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {
        "CellValue": "+64 9 360 9450"
      },
      "UpdatedDate": "2024-03-07T23:42:53.393+00:00",
      "OriginalKey": {
        "PersonId": 447
      },
      "CurrentKey": {
        "PersonId": 447
      },
      "Key": {
        "PersonId": 447
      },
      "Index": 0
    },
    {
      "PersonId": 448,
      "DisplayName": "Chris Parkinson",
      "Surname": "Parkinson",
      "FirstName": "Chris",
      "CompanyId": 2,
      "Company": "Workbench International Ltd",
      "BusinessPhone": "+64 9 360 9450",
      "IsEmployee": true,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "EmployeeNo": "CP2",
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "448",
        "CellValue": "Parkinson",
        "CellTag": "Chris Parkinson"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "448"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Parkinson"
      },
      "FirstNameValue": {
        "CellValue": "Chris"
      },
      "CompanyValue": {
        "CellId": "2",
        "CellValue": "Workbench International Ltd"
      },
      "RoleValue": {},
      "JobTitleValue": {},
      "EmailAddressValue": {},
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {
        "CellValue": "+64 9 360 9450"
      },
      "UpdatedDate": "2024-03-08T00:05:49.47+00:00",
      "OriginalKey": {
        "PersonId": 448
      },
      "CurrentKey": {
        "PersonId": 448
      },
      "Key": {
        "PersonId": 448
      },
      "Index": 0
    },
    {
      "PersonId": 215,
      "DisplayName": "Clifford Nolin",
      "Surname": "Nolin",
      "FirstName": "Clifford",
      "CompanyId": 1,
      "Company": "ASIA / PACIFIC CIVIL",
      "JobTitle": "Surveyor",
      "IsEmployee": true,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "EmployeeNo": "NOL001",
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "215",
        "CellValue": "Nolin",
        "CellTag": "Clifford Nolin"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "215"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Nolin"
      },
      "FirstNameValue": {
        "CellValue": "Clifford"
      },
      "CompanyValue": {
        "CellId": "1",
        "CellValue": "ASIA / PACIFIC CIVIL"
      },
      "RoleValue": {},
      "JobTitleValue": {
        "CellValue": "Surveyor"
      },
      "EmailAddressValue": {},
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {},
      "UpdatedDate": "2018-06-13T01:55:02.337+00:00",
      "OriginalKey": {
        "PersonId": 215
      },
      "CurrentKey": {
        "PersonId": 215
      },
      "Key": {
        "PersonId": 215
      },
      "Index": 0
    },
    {
      "PersonId": 318,
      "DisplayName": "Clive Gardner",
      "Surname": "Gardner",
      "FirstName": "Clive",
      "CompanyId": 2,
      "Company": "Workbench International Ltd",
      "JobTitle": "Manager",
      "EmailAddress": "cliveg@wbi.co.nz",
      "BusinessPhone": "+64 9 360 9450",
      "IsEmployee": true,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "EmployeeNo": "CG001",
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "318",
        "CellValue": "Gardner",
        "CellTag": "Clive Gardner"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "318"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Gardner"
      },
      "FirstNameValue": {
        "CellValue": "Clive"
      },
      "CompanyValue": {
        "CellId": "2",
        "CellValue": "Workbench International Ltd"
      },
      "RoleValue": {},
      "JobTitleValue": {
        "CellValue": "Manager"
      },
      "EmailAddressValue": {
        "CellValue": "cliveg@wbi.co.nz"
      },
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {
        "CellValue": "+64 9 360 9450"
      },
      "UpdatedDate": "2023-05-16T21:55:05.2482766+00:00",
      "OriginalKey": {
        "PersonId": 318
      },
      "CurrentKey": {
        "PersonId": 318
      },
      "Key": {
        "PersonId": 318
      },
      "Index": 0
    },
    {
      "PersonId": 283,
      "DisplayName": "Clorinda Scarpelli",
      "Surname": "Scarpelli",
      "FirstName": "Clorinda",
      "CompanyId": 1,
      "Company": "ASIA / PACIFIC CIVIL",
      "JobTitle": "Operator/Construction Worker",
      "IsEmployee": true,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "EmployeeNo": "SCA001",
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "283",
        "CellValue": "Scarpelli",
        "CellTag": "Clorinda Scarpelli"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "283"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Scarpelli"
      },
      "FirstNameValue": {
        "CellValue": "Clorinda"
      },
      "CompanyValue": {
        "CellId": "1",
        "CellValue": "ASIA / PACIFIC CIVIL"
      },
      "RoleValue": {},
      "JobTitleValue": {
        "CellValue": "Operator/Construction Worker"
      },
      "EmailAddressValue": {},
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {},
      "UpdatedDate": "2018-06-13T01:55:02.337+00:00",
      "OriginalKey": {
        "PersonId": 283
      },
      "CurrentKey": {
        "PersonId": 283
      },
      "Key": {
        "PersonId": 283
      },
      "Index": 0
    },
    {
      "PersonId": 364,
      "DisplayName": "Colin Diep",
      "Surname": "Diep",
      "FirstName": "Colin",
      "CompanyId": 1,
      "Company": "ASIA / PACIFIC CIVIL",
      "EmailAddress": "colind@wbi.co.nz",
      "IsEmployee": true,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "EmployeeNo": "tba",
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "364",
        "CellValue": "Diep",
        "CellTag": "Colin Diep"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "364"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Diep"
      },
      "FirstNameValue": {
        "CellValue": "Colin"
      },
      "CompanyValue": {
        "CellId": "1",
        "CellValue": "ASIA / PACIFIC CIVIL"
      },
      "RoleValue": {},
      "JobTitleValue": {},
      "EmailAddressValue": {
        "CellValue": "colind@wbi.co.nz"
      },
      "MobilePhoneValue": {},
      "BusinessPhoneValue": {},
      "UpdatedDate": "2024-02-20T21:57:14.8459583+00:00",
      "OriginalKey": {
        "PersonId": 364
      },
      "CurrentKey": {
        "PersonId": 364
      },
      "Key": {
        "PersonId": 364
      },
      "Index": 0
    },
    {
      "PersonId": 363,
      "DisplayName": "Contact Test",
      "Surname": "Test",
      "FirstName": "Contact",
      "CompanyId": 614,
      "Company": "Workbench International Ltd FX testzzzz",
      "EmailAddress": "email@wb.com",
      "MobilePhone": "11",
      "BusinessPhone": "12",
      "IsEmployee": false,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": true,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "363",
        "CellValue": "Test",
        "CellTag": "Contact Test"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "363"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Test"
      },
      "FirstNameValue": {
        "CellValue": "Contact"
      },
      "CompanyValue": {
        "CellId": "614",
        "CellValue": "Workbench International Ltd FX testzzzz"
      },
      "RoleValue": {},
      "JobTitleValue": {},
      "EmailAddressValue": {
        "CellValue": "email@wb.com"
      },
      "MobilePhoneValue": {
        "CellValue": "11"
      },
      "BusinessPhoneValue": {
        "CellValue": "12"
      },
      "UpdatedDate": "2022-05-11T04:29:51.243+00:00",
      "OriginalKey": {
        "PersonId": 363
      },
      "CurrentKey": {
        "PersonId": 363
      },
      "Key": {
        "PersonId": 363
      },
      "Index": 0
    },
    {
      "PersonId": 342,
      "DisplayName": "Contact Test",
      "Surname": "Test",
      "FirstName": "Contact",
      "CompanyId": 2,
      "Company": "Workbench International Ltd",
      "EmailAddress": "demo@wbi.co.nz",
      "MobilePhone": "1",
      "IsEmployee": false,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "342",
        "CellValue": "Test",
        "CellTag": "Contact Test"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "342"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Test"
      },
      "FirstNameValue": {
        "CellValue": "Contact"
      },
      "CompanyValue": {
        "CellId": "2",
        "CellValue": "Workbench International Ltd"
      },
      "RoleValue": {},
      "JobTitleValue": {},
      "EmailAddressValue": {
        "CellValue": "demo@wbi.co.nz"
      },
      "MobilePhoneValue": {
        "CellValue": "1"
      },
      "BusinessPhoneValue": {},
      "UpdatedDate": "2018-06-13T01:55:02.337+00:00",
      "OriginalKey": {
        "PersonId": 342
      },
      "CurrentKey": {
        "PersonId": 342
      },
      "Key": {
        "PersonId": 342
      },
      "Index": 0
    },
    {
      "PersonId": 347,
      "DisplayName": "Contact Test",
      "Surname": "Test",
      "FirstName": "Contact",
      "CompanyId": 2,
      "Company": "Workbench International Ltd",
      "EmailAddress": "demo@wbi.co.nz",
      "MobilePhone": "1",
      "IsEmployee": false,
      "IsActive": true,
      "Inactive": false,
      "IsBillingContact": false,
      "IsSiteContact": false,
      "IsCommercialContact": false,
      "SelectId": 0,
      "SelectTag": 0,
      "Select": {
        "CellId": "347",
        "CellValue": "Test",
        "CellTag": "Contact Test"
      },
      "PersonIdValue": {
        "CellId": "PopupDialog",
        "CellValue": "347"
      },
      "SurnameValue": {
        "CellId": "PopupDialog",
        "CellValue": "Test"
      },
      "FirstNameValue": {
        "CellValue": "Contact"
      },
      "CompanyValue": {
        "CellId": "2",
        "CellValue": "Workbench International Ltd"
      },
      "RoleValue": {},
      "JobTitleValue": {},
      "EmailAddressValue": {
        "CellValue": "demo@wbi.co.nz"
      },
      "MobilePhoneValue": {
        "CellValue": "1"
      },
      "BusinessPhoneValue": {},
      "UpdatedDate": "2018-06-13T01:55:02.337+00:00",
      "OriginalKey": {
        "PersonId": 347
      },
      "CurrentKey": {
        "PersonId": 347
      },
      "Key": {
        "PersonId": 347
      },
      "Index": 0
    }
  ]
}

Create a new person

Expand

title	Click to view

Request

Code Block

{
  "Key": {
    "PersonId": 0
  },
  "Main": {
    "Surname": {
      "StringValue": "Apple"
    },
    "FirstName": {
      "StringValue": "Adam"
    },
    "FullName": {
      "StringValue": "Adam Apple"
    },
    "Title": {
      "StringValue": "Mr"
    },
    "Company": {
      "SelectedValue": "1659",
      "SelectedText": "ABC2 Ltd"
    },
    "JobTitle": {
      "StringValue": "Supervisor"
    },
    "Salutation": {
      "StringValue": ""
    },
    "EmailAddress": {
      "StringValue": "antong@workbench.co.nz"
    },
    "EmailAddress2": {
      "StringValue": ""
    },
    "MobilePhone": {
      "StringValue": ""
    },
    "BusinessPhone": {
      "StringValue": ""
    },
    "CompanyPhone": {
	  "StringValue": ""
    },
    "HomePhone": {
      "StringValue": "610335561"
    },
    "Fax": {
      "StringValue": ""
    },
    "PersonReference": {
      "StringValue": ""
    },
    "PersonalAddress": {
      "StringValue": ""
    },
    "BillingContact": {
      "BoolValue": false
    },
    "SiteContact": {
      "BoolValue": false
    },
    "Inactive": {
      "BoolValue": false
    }
  },
  "Attributes": {
    "Rows": [
      {
        "CategoryValue": {
          "CellId": "Personal",
          "CellValue": "Personal"
        },
        "GroupValue": {
          "CellId": "DOB",
          "CellValue": "Date of Birth"
        },
        "Value": {
          "CellValue": "12/12/1981"
        },
        "CurrentKey": {
          "Category": "Personal",
          "Group": "DOB"
        },
		"IsNew": true,
        "Index": 1
      }
    ]
  },
  "Notes": {
    "Rows": [
      {
        "KeyTable": "People",
        "DescriptionValue": {
          "CellValue": "Note Description 1"
        },
        "DetailsValue": {
          "CellValue": "some details 1"
        },
        "NoteTypeValue": {
          "CellId": "5",
          "CellValue": "Date of birth"
        },
		"CurrentKey": {
          "ToDoNoteId": 0,
          "KeyTable": "People"
        },
        "Key": {
          "ToDoNoteId": 0,
          "KeyTable": "People"
        },
        "IsNew": true,
        "Index": 1
      }
    ]
  }
}

Response

Code Block

language	json

PeopleApiModel {
Key (GeneralPersonKey, optional),
Main (GeneralPersonMainFields, optional),
Attributes (PeopleApiGridLines_GeneralAttributeLine, optional),
Notes (PeopleApiGridLines_GeneralNoteLine, optional),
ToDoItems (PeopleApiGridLines_GeneralToDoLine, optional)
}
GeneralPersonKey {
PersonId (integer, optional)
}
GeneralPersonMainFields {
Surname (StringViewData, optional),
FirstName (StringViewData, optional),
FullName (StringViewData, optional),
PersonIdNum (StringViewData, optional),
Title (StringViewData, optional),
Company (PickerViewData, optional),
JobTitle (StringViewData, optional),
Salutation (StringViewData, optional),
EmailAddress (StringViewData, optional),
EmailAddress2 (StringViewData, optional),
MobilePhone (StringViewData, optional),
BusinessPhone (StringViewData, optional),
CompanyPhone (StringViewData, optional),
HomePhone (StringViewData, optional),
Fax (StringViewData, optional),
PersonReference (StringViewData, optional),
PersonalAddress (StringViewData, optional),
BillingContact (BoolViewData, optional),
SiteContact (BoolViewData, optional),
Inactive (BoolViewData, optional),
CommercialContact (BoolViewData, optional)
}
PeopleApiGridLines_GeneralAttributeLine {
Rows (Array[GeneralAttributeLine], optional)
}
PeopleApiGridLines_GeneralNoteLine {
Rows (Array[GeneralNoteLine], optional)
}
PeopleApiGridLines_GeneralToDoLine {
Rows (Array[GeneralToDoLine], optional)
}
StringViewData {
StringValue (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional)
}
PickerViewData {
SelectedValue (string, optional),
SelectedText (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
BoolViewData {
BoolValue (boolean, optional),
Name (string, optional),
Visible (boolean, optional),
InfoText (string, optional)
}
GeneralAttributeLine {
Category (string, optional),
Group (string, optional),
CategoryValue (CellData, optional),
GroupValue (CellData, optional),
Value (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (GeneralAttributeKey, optional),
CurrentKey (GeneralAttributeKey, optional),
Key (GeneralAttributeKey, optional),
Index (integer, optional)
}
GeneralNoteLine {
Description (string, optional),
Details (string, optional),
NoteTypeId (integer, optional),
NoteType (string, optional),
CreatedById (integer, optional),
CreatedBy (string, optional),
CreatedDate (string, optional),
KeyTable (string, optional),
EntityDescription (string, optional),
Select (CellData, optional),
DescriptionValue (CellData, optional),
DetailsValue (CellData, optional),
NoteTypeValue (CellData, optional),
CreatedByValue (CellData, optional),
CreatedDateValue (CellData, optional),
EntityValue (CellData, optional),
EntityDescriptionValue (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (GeneralNoteKey, optional),
CurrentKey (GeneralNoteKey, optional),
Key (GeneralNoteKey, optional),
Index (integer, optional)
}
GeneralToDoLine {
Description (string, optional),
Details (string, optional),
NoteTypeId (integer, optional),
NoteType (string, optional),
NoteStatusId (integer, optional),
NoteStatus (string, optional),
DoById (integer, optional),
CreatedByID (integer, optional),
DoBy (string, optional),
KeyTable (string, optional),
EntityDescription (string, optional),
DoByDate (string, optional),
Completed (boolean, optional),
Select (CellData, optional),
DescriptionValue (CellData, optional),
DetailsValue (CellData, optional),
NoteTypeValue (CellData, optional),
NoteStatusValue (CellData, optional),
DoByValue (CellData, optional),
EntityValue (CellData, optional),
EntityDescriptionValue (CellData, optional),
DoByDateValue (CellData, optional),
CompletedValue (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (GeneralToDoKey, optional),
CurrentKey (GeneralToDoKey, optional),
Key (GeneralToDoKey, optional),
Index (integer, optional)
}
CellData {
CellId (string, optional),
CellValue (string, optional),
CellNumValue (number, optional),
CellBoolValue (boolean, optional),
CellTag (string, optional),
CellValueDate (string, optional),
CellValueInt (integer, optional)
}
GeneralAttributeKey {
Category (string, optional),
Group (string, optional)
}
GeneralNoteKey {
ToDoNoteId (integer, optional),
KeyTable (string, optional),
GridId (string, optional)
}
GeneralToDoKey {
ToDoNoteId (integer, optional),
KeyTable (string, optional)
}

Response Sample

Code Block

language	json

{
  "Key": {
    "PersonId": 427
  },
  "Main": {
    "Surname": {
      "StringValue": "Apple"
    },
    "FirstName": {
      "StringValue": "Adam"
    },
    "FullName": {
      "StringValue": "Adam Apple"
    },
    "Title": {
      "StringValue": "Mr"
    },
    "Company": {
      "SelectedValue": "1659",
      "SelectedText": "ABC2 Ltd"
    },
    "JobTitle": {
      "StringValue": "Supervisor"
    },
    "Salutation": {
      "StringValue": ""
    },
    "EmailAddress": {
      "StringValue": "abc@company.com"
    },
    "EmailAddress2": {
      "StringValue": ""
    },
    "MobilePhone": {
      "StringValue": ""
    },
    "BusinessPhone": {
      "StringValue": ""
    },
    "CompanyPhone": {
	  "StringValue": ""
    },
    "HomePhone": {
      "StringValue": "610335561"
    },
    "Fax": {
      "StringValue": ""
    },
    "PersonReference": {
      "StringValue": ""
    },
    "PersonalAddress": {
      "StringValue": ""
    },
    "BillingContact": {
      "BoolValue": false
    },
    "SiteContact": {
      "BoolValue": false
    },
    "Inactive": {
      "BoolValue": false
    }
  },
  "Attributes": {
    "Rows": [
      {
        "CategoryValue": {
          "CellId": "Personal",
          "CellValue": "Personal"
        },
        "GroupValue": {
          "CellId": "DOB",
          "CellValue": "Date of Birth"
        },
        "Value": {
          "CellValue": "12/12/1980"
        },
        "CurrentKey": {
          "Category": "Personal",
          "Group": "DOB"
        },
		"IsNew": true,
        "Index": 1
      }
    ]
  },
  "Notes": {
    "Rows": [
      {
        "KeyTable": "People",
        "DescriptionValue": {
          "CellValue": "Note Description 1"
        },
        "DetailsValue": {
          "CellValue": "some details 1"
        },
        "NoteTypeValue": {
          "CellId": "5",
          "CellValue": "Date of birth"
        },
		"CurrentKey": {
          "ToDoNoteId": 0,
          "KeyTable": "People"
        },
        "Key": {
          "ToDoNoteId": 0,
          "KeyTable": "People"
        },
        "IsNew": true,
        "Index": 1
      }
    ]
  }
}

⬆️ Back to top

On this page

Table of Contents

minLevel	1
maxLevel	3
outline	false
type	list
separator	brackets
printable	false

Include Page

	KB1:How-to footer
	KB1:How-to footer

Versions Compared

Old Version 16

New Version 17

Key

Overview

Endpoints

AccountApi

PeopleListApi

PeopleDetailApi

Models

AccountApiModel

PersonKey

PersonLine

PeopleApiModel

PersonMainFields

Examples

Get the logged in user

Request

Response

Response sample

Get a filtered and sorted list of people

Request

Response

Response Sample

Create a new person

Request

Response

Response Sample

Page Comparison

Versions Compared

Old Version 16

New Version 17

Key

Overview

Endpoints

AccountApi

PeopleListApi

PeopleDetailApi

Models

AccountApiModel

PersonKey

PersonLine

PeopleApiModel

PersonMainFields

Examples

Get the logged in user

Request

Response

Response sample

Get a filtered and sorted list of people

Request

Response

Response Sample

Create a new person

Request

Response

Response Sample