Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

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.

 

Resource Location: /participants

Available Methods: GET POST PUT DELETE OPTIONS

Default Page Size: 50

Max Page Size: 100

Default Includes: None


Resource Atributes
FieldDescriptionFormatRequiredField TypeNotes
displayNameThe participants name formatted as defined by the Display Name Format global preference.stringtruedefault 
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.stringfalsedefault 
middleNameThe Individual's middle name.stringfalsedefault 
lastNameThe Individual's last name.stringfalsedefault 
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.stringfalselink 
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 
mailingCountryThe associated countries resource for the country portion of the mailing address.stringfalselink 
phone1Label stringfalsedefault 
phone1Country stringfalsedefault 
phone1Area stringfalsedefault 
phone1Number stringfalsedefault 
phone1Notes stringfalsedefault 
phone2Label stringfalseadditional 
phone2Country stringfalseadditional 
phone2Area stringfalseadditional 
phone2Number stringfalseadditional 
phone2Notes stringfalseadditional 
phone3Label stringfalseadditional 
phone3Country stringfalseadditional 
phone3Area stringfalseadditional 
phone3Number stringfalseadditional 
phone3Notes stringfalseadditional 
phone4Label stringfalseadditional 
phone4Country stringfalseadditional 
phone4Area stringfalseadditional 
phone4Number stringfalseadditional 
phone4Notes stringfalseadditional 
fax stringfalseadditional 
sms stringfalseadditional 
email stringfalsedefault 
website stringfalseadditional 
occupation stringfalseadditional 
taxNumber stringfalseadditional 
birthTimestamp timestampfalsedefault 
deathTimestamp timestampfalseadditional 
maritalStatus stringfalsedefault 
gender stringtruedefault 
emailFormat stringfalseadditional 
notificationMethod stringfalseadditional 
isNewsletterSubscriber booleanfalseadditional 
modifiedTimestamp timestampfalseadditional 
createdTimestamp timestampfalseadditional 
division stringtruelink 
billingPreference stringfalselink 

 

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
  • GET timerecords
  • POST timerecords
  • PUT timerecords
  • DELETE timerecords
  • No labels