TAG LINE
SMALL TITLE

Day of Week Type

(API Version v4)


This system defined entity represents the individual days of the week.


What can you do with DayOfWeekType?


Properties

Property Details
identity
READ-ONLY
"identity": 14
Type: Number
This is the unique numeric identifier for the DayOfWeekType
name
READ-ONLY
"name": "Monday"
Type: String
The system defined day of the week. These are used in conjunction with Time Periods for rating usage.
sortOrder
READ-ONLY
"sortOrder": 13
Type: Number
Unused


End Points

GETapi/v4/DayOfWeekType/
Retrieve all of the DayOfWeekType objects.
Retrieve all of the DayOfWeekType objects.
GET api/v4/DayOfWeekType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Monday",
            "sortOrder": 14
        }
    ]
}
GETapi/v4/DayOfWeekType/Paged
Retrieve all of the DayOfWeekType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the DayOfWeekType objects in a paged fashion.
GET api/v4/DayOfWeekType/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Monday",
                "sortOrder": 17
            }
        ]
    }
}
GETapi/v4/DayOfWeekType/{id}
Retrieve an instance of the DayOfWeekType object by its ID.
{id}Unique identifier for the DayOfWeekType object.
Retrieve an instance of the DayOfWeekType object by its ID.
GET api/v4/DayOfWeekType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Monday",
        "sortOrder": 6
    }
}
POSTapi/v4/DayOfWeekType/Search
Retreive a list of DayOfWeekType objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of DayOfWeekType objects based on search criteria.
POST api/v4/DayOfWeekType/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Monday",
            "sortOrder": 23
        }
    ]
}