Query OrgMonth
Retrieve a list of OrgMonths with a complex or simple query.
Body
Multiple query options are supported. You can build a complex query filling out the advancedFilter
section. We also support "simple" queries which used by putting the key you want to filter by in the query
section along with the value you want it to filter for. E.g., nameFirst=John
will return all persons with a first name of John.
Complex filter configuration allowing for multiple conditions with AND/OR operators.
Set to true
to merge requested fields with default response, or false/omit to return only requested fields plus ID
.
Page number for pagination.
Number of items per page. Defaults to 500.
Array of field names to return in the response.
Field name to sort by.
Sort direction: ascending (asc) or descending (desc).
asc
, desc
Additional key-value pairs for simple filtering. Any field from the entity can be used as a filter key. E.g., field=value
will return all records where that field matches the specified value.
Response
Represents the total number of all eligible entities within an organization for a specific month.
Represents the number of eligible entities within a random pool for a specific organization in a given month.
Represents the total number of alcoholic items selected in a specific organization for a given month.
Represents the total number of alcohol-related results selected within a specific organization for a given month.
Represents the total number of times a specific drug was selected within an organization in a given month.
Represents the total number of times a specific drug was selected within a given month by an organization.
Indicates whether an employee covered under the organization's insurance was removed during a specific month.
Indicates whether a miscellaneous report was dropped for a specific organization in a particular month.
Indicates whether a random selection is discarded in a specific month for an organization.
Unique identifier.
Represents the identifier or name assigned to a specific month related to an organization.
Represents the unique identifier for an organization in the OrgMonth table.