POST Applications/CreateFamilyProfile

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
GuardianID	string	None.
CompanyId	string	None.
FamilyID	string	None.
Name	string	Required
Surname	string	None.
PhoneNumber	string	Required
RelationshipWithChild	string	None.
PrimaryGuardian	boolean	None.
StudentStaffType	string	None.
StaffNo	string	None.
Occupation	string	None.
HomeAddress	string	None.
City	string	None.
State	string	None.
Email	string	None.
OfficeAddress	string	None.
PassportData	Collection of byte	None.
ImageType	string	Required Matching regular expression pattern: Jpeg\|jpeg\|jpg\|png
ImageSize	integer	Required Range: inclusive between 0 and 2097152

Request Formats

application/json, text/json

Sample:

{
  "GuardianID": "sample string 1",
  "CompanyId": "sample string 2",
  "FamilyID": "sample string 3",
  "Name": "sample string 4",
  "Surname": "sample string 5",
  "PhoneNumber": "sample string 6",
  "RelationshipWithChild": "sample string 7",
  "PrimaryGuardian": true,
  "StudentStaffType": "sample string 9",
  "StaffNo": "sample string 10",
  "Occupation": "sample string 11",
  "HomeAddress": "sample string 12",
  "City": "sample string 13",
  "State": "sample string 14",
  "Email": "sample string 15",
  "OfficeAddress": "sample string 16",
  "PassportData": "QEA=",
  "ImageType": "sample string 17",
  "ImageSize": 18
}

application/xml, text/xml

Sample:

<StudentGuardiansDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StudentPortalAPI.EntityDTOs.Students">
  <City>sample string 13</City>
  <CompanyId>sample string 2</CompanyId>
  <Email>sample string 15</Email>
  <FamilyID>sample string 3</FamilyID>
  <GuardianID>sample string 1</GuardianID>
  <HomeAddress>sample string 12</HomeAddress>
  <ImageSize>18</ImageSize>
  <ImageType>sample string 17</ImageType>
  <Name>sample string 4</Name>
  <Occupation>sample string 11</Occupation>
  <OfficeAddress>sample string 16</OfficeAddress>
  <PassportData>QEA=</PassportData>
  <PhoneNumber>sample string 6</PhoneNumber>
  <PrimaryGuardian>true</PrimaryGuardian>
  <RelationshipWithChild>sample string 7</RelationshipWithChild>
  <StaffNo>sample string 10</StaffNo>
  <State>sample string 14</State>
  <StudentStaffType>sample string 9</StudentStaffType>
  <Surname>sample string 5</Surname>
</StudentGuardiansDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.