POST admin/network/settings/registration/usertype/add

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,
  "settings": {
    "timeZone": 1
  },
  "schoolDescription": "sample string 1",
  "registrationInformation": "sample string 2",
  "restrictAgeSuspensionInfo": "sample string 3",
  "paymentInstructions": "sample string 4",
  "ineligibilityInstructions": "sample string 5",
  "contactInfo": "sample string 6",
  "schoolAddress": "sample string 7",
  "city": "sample string 8",
  "state": "sample string 9",
  "zipCode": "sample string 10",
  "webSite": "sample string 11",
  "telephone": "sample string 12",
  "enrollment": 1,
  "userReports": true,
  "networkType": "sample string 13",
  "privacySetting": 1,
  "networkTypeSettings": 1,
  "isSsoAllowGuests": true,
  "ssoGuestsName": "sample string 14",
  "ssoMembersName": "sample string 15",
  "allowSsoSetPassword": true,
  "ignoreSsoIneligibility": true,
  "remainEligibleIfOnRoster": true,
  "restrictAge": true,
  "restrictAgeNum": 1,
  "collectBirth": true,
  "collectGradYear": true,
  "allowDependents": true,
  "enableUserType": true,
  "promptForUserType": true,
  "userTypeId": 1,
  "userTypeName": "sample string 16",
  "userTypeCanBeSelected": true,
  "questionId": 1,
  "questionType": 1,
  "questionTitle": "sample string 17",
  "questionOptions": "sample string 18",
  "questionFor": 1,
  "customizedStatus": true,
  "statusTitle": "sample string 19",
  "statuses": [
    {
      "key": "sample string 1",
      "displayName": "sample string 2",
      "gradeYear": 3,
      "visible": true
    },
    {
      "key": "sample string 1",
      "displayName": "sample string 2",
      "gradeYear": 3,
      "visible": true
    },
    {
      "key": "sample string 1",
      "displayName": "sample string 2",
      "gradeYear": 3,
      "visible": true
    }
  ],
  "facebookUrl": "sample string 20",
  "instagramHash": "sample string 21",
  "useCustomTemplate": true,
  "emailBackgroundImage": "sample string 22",
  "emailFooterLogo": "sample string 23",
  "emailFacebookUrl": "sample string 24",
  "emailTwitterUrl": "sample string 25",
  "emailInstagramUrl": "sample string 26",
  "emailWebsiteUrl": "sample string 27",
  "footHeader": "sample string 28",
  "mainNavig": "sample string 29",
  "mainNaviFont": "sample string 30",
  "subNavig": "sample string 31",
  "subNaviFont": "sample string 32",
  "titleColor": "sample string 33",
  "fontTitleBack": "sample string 34",
  "schoolIdValue": "sample string 35",
  "publicViewable": 1,
  "networkTimeZone": 1,
  "schoolLogo": "sample string 36",
  "schoolBanner": "sample string 37",
  "enableAffiliation": true,
  "domainName": "sample string 38",
  "domainId": 1,
  "affiliationId": "sample string 39",
  "affiliationName": "sample string 40",
  "affiliationCode": "sample string 41",
  "pageType": 0
}

application/xml, text/xml

Sample:

