Get All Professionals for Record

Gets the professionals for the specified record.

Resource Information

Scoperecords

Deprecated scope name:   get_record_professionals

App TypeAll
Authorization TypeAccess token
URI /v4/records/{recordId}/professionals?lang={lang}&fields={fields}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNo Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.2
langStringNo Indicates the language applied.7.3.2
recordIdstringYes Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.addressLine1stringThe first line of the address. 7.3.2
result.addressLine2stringThe second line of the address.7.3.2
result.addressLine3stringThe third line of the address.7.3.2
result.birthDatedateTimeThe birth date of an individual.7.3.2
result.businessLicensestringThe official business license number issued by an agency. A licensed professional can have the same license number assigned to multiple license types.7.3.2
result.businessNamestringA secondary business name for the applicable individual.7.3.2
result.businessName2stringA secondary business name for the applicable individual.7.3.2
result.citystringThe name of the city.7.3.2
result.commentstringComments or notes about the current context.7.3.2
result.countryresult.country{}The name of the country.7.3.2
result.country.textstringThe localized display text.7.3.2
result.country.valuestringThe value for the specified parameter.7.3.2
result.emailstringThe contact's email address.7.3.2
result.expirationDatedateTimeThe date when the condition expires.7.3.2
result.faxstringThe fax number for the contact.7.3.2
result.federalEmployerIdstringThe Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
result.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
result.fullNamestringThe contact's full name. This field is only active when the Contact Type selected is Individual.7.3.2
result.genderresult.gender{}The gender (male or female) of the individual.7.3.2
result.gender.textstringThe localized display text.7.3.2
result.gender.valuestringThe value for the specified parameter.7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.isPrimarystringIndicates whether or not to designate the professional as the primary professional.7.3.2
result.lastNamestringThe last name (surname). 7.3.2
result.lastRenewalDatedateTimeThe last date for a professionals renewal license.7.3.2
result.licenseNumberstringThis is the license number for the contact.7.3.2
result.licenseTyperesult.licenseType{}The type of license held by the professional.7.3.2
result.licenseType.textstringThe localized display text.7.3.2
result.licenseType.valuestringThe value for the specified parameter.7.3.2
result.licensingBoardresult.licensingBoard{}The name of the licensing board that issued the license. 7.3.2
result.licensingBoard.textstringThe localized display text.7.3.2
result.licensingBoard.valuestringThe value for the specified parameter.7.3.2
result.middleNamestringThe middle name. 7.3.2
result.originalIssueDatedateTimeThe original issuance date of license.7.3.2
result.phone1stringThe primary telephone number of the contact. 7.3.2
result.phone2stringThe secondary telephone number of the contact.7.3.2
result.phone3stringThe tertiary telephone number for the contact.7.3.2
result.postalCodestringThe postal ZIP code for the address.7.3.2
result.postOfficeBoxstringThe post office box number.7.3.2
result.recordIdresult.recordId{}The unique ID associated with a record.7.3.2
result.recordId.customIdstringAn ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.7.3.2
result.recordId.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.recordId.valuestringThe value for the specified parameter.7.3.2
result.referenceLicenseIdstringThe unique Id generated for a professional stored in the system.7.3.2
result.salutationresult.salutation{}The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual.7.3.2
result.salutation.textstringThe localized display text.7.3.2
result.salutation.valuestringThe value for the specified parameter.7.3.2
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.stateresult.state{}The state corresponding to the address on record.7.3.2
result.state.textstringThe localized display text.7.3.2
result.state.valuestringThe value for the specified parameter.7.3.2
result.suffixstringThe contact name suffix.7.3.2
result.titlestringThe individual's business title. 7.3.2
statusintegerThe record status.7.3.3