POST api/Evaluation/GetAnnualReport

Request Information

URI Parameters

None.

Body Parameters

EvaluationDTO
NameDescriptionTypeAdditional information
EvaluationID

integer

None.

EvaluationItemID

integer

None.

EvaluationCategoryID

integer

None.

SystemUserID

integer

None.

StaffID

integer

None.

EvaluationValue

integer

None.

Year

integer

None.

Month

integer

None.

Note

string

None.

EvaluationItemNameEnglish

string

None.

EvaluationItemNameArabic

string

None.

lstEvaluationItems

Collection of EvaluationItemDTO

None.

lstEvaluationCategories

Collection of EvaluationCategoryDTO

None.

Request Formats

application/json, text/json

Sample:
{
  "EvaluationID": 1,
  "EvaluationItemID": 2,
  "EvaluationCategoryID": 3,
  "SystemUserID": 4,
  "StaffID": 5,
  "EvaluationValue": 1,
  "Year": 6,
  "Month": 7,
  "Note": "sample string 8",
  "EvaluationItemNameEnglish": "sample string 9",
  "EvaluationItemNameArabic": "sample string 10",
  "lstEvaluationItems": [
    {
      "EvaluationItemID": 1,
      "EvaluationID": 2,
      "EvaluationItemValue": 3,
      "EvaluationItemNameEnglish": "sample string 4",
      "EvaluationItemNameArabic": "sample string 5"
    },
    {
      "EvaluationItemID": 1,
      "EvaluationID": 2,
      "EvaluationItemValue": 3,
      "EvaluationItemNameEnglish": "sample string 4",
      "EvaluationItemNameArabic": "sample string 5"
    }
  ],
  "lstEvaluationCategories": [
    {
      "EvaluationCategoryID": 1,
      "EvaluationCategoryNameEnglish": "sample string 2",
      "EvaluationCategoryNameArabic": "sample string 3"
    },
    {
      "EvaluationCategoryID": 1,
      "EvaluationCategoryNameEnglish": "sample string 2",
      "EvaluationCategoryNameArabic": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<EvaluationDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HR.Objects.DTOs">
  <EvaluationCategoryID>3</EvaluationCategoryID>
  <EvaluationID>1</EvaluationID>
  <EvaluationItemID>2</EvaluationItemID>
  <EvaluationItemNameArabic>sample string 10</EvaluationItemNameArabic>
  <EvaluationItemNameEnglish>sample string 9</EvaluationItemNameEnglish>
  <EvaluationValue>1</EvaluationValue>
  <Month>7</Month>
  <Note>sample string 8</Note>
  <StaffID>5</StaffID>
  <SystemUserID>4</SystemUserID>
  <Year>6</Year>
  <lstEvaluationCategories>
    <EvaluationCategoryDTO>
      <EvaluationCategoryID>1</EvaluationCategoryID>
      <EvaluationCategoryNameArabic>sample string 3</EvaluationCategoryNameArabic>
      <EvaluationCategoryNameEnglish>sample string 2</EvaluationCategoryNameEnglish>
    </EvaluationCategoryDTO>
    <EvaluationCategoryDTO>
      <EvaluationCategoryID>1</EvaluationCategoryID>
      <EvaluationCategoryNameArabic>sample string 3</EvaluationCategoryNameArabic>
      <EvaluationCategoryNameEnglish>sample string 2</EvaluationCategoryNameEnglish>
    </EvaluationCategoryDTO>
  </lstEvaluationCategories>
  <lstEvaluationItems>
    <EvaluationItemDTO>
      <EvaluationID>2</EvaluationID>
      <EvaluationItemID>1</EvaluationItemID>
      <EvaluationItemNameArabic>sample string 5</EvaluationItemNameArabic>
      <EvaluationItemNameEnglish>sample string 4</EvaluationItemNameEnglish>
      <EvaluationItemValue>3</EvaluationItemValue>
    </EvaluationItemDTO>
    <EvaluationItemDTO>
      <EvaluationID>2</EvaluationID>
      <EvaluationItemID>1</EvaluationItemID>
      <EvaluationItemNameArabic>sample string 5</EvaluationItemNameArabic>
      <EvaluationItemNameEnglish>sample string 4</EvaluationItemNameEnglish>
      <EvaluationItemValue>3</EvaluationItemValue>
    </EvaluationItemDTO>
  </lstEvaluationItems>
</EvaluationDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of AnnualEvaluationDTO
NameDescriptionTypeAdditional information
ID

integer

None.

Year

integer

None.

Month

integer

None.

Note

string

None.

lstEvaluation

Collection of EvaluationDTO

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": 1,
    "Year": 2,
    "Month": 3,
    "Note": "sample string 4",
    "lstEvaluation": [
      {
        "EvaluationID": 1,
        "EvaluationItemID": 2,
        "EvaluationCategoryID": 3,
        "SystemUserID": 4,
        "StaffID": 5,
        "EvaluationValue": 1,
        "Year": 6,
        "Month": 7,
        "Note": "sample string 8",
        "EvaluationItemNameEnglish": "sample string 9",
        "EvaluationItemNameArabic": "sample string 10",
        "lstEvaluationItems": [
          {
            "EvaluationItemID": 1,
            "EvaluationID": 2,
            "EvaluationItemValue": 3,
            "EvaluationItemNameEnglish": "sample string 4",
            "EvaluationItemNameArabic": "sample string 5"
          },
          {
            "EvaluationItemID": 1,
            "EvaluationID": 2,
            "EvaluationItemValue": 3,
            "EvaluationItemNameEnglish": "sample string 4",
            "EvaluationItemNameArabic": "sample string 5"
          }
        ],
        "lstEvaluationCategories": [
          {
            "EvaluationCategoryID": 1,
            "EvaluationCategoryNameEnglish": "sample string 2",
            "EvaluationCategoryNameArabic": "sample string 3"
          },
          {
            "EvaluationCategoryID": 1,
            "EvaluationCategoryNameEnglish": "sample string 2",
            "EvaluationCategoryNameArabic": "sample string 3"
          }
        ]
      },
      {
        "EvaluationID": 1,
        "EvaluationItemID": 2,
        "EvaluationCategoryID": 3,
        "SystemUserID": 4,
        "StaffID": 5,
        "EvaluationValue": 1,
        "Year": 6,
        "Month": 7,
        "Note": "sample string 8",
        "EvaluationItemNameEnglish": "sample string 9",
        "EvaluationItemNameArabic": "sample string 10",
        "lstEvaluationItems": [
          {
            "EvaluationItemID": 1,
            "EvaluationID": 2,
            "EvaluationItemValue": 3,
            "EvaluationItemNameEnglish": "sample string 4",
            "EvaluationItemNameArabic": "sample string 5"
          },
          {
            "EvaluationItemID": 1,
            "EvaluationID": 2,
            "EvaluationItemValue": 3,
            "EvaluationItemNameEnglish": "sample string 4",
            "EvaluationItemNameArabic": "sample string 5"
          }
        ],
        "lstEvaluationCategories": [
          {
            "EvaluationCategoryID": 1,
            "EvaluationCategoryNameEnglish": "sample string 2",
            "EvaluationCategoryNameArabic": "sample string 3"
          },
          {
            "EvaluationCategoryID": 1,
            "EvaluationCategoryNameEnglish": "sample string 2",
            "EvaluationCategoryNameArabic": "sample string 3"
          }
        ]
      }
    ]
  },
  {
    "ID": 1,
    "Year": 2,
    "Month": 3,
    "Note": "sample string 4",
    "lstEvaluation": [
      {
        "EvaluationID": 1,
        "EvaluationItemID": 2,
        "EvaluationCategoryID": 3,
        "SystemUserID": 4,
        "StaffID": 5,
        "EvaluationValue": 1,
        "Year": 6,
        "Month": 7,
        "Note": "sample string 8",
        "EvaluationItemNameEnglish": "sample string 9",
        "EvaluationItemNameArabic": "sample string 10",
        "lstEvaluationItems": [
          {
            "EvaluationItemID": 1,
            "EvaluationID": 2,
            "EvaluationItemValue": 3,
            "EvaluationItemNameEnglish": "sample string 4",
            "EvaluationItemNameArabic": "sample string 5"
          },
          {
            "EvaluationItemID": 1,
            "EvaluationID": 2,
            "EvaluationItemValue": 3,
            "EvaluationItemNameEnglish": "sample string 4",
            "EvaluationItemNameArabic": "sample string 5"
          }
        ],
        "lstEvaluationCategories": [
          {
            "EvaluationCategoryID": 1,
            "EvaluationCategoryNameEnglish": "sample string 2",
            "EvaluationCategoryNameArabic": "sample string 3"
          },
          {
            "EvaluationCategoryID": 1,
            "EvaluationCategoryNameEnglish": "sample string 2",
            "EvaluationCategoryNameArabic": "sample string 3"
          }
        ]
      },
      {
        "EvaluationID": 1,
        "EvaluationItemID": 2,
        "EvaluationCategoryID": 3,
        "SystemUserID": 4,
        "StaffID": 5,
        "EvaluationValue": 1,
        "Year": 6,
        "Month": 7,
        "Note": "sample string 8",
        "EvaluationItemNameEnglish": "sample string 9",
        "EvaluationItemNameArabic": "sample string 10",
        "lstEvaluationItems": [
          {
            "EvaluationItemID": 1,
            "EvaluationID": 2,
            "EvaluationItemValue": 3,
            "EvaluationItemNameEnglish": "sample string 4",
            "EvaluationItemNameArabic": "sample string 5"
          },
          {
            "EvaluationItemID": 1,
            "EvaluationID": 2,
            "EvaluationItemValue": 3,
            "EvaluationItemNameEnglish": "sample string 4",
            "EvaluationItemNameArabic": "sample string 5"
          }
        ],
        "lstEvaluationCategories": [
          {
            "EvaluationCategoryID": 1,
            "EvaluationCategoryNameEnglish": "sample string 2",
            "EvaluationCategoryNameArabic": "sample string 3"
          },
          {
            "EvaluationCategoryID": 1,
            "EvaluationCategoryNameEnglish": "sample string 2",
            "EvaluationCategoryNameArabic": "sample string 3"
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfAnnualEvaluationDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HR.Objects.DTOs">
  <AnnualEvaluationDTO>
    <ID>1</ID>
    <Month>3</Month>
    <Note>sample string 4</Note>
    <Year>2</Year>
    <lstEvaluation>
      <EvaluationDTO>
        <EvaluationCategoryID>3</EvaluationCategoryID>
        <EvaluationID>1</EvaluationID>
        <EvaluationItemID>2</EvaluationItemID>
        <EvaluationItemNameArabic>sample string 10</EvaluationItemNameArabic>
        <EvaluationItemNameEnglish>sample string 9</EvaluationItemNameEnglish>
        <EvaluationValue>1</EvaluationValue>
        <Month>7</Month>
        <Note>sample string 8</Note>
        <StaffID>5</StaffID>
        <SystemUserID>4</SystemUserID>
        <Year>6</Year>
        <lstEvaluationCategories>
          <EvaluationCategoryDTO>
            <EvaluationCategoryID>1</EvaluationCategoryID>
            <EvaluationCategoryNameArabic>sample string 3</EvaluationCategoryNameArabic>
            <EvaluationCategoryNameEnglish>sample string 2</EvaluationCategoryNameEnglish>
          </EvaluationCategoryDTO>
          <EvaluationCategoryDTO>
            <EvaluationCategoryID>1</EvaluationCategoryID>
            <EvaluationCategoryNameArabic>sample string 3</EvaluationCategoryNameArabic>
            <EvaluationCategoryNameEnglish>sample string 2</EvaluationCategoryNameEnglish>
          </EvaluationCategoryDTO>
        </lstEvaluationCategories>
        <lstEvaluationItems>
          <EvaluationItemDTO>
            <EvaluationID>2</EvaluationID>
            <EvaluationItemID>1</EvaluationItemID>
            <EvaluationItemNameArabic>sample string 5</EvaluationItemNameArabic>
            <EvaluationItemNameEnglish>sample string 4</EvaluationItemNameEnglish>
            <EvaluationItemValue>3</EvaluationItemValue>
          </EvaluationItemDTO>
          <EvaluationItemDTO>
            <EvaluationID>2</EvaluationID>
            <EvaluationItemID>1</EvaluationItemID>
            <EvaluationItemNameArabic>sample string 5</EvaluationItemNameArabic>
            <EvaluationItemNameEnglish>sample string 4</EvaluationItemNameEnglish>
            <EvaluationItemValue>3</EvaluationItemValue>
          </EvaluationItemDTO>
        </lstEvaluationItems>
      </EvaluationDTO>
      <EvaluationDTO>
        <EvaluationCategoryID>3</EvaluationCategoryID>
        <EvaluationID>1</EvaluationID>
        <EvaluationItemID>2</EvaluationItemID>
        <EvaluationItemNameArabic>sample string 10</EvaluationItemNameArabic>
        <EvaluationItemNameEnglish>sample string 9</EvaluationItemNameEnglish>
        <EvaluationValue>1</EvaluationValue>
        <Month>7</Month>
        <Note>sample string 8</Note>
        <StaffID>5</StaffID>
        <SystemUserID>4</SystemUserID>
        <Year>6</Year>
        <lstEvaluationCategories>
          <EvaluationCategoryDTO>
            <EvaluationCategoryID>1</EvaluationCategoryID>
            <EvaluationCategoryNameArabic>sample string 3</EvaluationCategoryNameArabic>
            <EvaluationCategoryNameEnglish>sample string 2</EvaluationCategoryNameEnglish>
          </EvaluationCategoryDTO>
          <EvaluationCategoryDTO>
            <EvaluationCategoryID>1</EvaluationCategoryID>
            <EvaluationCategoryNameArabic>sample string 3</EvaluationCategoryNameArabic>
            <EvaluationCategoryNameEnglish>sample string 2</EvaluationCategoryNameEnglish>
          </EvaluationCategoryDTO>
        </lstEvaluationCategories>
        <lstEvaluationItems>
          <EvaluationItemDTO>
            <EvaluationID>2</EvaluationID>
            <EvaluationItemID>1</EvaluationItemID>
            <EvaluationItemNameArabic>sample string 5</EvaluationItemNameArabic>
            <EvaluationItemNameEnglish>sample string 4</EvaluationItemNameEnglish>
            <EvaluationItemValue>3</EvaluationItemValue>
          </EvaluationItemDTO>
          <EvaluationItemDTO>
            <EvaluationID>2</EvaluationID>
            <EvaluationItemID>1</EvaluationItemID>
            <EvaluationItemNameArabic>sample string 5</EvaluationItemNameArabic>
            <EvaluationItemNameEnglish>sample string 4</EvaluationItemNameEnglish>
            <EvaluationItemValue>3</EvaluationItemValue>
          </EvaluationItemDTO>
        </lstEvaluationItems>
      </EvaluationDTO>
    </lstEvaluation>
  </AnnualEvaluationDTO>
  <AnnualEvaluationDTO>
    <ID>1</ID>
    <Month>3</Month>
    <Note>sample string 4</Note>
    <Year>2</Year>
    <lstEvaluation>
      <EvaluationDTO>
        <EvaluationCategoryID>3</EvaluationCategoryID>
        <EvaluationID>1</EvaluationID>
        <EvaluationItemID>2</EvaluationItemID>
        <EvaluationItemNameArabic>sample string 10</EvaluationItemNameArabic>
        <EvaluationItemNameEnglish>sample string 9</EvaluationItemNameEnglish>
        <EvaluationValue>1</EvaluationValue>
        <Month>7</Month>
        <Note>sample string 8</Note>
        <StaffID>5</StaffID>
        <SystemUserID>4</SystemUserID>
        <Year>6</Year>
        <lstEvaluationCategories>
          <EvaluationCategoryDTO>
            <EvaluationCategoryID>1</EvaluationCategoryID>
            <EvaluationCategoryNameArabic>sample string 3</EvaluationCategoryNameArabic>
            <EvaluationCategoryNameEnglish>sample string 2</EvaluationCategoryNameEnglish>
          </EvaluationCategoryDTO>
          <EvaluationCategoryDTO>
            <EvaluationCategoryID>1</EvaluationCategoryID>
            <EvaluationCategoryNameArabic>sample string 3</EvaluationCategoryNameArabic>
            <EvaluationCategoryNameEnglish>sample string 2</EvaluationCategoryNameEnglish>
          </EvaluationCategoryDTO>
        </lstEvaluationCategories>
        <lstEvaluationItems>
          <EvaluationItemDTO>
            <EvaluationID>2</EvaluationID>
            <EvaluationItemID>1</EvaluationItemID>
            <EvaluationItemNameArabic>sample string 5</EvaluationItemNameArabic>
            <EvaluationItemNameEnglish>sample string 4</EvaluationItemNameEnglish>
            <EvaluationItemValue>3</EvaluationItemValue>
          </EvaluationItemDTO>
          <EvaluationItemDTO>
            <EvaluationID>2</EvaluationID>
            <EvaluationItemID>1</EvaluationItemID>
            <EvaluationItemNameArabic>sample string 5</EvaluationItemNameArabic>
            <EvaluationItemNameEnglish>sample string 4</EvaluationItemNameEnglish>
            <EvaluationItemValue>3</EvaluationItemValue>
          </EvaluationItemDTO>
        </lstEvaluationItems>
      </EvaluationDTO>
      <EvaluationDTO>
        <EvaluationCategoryID>3</EvaluationCategoryID>
        <EvaluationID>1</EvaluationID>
        <EvaluationItemID>2</EvaluationItemID>
        <EvaluationItemNameArabic>sample string 10</EvaluationItemNameArabic>
        <EvaluationItemNameEnglish>sample string 9</EvaluationItemNameEnglish>
        <EvaluationValue>1</EvaluationValue>
        <Month>7</Month>
        <Note>sample string 8</Note>
        <StaffID>5</StaffID>
        <SystemUserID>4</SystemUserID>
        <Year>6</Year>
        <lstEvaluationCategories>
          <EvaluationCategoryDTO>
            <EvaluationCategoryID>1</EvaluationCategoryID>
            <EvaluationCategoryNameArabic>sample string 3</EvaluationCategoryNameArabic>
            <EvaluationCategoryNameEnglish>sample string 2</EvaluationCategoryNameEnglish>
          </EvaluationCategoryDTO>
          <EvaluationCategoryDTO>
            <EvaluationCategoryID>1</EvaluationCategoryID>
            <EvaluationCategoryNameArabic>sample string 3</EvaluationCategoryNameArabic>
            <EvaluationCategoryNameEnglish>sample string 2</EvaluationCategoryNameEnglish>
          </EvaluationCategoryDTO>
        </lstEvaluationCategories>
        <lstEvaluationItems>
          <EvaluationItemDTO>
            <EvaluationID>2</EvaluationID>
            <EvaluationItemID>1</EvaluationItemID>
            <EvaluationItemNameArabic>sample string 5</EvaluationItemNameArabic>
            <EvaluationItemNameEnglish>sample string 4</EvaluationItemNameEnglish>
            <EvaluationItemValue>3</EvaluationItemValue>
          </EvaluationItemDTO>
          <EvaluationItemDTO>
            <EvaluationID>2</EvaluationID>
            <EvaluationItemID>1</EvaluationItemID>
            <EvaluationItemNameArabic>sample string 5</EvaluationItemNameArabic>
            <EvaluationItemNameEnglish>sample string 4</EvaluationItemNameEnglish>
            <EvaluationItemValue>3</EvaluationItemValue>
          </EvaluationItemDTO>
        </lstEvaluationItems>
      </EvaluationDTO>
    </lstEvaluation>
  </AnnualEvaluationDTO>
</ArrayOfAnnualEvaluationDTO>