<NetworkSettingsInVO 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 42</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>
  <affiliationCode>sample string 41</affiliationCode>
  <affiliationId>sample string 39</affiliationId>
  <affiliationName>sample string 40</affiliationName>
  <allowDependents>true</allowDependents>
  <allowSsoSetPassword>true</allowSsoSetPassword>
  <city>sample string 8</city>
  <collectBirth>true</collectBirth>
  <collectGradYear>true</collectGradYear>
  <contactInfo>sample string 6</contactInfo>
  <customizedStatus>true</customizedStatus>
  <domainId>1</domainId>
  <domainName>sample string 38</domainName>
  <emailBackgroundImage>sample string 22</emailBackgroundImage>
  <emailFacebookUrl>sample string 24</emailFacebookUrl>
  <emailFooterLogo>sample string 23</emailFooterLogo>
  <emailInstagramUrl>sample string 26</emailInstagramUrl>
  <emailTwitterUrl>sample string 25</emailTwitterUrl>
  <emailWebsiteUrl>sample string 27</emailWebsiteUrl>
  <enableAffiliation>true</enableAffiliation>
  <enableUserType>true</enableUserType>
  <enrollment>1</enrollment>
  <facebookUrl>sample string 20</facebookUrl>
  <fontTitleBack>sample string 34</fontTitleBack>
  <footHeader>sample string 28</footHeader>
  <ignoreSsoIneligibility>true</ignoreSsoIneligibility>
  <ineligibilityInstructions>sample string 5</ineligibilityInstructions>
  <instagramHash>sample string 21</instagramHash>
  <isSsoAllowGuests>true</isSsoAllowGuests>
  <mainNaviFont>sample string 30</mainNaviFont>
  <mainNavig>sample string 29</mainNavig>
  <networkTimeZone>1</networkTimeZone>
  <networkType>sample string 13</networkType>
  <networkTypeSettings>1</networkTypeSettings>
  <paymentInstructions>sample string 4</paymentInstructions>
  <privacySetting>1</privacySetting>
  <promptForUserType>true</promptForUserType>
  <publicViewable>1</publicViewable>
  <questionFor>1</questionFor>
  <questionId>1</questionId>
  <questionOptions>sample string 18</questionOptions>
  <questionTitle>sample string 17</questionTitle>
  <questionType>1</questionType>
  <registrationInformation>sample string 2</registrationInformation>
  <remainEligibleIfOnRoster>true</remainEligibleIfOnRoster>
  <restrictAge>true</restrictAge>
  <restrictAgeNum>1</restrictAgeNum>
  <restrictAgeSuspensionInfo>sample string 3</restrictAgeSuspensionInfo>
  <schoolAddress>sample string 7</schoolAddress>
  <schoolBanner>sample string 37</schoolBanner>
  <schoolDescription>sample string 1</schoolDescription>
  <schoolIdValue>sample string 35</schoolIdValue>
  <schoolLogo>sample string 36</schoolLogo>
  <settings>
    <timeZone>1</timeZone>
  </settings>
  <ssoGuestsName>sample string 14</ssoGuestsName>
  <ssoMembersName>sample string 15</ssoMembersName>
  <state>sample string 9</state>
  <statusTitle>sample string 19</statusTitle>
  <statuses>
    <StatusRowInVO>
      <displayName>sample string 2</displayName>
      <gradeYear>3</gradeYear>
      <key>sample string 1</key>
      <visible>true</visible>
    </StatusRowInVO>
    <StatusRowInVO>
      <displayName>sample string 2</displayName>
      <gradeYear>3</gradeYear>
      <key>sample string 1</key>
      <visible>true</visible>
    </StatusRowInVO>
    <StatusRowInVO>
      <displayName>sample string 2</displayName>
      <gradeYear>3</gradeYear>
      <key>sample string 1</key>
      <visible>true</visible>
    </StatusRowInVO>
  </statuses>
  <subNaviFont>sample string 32</subNaviFont>
  <subNavig>sample string 31</subNavig>
  <telephone>sample string 12</telephone>
  <titleColor>sample string 33</titleColor>
  <useCustomTemplate>true</useCustomTemplate>
  <userReports>true</userReports>
  <userTypeCanBeSelected>true</userTypeCanBeSelected>
  <userTypeId>1</userTypeId>
  <userTypeName>sample string 16</userTypeName>
  <webSite>sample string 11</webSite>
  <zipCode>sample string 10</zipCode>
</NetworkSettingsInVO>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="settings.timeZone"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="schoolDescription"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="registrationInformation"

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

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="paymentInstructions"

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

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="contactInfo"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="schoolAddress"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="city"

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

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="zipCode"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="webSite"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="telephone"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="enrollment"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="userReports"

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

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="privacySetting"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="networkTypeSettings"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="isSsoAllowGuests"

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

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ssoMembersName"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="allowSsoSetPassword"

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

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

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

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

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="collectBirth"

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

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

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

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

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

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="userTypeName"

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

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

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="questionType"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="questionTitle"

sample string 17
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="questionOptions"

sample string 18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="questionFor"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="customizedStatus"

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

sample string 19
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="statuses[0].key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="statuses[0].displayName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="statuses[0].gradeYear"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="statuses[0].visible"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="statuses[1].key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="statuses[1].displayName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="statuses[1].gradeYear"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="statuses[1].visible"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="statuses[2].key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="statuses[2].displayName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="statuses[2].gradeYear"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="statuses[2].visible"

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

sample string 20
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="instagramHash"

sample string 21
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="useCustomTemplate"

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

sample string 22
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="emailFooterLogo"

sample string 23
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="emailFacebookUrl"

sample string 24
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="emailTwitterUrl"

sample string 25
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="emailInstagramUrl"

sample string 26
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="emailWebsiteUrl"

sample string 27
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="footHeader"

sample string 28
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="mainNavig"

sample string 29
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="mainNaviFont"

sample string 30
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="subNavig"

sample string 31
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="subNaviFont"

sample string 32
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="titleColor"

sample string 33
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="fontTitleBack"

sample string 34
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="schoolIdValue"

sample string 35
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="publicViewable"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="networkTimeZone"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="schoolLogo"

sample string 36
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="schoolBanner"

sample string 37
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="enableAffiliation"

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

sample string 38
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="domainId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="affiliationId"

sample string 39
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="affiliationName"

sample string 40
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="affiliationCode"

sample string 41
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="pageType"

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

sample string 42
--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": "b6d9b53b-b1b3-45a9-bbfa-2342b6be978d",
  "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>b6d9b53b-b1b3-45a9-bbfa-2342b6be978d</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.