GET Workers/Address/Initialize
Get empty workerAddress
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EntityID | integer |
None. |
|
| EntityStringName | string |
None. |
|
| EntityName | NameDTO |
None. |
|
| BUID | integer |
None. |
|
| BusinessUnitName | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Empty AddressDTO
AddressDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| AddressID |
The unique identifier for the Address record. |
integer |
None. |
| EntityID |
The unique identifier for the Entity this Address record belongs to. |
integer |
None. |
| AddressTypeEntryID |
The **ID** of the code table entry where TableName is "Address Types", () denoting the type of address of this record. |
integer |
None. |
| StartDateUtc |
The Start Date of the Address record in UTC. |
date |
None. |
| StopDateUtc |
The Stop Date of the Address record in UTC. |
date |
None. |
| Description |
Description given to the Address. |
string |
None. |
| AddressLine1 |
The Address information given on Line 1. |
string |
None. |
| AddressLine2 |
The Address information given on Line 2. |
string |
None. |
| City |
The City where the Address is located. |
string |
None. |
| County |
The County where the Address is located if needed. |
string |
None. |
| ProvinceStateCode |
The Province or State Code where the Address is located. Input from code table entries where TableName is "Provinces/States", (). |
string |
None. |
| PostalZipCode |
The Postal or Zip Code for the Address. |
string |
None. |
| CountryCode |
The Country Code for the Address. Input from code table entries where TableName is "Countries", (). |
string |
None. |
| Directions |
The Directions to the Address if needed. |
string |
None. |
| GeoDataExists |
Whether Geography Data (Latitude, Longitude) exists for the Address record. |
boolean |
None. |
| GeoLatitude |
The Geography Latitude of the Address record, if it exists. |
decimal number |
None. |
| GeoLongitude |
The Geography Longitude of the Address record, if it exists. |
decimal number |
None. |
| GeoProps |
A collection of additional properties for the geography portion of the Address record. |
Collection of Object |
None. |
| SortOrder |
The Sort Order of the Address record for the Entity if more than one exists. |
integer |
None. |
| PartialData |
The value of the PartialData used as the criteria when requesting the Address record. |
PartialDataType |
None. |
| RecordState |
The Record state of the Address record. . |
RecordState |
None. |
| Created |
The audit information for the creation of the record, including the creation date in UTC and the user who created it, . This field is readonly. |
AuditDataDTO |
None. |
| LastUpdated |
The audit information for the last update to the record, including the update date in UTC and the user who made the update, . This field is readonly. |
AuditDataDTO |
None. |
| AddressTypeEntryValue |
The **Value** of the code table entry where TableName is "Address Types", () denoting the type of address of this record. |
string |
None. |
| IsPrimary |
Whether the Address is the primary address for the entity. |
boolean |
None. |
| Summary |
This field is read-only and is automatically set from the summary of the Address lines, city, province/state, and postal/zip code. |
string |
None. |
| SummaryShort |
This field is read-only and is automatically set from the summary of the Address lines and city. |
string |
None. |
| SummaryMasked |
This field is read-only and is automatically set from the summary of the Address lines and city with the numbers removed. |
string |
None. |
| SummaryLink |
This field is read-only and is automatically set from the summary of the Address lines, city, province/state, postal/zip code, and country code in a format to directly link to a mapping provider such as Google maps. |
string |
None. |