GET api/consumer/v1/periodUsers/user/{userId}?year={year}
Get all periods filtered by user and year
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userId |
ID of user |
integer |
Required |
| year |
Year, default current |
integer |
Default value is 0 |
Body Parameters
None
Response Information
Resource Description
List of period users
Collection of PeriodUserDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Period |
Period details |
PeriodDto |
None |
| User |
User |
UserMinDto |
None |
| State |
State of the period user |
PeriodStateMinDto |
None |
| LastUpdateDate |
Date of the last update of the period user |
date |
None |
| LastUpdatedBy |
User who made the last update |
UserMinDto |
None |
| Id |
Unique ID |
integer |
None |
Response Formats
application/json, text/json
Sample:
[
{
"Period": {
"StartDate": "2024-11-01T19:30:42.0199349+01:00",
"EndDate": "2024-11-01T19:30:42.0199349+01:00",
"Id": 3
},
"User": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"State": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"LastUpdateDate": "2024-11-01T19:30:42.0199349+01:00",
"LastUpdatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"Id": 1
},
{
"Period": {
"StartDate": "2024-11-01T19:30:42.0199349+01:00",
"EndDate": "2024-11-01T19:30:42.0199349+01:00",
"Id": 3
},
"User": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"State": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"LastUpdateDate": "2024-11-01T19:30:42.0199349+01:00",
"LastUpdatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"Id": 1
}
]
application/xml, text/xml
Sample:
<ArrayOfPeriodUserDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
<PeriodUserDto>
<Id>1</Id>
<LastUpdateDate>2024-11-01T19:30:42.0199349+01:00</LastUpdateDate>
<LastUpdatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</LastUpdatedBy>
<Period>
<Id>3</Id>
<EndDate>2024-11-01T19:30:42.0199349+01:00</EndDate>
<StartDate>2024-11-01T19:30:42.0199349+01:00</StartDate>
</Period>
<State>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</State>
<User>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</User>
</PeriodUserDto>
<PeriodUserDto>
<Id>1</Id>
<LastUpdateDate>2024-11-01T19:30:42.0199349+01:00</LastUpdateDate>
<LastUpdatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</LastUpdatedBy>
<Period>
<Id>3</Id>
<EndDate>2024-11-01T19:30:42.0199349+01:00</EndDate>
<StartDate>2024-11-01T19:30:42.0199349+01:00</StartDate>
</Period>
<State>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</State>
<User>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</User>
</PeriodUserDto>
</ArrayOfPeriodUserDto>