Home / API / ASP.NET Web API Details

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

Description

Get List Of Program Event By Program Type Id

Request Information

Parameters

NameDescriptionAdditional information
programtypeid
Program Type Id

Define this parameter in the request URI.

Response Information

List of Program Event

Response body formats

application/json, text/json

Sample:
[
  {
    "programtypeid": 1,
    "eventtypeid": 2,
    "patterntype": 64,
    "patternmonths": 4,
    "patterninterval": 5,
    "intervalvalue": 6,
    "aftereventtypeid": 7,
    "afterintervaltype": 64,
    "afterintervalvalue": 9,
    "isinitial": true,
    "utctimestamp": "2025-02-23T06:15:28.4637774+00:00",
    "utclastchanged": "2025-02-23T06:15:28.4637774+00:00",
    "lastchangedby": "sample string 12",
    "patterndays": 13,
    "isfirstseasonal": true,
    "isdefault": true,
    "isinitialdiff": true,
    "visitsfirstyear": 17,
    "visitsperyear": 18,
    "intervalafterinitial": 19,
    "patternafterinitial": 20,
    "isstoppattern": true,
    "isactive": true,
    "pastdueintervalvalue": 23,
    "pastdueintervaltype": 64,
    "warrantyid": 25,
    "allvaluetowo": 26,
    "sortorder": 27,
    "workpool": true,
    "usedeferredrevenue": true,
    "deferredrevenueinterval": 30,
    "deferredrevenuedurationmethod": 31,
    "deferredrevenueduration": 32,
    "deferredrevenuedelay": 33,
    "deferredrevenuewarrantytypes": "sample string 34",
    "addon": true,
    "isexcessinitialsvc": true,
    "isexcessinitialrecurrsvc": true,
    "racelegible": true,
    "paymentrequired": true,
    "autopayeligible": true
  },
  {
    "programtypeid": 1,
    "eventtypeid": 2,
    "patterntype": 64,
    "patternmonths": 4,
    "patterninterval": 5,
    "intervalvalue": 6,
    "aftereventtypeid": 7,
    "afterintervaltype": 64,
    "afterintervalvalue": 9,
    "isinitial": true,
    "utctimestamp": "2025-02-23T06:15:28.4637774+00:00",
    "utclastchanged": "2025-02-23T06:15:28.4637774+00:00",
    "lastchangedby": "sample string 12",
    "patterndays": 13,
    "isfirstseasonal": true,
    "isdefault": true,
    "isinitialdiff": true,
    "visitsfirstyear": 17,
    "visitsperyear": 18,
    "intervalafterinitial": 19,
    "patternafterinitial": 20,
    "isstoppattern": true,
    "isactive": true,
    "pastdueintervalvalue": 23,
    "pastdueintervaltype": 64,
    "warrantyid": 25,
    "allvaluetowo": 26,
    "sortorder": 27,
    "workpool": true,
    "usedeferredrevenue": true,
    "deferredrevenueinterval": 30,
    "deferredrevenuedurationmethod": 31,
    "deferredrevenueduration": 32,
    "deferredrevenuedelay": 33,
    "deferredrevenuewarrantytypes": "sample string 34",
    "addon": true,
    "isexcessinitialsvc": true,
    "isexcessinitialrecurrsvc": true,
    "racelegible": true,
    "paymentrequired": true,
    "autopayeligible": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfsetupprogramsetupeventmodel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APICOMMON">
  <setupprogramsetupeventmodel>
    <addon>true</addon>
    <aftereventtypeid>7</aftereventtypeid>
    <afterintervaltype>64</afterintervaltype>
    <afterintervalvalue>9</afterintervalvalue>
    <allvaluetowo>26</allvaluetowo>
    <autopayeligible>true</autopayeligible>
    <deferredrevenuedelay>33</deferredrevenuedelay>
    <deferredrevenueduration>32</deferredrevenueduration>
    <deferredrevenuedurationmethod>31</deferredrevenuedurationmethod>
    <deferredrevenueinterval>30</deferredrevenueinterval>
    <deferredrevenuewarrantytypes>sample string 34</deferredrevenuewarrantytypes>
    <eventtypeid>2</eventtypeid>
    <intervalafterinitial>19</intervalafterinitial>
    <intervalvalue>6</intervalvalue>
    <isactive>true</isactive>
    <isdefault>true</isdefault>
    <isexcessinitialrecurrsvc>true</isexcessinitialrecurrsvc>
    <isexcessinitialsvc>true</isexcessinitialsvc>
    <isfirstseasonal>true</isfirstseasonal>
    <isinitial>true</isinitial>
    <isinitialdiff>true</isinitialdiff>
    <isstoppattern>true</isstoppattern>
    <lastchangedby>sample string 12</lastchangedby>
    <pastdueintervaltype>64</pastdueintervaltype>
    <pastdueintervalvalue>23</pastdueintervalvalue>
    <patternafterinitial>20</patternafterinitial>
    <patterndays>13</patterndays>
    <patterninterval>5</patterninterval>
    <patternmonths>4</patternmonths>
    <patterntype>64</patterntype>
    <paymentrequired>true</paymentrequired>
    <programtypeid>1</programtypeid>
    <racelegible>true</racelegible>
    <sortorder>27</sortorder>
    <usedeferredrevenue>true</usedeferredrevenue>
    <utclastchanged>2025-02-23T06:15:28.4637774+00:00</utclastchanged>
    <utctimestamp>2025-02-23T06:15:28.4637774+00:00</utctimestamp>
    <visitsfirstyear>17</visitsfirstyear>
    <visitsperyear>18</visitsperyear>
    <warrantyid>25</warrantyid>
    <workpool>true</workpool>
  </setupprogramsetupeventmodel>
  <setupprogramsetupeventmodel>
    <addon>true</addon>
    <aftereventtypeid>7</aftereventtypeid>
    <afterintervaltype>64</afterintervaltype>
    <afterintervalvalue>9</afterintervalvalue>
    <allvaluetowo>26</allvaluetowo>
    <autopayeligible>true</autopayeligible>
    <deferredrevenuedelay>33</deferredrevenuedelay>
    <deferredrevenueduration>32</deferredrevenueduration>
    <deferredrevenuedurationmethod>31</deferredrevenuedurationmethod>
    <deferredrevenueinterval>30</deferredrevenueinterval>
    <deferredrevenuewarrantytypes>sample string 34</deferredrevenuewarrantytypes>
    <eventtypeid>2</eventtypeid>
    <intervalafterinitial>19</intervalafterinitial>
    <intervalvalue>6</intervalvalue>
    <isactive>true</isactive>
    <isdefault>true</isdefault>
    <isexcessinitialrecurrsvc>true</isexcessinitialrecurrsvc>
    <isexcessinitialsvc>true</isexcessinitialsvc>
    <isfirstseasonal>true</isfirstseasonal>
    <isinitial>true</isinitial>
    <isinitialdiff>true</isinitialdiff>
    <isstoppattern>true</isstoppattern>
    <lastchangedby>sample string 12</lastchangedby>
    <pastdueintervaltype>64</pastdueintervaltype>
    <pastdueintervalvalue>23</pastdueintervalvalue>
    <patternafterinitial>20</patternafterinitial>
    <patterndays>13</patterndays>
    <patterninterval>5</patterninterval>
    <patternmonths>4</patternmonths>
    <patterntype>64</patterntype>
    <paymentrequired>true</paymentrequired>
    <programtypeid>1</programtypeid>
    <racelegible>true</racelegible>
    <sortorder>27</sortorder>
    <usedeferredrevenue>true</usedeferredrevenue>
    <utclastchanged>2025-02-23T06:15:28.4637774+00:00</utclastchanged>
    <utctimestamp>2025-02-23T06:15:28.4637774+00:00</utctimestamp>
    <visitsfirstyear>17</visitsfirstyear>
    <visitsperyear>18</visitsperyear>
    <warrantyid>25</warrantyid>
    <workpool>true</workpool>
  </setupprogramsetupeventmodel>
</ArrayOfsetupprogramsetupeventmodel>