POST api/integration/receiveTransfer

Request Information

URI Parameters

None.

Body Parameters

StaffTransferInputModel
NameDescriptionTypeAdditional information
FirstName

string

None.
LastName

string

None.
Email

string

None.
DistrictId

integer

None.
SchoolId

integer

None.
Role

integer

None.
UserName

string

None.
SubStartDate

date

None.
SubEndDate

date

None.
Password

string

None.
Student

StudentForStaffTransferInputModel

None.

Request Formats

application/json, text/json

Sample: 
{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "Email": "sample string 3",
  "DistrictId": 4,
  "SchoolId": 5,
  "Role": 6,
  "UserName": "sample string 7",
  "SubStartDate": "2026-02-03T21:50:09.0606159+00:00",
  "SubEndDate": "2026-02-03T21:50:09.0606159+00:00",
  "Password": "sample string 10",
  "Student": {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "Gender": 3,
    "GradeLevel": 0,
    "Teacher": "sample string 4",
    "AssessmentLevel": 5,
    "SchoolId": 6,
    "SSID": 1
  }
}

application/xml, text/xml

Sample: 
<StaffTransferInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LS_API.Models.StaffModels.InputModel">
  <DistrictId>4</DistrictId>
  <Email>sample string 3</Email>
  <FirstName>sample string 1</FirstName>
  <LastName>sample string 2</LastName>
  <Password>sample string 10</Password>
  <Role>6</Role>
  <SchoolId>5</SchoolId>
  <Student xmlns:d2p1="http://schemas.datacontract.org/2004/07/Domain.Objects.StudentObjects.StudentModels.InputModel">
    <d2p1:AssessmentLevel>5</d2p1:AssessmentLevel>
    <d2p1:FirstName>sample string 1</d2p1:FirstName>
    <d2p1:Gender>3</d2p1:Gender>
    <d2p1:GradeLevel>KINDERGARTEN</d2p1:GradeLevel>
    <d2p1:LastName>sample string 2</d2p1:LastName>
    <d2p1:SSID>1</d2p1:SSID>
    <d2p1:SchoolId>6</d2p1:SchoolId>
    <d2p1:Teacher>sample string 4</d2p1:Teacher>
  </Student>
  <SubEndDate>2026-02-03T21:50:09.0606159+00:00</SubEndDate>
  <SubStartDate>2026-02-03T21:50:09.0606159+00:00</SubStartDate>
  <UserName>sample string 7</UserName>
</StaffTransferInputModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

StaffTransferReturnModelData
NameDescriptionTypeAdditional information
UserName

string

None.
URL

string

None.
Success

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "UserName": "sample string 1",
  "URL": "sample string 2",
  "Success": true
}

application/xml, text/xml

Sample: 
<StaffTransferReturnModelData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LS_API.Models.StaffModels.ViewModel">
  <Success>true</Success>
  <URL>sample string 2</URL>
  <UserName>sample string 1</UserName>
</StaffTransferReturnModelData>