GET api/EducationActivity?APIKey={APIKey}&ClientId={ClientId}&CustomColumns={CustomColumns}&EducationActivityId={EducationActivityId}&ContactNumber={ContactNumber}&AccountNumber={AccountNumber}&CourseCode={CourseCode}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
APIKey

string

Required

ClientId

string

Required

CustomColumns

string

Default value is

EducationActivityId

globally unique identifier

None.

ContactNumber

string

Default value is

AccountNumber

string

Default value is

CourseCode

string

Default value is

Body Parameters

None.

Response Information

Resource Description

EducationActivityRequest
NameDescriptionTypeAdditional information
EducationActivity

Collection of EducationActivity

None.

Response Formats

application/json, text/json

Sample:
{
  "EducationActivity": [
    {
      "Id": "72e1d993-85ce-4333-a911-1dc866883843",
      "ContactNumber": "sample string 2",
      "AccountNumber": "sample string 3",
      "CourseCode": "sample string 4",
      "CourseName": "sample string 5",
      "ActivityDate": "2024-05-03T05:03:39.7164447+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": "72e1d993-85ce-4333-a911-1dc866883843",
      "ContactNumber": "sample string 2",
      "AccountNumber": "sample string 3",
      "CourseCode": "sample string 4",
      "CourseName": "sample string 5",
      "ActivityDate": "2024-05-03T05:03:39.7164447+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-05-03T05:03:39.7164447+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>72e1d993-85ce-4333-a911-1dc866883843</Id>
      <Score>7</Score>
    </EducationActivity>
    <EducationActivity>
      <AccountNumber>sample string 3</AccountNumber>
      <ActivityDate>2024-05-03T05:03:39.7164447+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>72e1d993-85ce-4333-a911-1dc866883843</Id>
      <Score>7</Score>
    </EducationActivity>
  </EducationActivity>
</EducationActivityRequest>