GET restapi/sites/shortnames/{shortname}/v1

Get an itslearning site by shortname. The site may be inactive. If a site with the given shortname does not exist, null will be returned.

Request Information

URI Parameters

Name	Description	Type	Additional information
shortname	The shortname for the site	string	Required

Body Parameters

None.

Response Information

Resource Description

Itslearning.RestApi.Entities.Site

Name	Description	Type	Additional information
IsFronterUpgradedSite	IsFronterUpgradedSite flag.	boolean	None.
IsParentAppEnabled	Determines whether parent app is enabled.	boolean	None.
OrgApiBaseUrl	The Url to Organisation Api (AKA Content Import).	string	None.
CustomerId	The customer id for this site.	integer	None.
Title	The title used for the site.	string	None.
ShortName	The short name used for the site.	string	None.
CultureName	The culture name used for the site.	string	None.
BaseUrl	Base url for the site.	string	None.
IsPersonalRestApiEnabled	Check to see if the Personal API has been enabled for this site.	boolean	None.
ShowCustomerInDropdownList	Flag to identify wheteher customer should appear in dropdown lists.	boolean	None.
CountryCode	The country code for the customer.	string	None.
StateCode	The state code for the customer.	string	None.
Segment	The education segment.	Itsolutions.ItslUtils.Constants.CustomerEducationSegment	None.

Response Formats

application/json, text/json

Sample:

{
  "IsFronterUpgradedSite": true,
  "IsParentAppEnabled": true,
  "OrgApiBaseUrl": "sample string 3",
  "CustomerId": 4,
  "Title": "sample string 5",
  "ShortName": "sample string 6",
  "CultureName": "sample string 7",
  "BaseUrl": "sample string 8",
  "IsPersonalRestApiEnabled": true,
  "ShowCustomerInDropdownList": true,
  "CountryCode": "sample string 11",
  "StateCode": "sample string 12",
  "Segment": 0
}

application/xml, text/xml

Sample:

<Site xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <BaseUrl>sample string 8</BaseUrl>
  <CountryCode>sample string 11</CountryCode>
  <CultureName>sample string 7</CultureName>
  <CustomerId>4</CustomerId>
  <IsPersonalRestApiEnabled>true</IsPersonalRestApiEnabled>
  <Segment>Higher</Segment>
  <ShortName>sample string 6</ShortName>
  <ShowCustomerInDropdownList>true</ShowCustomerInDropdownList>
  <StateCode>sample string 12</StateCode>
  <Title>sample string 5</Title>
  <IsFronterUpgradedSite>true</IsFronterUpgradedSite>
  <IsParentAppEnabled>true</IsParentAppEnabled>
  <OrgApiBaseUrl>sample string 3</OrgApiBaseUrl>
</Site>