GET api/ProgramTypes

Returns a list of all program types in your database

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ProgramType

Name	Type	Additional information
ProgramTypeId	integer	None.
OrganizationId	integer	None.
Description	string	None.
IsActive	boolean	None.
IsSystemDefined	boolean	None.
AccountCode	string	None.
Links	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ProgramTypeId": 1,
    "OrganizationId": 2,
    "Description": "sample string 3",
    "IsActive": true,
    "IsSystemDefined": true,
    "AccountCode": "sample string 6",
    "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"
      }
    ]
  },
  {
    "ProgramTypeId": 1,
    "OrganizationId": 2,
    "Description": "sample string 3",
    "IsActive": true,
    "IsSystemDefined": true,
    "AccountCode": "sample string 6",
    "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:

<ArrayOfProgramType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProClassApi.Web.Api.Models">
  <ProgramType>
    <AccountCode>sample string 6</AccountCode>
    <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>
    <ProgramTypeId>1</ProgramTypeId>
  </ProgramType>
  <ProgramType>
    <AccountCode>sample string 6</AccountCode>
    <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>
    <ProgramTypeId>1</ProgramTypeId>
  </ProgramType>
</ArrayOfProgramType>