Create Record Addresses

Creates new address(es) for the specified record.

Resource Information

Scoperecords

Deprecated scope name:   create_record_addresses

App TypeAll
Authorization TypeAccess token
URI /v4/records/{recordId}/addresses?lang={lang}
HTTP MethodPOST
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
addressLine1stringNoThe first line of the address. 7.3.2
addressLine2stringNoThe second line of the address.7.3.2
addressTypeFlagaddressTypeFlag{}No Get All Address Unit Types The current status of the address record.7.3.2
addressTypeFlag.textstringNoThe localized display text.7.3.2
addressTypeFlag.valuestringNoThe value for the specified parameter.7.3.2
citystringNoThe name of the city.7.3.2
countrycountry{}No Get All Address Countries The name of the country.7.3.2
country.textstringNoThe localized display text.7.3.2
country.valuestringNoThe value for the specified parameter.7.3.2
countystringNoThe name of the county.7.3.2
descriptionstringNoThe description of the record or item.7.3.2
directiondirection{}No Get All Address Street Directions The street direction of the primary address associated with the application.7.3.2
direction.textstringNoThe localized display text.7.3.2
direction.valuestringNoThe value for the specified parameter.7.3.2
distancedoubleNoThe distance from another landmark used to locate the address. 7.3.2
houseAlphaEndstringNoThe ending street number that makes up the address.7.3.2
houseAlphaStartstringNoThe beginning street number that makes up the address.7.3.2
houseFractionEndhouseFractionEnd{}No Get All Address Street Fractions Used in combination with the Street # fields.7.3.2
houseFractionEnd.textstringNoThe localized display text.7.3.2
houseFractionEnd.valuestringNoThe value for the specified parameter.7.3.2
houseFractionStarthouseFractionStart{}No Get All Address Street Fractions Used In combination with the Street # fields.7.3.2
houseFractionStart.textstringNoThe localized display text.7.3.2
houseFractionStart.valuestringNoThe value for the specified parameter.7.3.2
idlongNoThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
inspectionDistrictstringNoThe inspection district where the address is located.7.3.2
inspectionDistrictPrefixstringNoThe prefix for the inspection district where the address is located.7.3.2
isPrimarystringNoY | NIndicates whether or not to designate the address as the primary address. Only one address can be primary at any given time.7.3.2
levelEndstringNoThe ending level number (floor number) that makes up the address within a complex.7.3.2
levelPrefixstringNoThe prefix for the level numbers (floor numbers) that make up the address.7.3.2
levelStartstringNoThe beginning level number (floor number) that makes up the address within a complex.7.3.2
neighborhoodstringNoThe neighborhood where the address is located.7.3.2
neighborhoodPrefixstringNoThe prefix for the neighborhood where the address is located.7.3.2
postalCodestringNoThe postal ZIP code for the address.7.3.2
recordIdrecordId{}No Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2
recordId.customIdstringNoAn 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
recordId.idstringNoThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
recordId.serviceProviderCodestringNoThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
recordId.trackingIdlongNoThe application tracking number (IVR tracking number).7.3.2
recordId.valuestringNoThe value for the specified parameter.7.3.2
refAddressIdlongNoThe unique Id generated for an address stored in the system.7.3.2
secondaryStreetstringNoThis 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
secondaryStreetNumberlongNoThis 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
serviceProviderCodestringNoThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
statestate{}No Get All Address States The state corresponding to the address on record.7.3.2
state.textstringNoThe localized display text.7.3.2
state.valuestringNoThe value for the specified parameter.7.3.2
statusstatus{}NoA | IThe address status indicating whether the address is active or inactive.7.3.2
status.textstringNoThe localized display text.7.3.2
status.valuestringNoThe value for the specified parameter.7.3.2
streetAddressstringNoThe street address. 7.3.2
streetEndlongNoThe end of a range of street numbers.7.3.2
streetEndFromlongNoThe start of the street End range.7.3.2
streetEndTolongNoThe last of the street End range.7.3.2
streetNamestringNoThe street name for the address.7.3.2
streetPrefixstringNoAny 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
streetStartlongNoThe start of a range of street numbers.7.3.2
streetStartFromlongNoThe first of the street start range.7.3.2
streetStartTolongNoThe last of the street start range.7.3.2
streetSuffixstreetSuffix{}No Get All Address Street Suffixes The type of street such as "Lane" or "Boulevard".7.3.2
streetSuffix.textstringNoThe localized display text.7.3.2
streetSuffix.valuestringNoThe value for the specified parameter.7.3.2
streetSuffixDirectionstreetSuffixDirection{}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
streetSuffixDirection.textstringNoThe localized display text.7.3.2
streetSuffixDirection.valuestringNoThe value for the specified parameter.7.3.2
typetype{}No Get All Address Unit Types The address type.7.3.2
type.textstringNoThe localized display text.7.3.2
type.valuestringNoThe value for the specified parameter.7.3.2
unitEndstringNoThe end parameter of a range of unit numbers.7.3.2
unitStartstringNoThe starting parameter of a range of unit numbers.7.3.2
unitTypeunitType{}No Get All Address Unit Types The unit type designation of the address.7.3.2
unitType.textstringNoThe localized display text.7.3.2
unitType.valuestringNoThe value for the specified parameter.7.3.2
xCoordinatedoubleNoThe longitudinal coordinate for this address. 7.3.2
yCoordinatedoubleNoThe latitudinal coordinate for this address. 7.3.2
langStringNoIndicates 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.codestringA code identifying an associated item7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.isSuccessbooleanIndicates whether or not the operation on the item is successful. 7.3.2
result.messagestringA text message related to the operation.7.3.2
statusintegerThe record status.7.3.3