POST v3/members/joinnetwork?networkId={networkId}
join school
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
networkId |
Define this parameter in the request URI. |
|
inVO |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{ "requestMessage": "sample string 1", "status": "sample string 2", "gradYear": "sample string 3", "answers": [ { "id": 1, "answer": "sample string 2" }, { "id": 1, "answer": "sample string 2" }, { "id": 1, "answer": "sample string 2" } ], "schoolId": "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, "isFullEmbed": true, "clientType": 0, "clientVersion": "sample string 14", "clientOS": "sample string 15", "clientBuild": "sample string 16", "premiumAppId": "sample string 17", "clientWidth": 18, "clientHeight": 19, "timezone": 20 }
application/xml, text/xml
Sample:
<JoinSchoolInVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input"> <ClientHeight>19</ClientHeight> <ClientType>Site</ClientType> <ClientWidth>18</ClientWidth> <absoluteApplicationPath>sample string 10</absoluteApplicationPath> <applicationPath>sample string 8</applicationPath> <cachedKey>sample string 1</cachedKey> <clientBuild>sample string 16</clientBuild> <clientOS>sample string 15</clientOS> <clientVersion>sample string 14</clientVersion> <curUserId>sample string 5</curUserId> <isFullEmbed>true</isFullEmbed> <isHttps>true</isHttps> <isMobileDevice>true</isMobileDevice> <isSSO>true</isSSO> <premiumAppId>sample string 17</premiumAppId> <requestHost>sample string 7</requestHost> <secureApplicationPath>sample string 9</secureApplicationPath> <timezone>20</timezone> <SchoolId>sample string 4</SchoolId> <GradYear>sample string 3</GradYear> <RequestMessage>sample string 1</RequestMessage> <Status>sample string 2</Status> <answers> <QuestionAnswerInVO> <answer>sample string 2</answer> <id>1</id> </QuestionAnswerInVO> <QuestionAnswerInVO> <answer>sample string 2</answer> <id>1</id> </QuestionAnswerInVO> <QuestionAnswerInVO> <answer>sample string 2</answer> <id>1</id> </QuestionAnswerInVO> </answers> </JoinSchoolInVO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
{ "type": 1, "schoolMemberId": "sample string 2", "message": "sample string 3" }
application/xml, text/xml
Sample:
<JoinSchoolResultOutVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.Member"> <Message>sample string 3</Message> <SchoolMemberId>sample string 2</SchoolMemberId> <Type>1</Type> </JoinSchoolResultOutVO>