Home / API / ASP.NET Web API Details

GET api/v1/Setup/GetProgramByProgramTypeId?programtypeid={programtypeid}

Description

Get Program Info By Program Type Id

Request Information

Parameters

NameDescriptionAdditional information
programtypeid
Program Type Id

Define this parameter in the request URI.

Response Information

Program Information

Response body formats

application/json, text/json

Sample:
{
  "programtypeid": 1,
  "companyid": 2,
  "isactive": true,
  "utctimestamp": "2025-02-23T06:04:19.8281807+00:00",
  "utclastchanged": "2025-02-23T06:04:19.8281807+00:00",
  "lastchangedby": "sample string 5",
  "scheduletype": 6,
  "glcashaccount": 7,
  "reportcategory": 8,
  "timeentry": 64,
  "isrenewal": 10,
  "renewalinterval": 11,
  "renewalterm": 12,
  "renewalcreateinvoice": 13,
  "renewalinspectinactive": 14,
  "prepaydiscount": 15.0,
  "prepaydiscounttypeid": 16,
  "boosterinterval": 17,
  "glrenewaldebit": 18,
  "programcategory": 19,
  "billingmonthcount": 20,
  "targetrequired": true,
  "servicetypeid": 22,
  "hidesvcamount": true,
  "hasguarantee": true,
  "reportcategoryid2": 25,
  "reportcategoryid3": 26,
  "reportcategoryid4": 27,
  "reportcategoryid5": 28,
  "useallowances": true,
  "eligibletobereversed": 30,
  "month1revenue": 31.1,
  "month2revenue": 32.1,
  "usedeferredrevenue": true,
  "deferredrevenueglid": 34,
  "deferredrevenueinterval": 35,
  "month10revenue": 36.1,
  "month11revenue": 37.1,
  "month3revenue": 38.1,
  "month4revenue": 39.1,
  "month5revenue": 40.1,
  "month6revenue": 41.1,
  "month7revenue": 42.1,
  "month8revenue": 43.1,
  "month9revenue": 44.1,
  "glrenewalcredit": 45,
  "defaultcomminterval": 46,
  "defaultestimatetype": 47,
  "programservice": 48,
  "programfrecuency": 49,
  "deferredrevenuedurationmethod": 50,
  "deferredrevenueduration": 51,
  "deferredrevenuedelay": 52,
  "deferredrevenuewarrantytypes": "sample string 53",
  "programtype": 54,
  "servicetype": 55,
  "taxgroupid": 56,
  "autopayeligible": true,
  "autopayinterval": 58,
  "portalrenewaldiscount": true,
  "payincreaseformid": "sample string 60",
  "prepayformid": "sample string 61",
  "lowdollarformid": "sample string 62",
  "lowdollarformid2": "sample string 63",
  "billinginterval": 64,
  "renewalstartafter": 65,
  "islinktopayplan": true,
  "showonmobiledevice": true,
  "iscallagentitem": true,
  "isproratedprogram": true,
  "feb_multiplier": 70,
  "aug_multiplier": 71,
  "dec_multiplier": 72,
  "sep_multiplier": 73,
  "permanentrenewalmonth": 74,
  "oct_multiplier": 75,
  "apr_multiplier": 76,
  "nov_multiplier": 77,
  "jul_multiplier": 78,
  "jun_multiplier": 79,
  "jan_multiplier": 80,
  "mar_multiplier": 81,
  "may_multiplier": 82,
  "renewalemailmsg": "sample string 83",
  "ismultirenewal": true,
  "outstandingrenewal": true,
  "programname": {
    "programtypeid": 1,
    "programname": "sample string 2",
    "utctimestamp": "2025-02-23T06:04:19.8307543+00:00",
    "utclastchanged": "2025-02-23T06:04:19.8307543+00:00",
    "lastchangedby": "sample string 3",
    "pialetternote": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<setupprogrammodel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APICOMMON">
  <apr_multiplier>76</apr_multiplier>
  <aug_multiplier>71</aug_multiplier>
  <autopayeligible>true</autopayeligible>
  <autopayinterval>58</autopayinterval>
  <billinginterval>64</billinginterval>
  <billingmonthcount>20</billingmonthcount>
  <boosterinterval>17</boosterinterval>
  <companyid>2</companyid>
  <dec_multiplier>72</dec_multiplier>
  <defaultcomminterval>46</defaultcomminterval>
  <defaultestimatetype>47</defaultestimatetype>
  <deferredrevenuedelay>52</deferredrevenuedelay>
  <deferredrevenueduration>51</deferredrevenueduration>
  <deferredrevenuedurationmethod>50</deferredrevenuedurationmethod>
  <deferredrevenueglid>34</deferredrevenueglid>
  <deferredrevenueinterval>35</deferredrevenueinterval>
  <deferredrevenuewarrantytypes>sample string 53</deferredrevenuewarrantytypes>
  <eligibletobereversed>30</eligibletobereversed>
  <feb_multiplier>70</feb_multiplier>
  <glcashaccount>7</glcashaccount>
  <glrenewalcredit>45</glrenewalcredit>
  <glrenewaldebit>18</glrenewaldebit>
  <hasguarantee>true</hasguarantee>
  <hidesvcamount>true</hidesvcamount>
  <isactive>true</isactive>
  <iscallagentitem>true</iscallagentitem>
  <islinktopayplan>true</islinktopayplan>
  <ismultirenewal>true</ismultirenewal>
  <isproratedprogram>true</isproratedprogram>
  <isrenewal>10</isrenewal>
  <jan_multiplier>80</jan_multiplier>
  <jul_multiplier>78</jul_multiplier>
  <jun_multiplier>79</jun_multiplier>
  <lastchangedby>sample string 5</lastchangedby>
  <lowdollarformid>sample string 62</lowdollarformid>
  <lowdollarformid2>sample string 63</lowdollarformid2>
  <mar_multiplier>81</mar_multiplier>
  <may_multiplier>82</may_multiplier>
  <month10revenue>36.1</month10revenue>
  <month11revenue>37.1</month11revenue>
  <month1revenue>31.1</month1revenue>
  <month2revenue>32.1</month2revenue>
  <month3revenue>38.1</month3revenue>
  <month4revenue>39.1</month4revenue>
  <month5revenue>40.1</month5revenue>
  <month6revenue>41.1</month6revenue>
  <month7revenue>42.1</month7revenue>
  <month8revenue>43.1</month8revenue>
  <month9revenue>44.1</month9revenue>
  <nov_multiplier>77</nov_multiplier>
  <oct_multiplier>75</oct_multiplier>
  <outstandingrenewal>true</outstandingrenewal>
  <payincreaseformid>sample string 60</payincreaseformid>
  <permanentrenewalmonth>74</permanentrenewalmonth>
  <portalrenewaldiscount>true</portalrenewaldiscount>
  <prepaydiscount>15</prepaydiscount>
  <prepaydiscounttypeid>16</prepaydiscounttypeid>
  <prepayformid>sample string 61</prepayformid>
  <programcategory>19</programcategory>
  <programfrecuency>49</programfrecuency>
  <programname>
    <lastchangedby>sample string 3</lastchangedby>
    <pialetternote>sample string 4</pialetternote>
    <programname>sample string 2</programname>
    <programtypeid>1</programtypeid>
    <utclastchanged>2025-02-23T06:04:19.8307543+00:00</utclastchanged>
    <utctimestamp>2025-02-23T06:04:19.8307543+00:00</utctimestamp>
  </programname>
  <programservice>48</programservice>
  <programtype>54</programtype>
  <programtypeid>1</programtypeid>
  <renewalcreateinvoice>13</renewalcreateinvoice>
  <renewalemailmsg>sample string 83</renewalemailmsg>
  <renewalinspectinactive>14</renewalinspectinactive>
  <renewalinterval>11</renewalinterval>
  <renewalstartafter>65</renewalstartafter>
  <renewalterm>12</renewalterm>
  <reportcategory>8</reportcategory>
  <reportcategoryid2>25</reportcategoryid2>
  <reportcategoryid3>26</reportcategoryid3>
  <reportcategoryid4>27</reportcategoryid4>
  <reportcategoryid5>28</reportcategoryid5>
  <scheduletype>6</scheduletype>
  <sep_multiplier>73</sep_multiplier>
  <servicetype>55</servicetype>
  <servicetypeid>22</servicetypeid>
  <showonmobiledevice>true</showonmobiledevice>
  <targetrequired>true</targetrequired>
  <taxgroupid>56</taxgroupid>
  <timeentry>64</timeentry>
  <useallowances>true</useallowances>
  <usedeferredrevenue>true</usedeferredrevenue>
  <utclastchanged>2025-02-23T06:04:19.8281807+00:00</utclastchanged>
  <utctimestamp>2025-02-23T06:04:19.8281807+00:00</utctimestamp>
</setupprogrammodel>