POST api/EducationActivity?APIKey={APIKey}&ClientId={ClientId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
APIKey

string

Required

ClientId

string

Required

Body Parameters

EducationActivityRequest
NameDescriptionTypeAdditional information
EducationActivity

Collection of EducationActivity

None.

Request Formats

application/json, text/json

Sample:
{
  "EducationActivity": [
    {
      "Id": "c670cfe2-21a8-47c8-9c04-4bc0c2e0ea6c",
      "ContactNumber": "sample string 2",
      "AccountNumber": "sample string 3",
      "CourseCode": "sample string 4",
      "CourseName": "sample string 5",
      "ActivityDate": "2024-11-21T11:21:59.3429505+00:00",
      "Score": 7.0,
      "CreditStatus": 1,
      "Custom": {
        "Attribute": [
          {
            "Type": 0,
            "Key": "sample string 1",
            "Value": "sample string 2",
            "FormattedValue": "sample string 3"
          },
          {
            "Type": 0,
            "Key": "sample string 1",
            "Value": "sample string 2",
            "FormattedValue": "sample string 3"
          }
        ]
      }
    },
    {
      "Id": "c670cfe2-21a8-47c8-9c04-4bc0c2e0ea6c",
      "ContactNumber": "sample string 2",
      "AccountNumber": "sample string 3",
      "CourseCode": "sample string 4",
      "CourseName": "sample string 5",
      "ActivityDate": "2024-11-21T11:21:59.3429505+00:00",
      "Score": 7.0,
      "CreditStatus": 1,
      "Custom": {
        "Attribute": [
          {
            "Type": 0,
            "Key": "sample string 1",
            "Value": "sample string 2",
            "FormattedValue": "sample string 3"
          },
          {
            "Type": 0,
            "Key": "sample string 1",
            "Value": "sample string 2",
            "FormattedValue": "sample string 3"
          }
        ]
      }
    }
  ]
}

application/xml, text/xml

Sample:
<EducationActivityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.EducationActivity">
  <EducationActivity>
    <EducationActivity>
      <AccountNumber>sample string 3</AccountNumber>
      <ActivityDate>2024-11-21T11:21:59.3429505+00:00</ActivityDate>
      <ContactNumber>sample string 2</ContactNumber>
      <CourseCode>sample string 4</CourseCode>
      <CourseName>sample string 5</CourseName>
      <CreditStatus>Enrolled</CreditStatus>
      <Custom>
        <Attribute xmlns:d5p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity">
          <d5p1:Attribute>
            <d5p1:FormattedValue>sample string 3</d5p1:FormattedValue>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Type>text</d5p1:Type>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:Attribute>
          <d5p1:Attribute>
            <d5p1:FormattedValue>sample string 3</d5p1:FormattedValue>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Type>text</d5p1:Type>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:Attribute>
        </Attribute>
      </Custom>
      <Id>c670cfe2-21a8-47c8-9c04-4bc0c2e0ea6c</Id>
      <Score>7</Score>
    </EducationActivity>
    <EducationActivity>
      <AccountNumber>sample string 3</AccountNumber>
      <ActivityDate>2024-11-21T11:21:59.3429505+00:00</ActivityDate>
      <ContactNumber>sample string 2</ContactNumber>
      <CourseCode>sample string 4</CourseCode>
      <CourseName>sample string 5</CourseName>
      <CreditStatus>Enrolled</CreditStatus>
      <Custom>
        <Attribute xmlns:d5p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity">
          <d5p1:Attribute>
            <d5p1:FormattedValue>sample string 3</d5p1:FormattedValue>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Type>text</d5p1:Type>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:Attribute>
          <d5p1:Attribute>
            <d5p1:FormattedValue>sample string 3</d5p1:FormattedValue>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Type>text</d5p1:Type>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:Attribute>
        </Attribute>
      </Custom>
      <Id>c670cfe2-21a8-47c8-9c04-4bc0c2e0ea6c</Id>
      <Score>7</Score>
    </EducationActivity>
  </EducationActivity>
</EducationActivityRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIResponse
NameDescriptionTypeAdditional information
Status

Status

None.

Id

globally unique identifier

None.

Description

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 0,
  "Id": "c9296c40-e5e4-43b9-bc09-09fe6419026c",
  "Description": "sample string 2"
}

application/xml, text/xml

Sample:
<APIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Response">
  <Description>sample string 2</Description>
  <Id>c9296c40-e5e4-43b9-bc09-09fe6419026c</Id>
  <Status>Success</Status>
</APIResponse>