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
addressLine1stringNo The first line of the address. 7.3.2
addressLine2stringNo The 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.textstringNo The localized display text.7.3.2
addressTypeFlag.valuestringNo The value for the specified parameter.7.3.2
citystringNo The name of the city.7.3.2
countrycountry{}No Get All Address Countries The name of the country.7.3.2
country.textstringNo The localized display text.7.3.2
country.valuestringNo The value for the specified parameter.7.3.2
countystringNo The name of the county.7.3.2
descriptionstringNo The 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.textstringNo The localized display text.7.3.2
direction.valuestringNo The value for the specified parameter.7.3.2
distancedoubleNo The distance from another landmark used to locate the address. 7.3.2
houseAlphaEndstringNo The ending street number that makes up the address.7.3.2
houseAlphaStartstringNo The 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.textstringNo The localized display text.7.3.2
houseFractionEnd.valuestringNo The 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.textstringNo The localized display text.7.3.2
houseFractionStart.valuestringNo The value for the specified parameter.7.3.2
idlongNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
inspectionDistrictstringNo The inspection district where the address is located.7.3.2
inspectionDistrictPrefixstringNo The 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
levelEndstringNo The ending level number (floor number) that makes up the address within a complex.7.3.2
levelPrefixstringNo The prefix for the level numbers (floor numbers) that make up the address.7.3.2
levelStartstringNo The beginning level number (floor number) that makes up the address within a complex.7.3.2
neighborhoodstringNo The neighborhood where the address is located.7.3.2
neighborhoodPrefixstringNo The prefix for the neighborhood where the address is located.7.3.2
postalCodestringNo The 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.customIdstringNo 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
recordId.idstringNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
recordId.serviceProviderCodestringNo The unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
recordId.trackingIdlongNo The application tracking number (IVR tracking number).7.3.2
recordId.valuestringNo The value for the specified parameter.7.3.2
refAddressIdlongNo The unique Id generated for an address stored in the system.7.3.2
secondaryStreetstringNo 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
secondaryStreetNumberlongNo 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
serviceProviderCodestringNo The 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.textstringNo The localized display text.7.3.2
state.valuestringNo The 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.textstringNo The localized display text.7.3.2
status.valuestringNo The value for the specified parameter.7.3.2
streetAddressstringNo The street address. 7.3.2
streetEndlongNo The end of a range of street numbers.7.3.2
streetEndFromlongNo The start of the street End range.7.3.2
streetEndTolongNo The last of the street End range.7.3.2
streetNamestringNo The street name for the address.7.3.2
streetPrefixstringNo 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
streetStartlongNo The start of a range of street numbers.7.3.2
streetStartFromlongNo The first of the street start range.7.3.2
streetStartTolongNo The 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.textstringNo The localized display text.7.3.2
streetSuffix.valuestringNo The 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.textstringNo The localized display text.7.3.2
streetSuffixDirection.valuestringNo The value for the specified parameter.7.3.2
typetype{}No Get All Address Unit Types The address type.7.3.2
type.textstringNo The localized display text.7.3.2
type.valuestringNo The value for the specified parameter.7.3.2
unitEndstringNo The end parameter of a range of unit numbers.7.3.2
unitStartstringNo The 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.textstringNo The localized display text.7.3.2
unitType.valuestringNo The value for the specified parameter.7.3.2
xCoordinatedoubleNo The longitudinal coordinate for this address. 7.3.2
yCoordinatedoubleNo The latitudinal coordinate for this address. 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.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