Versions Compared

Old Version 14

changes.mady.by.user Jeremy Bruce (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Steve Randall

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
The information in this document is currently in BETA and subject to change.


The Participants resource is one the central resources in the Actionstep system. Many other resources reference it and there are a large number of resources that extend this base resource.

 

Participants server as the base contact record for general Contacts, Action Participants, System Users and Divisions.


Resource Properties
Scope Parameterparticipants
Location/participants
MethodsGET POST PUT
DELETE OPTIONS
Default Page Size50
Max Page Size
100
200
Default IncludesNone


Resource Atributes
FieldDescriptionFormatRequiredField TypeNotes
displayNameThe participants name formatted as defined by the Display Name Format global preference.string
true
falsedefault
 
Read-only field. Returned in GET requests.
isCompanyDefines the participant as either a Company or Individual.booleantruedefault
 

companyNameThe name of the company if the participant is a Company, or the name of the employer if the participant is an Individual.stringfalsedefault
 

salutationThe Individual's prefix.stringfalsedefault
 

firstNameThe Individual's first name.string
false
*default
 
If isCompany === false then this field is required.
middleNameThe Individual's middle name.stringfalsedefault
 

lastNameThe Individual's last name.string
false
*default
 
If isCompany === false then this field is required.
suffixThe Individual's suffix.stringfalsedefault
 

preferredNameThe Individual's preferred name.stringfalseadditional
 

physicalAddressLine1The primary field for the physical address of the participant.stringfalsedefault
 

physicalAddressLine2An optional secondary address field for the physical address.stringfalsedefault
 

physicalCityThe city portion of the physical address.stringfalsedefault
 

physicalStateProvinceThe state or province portion of the physical address.stringfalsedefault
 

physicalPostCodeThe postcode or zip code portion of the physical address.stringfalsedefault
 physicalCountryThe associated countries resource for the country portion of the physical address.string
falselink 

mailingAddressLine1The primary field for the mailing address of the participant.stringfalseadditional
 

mailingAddressLine2An optional secondary address field for the mailing address.stringfalseadditional
 

mailingCityThe city portion of the mailing address.stringfalseadditional
 

mailingStateProvinceThe state or province portion of the mailing address.stringfalseadditional
 

mailingPostCodeThe postcode or zip code portion of the mailing address.stringfalseadditional
 mailingCountry
The associated countries resource for the country portion of the mailing address.stringfalselink 

phone1LabelA description of the primary phone number.stringfalsedefault
 

phone1CountryThe country portion of the primary phone number.
string
integerfalsedefault
 

phone1AreaThe area code portion of the primary phone number.
string
integerfalsedefault
 

phone1NumberThe number portion of the primary phone number.stringfalsedefault
 

phone1NotesA notes field for the primary phone number.stringfalsedefault
 

phone2LabelA description of the secondary phone number.stringfalseadditional
 

phone2CountryThe country portion of the secondary phone number.
string
integerfalseadditional
 

phone2AreaThe area code portion of the secondary phone number.
string
integerfalseadditional
 

phone2NumberThe number portion of the secondary phone number.stringfalseadditional
 

phone2NotesA notes field for the secondary phone number.stringfalseadditional
 

phone3LabelA description of the tertiary phone number.stringfalseadditional
 

phone3CountryThe country portion of the tertiary phone number.
string
integerfalseadditional
 

phone3AreaThe area code portion of the tertiary phone number.
string
integerfalseadditional
 

phone3NumberThe number portion of the tertiary phone number.stringfalseadditional
 

phone3NotesA notes field for the tertiary phone number.stringfalseadditional
 

phone4LabelA description of the quaternary phone number.stringfalseadditional
 

phone4CountryThe country portion of the quaternary phone number.
string
integerfalseadditional
 

phone4AreaThe area code portion of the quaternary phone number.
string
integerfalseadditional
 

phone4NumberThe number portion of the quaternary phone number.stringfalseadditional
 

phone4NotesA notes field for the quaternary phone number.stringfalseadditional
 

faxThe participant's fax number.stringfalseadditional
 

smsThe number to use for SMS.stringfalseadditional
 

emailThe participant's email address.stringfalsedefault
 

websiteThe participant's web address.stringfalseadditional
 

occupationThe participant's occupation.stringfalseadditional
 

taxNumberThe tax number
.stringfalseadditional
for the Company or Individual. Uses the Tax Number Alias on the Base Participant Type to determine what type of tax this is.stringfalseadditional
birthTimestampThe
participant
Individual's Date of Birth.
timestamp
datefalsedefault
 

deathTimestampThe
participant
Individual's Date of Death.
timestamp
datefalseadditional
 

maritalStatus
Marital
The marital status of the Individual.stringfalsedefault
 

genderThe gender
Genderstring
of the Individual.stringtruedefault
 emailFormatThe preferred email format for the participant.

notificationMethodThe preferred notification method for the participant.string
modifiedTimestampTimestamp when the record was last modified.timestampfalseadditional
Text / HTML

 
createdTimestampTimestamp when the record was created.timestampfalseadditional
 isNewsletterSubscriberIf the participant is a Newsletter subscriber.booleanfalseadditionalDeprecated?modifiedTimestampTimestamp when the record was last modified.timestampfalseadditional createdTimestampTimestamp when the record was created.timestampfalseadditional

baseParticipantTypeThe base Participant Type for this resource.stringtruelinkMay only have one base type. Not yet implemented
physicalCountryThe associated Countries resource for the country portion of the physical address.stringfalselink
mailingCountryThe associated Countries resource for the country portion of the mailing address.stringfalselink
divisionThe associated
divisions
Divisions resource for the participant.stringtruelink
 

billingPreferenceThe associated
billingpreference
Billingpreference resource of the participant.stringfalselink
 

...

Not Yet Implemented
amlStatusThe status for the AML check for this participant.stringfalsestringMust be one of 'Not started', 'In progress', 'Signed off'.
amlProgressThe percentage of the AML process completed.integerfalseinteger0 to 100.
amlRiskThe AML risk level assigned to this participant.stringfalsestringMust be one of 'Unknown', 'Low', 'Medium', 'High'.
amlNoteSome AML notes.stringfalsestring


Link Templates
IdentifierResourceLocation Template
participants.physicalCountrycountries/countries/{participants.physicalCountry}
participants.mailingCountrycountries/countries/{participants.mailingCountry}
participants.divisiondivisions/divisions/{participants.division}
participants.billingPreferencebillingPreferences/billingPreferences/{participants.billingPreference}

 

Example Requests / Responses

...