GET api/StudentRelationships/{StudentRelationshipId}

Returns a Student Relationship.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
StudentRelationshipId

Application identifier for the Student Relationship

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

StudentRelationship object for the specified StudentRelationshipId

StudentRelationship
NameDescriptionTypeAdditional information
StudentId

The application identifier of the Student for the Student Relationship.

 globally unique identifier

None.
StudentRelationshipPerson

The Person for the Student Relationship.

 Person

None.
RelationshipType

The Relationship Type user identifier for the Student Relationship.

 string

None.
RelationshipDescription

The Relationship Type description for the Student Relationship.

 string

None.
ContactSequence

The contact sequence for the Student Relationship. This is the order in which Student Relationships should be contacted.

 integer

None.
ParentLegalGuardian

The indicator for whether the Student Relationship is a parent or legal guardian for the Student.

 boolean

None.
HasCustody

The indicator for whether the Student Relationship has custody for the Student.

 boolean

None.
AccessToRecords

The indicator for whether the Student Relationship has access to records for the Student.

 boolean

None.
PickupRights

The indicator for whether the Student Relationship has pickup rights for the Student.

 boolean

None.
LivesWith

The indicator for whether the Student Relationship lives with the Student.

 boolean

None.
EmergencyContact

The indicator for whether the Student Relationship is an emergency contact for the Student.

 boolean

None.
DefaultAddress

The default address for the Student Relationship.

 Address

None.
AddressList

The addresses for the Student Relationship. This list includes the default address for the Student Relationship.

 Collection of Address

None.
DefaultPhone

The default phone for the Student Relationship.

 Phone

None.
PhoneList

The phones for the Student Relationship. This list includes the default phone for the Student Relationship.

 Collection of Phone

None.
DefaultEmail

The default email for the Student Relationship.

 Email

None.
EmailList

The emails for the Student Relationship. This list includes the default email for the Student Relationship.

 Collection of Email

None.
SIFRefId

The SIFRefID for the Student Relationship.

 globally unique identifier

None.
Id

The application identifier for the object. This cannot be changed by the user.

 globally unique identifier

None.
DataVersion

The version of the API data

 string

None.
ApiName

