Home / API / ASP.NET Web API Details

GET api/v1/Program/GetProgramsListByCompany?companyid={companyid}&page={page}&pagelimit={pagelimit}

Description

Get Program List By Company

Request Information

Parameters

NameDescriptionAdditional information
companyid
int

Define this parameter in the request URI.

page
int, default value 1

Define this parameter in the request URI.

pagelimit
int, default value 500

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
[
  {
    "programtypeid": 1,
    "companyid": 2,
    "isactive": true,
    "utctimestamp": "2025-02-23T06:05:13.3688171+00:00",
    "utclastchanged": "2025-02-23T06:05:13.3688171+00:00",
    "lastchangedby": "sample string 4",
    "scheduletype": 5,
    "glcashaccount": 6,
    "reportcategory": 7,
    "timeentry": 8,
    "isrenewal": 9,
    "renewalinterval": 10,
    "renewalterm": 11,
    "renewalcreateinvoice": 12,
    "renewalinspectinactive": 13,
    "prepaydiscount": 14.0,
    "prepaydiscounttypeid": 15,
    "boosterinterval": 16,
    "glrenewaldebit": 17,
    "programcategory": 18,
    "billingmonthcount": 19,
    "targetrequired": true,
    "servicetypeid": 21,
    "hidesvcamount": true,
    "hasguarantee": true,
    "reportcategoryid2": 24,
    "reportcategoryid3": 25,
    "reportcategoryid4": 26,
    "reportcategoryid5": 27,
    "useallowances": true,
    "eligibletobereversed": 29,
    "month1revenue": 30.1,
    "month2revenue": 31.1,
    "usedeferredrevenue": true,
    "deferredrevenueglid": 33,
    "deferredrevenueinterval": 34,
    "month10revenue": 35.1,
    "month11revenue": 36.1,
    "month3revenue": 37.1,
    "month4revenue": 38.1,
    "month5revenue": 39.1,
    "month6revenue": 40.1,
    "month7revenue": 41.1,
    "month8revenue": 42.1,
    "month9revenue": 43.1,
    "glrenewalcredit": 44,
    "defaultcomminterval": 45,
    "defaultestimatetype": 46,
    "programservice": 47,
    "programfrecuency": 48,
    "deferredrevenuedurationmethod": 49,
    "deferredrevenueduration": 50,
    "deferredrevenuedelay": 51,
    "deferredrevenuewarrantytypes": "sample string 52",
    "programtype": 53,
    "servicetype": 54,
    "taxgroupid": 55,
    "autopayeligible": true,
    "autopayinterval": 57,
    "portalrenewaldiscount": true,
    "payincreaseformid": "sample string 59",
    "prepayformid": "sample string 60",
    "lowdollarformid": "sample string 61",
    "lowdollarformid2": "sample string 62",
    "billinginterval": 63,
    "renewalstartafter": 64,
    "islinktopayplan": true,
    "showonmobiledevice": true,
    "iscallagentitem": true,
    "isproratedprogram": true,
    "feb_multiplier": 69,
    "aug_multiplier": 70,
    "dec_multiplier": 71,
    "sep_multiplier": 72,
    "permanentrenewalmonth": 73,
    "oct_multiplier": 74,
    "apr_multiplier": 75,
    "nov_multiplier": 76,
    "jul_multiplier": 77,
    "jun_multiplier": 78,
    "jan_multiplier": 79,
    "mar_multiplier": 80,
    "may_multiplier": 81,
    "renewalemailmsg": "sample string 82",
    "ismultirenewal": true,
    "outstandingrenewal": true,
    "measurementgroupid": 85,
    "uselfpricechart": true,
    "AvailableAsEstimateOrProposal": true,
    "usestatementinformation": true,
    "defaultrouteid": 89,
    "defaultrenewalfee": 90.0,
    "programname": {
      "programtypeid": 1,
      "programname": "sample string 2",
      "utctimestamp": "2025-02-23T06:05:13.3719727+00:00",
      "utclastchanged": "2025-02-23T06:05:13.3719727+00:00",
      "lastchangedby": "sample string 3",
      "pialetternote": "sample string 4"
    }
  },
  {
    "programtypeid": 1,
    "companyid": 2,
    "isactive": true,
    "utctimestamp": "2025-02-23T06:05:13.3688171+00:00",
    "utclastchanged": "2025-02-23T06:05:13.3688171+00:00",
    "lastchangedby": "sample string 4",
    "scheduletype": 5,
    "glcashaccount": 6,
    "reportcategory": 7,
    "timeentry": 8,
    "isrenewal": 9,
    "renewalinterval": 10,
    "renewalterm": 11,
    "renewalcreateinvoice": 12,
    "renewalinspectinactive": 13,
    "prepaydiscount": 14.0,
    "prepaydiscounttypeid": 15,
    "boosterinterval": 16,
    "glrenewaldebit": 17,
    "programcategory": 18,
    "billingmonthcount": 19,
    "targetrequired": true,
    "servicetypeid": 21,
    "hidesvcamount": true,
    "hasguarantee": true,
    "reportcategoryid2": 24,
    "reportcategoryid3": 25,
    "reportcategoryid4": 26,
    "reportcategoryid5": 27,
    "useallowances": true,
    "eligibletobereversed": 29,
    "month1revenue": 30.1,
    "month2revenue": 31.1,
    "usedeferredrevenue": true,
    "deferredrevenueglid": 33,
    "deferredrevenueinterval": 34,
    "month10revenue": 35.1,
    "month11revenue": 36.1,
    "month3revenue": 37.1,
    "month4revenue": 38.1,
    "month5revenue": 39.1,
    "month6revenue": 40.1,
    "month7revenue": 41.1,
    "month8revenue": 42.1,
    "month9revenue": 43.1,
    "glrenewalcredit": 44,
    "defaultcomminterval": 45,
    "defaultestimatetype": 46,
    "programservice": 47,
    "programfrecuency": 48,
    "deferredrevenuedurationmethod": 49,
    "deferredrevenueduration": 50,
    "deferredrevenuedelay": 51,
    "deferredrevenuewarrantytypes": "sample string 52",
    "programtype": 53,
    "servicetype": 54,
    "taxgroupid": 55,
    "autopayeligible": true,
    "autopayinterval": 57,
    "portalrenewaldiscount": true,
    "payincreaseformid": "sample string 59",
    "prepayformid": "sample string 60",
    "lowdollarformid": "sample string 61",
    "lowdollarformid2": "sample string 62",
    "billinginterval": 63,
    "renewalstartafter": 64,
    "islinktopayplan": true,
    "showonmobiledevice": true,
    "iscallagentitem": true,
    "isproratedprogram": true,
    "feb_multiplier": 69,
    "aug_multiplier": 70,
    "dec_multiplier": 71,
    "sep_multiplier": 72,
    "permanentrenewalmonth": 73,
    "oct_multiplier": 74,
    "apr_multiplier": 75,
    "nov_multiplier": 76,
    "jul_multiplier": 77,
    "jun_multiplier": 78,
    "jan_multiplier": 79,
    "mar_multiplier": 80,
    "may_multiplier": 81,
    "renewalemailmsg": "sample string 82",
    "ismultirenewal": true,
    "outstandingrenewal": true,
    "measurementgroupid": 85,
    "uselfpricechart": true,
    "AvailableAsEstimateOrProposal": true,
    "usestatementinformation": true,
    "defaultrouteid": 89,
    "defaultrenewalfee": 90.0,
    "programname": {
      "programtypeid": 1,
      "programname": "sample string 2",
      "utctimestamp": "2025-02-23T06:05:13.3719727+00:00",
      "utclastchanged": "2025-02-23T06:05:13.3719727+00:00",
      "lastchangedby": "sample string 3",
      "pialetternote": "sample string 4"
    }
  }
]

application/xml, text/xml

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