POST admin/network/settings/sid/load

No documentation available.

Request Information

Parameters

Name	Description	Additional information
inVO	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "entityType": "sample string 1",
  "entityId": "sample string 2",
  "forEmbed": true,
  "pageSuffix": "sample string 4",
  "curUserId": "sample string 5",
  "isSSO": true,
  "requestHost": "sample string 7",
  "applicationPath": "sample string 8",
  "secureApplicationPath": "sample string 9",
  "absoluteApplicationPath": "sample string 10",
  "isHttps": true,
  "isMobileDevice": true,
  "isElectron": true,
  "isFullEmbed": true,
  "clientType": 0,
  "clientVersion": "sample string 15",
  "clientOS": "sample string 16",
  "clientBuild": "sample string 17",
  "premiumAppId": "sample string 18",
  "clientWidth": 19,
  "clientHeight": 20,
  "timezone": 21,
  "needSid": true,
  "additionInfoLabel": "sample string 2",
  "displayOnScoreSheet": true,
  "sidAlias": "sample string 4",
  "minSidCharacters": 5,
  "maxSidCharacters": 6,
  "sidCharactersType": 7,
  "sidExtraInfo": "sample string 8",
  "alwaysRequireSid": true,
  "sidExportDisp": true,
  "sidAdminDisp": true,
  "sidRefsDisp": true,
  "sidStudentDisp": true,
  "autoCheckType": 14,
  "checkSidThroughoutSeason": true,
  "sidVerificationFailMessage": "sample string 16",
  "sidAliasDigitsEnabled": true,
  "sidAliasDigits": 18,
  "pageType": 0
}

application/xml, text/xml

Sample:

<NetworkSidSettingsInVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Web.API.VO.Input.Network">
  <ClientHeight xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">20</ClientHeight>
  <ClientType xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">Site</ClientType>
  <ClientWidth xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">19</ClientWidth>
  <absoluteApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 10</absoluteApplicationPath>
  <applicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 8</applicationPath>
  <cachedKey xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 19</cachedKey>
  <clientBuild xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 17</clientBuild>
  <clientOS xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 16</clientOS>
  <clientVersion xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 15</clientVersion>
  <curUserId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 5</curUserId>
  <isElectron xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isElectron>
  <isFullEmbed xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isFullEmbed>
  <isHttps xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isHttps>
  <isMobileDevice xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isMobileDevice>
  <isSSO xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isSSO>
  <premiumAppId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 18</premiumAppId>
  <requestHost xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 7</requestHost>
  <secureApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 9</secureApplicationPath>
  <timezone xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">21</timezone>
  <entityId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 2</entityId>
  <entityType xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 1</entityType>
  <forEmbed xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</forEmbed>
  <pageSuffix xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 4</pageSuffix>
  <pageType xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">FrontPage</pageType>
  <additionInfoLabel>sample string 2</additionInfoLabel>
  <alwaysRequireSid>true</alwaysRequireSid>
  <autoCheckType>14</autoCheckType>
  <checkSidThroughoutSeason>true</checkSidThroughoutSeason>
  <displayOnScoreSheet>true</displayOnScoreSheet>
  <maxSidCharacters>6</maxSidCharacters>
  <minSidCharacters>5</minSidCharacters>
  <needSid>true</needSid>
  <sidAdminDisp>true</sidAdminDisp>
  <sidAlias>sample string 4</sidAlias>
  <sidAliasDigits>18</sidAliasDigits>
  <sidAliasDigitsEnabled>true</sidAliasDigitsEnabled>
  <sidCharactersType>7</sidCharactersType>
  <sidExportDisp>true</sidExportDisp>
  <sidExtraInfo>sample string 8</sidExtraInfo>
  <sidRefsDisp>true</sidRefsDisp>
  <sidStudentDisp>true</sidStudentDisp>
  <sidVerificationFailMessage>sample string 16</sidVerificationFailMessage>
</NetworkSidSettingsInVO>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="needSid"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="additionInfoLabel"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="displayOnScoreSheet"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="sidAlias"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="minSidCharacters"

5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="maxSidCharacters"

6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="sidCharactersType"

7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="sidExtraInfo"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="alwaysRequireSid"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="sidExportDisp"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="sidAdminDisp"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="sidRefsDisp"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="sidStudentDisp"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="autoCheckType"

14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="checkSidThroughoutSeason"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="sidVerificationFailMessage"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="sidAliasDigitsEnabled"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="sidAliasDigits"

18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="pageType"

FrontPage
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="cachedKey"

sample string 19
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:

{
  "isDone": true,
  "code": 0,
  "message": "sample string 2",
  "data": {},
  "cachedKey": "sample string 4",
  "correlationId": "d0010be9-6c6f-4dab-92c5-cde5494c6981",
  "jwtTokenForSPA": "sample string 6",
  "jwtTokenIndexForSPA": 1
}

application/xml, text/xml

Sample:

<ResultOutVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.Common">
  <CachedKey>sample string 4</CachedKey>
  <Code>None</Code>
  <CorrelationId>d0010be9-6c6f-4dab-92c5-cde5494c6981</CorrelationId>
  <Data />
  <IsDone>true</IsDone>
  <JwtTokenForSPA>sample string 6</JwtTokenForSPA>
  <JwtTokenIndexForSPA>1</JwtTokenIndexForSPA>
  <Message>sample string 2</Message>
</ResultOutVO>

multipart/form-data

Sample:

Sample not available.