GET api/Programs/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

ProgramsModel
NameDescriptionTypeAdditional information
prog_id

integer

None.

person_link

integer

None.

commit_level

integer

None.

prog_start_date

date

None.

prog_complete_date

date

None.

completed

boolean

None.

eula

boolean

None.

exercise_order

string

None.

my_coach

integer

None.

certificate

boolean

None.

last_step

string

None.

date_login

date

None.

guid_key

globally unique identifier

None.

WhoAreYou

boolean

None.

AssignedTPC

integer

None.

numSessions

integer

None.

TPCInvoiceID

integer

None.

gender

integer

None.

currentsession

MySessionsModel

None.

currentstep

MyStepsModel

None.

PDFPath

string

None.

Response Formats

application/json, text/json

Sample:
{
  "prog_id": 1,
  "person_link": 2,
  "commit_level": 1,
  "prog_start_date": "2021-10-17T09:49:59.4723632-07:00",
  "prog_complete_date": "2021-10-17T09:49:59.4723632-07:00",
  "completed": true,
  "eula": true,
  "exercise_order": "sample string 6",
  "my_coach": 7,
  "certificate": true,
  "last_step": "sample string 9",
  "date_login": "2021-10-17T09:49:59.4723632-07:00",
  "guid_key": "f3bc3d2c-7a32-4c2e-92bc-613fa87f39e0",
  "WhoAreYou": true,
  "AssignedTPC": 13,
  "numSessions": 14,
  "TPCInvoiceID": 15,
  "gender": 16,
  "currentsession": {
    "my_session_id": 1,
    "prog_link": 2,
    "session_no": 3,
    "trait_link": 4,
    "sched_date": "2021-10-17T09:49:59.4723632-07:00",
    "start_date": "2021-10-17T09:49:59.4723632-07:00",
    "complete_date": "2021-10-17T09:49:59.4723632-07:00",
    "billing_date": "2021-10-17T09:49:59.4723632-07:00",
    "paid_date": "2021-10-17T09:49:59.4723632-07:00",
    "completed": true,
    "isReadyForBilling": true,
    "isBilled": true,
    "isPaid": true
  },
  "currentstep": {
    "my_step_id": 1,
    "session_link": 2,
    "trait_link": 3,
    "step": "sample string 4",
    "Trait": "sample string 5",
    "PDFPath": "sample string 6"
  },
  "PDFPath": "sample string 17"
}

application/xml, text/xml

Sample:
<ProgramsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_10RuleAPI.Models.Programs">
  <AssignedTPC>13</AssignedTPC>
  <PDFPath>sample string 17</PDFPath>
  <TPCInvoiceID>15</TPCInvoiceID>
  <WhoAreYou>true</WhoAreYou>
  <certificate>true</certificate>
  <commit_level>1</commit_level>
  <completed>true</completed>
  <currentsession>
    <billing_date>2021-10-17T09:49:59.4723632-07:00</billing_date>
    <complete_date>2021-10-17T09:49:59.4723632-07:00</complete_date>
    <completed>true</completed>
    <isBilled>true</isBilled>
    <isPaid>true</isPaid>
    <isReadyForBilling>true</isReadyForBilling>
    <my_session_id>1</my_session_id>
    <paid_date>2021-10-17T09:49:59.4723632-07:00</paid_date>
    <prog_link>2</prog_link>
    <sched_date>2021-10-17T09:49:59.4723632-07:00</sched_date>
    <session_no>3</session_no>
    <start_date>2021-10-17T09:49:59.4723632-07:00</start_date>
    <trait_link>4</trait_link>
  </currentsession>
  <currentstep>
    <PDFPath>sample string 6</PDFPath>
    <Trait>sample string 5</Trait>
    <my_step_id>1</my_step_id>
    <session_link>2</session_link>
    <step>sample string 4</step>
    <trait_link>3</trait_link>
  </currentstep>
  <date_login>2021-10-17T09:49:59.4723632-07:00</date_login>
  <eula>true</eula>
  <exercise_order>sample string 6</exercise_order>
  <gender>16</gender>
  <guid_key>f3bc3d2c-7a32-4c2e-92bc-613fa87f39e0</guid_key>
  <last_step>sample string 9</last_step>
  <my_coach>7</my_coach>
  <numSessions>14</numSessions>
  <person_link>2</person_link>
  <prog_complete_date>2021-10-17T09:49:59.4723632-07:00</prog_complete_date>
  <prog_id>1</prog_id>
  <prog_start_date>2021-10-17T09:49:59.4723632-07:00</prog_start_date>
</ProgramsModel>