POST

apiportal/v1/StudentContact

No documentation available.

Request Information

Roles

Vendor_APIClient

URI Parameters

None.

Body Parameters

Collection of spiStudentContactRequest

Name	Type	Additional information
ID	integer	None.
ContactType	string	None.
LinkedID	integer	None.
LinkedIDSeq	integer	None.
PrimaryOnlyFlag	boolean	None.
NormalMailFlag	boolean	None.
ReportsFlag	boolean	None.
ParentFlag	boolean	None.
LivesWithFlag	boolean	None.

Request Formats

[
  {
    "ID": 1,
    "ContactType": "sample string 2",
    "LinkedID": 3,
    "LinkedIDSeq": 4,
    "PrimaryOnlyFlag": true,
    "NormalMailFlag": true,
    "ReportsFlag": true,
    "ParentFlag": true,
    "LivesWithFlag": true
  },
  {
    "ID": 1,
    "ContactType": "sample string 2",
    "LinkedID": 3,
    "LinkedIDSeq": 4,
    "PrimaryOnlyFlag": true,
    "NormalMailFlag": true,
    "ReportsFlag": true,
    "ParentFlag": true,
    "LivesWithFlag": true
  }
]

<ArrayOfspiStudentContactRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <spiStudentContactRequest>
    <ContactType>sample string 2</ContactType>
    <ID>1</ID>
    <LinkedID>3</LinkedID>
    <LinkedIDSeq>4</LinkedIDSeq>
    <LivesWithFlag>true</LivesWithFlag>
    <NormalMailFlag>true</NormalMailFlag>
    <ParentFlag>true</ParentFlag>
    <PrimaryOnlyFlag>true</PrimaryOnlyFlag>
    <ReportsFlag>true</ReportsFlag>
  </spiStudentContactRequest>
  <spiStudentContactRequest>
    <ContactType>sample string 2</ContactType>
    <ID>1</ID>
    <LinkedID>3</LinkedID>
    <LinkedIDSeq>4</LinkedIDSeq>
    <LivesWithFlag>true</LivesWithFlag>
    <NormalMailFlag>true</NormalMailFlag>
    <ParentFlag>true</ParentFlag>
    <PrimaryOnlyFlag>true</PrimaryOnlyFlag>
    <ReportsFlag>true</ReportsFlag>
  </spiStudentContactRequest>
</ArrayOfspiStudentContactRequest>

Sample not available.

Response Information

Resource Description

Collection of ChangeEntitySeqRespModel

Name	Description	Type	Additional information
RowNum		integer	None.
Result		ChangeEntitySeqModel	None.

[
  {
    "RowNum": 1,
    "Result": {
      "EntitySeq": 1,
      "Error": "sample string 1",
      "ValidationDetails": [
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        },
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        }
      ]
    }
  },
  {
    "RowNum": 1,
    "Result": {
      "EntitySeq": 1,
      "Error": "sample string 1",
      "ValidationDetails": [
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        },
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        }
      ]
    }
  }
]

<ArrayOfChangeEntitySeqRespModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <ChangeEntitySeqRespModel>
    <Result>
      <Error>sample string 1</Error>
      <ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
      </ValidationDetails>
      <EntitySeq>1</EntitySeq>
    </Result>
    <RowNum>1</RowNum>
  </ChangeEntitySeqRespModel>
  <ChangeEntitySeqRespModel>
    <Result>
      <Error>sample string 1</Error>
      <ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
      </ValidationDetails>
      <EntitySeq>1</EntitySeq>
    </Result>
    <RowNum>1</RowNum>
  </ChangeEntitySeqRespModel>
</ArrayOfChangeEntitySeqRespModel>