lock
GET
apiportal/v1/StudentContact/{id}?page={page}
No documentation available.
EXPANDexpand_more
Request Information
Roles
- Vendor_APIClient
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| page | integer |
None. |
|
| id | integer |
None. |
Body Parameters
None.
EXPANDexpand_more
Response Information
Resource Description
Collection of spsStudentContactsAPI_Response| Name | Description | Type | Additional information |
|---|---|---|---|
| StudentID | integer |
None. |
|
| StudentPersonalInfo | _PersonalInfo |
None. |
|
| ContactID | integer |
None. |
|
| ContactName | string |
None. |
|
| ContactPersonalInfo | _PersonalInfo |
None. |
|
| ContactType | string |
None. |
|
| ContactTypeDescription | string |
None. |
|
| ContactRelationship | string |
None. |
|
| ContactRelationshipDescription | string |
None. |
|
| ContactAddressDetails | CommunityAddress |
None. |
|
| ContactDefaultEmail | string |
None. |
|
| ContactOccupEmail | string |
None. |
|
| ContactEmail | string |
None. |
|
| UseSMS | string |
None. |
|
| UseEmail | string |
None. |
|
| PortalApproval | string |
None. |
|
| ParentFlag | boolean |
None. |
|
| NormalMailFlag | boolean |
None. |
|
| ReportsFlag | boolean |
None. |
|
| PrimaryOnlyFlag | boolean |
None. |
|
| LivesWithFlag | boolean |
None. |
|
| ContactSpouseID | integer |
None. |
|
| ContactSpouseFullName | string |
None. |
|
| ContactSpouseRelationship | string |
None. |
|
| ContactSpouseRelationshipDescription | string |
None. |
|
| SpouseDefaultMobilePhone | string |
None. |
|
| SpouseDefaultEmail | string |
None. |
|
| SpouseSIF3RefID | globally unique identifier |
None. |
|
| SIF3RefID | globally unique identifier |
None. |
|
| StudentContactsSeq | integer |
None. |
Response Formats
[
{
"StudentID": 1,
"StudentPersonalInfo": {
"Given1": "sample string 1",
"Given2": "sample string 2",
"Initials": "sample string 3",
"Suffix": "sample string 4",
"Surname": "sample string 5",
"NameInternal": "sample string 6",
"NameExternal": "sample string 7",
"LegalFullName": "sample string 8",
"PreferredFormal": "sample string 9",
"Title": "sample string 10",
"Preferred": "sample string 11",
"Gender": "sample string 12"
},
"ContactID": 2,
"ContactName": "sample string 3",
"ContactPersonalInfo": {
"Given1": "sample string 1",
"Given2": "sample string 2",
"Initials": "sample string 3",
"Suffix": "sample string 4",
"Surname": "sample string 5",
"NameInternal": "sample string 6",
"NameExternal": "sample string 7",
"LegalFullName": "sample string 8",
"PreferredFormal": "sample string 9",
"Title": "sample string 10",
"Preferred": "sample string 11",
"Gender": "sample string 12"
},
"ContactType": "sample string 4",
"ContactTypeDescription": "sample string 5",
"ContactRelationship": "sample string 6",
"ContactRelationshipDescription": "sample string 7",
"ContactAddressDetails": {
"AddressID": 1,
"HomeAddress1": "sample string 2",
"HomeAddress2": "sample string 3",
"HomeAddress3": "sample string 4",
"HomeSuburb": "sample string 5",
"HomeState": "sample string 6",
"HomePostCode": "sample string 7",
"HomeCountryCode": "sample string 8",
"Address1": "sample string 9",
"Address2": "sample string 10",
"Address3": "sample string 11",
"Suburb": "sample string 12",
"State": "sample string 13",
"PostCode": "sample string 14",
"CountryCode": "sample string 15",
"PhoneActual": "sample string 16",
"PhoneAlt": "sample string 17",
"SilentPhoneFlag": true,
"ValidAddressFlag": true,
"HomeAddressSameFlag": true,
"Fax": "sample string 21",
"HomeAddressDPID": "sample string 22",
"HomeAddressDPIDBarcode": "sample string 23",
"HomeAddressSortPlanNumber": "sample string 24",
"HomeAddressPAFVersion": "sample string 25",
"AddressDPID": "sample string 26",
"AddressDPIDBarcode": "sample string 27",
"AddressSortPlanNumber": "sample string 28",
"AddressPAFVersion": "sample string 29",
"HomeAddressLatitude": "sample string 30",
"HomeAddressLongitude": "sample string 31",
"ExternalValidationFlag": true,
"HomeAddressValidationSeq": 33,
"AddressValidationSeq": 34
},
"ContactDefaultEmail": "sample string 8",
"ContactOccupEmail": "sample string 9",
"ContactEmail": "sample string 10",
"UseSMS": "sample string 11",
"UseEmail": "sample string 12",
"PortalApproval": "sample string 13",
"ParentFlag": true,
"NormalMailFlag": true,
"ReportsFlag": true,
"PrimaryOnlyFlag": true,
"LivesWithFlag": true,
"ContactSpouseID": 19,
"ContactSpouseFullName": "sample string 20",
"ContactSpouseRelationship": "sample string 21",
"ContactSpouseRelationshipDescription": "sample string 22",
"SpouseDefaultMobilePhone": "sample string 23",
"SpouseDefaultEmail": "sample string 24",
"SpouseSIF3RefID": "2e281bc3-8860-408d-843b-71fcb5ca33f7",
"SIF3RefID": "0c6a8aa1-4595-4d13-8a06-14c7315c0073",
"StudentContactsSeq": 25
},
{
"StudentID": 1,
"StudentPersonalInfo": {
"Given1": "sample string 1",
"Given2": "sample string 2",
"Initials": "sample string 3",
"Suffix": "sample string 4",
"Surname": "sample string 5",
"NameInternal": "sample string 6",
"NameExternal": "sample string 7",
"LegalFullName": "sample string 8",
"PreferredFormal": "sample string 9",
"Title": "sample string 10",
"Preferred": "sample string 11",
"Gender": "sample string 12"
},
"ContactID": 2,
"ContactName": "sample string 3",
"ContactPersonalInfo": {
"Given1": "sample string 1",
"Given2": "sample string 2",
"Initials": "sample string 3",
"Suffix": "sample string 4",
"Surname": "sample string 5",
"NameInternal": "sample string 6",
"NameExternal": "sample string 7",
"LegalFullName": "sample string 8",
"PreferredFormal": "sample string 9",
"Title": "sample string 10",
"Preferred": "sample string 11",
"Gender": "sample string 12"
},
"ContactType": "sample string 4",
"ContactTypeDescription": "sample string 5",
"ContactRelationship": "sample string 6",
"ContactRelationshipDescription": "sample string 7",
"ContactAddressDetails": {
"AddressID": 1,
"HomeAddress1": "sample string 2",
"HomeAddress2": "sample string 3",
"HomeAddress3": "sample string 4",
"HomeSuburb": "sample string 5",
"HomeState": "sample string 6",
"HomePostCode": "sample string 7",
"HomeCountryCode": "sample string 8",
"Address1": "sample string 9",
"Address2": "sample string 10",
"Address3": "sample string 11",
"Suburb": "sample string 12",
"State": "sample string 13",
"PostCode": "sample string 14",
"CountryCode": "sample string 15",
"PhoneActual": "sample string 16",
"PhoneAlt": "sample string 17",
"SilentPhoneFlag": true,
"ValidAddressFlag": true,
"HomeAddressSameFlag": true,
"Fax": "sample string 21",
"HomeAddressDPID": "sample string 22",
"HomeAddressDPIDBarcode": "sample string 23",
"HomeAddressSortPlanNumber": "sample string 24",
"HomeAddressPAFVersion": "sample string 25",
"AddressDPID": "sample string 26",
"AddressDPIDBarcode": "sample string 27",
"AddressSortPlanNumber": "sample string 28",
"AddressPAFVersion": "sample string 29",
"HomeAddressLatitude": "sample string 30",
"HomeAddressLongitude": "sample string 31",
"ExternalValidationFlag": true,
"HomeAddressValidationSeq": 33,
"AddressValidationSeq": 34
},
"ContactDefaultEmail": "sample string 8",
"ContactOccupEmail": "sample string 9",
"ContactEmail": "sample string 10",
"UseSMS": "sample string 11",
"UseEmail": "sample string 12",
"PortalApproval": "sample string 13",
"ParentFlag": true,
"NormalMailFlag": true,
"ReportsFlag": true,
"PrimaryOnlyFlag": true,
"LivesWithFlag": true,
"ContactSpouseID": 19,
"ContactSpouseFullName": "sample string 20",
"ContactSpouseRelationship": "sample string 21",
"ContactSpouseRelationshipDescription": "sample string 22",
"SpouseDefaultMobilePhone": "sample string 23",
"SpouseDefaultEmail": "sample string 24",
"SpouseSIF3RefID": "2e281bc3-8860-408d-843b-71fcb5ca33f7",
"SIF3RefID": "0c6a8aa1-4595-4d13-8a06-14c7315c0073",
"StudentContactsSeq": 25
}
]
<ArrayOfspsStudentContactsAPI_Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
<spsStudentContactsAPI_Response>
<ContactAddressDetails>
<Address1>sample string 9</Address1>
<Address2>sample string 10</Address2>
<Address3>sample string 11</Address3>
<AddressDPID>sample string 26</AddressDPID>
<AddressDPIDBarcode>sample string 27</AddressDPIDBarcode>
<AddressID>1</AddressID>
<AddressPAFVersion>sample string 29</AddressPAFVersion>
<AddressSortPlanNumber>sample string 28</AddressSortPlanNumber>
<AddressValidationSeq>34</AddressValidationSeq>
<CountryCode>sample string 15</CountryCode>
<ExternalValidationFlag>true</ExternalValidationFlag>
<Fax>sample string 21</Fax>
<HomeAddress1>sample string 2</HomeAddress1>
<HomeAddress2>sample string 3</HomeAddress2>
<HomeAddress3>sample string 4</HomeAddress3>
<HomeAddressDPID>sample string 22</HomeAddressDPID>
<HomeAddressDPIDBarcode>sample string 23</HomeAddressDPIDBarcode>
<HomeAddressLatitude>sample string 30</HomeAddressLatitude>
<HomeAddressLongitude>sample string 31</HomeAddressLongitude>
<HomeAddressPAFVersion>sample string 25</HomeAddressPAFVersion>
<HomeAddressSameFlag>true</HomeAddressSameFlag>
<HomeAddressSortPlanNumber>sample string 24</HomeAddressSortPlanNumber>
<HomeAddressValidationSeq>33</HomeAddressValidationSeq>
<HomeCountryCode>sample string 8</HomeCountryCode>
<HomePostCode>sample string 7</HomePostCode>
<HomeState>sample string 6</HomeState>
<HomeSuburb>sample string 5</HomeSuburb>
<PhoneActual>sample string 16</PhoneActual>
<PhoneAlt>sample string 17</PhoneAlt>
<PostCode>sample string 14</PostCode>
<SilentPhoneFlag>true</SilentPhoneFlag>
<State>sample string 13</State>
<Suburb>sample string 12</Suburb>
<ValidAddressFlag>true</ValidAddressFlag>
</ContactAddressDetails>
<ContactDefaultEmail>sample string 8</ContactDefaultEmail>
<ContactEmail>sample string 10</ContactEmail>
<ContactID>2</ContactID>
<ContactName>sample string 3</ContactName>
<ContactOccupEmail>sample string 9</ContactOccupEmail>
<ContactPersonalInfo>
<Gender>sample string 12</Gender>
<Given1>sample string 1</Given1>
<Given2>sample string 2</Given2>
<Initials>sample string 3</Initials>
<LegalFullName>sample string 8</LegalFullName>
<NameExternal>sample string 7</NameExternal>
<NameInternal>sample string 6</NameInternal>
<Preferred>sample string 11</Preferred>
<PreferredFormal>sample string 9</PreferredFormal>
<Suffix>sample string 4</Suffix>
<Surname>sample string 5</Surname>
<Title>sample string 10</Title>
</ContactPersonalInfo>
<ContactRelationship>sample string 6</ContactRelationship>
<ContactRelationshipDescription>sample string 7</ContactRelationshipDescription>
<ContactSpouseFullName>sample string 20</ContactSpouseFullName>
<ContactSpouseID>19</ContactSpouseID>
<ContactSpouseRelationship>sample string 21</ContactSpouseRelationship>
<ContactSpouseRelationshipDescription>sample string 22</ContactSpouseRelationshipDescription>
<ContactType>sample string 4</ContactType>
<ContactTypeDescription>sample string 5</ContactTypeDescription>
<LivesWithFlag>true</LivesWithFlag>
<NormalMailFlag>true</NormalMailFlag>
<ParentFlag>true</ParentFlag>
<PortalApproval>sample string 13</PortalApproval>
<PrimaryOnlyFlag>true</PrimaryOnlyFlag>
<ReportsFlag>true</ReportsFlag>
<SIF3RefID>0c6a8aa1-4595-4d13-8a06-14c7315c0073</SIF3RefID>
<SpouseDefaultEmail>sample string 24</SpouseDefaultEmail>
<SpouseDefaultMobilePhone>sample string 23</SpouseDefaultMobilePhone>
<SpouseSIF3RefID>2e281bc3-8860-408d-843b-71fcb5ca33f7</SpouseSIF3RefID>
<StudentContactsSeq>25</StudentContactsSeq>
<StudentID>1</StudentID>
<StudentPersonalInfo>
<Gender>sample string 12</Gender>
<Given1>sample string 1</Given1>
<Given2>sample string 2</Given2>
<Initials>sample string 3</Initials>
<LegalFullName>sample string 8</LegalFullName>
<NameExternal>sample string 7</NameExternal>
<NameInternal>sample string 6</NameInternal>
<Preferred>sample string 11</Preferred>
<PreferredFormal>sample string 9</PreferredFormal>
<Suffix>sample string 4</Suffix>
<Surname>sample string 5</Surname>
<Title>sample string 10</Title>
</StudentPersonalInfo>
<UseEmail>sample string 12</UseEmail>
<UseSMS>sample string 11</UseSMS>
</spsStudentContactsAPI_Response>
<spsStudentContactsAPI_Response>
<ContactAddressDetails>
<Address1>sample string 9</Address1>
<Address2>sample string 10</Address2>
<Address3>sample string 11</Address3>
<AddressDPID>sample string 26</AddressDPID>
<AddressDPIDBarcode>sample string 27</AddressDPIDBarcode>
<AddressID>1</AddressID>
<AddressPAFVersion>sample string 29</AddressPAFVersion>
<AddressSortPlanNumber>sample string 28</AddressSortPlanNumber>
<AddressValidationSeq>34</AddressValidationSeq>
<CountryCode>sample string 15</CountryCode>
<ExternalValidationFlag>true</ExternalValidationFlag>
<Fax>sample string 21</Fax>
<HomeAddress1>sample string 2</HomeAddress1>
<HomeAddress2>sample string 3</HomeAddress2>
<HomeAddress3>sample string 4</HomeAddress3>
<HomeAddressDPID>sample string 22</HomeAddressDPID>
<HomeAddressDPIDBarcode>sample string 23</HomeAddressDPIDBarcode>
<HomeAddressLatitude>sample string 30</HomeAddressLatitude>
<HomeAddressLongitude>sample string 31</HomeAddressLongitude>
<HomeAddressPAFVersion>sample string 25</HomeAddressPAFVersion>
<HomeAddressSameFlag>true</HomeAddressSameFlag>
<HomeAddressSortPlanNumber>sample string 24</HomeAddressSortPlanNumber>
<HomeAddressValidationSeq>33</HomeAddressValidationSeq>
<HomeCountryCode>sample string 8</HomeCountryCode>
<HomePostCode>sample string 7</HomePostCode>
<HomeState>sample string 6</HomeState>
<HomeSuburb>sample string 5</HomeSuburb>
<PhoneActual>sample string 16</PhoneActual>
<PhoneAlt>sample string 17</PhoneAlt>
<PostCode>sample string 14</PostCode>
<SilentPhoneFlag>true</SilentPhoneFlag>
<State>sample string 13</State>
<Suburb>sample string 12</Suburb>
<ValidAddressFlag>true</ValidAddressFlag>
</ContactAddressDetails>
<ContactDefaultEmail>sample string 8</ContactDefaultEmail>
<ContactEmail>sample string 10</ContactEmail>
<ContactID>2</ContactID>
<ContactName>sample string 3</ContactName>
<ContactOccupEmail>sample string 9</ContactOccupEmail>
<ContactPersonalInfo>
<Gender>sample string 12</Gender>
<Given1>sample string 1</Given1>
<Given2>sample string 2</Given2>
<Initials>sample string 3</Initials>
<LegalFullName>sample string 8</LegalFullName>
<NameExternal>sample string 7</NameExternal>
<NameInternal>sample string 6</NameInternal>
<Preferred>sample string 11</Preferred>
<PreferredFormal>sample string 9</PreferredFormal>
<Suffix>sample string 4</Suffix>
<Surname>sample string 5</Surname>
<Title>sample string 10</Title>
</ContactPersonalInfo>
<ContactRelationship>sample string 6</ContactRelationship>
<ContactRelationshipDescription>sample string 7</ContactRelationshipDescription>
<ContactSpouseFullName>sample string 20</ContactSpouseFullName>
<ContactSpouseID>19</ContactSpouseID>
<ContactSpouseRelationship>sample string 21</ContactSpouseRelationship>
<ContactSpouseRelationshipDescription>sample string 22</ContactSpouseRelationshipDescription>
<ContactType>sample string 4</ContactType>
<ContactTypeDescription>sample string 5</ContactTypeDescription>
<LivesWithFlag>true</LivesWithFlag>
<NormalMailFlag>true</NormalMailFlag>
<ParentFlag>true</ParentFlag>
<PortalApproval>sample string 13</PortalApproval>
<PrimaryOnlyFlag>true</PrimaryOnlyFlag>
<ReportsFlag>true</ReportsFlag>
<SIF3RefID>0c6a8aa1-4595-4d13-8a06-14c7315c0073</SIF3RefID>
<SpouseDefaultEmail>sample string 24</SpouseDefaultEmail>
<SpouseDefaultMobilePhone>sample string 23</SpouseDefaultMobilePhone>
<SpouseSIF3RefID>2e281bc3-8860-408d-843b-71fcb5ca33f7</SpouseSIF3RefID>
<StudentContactsSeq>25</StudentContactsSeq>
<StudentID>1</StudentID>
<StudentPersonalInfo>
<Gender>sample string 12</Gender>
<Given1>sample string 1</Given1>
<Given2>sample string 2</Given2>
<Initials>sample string 3</Initials>
<LegalFullName>sample string 8</LegalFullName>
<NameExternal>sample string 7</NameExternal>
<NameInternal>sample string 6</NameInternal>
<Preferred>sample string 11</Preferred>
<PreferredFormal>sample string 9</PreferredFormal>
<Suffix>sample string 4</Suffix>
<Surname>sample string 5</Surname>
<Title>sample string 10</Title>
</StudentPersonalInfo>
<UseEmail>sample string 12</UseEmail>
<UseSMS>sample string 11</UseSMS>
</spsStudentContactsAPI_Response>
</ArrayOfspsStudentContactsAPI_Response>