Data returned from endpoints
Arrays, objects, and elements returned from the API
Symmetry Minimum Wage Finder returns minimum wage data for all authority types (for example, state, city, federal, and more) along with the effective date, job type, job function, and other important details that correspond to each rate.
The /mwf/v1/id endpoint supports pagination so metadata about the pagination collection is returned in the response in addition to minimum wage rate data.
Below are the objects returned from these endpoints.
Minimum Wage Rate object
| Element | Type | Description |
|---|---|---|
mwUid | String | Unique wage code for the minimum wage. Please refer to the Client Support Center for additional details on the mwUid. |
state | String | State name that corresponds to stateCode returned. |
stateCode | Number | Two-digit value that represents the state. |
authorityCode | Number | Proprietary code to identify the authority. Please log into the Client Support Center for additional details. |
authority | String | Name of the relevant city or local taxation authority. State and Federal return null. |
authorityType | String | Taxing authority that defines the authorityTypeCode. Values are as follows: Federal, State, County, City, City Metro, Municipal. |
authorityTypeCode | Number | Proprietary value that corresponds to the taxing authority (authorityType). Please refer to the Client Support Center for additional information. |
rate | String | Minimum wage rate. |
effectiveDate | String | Minimum wage effective date. |
majorType | String | Three-character code that represents wage type. Values are as follows: REG (regular), TIP (tipped), EXM (exempt). |
industryType | String | Industry where the wages are earned (e.g., non-profit organization, agriculture, apparel, healthcare, etc.). |
industryTypeCode | Number | Proprietary code to identify the industryType. Please refer to the Client Support Center for additional information. |
minorType | String | Short description of employer and defines minorTypeCode. |
minorTypeCode | Number | Proprietary code to identify the minorType. Please refer to the Client Support Center for additional information. |
details | String | Long description of minorType. |
updated | String | Timestamp when the minimum wage record was last updated. Note: this applies to any change to the record, not just rate changes. |
Normalized Address object (normalizedAddress)
normalizedAddress)| Element | Type | Description |
|---|---|---|
streetAddress1 | String | Normalized street address that conforms to USPS address standardization used for rate determination. |
city | String | City name of normalized address that confirms to USPS address standardization used for rate determination. |
state | String | State abbreviation of normalized address that confirms to USPS address standardization used for rate determination. |
zipCode | String | ZIP code of normalized address that confirms to USPS address standardization used for rate determination. |
Normalized Coordinates object (normalizedCoordinates)
normalizedCoordinates)| Element | Type | Description |
|---|---|---|
longitude | Number | Longitude of normalized address used for rate determination. If a longitude and latitude were passed in, this will return null. |
latitude | Number | Latitude of normalized address used for rate determination. If a longitude and latitude were passed in, this will return null. |
Rates array (rates)
rates)Contains an array of minimum wage objects. See above for the elements that comprise the minimum wage object and their definitions.
Rates Page object (ratesPage)
ratesPage)Returned from the /mwf/v1/id endpoint. Contains an array of minimum wage objects. See above for the elements that comprise the minimum wage object and their definitions.
| Element | Type | Description |
|---|---|---|
content | Array | Contains one or more minimum wage objects. |
pageable | Object | Contains metadata about the pagination collection along with the sort object. |
last | Boolean | Returns true if it's the last page in the pagination collection. |
totalPages | Number | Number of pages within the pagination collection. |
totalElements | Number | Number of minimum wage objects returned within the entire pagination collection. |
sort | Object | Contains data on the MWF default sort order. This cannot be changed. |
size | Number | Maximum number of minimum wage objects returned within each page. Set by pageSize. |
number | Number | Page number in collection. Set by pageNumber. The first page in the collection is always pageNumber=0. |
first | Boolean | Returns true if payload is the first within the pagination collection (pageNumber = 0). |
numberOfElements | Number | Number of minimum wage objects returned within the payload. |
empty | Boolean | Returns true when the content array is empty (no minimum wage objects are returned) for that specific pageNumber. |
Pageable object (pageable)
pageable)Returned from the /mwf/v1/id endpoint.
| Element | Type | Description |
|---|---|---|
sort | Contains the default sort for MWF as defined by the application:/mwf/v1/id is sorted by state_code, authority_code, effective_date./mwf/v1/location is sorted by authority level (federal - state - county – local level). | |
sort.unsorted | Always returns true. | |
sort.sorted | Always returns false. | |
sort.empty | Always returns true. | |
offset | Record number of the first item in the current paginated result. | |
pageNumber | Page number in collection. Set by pageNumber. | |
pageSize | Maximum number of minimum wage objects returned within each page. Set by pageSize. | |
unpaged | Will always return false. | |
paged | Will always return true. |
Updated over 1 year ago
