GET api/ProgramInstructors

Returns a list of all program instructors in your database. This list is searchable using the OData protocol.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ProgramInstructor

Name	Type	Additional information
ProgramInstructorId	integer	None.
ProgramId	integer	None.
InstructorId	integer	None.
ContactId	integer	None.
ProgramInstructorType	ProgramInstructorType	None.
IsPrimary	boolean	None.
ContractAmount	decimal number	None.
TravelAllowance	decimal number	None.
UnitId	integer	None.
Links	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ProgramInstructorId": 1,
    "ProgramId": 2,
    "InstructorId": 3,
    "ContactId": 4,
    "ProgramInstructorType": {
      "ProgramInstructorTypeId": 1,
      "OrganizationId": 2,
      "Description": "sample string 3",
      "IsActive": true,
      "IsSystemDefined": true,
      "Links": [
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        }
      ]
    },
    "IsPrimary": true,
    "ContractAmount": 6.0,
    "TravelAllowance": 7.0,
    "UnitId": 8,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      }
    ]
  },
  {
    "ProgramInstructorId": 1,
    "ProgramId": 2,
    "InstructorId": 3,
    "ContactId": 4,
    "ProgramInstructorType": {
      "ProgramInstructorTypeId": 1,
      "OrganizationId": 2,
      "Description": "sample string 3",
      "IsActive": true,
      "IsSystemDefined": true,
      "Links": [
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        }
      ]
    },
    "IsPrimary": true,
    "ContractAmount": 6.0,
    "TravelAllowance": 7.0,
    "UnitId": 8,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfProgramInstructor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProClassApi.Web.Api.Models">
  <ProgramInstructor>
    <ContactId>4</ContactId>
    <ContractAmount>6</ContractAmount>
    <InstructorId>3</InstructorId>
    <IsPrimary>true</IsPrimary>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
    </Links>
    <ProgramId>2</ProgramId>
    <ProgramInstructorId>1</ProgramInstructorId>
    <ProgramInstructorType>
      <Description>sample string 3</Description>
      <IsActive>true</IsActive>
      <IsSystemDefined>true</IsSystemDefined>
      <Links>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
      </Links>
      <OrganizationId>2</OrganizationId>
      <ProgramInstructorTypeId>1</ProgramInstructorTypeId>
    </ProgramInstructorType>
    <TravelAllowance>7</TravelAllowance>
    <UnitId>8</UnitId>
  </ProgramInstructor>
  <ProgramInstructor>
    <ContactId>4</ContactId>
    <ContractAmount>6</ContractAmount>
    <InstructorId>3</InstructorId>
    <IsPrimary>true</IsPrimary>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
    </Links>
    <ProgramId>2</ProgramId>
    <ProgramInstructorId>1</ProgramInstructorId>
    <ProgramInstructorType>
      <Description>sample string 3</Description>
      <IsActive>true</IsActive>
      <IsSystemDefined>true</IsSystemDefined>
      <Links>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
      </Links>
      <OrganizationId>2</OrganizationId>
      <ProgramInstructorTypeId>1</ProgramInstructorTypeId>
    </ProgramInstructorType>
    <TravelAllowance>7</TravelAllowance>
    <UnitId>8</UnitId>
  </ProgramInstructor>
</ArrayOfProgramInstructor>