POST api/WelcomeSection/GetWelcomeSection

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
SchoolId	integer	None.
SortOrder	integer	None.
Title	string	None.
Introduction	string	None.
Links	Collection of WelcomeSectionLink	None.
AuthToken	string	None.
Image	string	None.
Error	Error	None.
LinksTitle	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "SchoolId": 2,
  "SortOrder": 3,
  "Title": "sample string 4",
  "Introduction": "sample string 5",
  "Links": [
    {
      "Id": 1,
      "WelcomeSectionId": 2,
      "Url": "sample string 3",
      "LinkTitle": "sample string 4",
      "SortOrder": 5,
      "SchoolId": 6,
      "AuthToken": "sample string 7",
      "Error": {
        "ID": "sample string 1",
        "RawError": "sample string 2",
        "StackTrace": "sample string 3",
        "FriendlyMessage": "sample string 4"
      }
    },
    {
      "Id": 1,
      "WelcomeSectionId": 2,
      "Url": "sample string 3",
      "LinkTitle": "sample string 4",
      "SortOrder": 5,
      "SchoolId": 6,
      "AuthToken": "sample string 7",
      "Error": {
        "ID": "sample string 1",
        "RawError": "sample string 2",
        "StackTrace": "sample string 3",
        "FriendlyMessage": "sample string 4"
      }
    }
  ],
  "AuthToken": "sample string 6",
  "Image": "sample string 7",
  "Error": {
    "ID": "sample string 1",
    "RawError": "sample string 2",
    "StackTrace": "sample string 3",
    "FriendlyMessage": "sample string 4"
  },
  "LinksTitle": "sample string 8"
}

application/xml, text/xml

Sample:

<WelcomeSection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BSTData">
  <AuthToken>sample string 6</AuthToken>
  <Error xmlns:d2p1="http://schemas.datacontract.org/2004/07/BSTServices.Models">
    <d2p1:FriendlyMessage>sample string 4</d2p1:FriendlyMessage>
    <d2p1:ID>sample string 1</d2p1:ID>
    <d2p1:RawError>sample string 2</d2p1:RawError>
    <d2p1:StackTrace>sample string 3</d2p1:StackTrace>
  </Error>
  <Id>1</Id>
  <Image>sample string 7</Image>
  <Introduction>sample string 5</Introduction>
  <Links>
    <WelcomeSectionLink>
      <AuthToken>sample string 7</AuthToken>
      <Error xmlns:d4p1="http://schemas.datacontract.org/2004/07/BSTServices.Models">
        <d4p1:FriendlyMessage>sample string 4</d4p1:FriendlyMessage>
        <d4p1:ID>sample string 1</d4p1:ID>
        <d4p1:RawError>sample string 2</d4p1:RawError>
        <d4p1:StackTrace>sample string 3</d4p1:StackTrace>
      </Error>
      <Id>1</Id>
      <LinkTitle>sample string 4</LinkTitle>
      <SchoolId>6</SchoolId>
      <SortOrder>5</SortOrder>
      <Url>sample string 3</Url>
      <WelcomeSectionId>2</WelcomeSectionId>
    </WelcomeSectionLink>
    <WelcomeSectionLink>
      <AuthToken>sample string 7</AuthToken>
      <Error xmlns:d4p1="http://schemas.datacontract.org/2004/07/BSTServices.Models">
        <d4p1:FriendlyMessage>sample string 4</d4p1:FriendlyMessage>
        <d4p1:ID>sample string 1</d4p1:ID>
        <d4p1:RawError>sample string 2</d4p1:RawError>
        <d4p1:StackTrace>sample string 3</d4p1:StackTrace>
      </Error>
      <Id>1</Id>
      <LinkTitle>sample string 4</LinkTitle>
      <SchoolId>6</SchoolId>
      <SortOrder>5</SortOrder>
      <Url>sample string 3</Url>
      <WelcomeSectionId>2</WelcomeSectionId>
    </WelcomeSectionLink>
  </Links>
  <LinksTitle>sample string 8</LinksTitle>
  <SchoolId>2</SchoolId>
  <SortOrder>3</SortOrder>
  <Title>sample string 4</Title>
</WelcomeSection>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.