The name of the object without the Api suffix

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "StudentId": "c0629c70-b834-4928-81f9-a6aba10d0141",
  "StudentRelationshipPerson": {
    "Title": "sample string 1",
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "Suffix": "sample string 5",
    "AlternateFirstName": "sample string 6",
    "AlternateLastName": "sample string 7",
    "SSN": "sample string 8",
    "Gender": "sample string 9",
    "BirthDate": "2025-04-25T23:36:23.2130233-05:00",
    "HispanicLatino": true,
    "AmericanIndian": true,
    "White": true,
    "Asian": true,
    "PacificIslander": true,
    "Black": true,
    "UnknownRace": true,
    "EmployerName": "sample string 18",
    "LanguageCodeUid": "sample string 19",
    "LanguageCodeDescription": "sample string 20",
    "Id": "cb1d00f1-eb70-4d79-9ce5-f88dce245fba",
    "DataVersion": "sample string 22",
    "ApiName": ""
  },
  "RelationshipType": "sample string 2",
  "RelationshipDescription": "sample string 3",
  "ContactSequence": 4,
  "ParentLegalGuardian": true,
  "HasCustody": true,
  "AccessToRecords": true,
  "PickupRights": true,
  "LivesWith": true,
  "EmergencyContact": true,
  "DefaultAddress": {
    "AddressType": "sample string 1",
    "AddressTypeDescription": "sample string 2",
    "Line1": "sample string 3",
    "Line2": "sample string 4",
    "Line3": "sample string 5",
    "Apartment": "sample string 6",
    "City": "sample string 7",
    "State": "sample string 8",
    "Country": "sample string 9",
    "PostalCode": "sample string 10",
    "Zip": "sample string 11",
    "ZipPlusFour": "sample string 12",
    "RoomNumber": "sample string 13",
    "Id": "1b7e021a-6ffe-4d3b-aab3-1f3468998a41",
    "DataVersion": "sample string 15",
    "ApiName": ""
  },
  "AddressList": [
    {
      "AddressType": "sample string 1",
      "AddressTypeDescription": "sample string 2",
      "Line1": "sample string 3",
      "Line2": "sample string 4",
      "Line3": "sample string 5",
      "Apartment": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "Country": "sample string 9",
      "PostalCode": "sample string 10",
      "Zip": "sample string 11",
      "ZipPlusFour": "sample string 12",
      "RoomNumber": "sample string 13",
      "Id": "1b7e021a-6ffe-4d3b-aab3-1f3468998a41",
      "DataVersion": "sample string 15",
      "ApiName": ""
    },
    {
      "AddressType": "sample string 1",
      "AddressTypeDescription": "sample string 2",
      "Line1": "sample string 3",
      "Line2": "sample string 4",
      "Line3": "sample string 5",
      "Apartment": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "Country": "sample string 9",
      "PostalCode": "sample string 10",
      "Zip": "sample string 11",
      "ZipPlusFour": "sample string 12",
      "RoomNumber": "sample string 13",
      "Id": "1b7e021a-6ffe-4d3b-aab3-1f3468998a41",
      "DataVersion": "sample string 15",
      "ApiName": ""
    }
  ],
  "DefaultPhone": {
    "MessageDeviceType": "sample string 1",
    "MessageDeviceTypeDescription": "sample string 2",
    "Number": "sample string 3",
    "Description": "sample string 4",
    "Id": "8dcd0003-684d-445f-8d97-6eb739e3ef7c",
    "DataVersion": "sample string 6",
    "ApiName": ""
  },
  "PhoneList": [
    {
      "MessageDeviceType": "sample string 1",
      "MessageDeviceTypeDescription": "sample string 2",
      "Number": "sample string 3",
      "Description": "sample string 4",
      "Id": "8dcd0003-684d-445f-8d97-6eb739e3ef7c",
      "DataVersion": "sample string 6",
      "ApiName": ""
    },
    {
      "MessageDeviceType": "sample string 1",
      "MessageDeviceTypeDescription": "sample string 2",
      "Number": "sample string 3",
      "Description": "sample string 4",
      "Id": "8dcd0003-684d-445f-8d97-6eb739e3ef7c",
      "DataVersion": "sample string 6",
      "ApiName": ""
    }
  ],
  "DefaultEmail": {
    "Address": "sample string 1",
    "Description": "sample string 2",
    "Id": "31add8ec-f335-4cc3-9cde-8ffc6366cc99",
    "DataVersion": "sample string 4",
    "ApiName": ""
  },
  "EmailList": [
    {
      "Address": "sample string 1",
      "Description": "sample string 2",
      "Id": "31add8ec-f335-4cc3-9cde-8ffc6366cc99",
      "DataVersion": "sample string 4",
      "ApiName": ""
    },
    {
      "Address": "sample string 1",
      "Description": "sample string 2",
      "Id": "31add8ec-f335-4cc3-9cde-8ffc6366cc99",
      "DataVersion": "sample string 4",
      "ApiName": ""
    }
  ],
  "SIFRefId": "74600299-e12e-4890-81b0-8e04464cef7a",
  "Id": "c4663a32-13db-4b62-82e0-1fae01fb7fa6",
  "DataVersion": "sample string 13",
  "ApiName": ""
}

application/xml, text/xml

