POST web/admin/network/sidimport/startimport

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:

{
  "schoolID": "sample string 1",
  "replaceOldRecords": true,
  "keepManullyAddedRecords": true,
  "fieldMappings": [
    {
      "fieldName": "sample string 1",
      "mappingFieldName": "sample string 2",
      "isOverwrite": true
    },
    {
      "fieldName": "sample string 1",
      "mappingFieldName": "sample string 2",
      "isOverwrite": true
    },
    {
      "fieldName": "sample string 1",
      "mappingFieldName": "sample string 2",
      "isOverwrite": true
    }
  ],
  "selectedSheets": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "scopeType": 4,
  "isCleanUpUserType": true,
  "cleanUpUserTypes": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "isUpdateMemberInfo": true,
  "createAfterImportAccount": true,
  "notifyUserAfterImportAccount": true,
  "autoAssignMembership": true,
  "assignMembershipList": [
    {
      "membershipId": 1,
      "userTypes": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    {
      "membershipId": 1,
      "userTypes": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    {
      "membershipId": 1,
      "userTypes": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    }
  ],
  "isCleanUpMembership": true,
  "curUserId": "sample string 11",
  "isSSO": true,
  "requestHost": "sample string 13",
  "applicationPath": "sample string 14",
  "secureApplicationPath": "sample string 15",
  "absoluteApplicationPath": "sample string 16",
  "isHttps": true,
  "isMobileDevice": true,
  "isElectron": true,
  "isFullEmbed": true,
  "clientType": 0,
  "clientVersion": "sample string 21",
  "clientOS": "sample string 22",
  "clientBuild": "sample string 23",
  "premiumAppId": "sample string 24",
  "clientWidth": 25,
  "clientHeight": 26,
  "timezone": 27
}

application/xml, text/xml

Sample:

<SidImportStartInVO 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">26</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">25</ClientWidth>
  <absoluteApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 16</absoluteApplicationPath>
  <applicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 14</applicationPath>
  <cachedKey xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 1</cachedKey>
  <clientBuild xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 23</clientBuild>
  <clientOS xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 22</clientOS>
  <clientVersion xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 21</clientVersion>
  <curUserId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 11</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 24</premiumAppId>
  <requestHost xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 13</requestHost>
  <secureApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 15</secureApplicationPath>
  <timezone xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">27</timezone>
  <AssignMembershipList>
    <SidImportAssignMembershipItem>
      <MembershipId>1</MembershipId>
      <UserTypes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </UserTypes>
    </SidImportAssignMembershipItem>
    <SidImportAssignMembershipItem>
      <MembershipId>1</MembershipId>
      <UserTypes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </UserTypes>
    </SidImportAssignMembershipItem>
    <SidImportAssignMembershipItem>
      <MembershipId>1</MembershipId>
      <UserTypes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </UserTypes>
    </SidImportAssignMembershipItem>
  </AssignMembershipList>
  <AutoAssignMembership>true</AutoAssignMembership>
  <CleanUpUserTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </CleanUpUserTypes>
  <CreateAfterImportAccount>true</CreateAfterImportAccount>
  <FieldMappings>
    <SidImportFieldMappingItem>
      <FieldName>sample string 1</FieldName>
      <IsOverwrite>true</IsOverwrite>
      <MappingFieldName>sample string 2</MappingFieldName>
    </SidImportFieldMappingItem>
    <SidImportFieldMappingItem>
      <FieldName>sample string 1</FieldName>
      <IsOverwrite>true</IsOverwrite>
      <MappingFieldName>sample string 2</MappingFieldName>
    </SidImportFieldMappingItem>
    <SidImportFieldMappingItem>
      <FieldName>sample string 1</FieldName>
      <IsOverwrite>true</IsOverwrite>
      <MappingFieldName>sample string 2</MappingFieldName>
    </SidImportFieldMappingItem>
  </FieldMappings>
  <IsCleanUpMembership>true</IsCleanUpMembership>
  <IsCleanUpUserType>true</IsCleanUpUserType>
  <IsUpdateMemberInfo>true</IsUpdateMemberInfo>
  <KeepManullyAddedRecords>true</KeepManullyAddedRecords>
  <NotifyUserAfterImportAccount>true</NotifyUserAfterImportAccount>
  <ReplaceOldRecords>true</ReplaceOldRecords>
  <SchoolID>sample string 1</SchoolID>
  <ScopeType>4</ScopeType>
  <SelectedSheets xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </SelectedSheets>
</SidImportStartInVO>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

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

sample string 1
--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": "cd19d451-097b-47de-b38b-4066e8db7979",
  "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>cd19d451-097b-47de-b38b-4066e8db7979</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.