Create Record

Creates a new, full record in Civic Platform. The Create Record API triggers the business rules engine event ApplicationSubmitAfter.

Note: The Create Record API does not include custom forms and custom tables in the request body. To add or update custom forms and custom tables, use the Update Record Custom Forms and Update Record Custom Tables after the Create Record request.

Resource Information

Scoperecords

Deprecated scope name:   create_record
App Type All
Authorization Type Access token
URI /v4/records?lang={lang}&fields={fields}
HTTP Method POST
Automation Version(s) 7.3.2

Request Information

Field or Parameter Type Required Values Description Automation Version
fields string No   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
lang String No   Indicates the language applied. 7.3.2
actualProductionUnit double No   Actual cost per production unit. 7.3.2
addresses[] addresses{} No   Contains one or more address information 7.3.2
addresses.addressLine1 string No   The first line of the address. 7.3.2
addresses.addressLine2 string No   The second line of the address. 7.3.2
addresses.addressTypeFlag addresses.addressTypeFlag{} No Get All Address Unit Types The current status of the address record. 7.3.2
addresses.addressTypeFlag.text string No   The localized display text. 7.3.2
addresses.addressTypeFlag.value string No   The value for the specified parameter. 7.3.2
addresses.city string No   The name of the city. 7.3.2
addresses.country addresses.country{} No Get All Address Countries The name of the country. 7.3.2
addresses.country.text string No   The localized display text. 7.3.2
addresses.country.value string No   The value for the specified parameter. 7.3.2
addresses.county string No   The name of the county. 7.3.2
addresses.description string No   The description of the record or item. 7.3.2
addresses.direction addresses.direction{} No Get All Address Street Directions The street direction of the primary address associated with the application. 7.3.2
addresses.direction.text string No   The localized display text. 7.3.2
addresses.direction.value string No   The value for the specified parameter. 7.3.2
addresses.distance double No   The distance from another landmark used to locate the address. 7.3.2
addresses.houseAlphaEnd string No   The ending street number that makes up the address. 7.3.2
addresses.houseAlphaStart string No   The beginning street number that makes up the address. 7.3.2
addresses.houseFractionEnd addresses.houseFractionEnd{} No Get All Address Street Fractions Used in combination with the Street # fields. 7.3.2
addresses.houseFractionEnd.text string No   The localized display text. 7.3.2
addresses.houseFractionEnd.value string No   The value for the specified parameter. 7.3.2
addresses.houseFractionStart addresses.houseFractionStart{} No Get All Address Street Fractions Used In combination with the Street # fields. 7.3.2
addresses.houseFractionStart.text string No   The localized display text. 7.3.2
addresses.houseFractionStart.value string No   The value for the specified parameter. 7.3.2
addresses.id long No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
addresses.inspectionDistrict string No   The inspection district where the address is located. 7.3.2
addresses.inspectionDistrictPrefix string No   The prefix for the inspection district where the address is located. 7.3.2
addresses.isPrimary string No Y | N Indicates whether or not to designate the address as the primary address. Only one address can be primary at any given time. 7.3.2
addresses.levelEnd string No   The ending level number (floor number) that makes up the address within a complex. 7.3.2
addresses.levelPrefix string No   The prefix for the level numbers (floor numbers) that make up the address. 7.3.2
addresses.levelStart string No   The beginning level number (floor number) that makes up the address within a complex. 7.3.2
addresses.neighborhood string No   The neighborhood where the address is located. 7.3.2
addresses.neighborhoodPrefix string No   The prefix for the neighborhood where the address is located. 7.3.2
addresses.postalCode string No   The postal ZIP code for the address. 7.3.2
addresses.recordId addresses.recordId{} No Get All Records Search Records Get My Records The unique ID associated with a record. 7.3.2
addresses.recordId.customId string No   An 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
addresses.recordId.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
addresses.recordId.serviceProviderCode string No   The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
addresses.recordId.trackingId long No   The application tracking number (IVR tracking number). 7.3.2
addresses.recordId.value string No   The value for the specified parameter. 7.3.2
addresses.refAddressId long No   The unique Id generated for an address stored in the system. 7.3.2
addresses.secondaryStreet string No   This field (along with the Secondary Road Number field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location. 7.3.2
addresses.secondaryStreetNumber long No   This field (along with the Secondary Road field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location. 7.3.2
addresses.serviceProviderCode string No   The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
addresses.state addresses.state{} No Get All Address States The state corresponding to the address on record. 7.3.2
addresses.state.text string No   The localized display text. 7.3.2
addresses.state.value string No   The value for the specified parameter. 7.3.2
addresses.status addresses.status{} No A | I The address status indicating whether the address is active or inactive. 7.3.2
addresses.status.text string No   The localized display text. 7.3.2
addresses.status.value string No   The value for the specified parameter. 7.3.2
addresses.streetAddress string No   The street address. 7.3.2
addresses.streetEnd long No   The end of a range of street numbers. 7.3.2
addresses.streetEndFrom long No   The start of the street End range. 7.3.2
addresses.streetEndTo long No   The last of the street End range. 7.3.2
addresses.streetName string No   The street name for the address. 7.3.2
addresses.streetPrefix string No   Any part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix. 7.3.2
addresses.streetStart long No   The start of a range of street numbers. 7.3.2
addresses.streetStartFrom long No   The first of the street start range. 7.3.2
addresses.streetStartTo long No   The last of the street start range. 7.3.2
addresses.streetSuffix addresses.streetSuffix{} No Get All Address Street Suffixes The type of street such as "Lane" or "Boulevard". 7.3.2
addresses.streetSuffix.text string No   The localized display text. 7.3.2
addresses.streetSuffix.value string No   The value for the specified parameter. 7.3.2
addresses.streetSuffixDirection addresses.streetSuffixDirection{} No Get All Address Street Directions The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction. 7.3.2
addresses.streetSuffixDirection.text string No   The localized display text. 7.3.2
addresses.streetSuffixDirection.value string No   The value for the specified parameter. 7.3.2
addresses.type addresses.type{} No Get All Address Unit Types The address type. 7.3.2
addresses.type.text string No   The localized display text. 7.3.2
addresses.type.value string No   The value for the specified parameter. 7.3.2
addresses.unitEnd string No   The end parameter of a range of unit numbers. 7.3.2
addresses.unitStart string No   The starting parameter of a range of unit numbers. 7.3.2
addresses.unitType addresses.unitType{} No Get All Address Unit Types The unit type designation of the address. 7.3.2
addresses.unitType.text string No   The localized display text. 7.3.2
addresses.unitType.value string No   The value for the specified parameter. 7.3.2
addresses.xCoordinate double No   The longitudinal coordinate for this address. 7.3.2
addresses.yCoordinate double No   The latitudinal coordinate for this address. 7.3.2
appearanceDate dateTime No   The date for a hearing appearance. 7.3.2
appearanceDayOfWeek string No   The day for a hearing appearance. 7.3.2
assignedDate dateTime No   The date of the assigned action. 7.3.2
assignedToDepartment string No Get All Departments The department responsible for the action. 7.3.2
assignedUser string No   The staff member responsible for the action. 7.3.2
booking Boolean No true | false Indicates whether or not there was a booking in addition to a citation. 7.3.2
closedByDepartment string No Get All Departments The department responsible for closure. 7.3.2
closedByUser string No   The staff member responsible for closure. 7.3.2
closedDate dateTime No   The closure date. 7.3.2
completedByDepartment string No Get All Departments The department responsible for completion. 7.3.2
completedByUser string No   The staff member responsible for completion. 7.3.2
completedDate dateTime No   The date of completion. 7.3.2
constructionType constructionType{} No Get All Record Construction Types The US Census Bureau construction type code. 7.3.2
constructionType.text string No   The localized display text. 7.3.2
constructionType.value string No   The value for the specified parameter. 7.3.2
contacts[] contacts{} No   An array of contact information. 7.3.2
contacts.address contacts.address{} No   The address of the subject. 7.3.2
contacts.address.addressLine1 string No   The first line of the address. 7.3.2
contacts.address.addressLine2 string No   The second line of the address. 7.3.2
contacts.address.addressLine3 string No   The third line of the address. 7.3.2
contacts.address.city string No   The name of the city. 7.3.2
contacts.address.country contacts.address.country{} No Get All Address Countries The name of the country. 7.3.2
contacts.address.country.text string No   The localized display text. 7.3.2
contacts.address.country.value string No   The value for the specified parameter. 7.3.2
contacts.address.postalCode string No   The postal ZIP code for the address. 7.3.2
contacts.address.state contacts.address.state{} No Get All Address States The state corresponding to the address on record. 7.3.2
contacts.address.state.text string No   The localized display text. 7.3.2
contacts.address.state.value string No   The value for the specified parameter. 7.3.2
contacts.birthCity contacts.birthCity{} No   The city of birth for an individual. 7.3.2
contacts.birthCity.text string No   The localized display text. 7.3.2
contacts.birthCity.value string No   The value for the specified parameter. 7.3.2
contacts.birthDate dateTime No   The birth date of an individual. 7.3.2
contacts.birthRegion contacts.birthRegion{} No   The country of birth or region of birth for an individual. 7.3.2
contacts.birthRegion.text string No   The localized display text. 7.3.2
contacts.birthRegion.value string No   The value for the specified parameter. 7.3.2
contacts.birthState contacts.birthState{} No Get All Address States The state of birth for an individual. 7.3.2
contacts.birthState.text string No   The localized display text. 7.3.2
contacts.birthState.value string No   The value for the specified parameter. 7.3.2
contacts.businessName string No   A secondary business name for the applicable individual. 7.3.2
contacts.comment string No   Comments or notes about the current context. 7.3.2
contacts.deceasedDate dateTime No   The date of death. This field is active only when the Contact Type selected is Individual. 7.3.2
contacts.driverLicenseNumber string No   The driver's license number of the contact. This field is active only when the Contact Type selected is Individual. 7.3.2
contacts.driverLicenseState contacts.driverLicenseState{} No Get All Address States The state that issued the driver's license. 7.3.2
contacts.driverLicenseState.text string No   The localized display text. 7.3.2
contacts.driverLicenseState.value string No   The value for the specified parameter. 7.3.2
contacts.email string No   The contact's email address. 7.3.2
contacts.endDate dateTime No   The date when the contact address ceases to be active. 7.3.2
contacts.fax string No   The fax number for the contact. 7.3.2
contacts.faxCountryCode string No   Fax Number Country Code 7.3.2
contacts.federalEmployerId string No   The Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
contacts.firstName string No   The contact's first name. This field is only active when the Contact Type selected is Individual. 7.3.2
contacts.fullName string No   The contact's full name. This field is only active when the Contact Type selected is Individual. 7.3.2
contacts.gender contacts.gender{} No   The gender (male or female) of the individual. 7.3.2
contacts.gender.text string No   The localized display text. 7.3.2
contacts.gender.value string No   The value for the specified parameter. 7.3.2
contacts.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
contacts.individualOrOrganization string No   The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization. 7.3.2
contacts.isPrimary string No Y | N Indicates whether or not to designate the contact as the primary contact Only one address can be primary at any given time. 7.3.2
contacts.lastName string No   The last name (surname). 7.3.2
contacts.middleName string No   The middle name. 7.3.2
contacts.organizationName string No   The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization. 7.3.2
contacts.passportNumber string No   The contact's passport number. This field is only active when the Contact Type selected is Individual. 7.3.2
contacts.phone1 string No   The primary telephone number of the contact. 7.3.2
contacts.phone1CountryCode string No   Phone Number 1 Country Code 7.3.2
contacts.phone2 string No   The secondary telephone number of the contact. 7.3.2
contacts.phone2CountryCode string No   Phone Number 2 Country Code 7.3.2
contacts.phone3 string No   The tertiary telephone number for the contact. 7.3.2
contacts.phone3CountryCode string No   Phone Number 3 Country Code 7.3.2
contacts.postOfficeBox string No   The post office box number. 7.3.2
contacts.preferredChannel contacts.preferredChannel{} No Get All Contact Preferred Channels The method by which the contact prefers to be notified, by phone for example. 7.3.2
contacts.preferredChannel.text string No   The localized display text. 7.3.2
contacts.preferredChannel.value string No   The value for the specified parameter. 7.3.2
contacts.race contacts.race{} No Get All Contact Races The contact's race/ethnicity. 7.3.2
contacts.race.text string No   The localized display text. 7.3.2
contacts.race.value string No   The value for the specified parameter. 7.3.2
contacts.recordId contacts.recordId{} No Get All Records Search Records Get My Records The unique ID associated with a record. 7.3.2
contacts.recordId.customId string No   An 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
contacts.recordId.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
contacts.recordId.serviceProviderCode string No   The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
contacts.recordId.trackingId long No   The application tracking number (IVR tracking number). 7.3.2
contacts.recordId.value string No   The value for the specified parameter. 7.3.2
contacts.referenceContactId string No   The unique Id generated for a contact stored in the sytem. 7.3.2
contacts.relation contacts.relation{} No   The contact's relationship to the application or service request. 7.3.2
contacts.relation.text string No   The localized display text. 7.3.2
contacts.relation.value string No   The value for the specified parameter. 7.3.2
contacts.salutation contacts.salutation{} No Get All Contact Salutations 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
contacts.salutation.text string No   The localized display text. 7.3.2
contacts.salutation.value string No   The value for the specified parameter. 7.3.2
contacts.socialSecurityNumber string No   The individual's social security number. This field is only active when the Contact Type selected is Individual. 7.3.2
contacts.startDate dateTime No   The date the contact became active. 7.3.2
contacts.stateIdNumber string No   The contact's state ID number. This field is only active when the Contact Type selected is Individual. 7.3.2
contacts.status contacts.status{} No   The contact status. 7.3.2
contacts.status.text string No   The localized display text. 7.3.2
contacts.status.value string No   The value for the specified parameter. 7.3.2
contacts.suffix string No   The contact name suffix. 7.3.2
contacts.title string No   The individual's business title. 7.3.2
contacts.tradeName string No   The contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization. 7.3.2
contacts.type contacts.type{} No Get All Contact Types The contact type. 7.3.2
contacts.type.text string No   The localized display text. 7.3.2
contacts.type.value string No   The value for the specified parameter. 7.3.2
costPerUnit double No   The cost for one unit. 7.3.2
createdBy string No   The unique user id of the individual that created the entry. 7.3.2
customId string No   An 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
defendantSignature Boolean No true | false Indicates whether or not a defendant's signature has been obtained. 7.3.2
description string No   The description of the record or item. 7.3.2
enforceDepartment string No Get All Departments The name of the department responsible for enforcement. 7.3.2
enforceUser string No   Name of the enforcement officer. 7.3.2
enforceUserId string No   ID number of the enforcement officer. 7.3.2
estimatedCostPerUnit double No   The estimated cost per unit. 7.3.2
estimatedDueDate dateTime No   The estimated date of completion. 7.3.2
estimatedProductionUnit double No   The estimated number of production units. 7.3.2
estimatedTotalJobCost double No   The estimated cost of the job. 7.3.2
firstIssuedDate dateTime No   The first issued date for license. 7.3.2
housingUnits long No   The number of housing units. 7.3.2
id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
infraction Boolean No true | false Indicates whether or not an infraction occurred. 7.3.2
inPossessionTime double No   The application level in possession time of the time tracking feature. 7.3.2
inspectorDepartment string No Get All Departments The name of the department where the inspector works. 7.3.2
inspectorId string No Get All Inspectors The ID number of the inspector. 7.3.2
inspectorName string No Get All Inspectors The name of the inspector. 7.3.2
jobValue double No   The value of the job. 7.3.2
misdemeanor Boolean No true | false Indicates whether or not a misdemeanor occurred. 7.3.2
module string No Get All Modules Use to filter by the module. 7.3.2
name string No   The full name for the application contact. 7.3.2
numberOfBuildings long No   The number of buildings. 7.3.2
offenseWitnessed Boolean No true | false Indicates whether or not there was a witness to the alleged offense. 7.3.2
owners[] owners{} No   Contains the fields that define an owner. 7.3.2
owners.email string No   The contact's email address. 7.3.2
owners.fax string No   The fax number for the contact. 7.3.2
owners.firstName string No   The contact's first name. This field is only active when the Contact Type selected is Individual. 7.3.2
owners.fullName string No   The contact's full name. This field is only active when the Contact Type selected is Individual. 7.3.2
owners.id long No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
owners.isPrimary string No Y | N Indicates whether or not to designate the owner as the primary owner. 7.3.2
owners.lastName string No   The last name (surname). 7.3.2
owners.mailAddress owners.mailAddress{} No   Contains the fields that define an owner's address. 7.3.2
owners.mailAddress.addressLine1 string No   The first line of the address. 7.3.2
owners.mailAddress.addressLine2 string No   The second line of the address. 7.3.2
owners.mailAddress.addressLine3 string No   The third line of the address. 7.3.2
owners.mailAddress.city string No   The name of the city. 7.3.2
owners.mailAddress.country owners.mailAddress.country{} No Get All Address Countries The name of the country. 7.3.2
owners.mailAddress.country.text string No   The localized display text. 7.3.2
owners.mailAddress.country.value string No   The value for the specified parameter. 7.3.2
owners.mailAddress.postalCode string No   The postal ZIP code for the address. 7.3.2
owners.mailAddress.state owners.mailAddress.state{} No Get All Address States The state corresponding to the address on record. 7.3.2
owners.mailAddress.state.text string No   The localized display text. 7.3.2
owners.mailAddress.state.value string No   The value for the specified parameter. 7.3.2
owners.middleName string No   The middle name. 7.3.2
owners.phone string No   The telephone number of the user. 7.3.2
owners.recordId owners.recordId{} No Get All Records Search Records Get My Records The unique ID associated with a record. 7.3.2
owners.recordId.customId string No   An 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
owners.recordId.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
owners.recordId.serviceProviderCode string No   The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
owners.recordId.trackingId long No   The application tracking number (IVR tracking number). 7.3.2
owners.recordId.value string No   The value for the specified parameter. 7.3.2
owners.refOwnerId double No   The unique Id generated for an owner stored in the system. 7.3.2
owners.status owners.status{} No   The owner status. 7.3.2
owners.status.text string No   The localized display text. 7.3.2
owners.status.value string No   The value for the specified parameter. 7.3.2
owners.taxId string No   The owner's tax ID number. 7.3.2
owners.title string No   The individual's business title. 7.3.2
owners.type string No   The owner type. 7.3.2
parcels[] parcels{} No   Contains fields that define a parcel. 7.3.2
parcels.block string No   The block number associated with the parcel. 7.3.2
parcels.book string No   A reference to the physical location of parcel information in the County Assessor's office. 7.3.2
parcels.censusTract string No   The unique number assigned by the Census Bureau that identifies the tract to which this parcel belongs. 7.3.2
parcels.councilDistrict string No   The council district to which the parcel belongs. 7.3.2
parcels.exemptionValue double No   The total value of any tax exemptions that apply to the land within the parcel. 7.3.2
parcels.gisSequenceNumber long No   This is the ID number that you use to identify the parcel in Geographic Information Systems (GIS). 7.3.2
parcels.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
parcels.improvedValue double No   This is the total value of any improvements to the land within the parcel. 7.3.2
parcels.isPrimary string No Y | N Indicates whether or not to designate the parcel as the primary parcel. 7.3.2
parcels.landValue double No   This is the total value of the land within the parcel. 7.3.2
parcels.legalDescription string No   The legal description of the parcel. 7.3.2
parcels.lot string No   This is the lot name. 7.3.2
parcels.mapNumber string No   The unique map number that identifies the map for this parcel. 7.3.2
parcels.mapReferenceInfo string No   The reference to where the map for this parcel exists. 7.3.2
parcels.page string No   A reference to the physical location of the parcel information in the records of the County Assessor (or other responsible department). 7.3.2
parcels.parcel string No   The official parcel name or number, as determined by the county assessor or other responsible department. 7.3.2
parcels.parcelArea double No   The total area of the parcel. Your agency determines the standard unit of measure. 7.3.2
parcels.parcelNumber string No   The localized display text. 7.3.2
parcels.planArea string No   The total area of the parcel. Your agency determines the standard unit of measure. 7.3.2
parcels.range string No   When land is surveyed using the rectangular-survey system, range represents the measure of units east and west of the base line. 7.3.2
parcels.section long No   A piece of a township measuring 640 acres, one square mile, numbered with reference to the base line and meridian line. 7.3.2
parcels.status parcels.status{} No   The parcel status. 7.3.2
parcels.status.text string No   The localized display text. 7.3.2
parcels.status.value string No   The value for the specified parameter. 7.3.2
parcels.subdivision parcels.subdivision{} No   The name of the subdivision. 7.3.2
parcels.subdivision.text string No   The localized display text. 7.3.2
parcels.subdivision.value string No   The value for the specified parameter. 7.3.2
parcels.supervisorDistrict string No   The supervisor district to which the parcel belongs. 7.3.2
parcels.township string No   When land is surveyed using the rectangular-survey system, township represents the measure of units North or South of the base line. Townships typically measure 6 miles to a side, or 36 square miles. 7.3.2
parcels.tract string No   The name of the tract associated with this application. A tract may contain one or more related parcels. 7.3.2
priority priority{} No Get All Priorities The priority level assigned to the record. 7.3.2
priority.text string No   The localized display text. 7.3.2
priority.value string No   The value for the specified parameter. 7.3.2
professionals[] professionals{} No   Contains the fields that define a licensed professional. 7.3.2
professionals.addressLine1 string No   The first line of the address. 7.3.2
professionals.addressLine2 string No   The second line of the address. 7.3.2
professionals.addressLine3 string No   The third line of the address. 7.3.2
professionals.birthDate dateTime No   The birth date of an individual. 7.3.2
professionals.businessLicense string No   The 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
professionals.businessName string No   A secondary business name for the applicable individual. 7.3.2
professionals.businessName2 string No   A secondary business name for the applicable individual. 7.3.2
professionals.city string No   The name of the city. 7.3.2
professionals.comment string No   Comments or notes about the current context. 7.3.2
professionals.country professionals.country{} No Get All Address Countries The name of the country. 7.3.2
professionals.country.text string No   The localized display text. 7.3.2
professionals.country.value string No   The value for the specified parameter. 7.3.2
professionals.email string No   The contact's email address. 7.3.2
professionals.expirationDate dateTime No   The date when the condition expires. 7.3.2
professionals.fax string No   The fax number for the contact. 7.3.2
professionals.federalEmployerId string No   The Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
professionals.firstName string No   The contact's first name. This field is only active when the Contact Type selected is Individual. 7.3.2
professionals.fullName string No   The contact's full name. This field is only active when the Contact Type selected is Individual. 7.3.2
professionals.gender professionals.gender{} No   The gender (male or female) of the individual. 7.3.2
professionals.gender.text string No   The localized display text. 7.3.2
professionals.gender.value string No   The value for the specified parameter. 7.3.2
professionals.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
professionals.isPrimary string No Y | N Indicates whether or not to designate the professional as the primary professional. 7.3.2
professionals.lastName string No   The last name (surname). 7.3.2
professionals.lastRenewalDate dateTime No   The last date for a professionals renewal license. 7.3.2
professionals.licenseNumber string No   This is the license number for the contact. 7.3.2
professionals.licenseType professionals.licenseType{} No Get All Professional License Types The type of license held by the professional. 7.3.2
professionals.licenseType.text string No   The localized display text. 7.3.2
professionals.licenseType.value string No   The value for the specified parameter. 7.3.2
professionals.licensingBoard professionals.licensingBoard{} No Get All Professional License Boards The name of the licensing board that issued the license. 7.3.2
professionals.licensingBoard.text string No   The localized display text. 7.3.2
professionals.licensingBoard.value string No   The value for the specified parameter. 7.3.2
professionals.middleName string No   The middle name. 7.3.2
professionals.originalIssueDate dateTime No   The original issuance date of license. 7.3.2
professionals.phone1 string No   The primary telephone number of the contact. 7.3.2
professionals.phone2 string No   The secondary telephone number of the contact. 7.3.2
professionals.phone3 string No   The tertiary telephone number for the contact. 7.3.2
professionals.postalCode string No   The postal ZIP code for the address. 7.3.2
professionals.postOfficeBox string No   The post office box number. 7.3.2
professionals.recordId professionals.recordId{} No Get All Records Search Records Get My Records The unique ID associated with a record. 7.3.2
professionals.recordId.customId string No   An 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
professionals.recordId.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
professionals.recordId.serviceProviderCode string No   The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
professionals.recordId.trackingId long No   The application tracking number (IVR tracking number). 7.3.2
professionals.recordId.value string No   The value for the specified parameter. 7.3.2
professionals.referenceLicenseId string No   The unique Id generated for a professional stored in the system. 7.3.2
professionals.salutation professionals.salutation{} No Get All Contact Salutations 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
professionals.salutation.text string No   The localized display text. 7.3.2
professionals.salutation.value string No   The value for the specified parameter. 7.3.2
professionals.serviceProviderCode string No   The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
professionals.state professionals.state{} No Get All Address States The state corresponding to the address on record. 7.3.2
professionals.state.text string No   The localized display text. 7.3.2
professionals.state.value string No   The value for the specified parameter. 7.3.2
professionals.suffix string No   The contact name suffix. 7.3.2
professionals.title string No   The individual's business title. 7.3.2
publicOwned Boolean No true | false Indicates whether or not the public owns the item. 7.3.2
recordClass string No   General information about the record. 7.3.2
renewalInfo renewalInfo{} No   Defines the parameters related to renewal of a record. 7.3.2
renewalInfo.expirationDate dateTime No   The date when the condition expires. 7.3.2
renewalInfo.expirationStatus renewalInfo.expirationStatus{} No Get All Record Expiration Statuses Indicates whether the expiration is enabled or disabled. 7.3.2
renewalInfo.expirationStatus.text string No   The localized display text. 7.3.2
renewalInfo.expirationStatus.value string No   The value for the specified parameter. 7.3.2
reportedChannel reportedChannel{} No   The incoming channel through which the applicant submitted the application. 7.3.2
reportedChannel.text string No   The localized display text. 7.3.2
reportedChannel.value string No   The value for the specified parameter. 7.3.2
reportedType reportedType{} No   The type of complaint or incident being reported. 7.3.2
reportedType.text string No   The localized display text. 7.3.2
reportedType.value string No   The value for the specified parameter. 7.3.2
scheduledDate dateTime No   The date when the inspection gets scheduled. 7.3.2
severity severity{} No   Indicates the severity of the condition. 7.3.2
severity.text string No   The localized display text. 7.3.2
severity.value string No   The value for the specified parameter. 7.3.2
shortNotes string No   A brief note about the record subject. 7.3.2
status status{} No   The record status. 7.3.2
status.text string No   The localized display text. 7.3.2
status.value string No   The value for the specified parameter. 7.3.2
statusReason statusReason{} No   The reason for the status setting on the record. 7.3.2
statusReason.text string No   The localized display text. 7.3.2
statusReason.value string No   The value for the specified parameter. 7.3.2
totalJobCost double No   The combination of work order assignments (labor) and costs. 7.3.2
type type{} No   The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.alias string No   The record type alias. 7.3.2
type.category string No   The 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.filterName string No   The name of the record type filter which defines the record types to be displayed for the citizen user. 7.3.2
type.group string No   The 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
type.module string No Get All Modules Use to filter by the module. 7.3.2
type.subType string No   The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.text string No   The localized display text. 7.3.2
type.type string No   The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.value string No   The value for the specified parameter. 7.3.2
undistributedCost double No   The undistributed costs for this work order. 7.3.2

Example

Sample Request Head

                    POST https://apis.accela.com/v4/records

Sample Request Body

{
  "type": {
    "id": "Building-Residential-Alteration-NA"
  },
  "description": "Residence alteration",
  "parcels": [
    {
      "parcelNumber": "005020018"
    }
  ],
  "professionals": [
    {
      "businessName": "Acme Professionals",
      "addressLine1": "123 Main Street",
      "city": "Pleasanton",
      "postalCode": "94588"
    }
  ],
  "addresses": [
    {
      "isPrimary": "Y",
      "streetName": "123 Main Street",
      "city": "Pleasanton",
      "postalCode": "94588",
      "state": {
        "value": "CA",
        "text": "CA"
      }
    }
  ],
  "contacts": [
    {
      "isPrimary": "Y",
      "fullName": "Joe Smith",
      "email": "jsmith@email.com",
      "firstName": "Joe",
      "lastName": "Smith",
      "phone3": "925.123.4568",
      "status": {
        "value": "A",
        "text": "Active"
      },
      "type": {
        "value": "Contractor",
        "text": "Contractor"
      }
    }
  ]
}

Response Information

Field Type Description Automation Version
result result{}   7.3.2
result.actualProductionUnit double Estimated cost per production unit. 7.3.2
result.appearanceDate dateTime The date for a hearing appearance. 7.3.2
result.appearanceDayOfWeek string The day for a hearing appearance. 7.3.2
result.assignedDate dateTime The date of the assigned action. 7.3.2
result.assignedToDepartment string The department responsible for the action. 7.3.2
result.assignedUser string The staff member responsible for the action. 7.3.2
result.balance Double The balance of the account. 7.3.2
result.booking Boolean Indicates whether or not there was a booking in addition to a citation. 7.3.2
result.closedByDepartment string The department responsible for closure. 7.3.2
result.closedByUser string The staff member responsible for closure. 7.3.2
result.closedDate dateTime The closure date. 7.3.2
result.completedByDepartment string The department responsible for completion. 7.3.2
result.completedByUser string The staff member responsible for completion. 7.3.2
result.completedDate dateTime The date of completion. 7.3.2
result.constructionType result.constructionType{} The US Census Bureau construction type code. 7.3.2
result.constructionType.text string The localized display text. 7.3.2
result.constructionType.value string The value for the specified parameter. 7.3.2
result.costPerUnit double The cost for one unit. 7.3.2
result.createdBy string The unique user id of the individual that created the entry. 7.3.2
result.createdByCloning string Indictes whether or not the record was cloned. 7.3.2
result.customId string An 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.defendantSignature Boolean Indicates whether or not a defendant's signature has been obtained. 7.3.2
result.description string The description of the record or item. 7.3.2
result.enforceDepartment string The name of the department responsible for enforcement. 7.3.2
result.enforceUser string Name of the enforcement officer. 7.3.2
result.enforceUserId string ID number of the enforcement officer. 7.3.2
result.estimatedCostPerUnit double The estimated cost per unit. 7.3.2
result.estimatedDueDate dateTime The estimated date of completion. 7.3.2
result.estimatedProductionUnit double The estimated number of production units. 7.3.2
result.estimatedTotalJobCost double The estimated cost of the job. 7.3.2
result.firstIssuedDate dateTime The first issued date for license. 7.3.2
result.housingUnits long The number of housing units. 7.3.2
result.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.infraction Boolean This defines whether or not an infraction occurred. 7.3.2
result.initiatedProduct string The Accela Automation product area where the application is submitted: "AA" : Classic Accela Automation. "ACA" : Accela Citizen Access. "AIVR" : Accela Integrated Voice Response. "AMO" : Accela Mobile Office. "AV360" : Accela Asset Management, Accela Land Man. 7.3.2
result.inPossessionTime double The application level in possession time of the time tracking feature. 7.3.2
result.inspectorDepartment string The name of the department where the inspector works. 7.3.2
result.inspectorId string The ID number of the inspector. 7.3.2
result.inspectorName string The name of the inspector. 7.3.2
result.jobValue double The value of the job. 7.3.2
result.misdemeanor Boolean Indicates whether or not a misdemeanor occurred. 7.3.2
result.module string Use to filter by the module. 7.3.2
result.name string The full name for the application contact. 7.3.2
result.numberOfBuildings long The number of buildings. 7.3.2
result.offenseWitnessed Boolean Indicates whether or not there was a witness to the alleged offense. 7.3.2
result.openedDate dateTime The date when the system created the record. 7.3.2
result.overallApplicationTime double The amount of elapsed time from the time tracking start date to the completion of the application. 7.3.2
result.priority result.priority{} The priority level assigned to the record. 7.3.2
result.priority.text string The localized display text. 7.3.2
result.priority.value string The value for the specified parameter. 7.3.2
result.publicOwned Boolean A flag that indicates whether or not the public owns the item. 7.3.2
result.recordClass string General information about the record. 7.3.2
result.renewalInfo result.renewalInfo{} Defines the parameters related to renewal of a record. 7.3.2
result.renewalInfo.expirationDate dateTime The date when the condition expires. 7.3.2
result.renewalInfo.expirationStatus result.renewalInfo.expirationStatus{} Indicates whether the expiration is enabled or disabled. 7.3.2
result.renewalInfo.expirationStatus.text string The localized display text. 7.3.2
result.renewalInfo.expirationStatus.value string The value for the specified parameter. 7.3.2
result.reportedChannel result.reportedChannel{} The incoming channel through which the applicant submitted the application. 7.3.2
result.reportedChannel.text string The localized display text. 7.3.2
result.reportedChannel.value string The value for the specified parameter. 7.3.2
result.reportedDate dateTime The date when a complaint or incident is reported. 7.3.2
result.reportedType result.reportedType{} The type of complaint or incident being reported. 7.3.2
result.reportedType.text string The localized display text. 7.3.2
result.reportedType.value string The value for the specified parameter. 7.3.2
result.scheduledDate dateTime The date when the inspection gets scheduled. 7.3.2
result.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
result.severity result.severity{} Indicates the severity of the condition. 7.3.2
result.severity.text string The localized display text. 7.3.2
result.severity.value string The value for the specified parameter. 7.3.2
result.shortNotes string A brief note about the record subject. 7.3.2
result.status result.status{} The record status. 7.3.2
result.status.text string The localized display text. 7.3.2
result.status.value string The value for the specified parameter. 7.3.2
result.statusDate dateTime The date when the current status changed. 7.3.2
result.statusReason result.statusReason{} The reason for the status setting on the record. 7.3.2
result.statusReason.text string The localized display text. 7.3.2
result.statusReason.value string The value for the specified parameter. 7.3.2
result.totalFee Double The total amount of the fees invoiced to the record. 7.3.2
result.totalJobCost double The combination of work order assignments (labor) and costs. 7.3.2
result.totalPay Double The total amount of pay. 7.3.2
result.trackingId long The application tracking number (IVR tracking number). 7.3.2
result.type result.type{} The record type. If this type field is within the record type definition, it specifies the 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.alias string The record type alias. 7.3.2
result.type.category string The 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.filterName string The name of the record type filter which defines the record types to be displayed for the citizen user. 7.3.2
result.type.group string The 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.type.module string Use to filter by the module. 7.3.2
result.type.subType string The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.text string The localized display text. 7.3.2
result.type.type string The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.value string The value for the specified parameter. 7.3.2
result.undistributedCost double The undistributed costs for this work order. 7.3.2
result.value string The value for the specified parameter. 7.3.2
status integer The record status. 7.3.3

Example

Sample Response Body

{
  "status": 200,
  "result": {
    "id": "ISLANDTON-14CAP-00000-000I4",
    "type": {
      "module": "Building",
      "type": "Residential",
      "value": "Building/Residential/Alteration/NA",
      "group": "Building",
      "category": "NA",
      "text": "Residential Alteration",
      "subType": "Alteration",
      "id": "Building-Residential-Alteration-NA"
    },
    "status": {
      "value": "Submitted",
      "text": "Submitted"
    },
    "description": "Residence alteration",
    "createdBy": "DEVELOPER",
    "serviceProviderCode": "ISLANDTON",
    "statusDate": "2014-10-15 14:46:49",
    "module": "Building",
    "customId": "BLD14-00255",
    "initiatedProduct": "AV360",
    "recordClass": "COMPLETE",
    "trackingId": 204387084,
    "value": "14CAP-00000-000I4",
    "totalFee": 0,
    "totalPay": 0,
    "balance": 0,
    "booking": false,
    "infraction": false,
    "misdemeanor": false,
    "offenseWitnessed": false,
    "defendantSignature": false,
    "publicOwned": false
  }
}