Sample: 
<StudentRelationship xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi.v1">
  <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 13</DataVersion>
  <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">c4663a32-13db-4b62-82e0-1fae01fb7fa6</Id>
  <AccessToRecords>true</AccessToRecords>
  <AddressList>
    <Address>
      <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 15</DataVersion>
      <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">1b7e021a-6ffe-4d3b-aab3-1f3468998a41</Id>
      <AddressType>sample string 1</AddressType>
      <AddressTypeDescription>sample string 2</AddressTypeDescription>
      <Apartment>sample string 6</Apartment>
      <City>sample string 7</City>
      <Country>sample string 9</Country>
      <Line1>sample string 3</Line1>
      <Line2>sample string 4</Line2>
      <Line3>sample string 5</Line3>
      <PostalCode>sample string 10</PostalCode>
      <RoomNumber>sample string 13</RoomNumber>
      <State>sample string 8</State>
      <Zip>sample string 11</Zip>
      <ZipPlusFour>sample string 12</ZipPlusFour>
    </Address>
    <Address>
      <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 15</DataVersion>
      <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">1b7e021a-6ffe-4d3b-aab3-1f3468998a41</Id>
      <AddressType>sample string 1</AddressType>
      <AddressTypeDescription>sample string 2</AddressTypeDescription>
      <Apartment>sample string 6</Apartment>
      <City>sample string 7</City>
      <Country>sample string 9</Country>
      <Line1>sample string 3</Line1>
      <Line2>sample string 4</Line2>
      <Line3>sample string 5</Line3>
      <PostalCode>sample string 10</PostalCode>
      <RoomNumber>sample string 13</RoomNumber>
      <State>sample string 8</State>
      <Zip>sample string 11</Zip>
      <ZipPlusFour>sample string 12</ZipPlusFour>
    </Address>
  </AddressList>
  <ContactSequence>4</ContactSequence>
  <DefaultAddress>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 15</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">1b7e021a-6ffe-4d3b-aab3-1f3468998a41</Id>
    <AddressType>sample string 1</AddressType>
    <AddressTypeDescription>sample string 2</AddressTypeDescription>
    <Apartment>sample string 6</Apartment>
    <City>sample string 7</City>
    <Country>sample string 9</Country>
    <Line1>sample string 3</Line1>
    <Line2>sample string 4</Line2>
    <Line3>sample string 5</Line3>
    <PostalCode>sample string 10</PostalCode>
    <RoomNumber>sample string 13</RoomNumber>
    <State>sample string 8</State>
    <Zip>sample string 11</Zip>
    <ZipPlusFour>sample string 12</ZipPlusFour>
  </DefaultAddress>
  <DefaultEmail>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 4</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">31add8ec-f335-4cc3-9cde-8ffc6366cc99</Id>
    <Address>sample string 1</Address>
    <Description>sample string 2</Description>
  </DefaultEmail>
  <DefaultPhone>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 6</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">8dcd0003-684d-445f-8d97-6eb739e3ef7c</Id>
    <Description>sample string 4</Description>
    <MessageDeviceType>sample string 1</MessageDeviceType>
    <MessageDeviceTypeDescription>sample string 2</MessageDeviceTypeDescription>
    <Number>sample string 3</Number>
  </DefaultPhone>
  <EmailList>
    <Email>
      <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 4</DataVersion>
      <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">31add8ec-f335-4cc3-9cde-8ffc6366cc99</Id>
      <Address>sample string 1</Address>
      <Description>sample string 2</Description>
    </Email>
    <Email>
      <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 4</DataVersion>
      <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">31add8ec-f335-4cc3-9cde-8ffc6366cc99</Id>
      <Address>sample string 1</Address>
      <Description>sample string 2</Description>
    </Email>
  </EmailList>
  <EmergencyContact>true</EmergencyContact>
  <HasCustody>true</HasCustody>
  <LivesWith>true</LivesWith>
  <ParentLegalGuardian>true</ParentLegalGuardian>
  <PhoneList>
    <Phone>
      <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 6</DataVersion>
      <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">8dcd0003-684d-445f-8d97-6eb739e3ef7c</Id>
      <Description>sample string 4</Description>
      <MessageDeviceType>sample string 1</MessageDeviceType>
      <MessageDeviceTypeDescription>sample string 2</MessageDeviceTypeDescription>
      <Number>sample string 3</Number>
    </Phone>
    <Phone>
      <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 6</DataVersion>
      <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">8dcd0003-684d-445f-8d97-6eb739e3ef7c</Id>
      <Description>sample string 4</Description>
      <MessageDeviceType>sample string 1</MessageDeviceType>
      <MessageDeviceTypeDescription>sample string 2</MessageDeviceTypeDescription>
      <Number>sample string 3</Number>
    </Phone>
  </PhoneList>
  <PickupRights>true</PickupRights>
  <RelationshipDescription>sample string 3</RelationshipDescription>
  <RelationshipType>sample string 2</RelationshipType>
  <SIFRefId>74600299-e12e-4890-81b0-8e04464cef7a</SIFRefId>
  <StudentId>c0629c70-b834-4928-81f9-a6aba10d0141</StudentId>
  <StudentRelationshipPerson>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 22</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">cb1d00f1-eb70-4d79-9ce5-f88dce245fba</Id>
    <AlternateFirstName>sample string 6</AlternateFirstName>
    <AlternateLastName>sample string 7</AlternateLastName>
    <AmericanIndian>true</AmericanIndian>
    <Asian>true</Asian>
    <BirthDate>2025-04-25T23:36:23.2130233-05:00</BirthDate>
    <Black>true</Black>
    <EmployerName>sample string 18</EmployerName>
    <FirstName>sample string 2</FirstName>
    <Gender>sample string 9</Gender>
    <HispanicLatino>true</HispanicLatino>
    <LanguageCodeDescription>sample string 20</LanguageCodeDescription>
    <LanguageCodeUid>sample string 19</LanguageCodeUid>
    <LastName>sample string 4</LastName>
    <MiddleName>sample string 3</MiddleName>
    <PacificIslander>true</PacificIslander>
    <SSN>sample string 8</SSN>
    <Suffix>sample string 5</Suffix>
    <Title>sample string 1</Title>
    <UnknownRace>true</UnknownRace>
    <White>true</White>
  </StudentRelationshipPerson>
</StudentRelationship>