GET api/term/SearchTerm/{keyword}

Request Information

URI Parameters

Name	Description	Type	Additional information
keyword		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Term

Name	Type	Additional information
Id	integer	None.
TermCode	string	String length: inclusive between 0 and 5
Description	string	String length: inclusive between 0 and 50
SchoolYearStart	integer	None.
SchoolYearEnd	integer	None.
Active	integer	None.
Sorting	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "termCode": "sample string 2",
    "description": "sample string 3",
    "schoolYearStart": 4,
    "schoolYearEnd": 5,
    "active": 6,
    "sorting": 7
  },
  {
    "id": 1,
    "termCode": "sample string 2",
    "description": "sample string 3",
    "schoolYearStart": 4,
    "schoolYearEnd": 5,
    "active": 6,
    "sorting": 7
  }
]

text/html

Sample:

[{"id":1,"termCode":"sample string 2","description":"sample string 3","schoolYearStart":4,"schoolYearEnd":5,"active":6,"sorting":7},{"id":1,"termCode":"sample string 2","description":"sample string 3","schoolYearStart":4,"schoolYearEnd":5,"active":6,"sorting":7}]

application/xml, text/xml

Sample:

<ArrayOfTerm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UBBEAMS.Infrastructure.Models">
  <Term>
    <Active>6</Active>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <SchoolYearEnd>5</SchoolYearEnd>
    <SchoolYearStart>4</SchoolYearStart>
    <Sorting>7</Sorting>
    <TermCode>sample string 2</TermCode>
  </Term>
  <Term>
    <Active>6</Active>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <SchoolYearEnd>5</SchoolYearEnd>
    <SchoolYearStart>4</SchoolYearStart>
    <Sorting>7</Sorting>
    <TermCode>sample string 2</TermCode>
  </Term>
</ArrayOfTerm>