Home / API / ASP.NET Web API Details

GET api/v1/Account/GetDetailedListOfAccountWithActivePrograms?asofdate={asofdate}&companyid={companyid}

Description

Get Detailed Account List With Active Programs

Request Information

Parameters

NameDescriptionAdditional information
asofdate
End Date

Define this parameter in the request URI.

companyid
CompanyId

Define this parameter in the request URI.

Response Information

Detailed list of the accounts with active programs

Response body formats

application/json, text/json

Sample:
[
  {
    "accountid": 1,
    "customername": "sample string 2",
    "companyid": 3,
    "branchid": 4,
    "branchname": "sample string 5",
    "programs": [
      {
        "programid": 1,
        "programname": "sample string 2",
        "programsaledate": "2025-02-23T06:08:23.5614614+00:00",
        "programstartdate": "2025-02-23T06:08:23.5614614+00:00",
        "programtypeid": 3,
        "programemployeeid": 1,
        "programreportcategoryid": 4,
        "programreportcategory": "sample string 5",
        "programsalespersonid": 1,
        "programsalesperson": "sample string 6",
        "programannualvalue": 7.0,
        "programsalevalue": 8.0,
        "programrouteid": 9,
        "programroute": "sample string 10"
      },
      {
        "programid": 1,
        "programname": "sample string 2",
        "programsaledate": "2025-02-23T06:08:23.5614614+00:00",
        "programstartdate": "2025-02-23T06:08:23.5614614+00:00",
        "programtypeid": 3,
        "programemployeeid": 1,
        "programreportcategoryid": 4,
        "programreportcategory": "sample string 5",
        "programsalespersonid": 1,
        "programsalesperson": "sample string 6",
        "programannualvalue": 7.0,
        "programsalevalue": 8.0,
        "programrouteid": 9,
        "programroute": "sample string 10"
      }
    ]
  },
  {
    "accountid": 1,
    "customername": "sample string 2",
    "companyid": 3,
    "branchid": 4,
    "branchname": "sample string 5",
    "programs": [
      {
        "programid": 1,
        "programname": "sample string 2",
        "programsaledate": "2025-02-23T06:08:23.5614614+00:00",
        "programstartdate": "2025-02-23T06:08:23.5614614+00:00",
        "programtypeid": 3,
        "programemployeeid": 1,
        "programreportcategoryid": 4,
        "programreportcategory": "sample string 5",
        "programsalespersonid": 1,
        "programsalesperson": "sample string 6",
        "programannualvalue": 7.0,
        "programsalevalue": 8.0,
        "programrouteid": 9,
        "programroute": "sample string 10"
      },
      {
        "programid": 1,
        "programname": "sample string 2",
        "programsaledate": "2025-02-23T06:08:23.5614614+00:00",
        "programstartdate": "2025-02-23T06:08:23.5614614+00:00",
        "programtypeid": 3,
        "programemployeeid": 1,
        "programreportcategoryid": 4,
        "programreportcategory": "sample string 5",
        "programsalespersonid": 1,
        "programsalesperson": "sample string 6",
        "programannualvalue": 7.0,
        "programsalevalue": 8.0,
        "programrouteid": 9,
        "programroute": "sample string 10"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfdetailedaccountwithactiveprograms xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APICOMMON">
  <detailedaccountwithactiveprograms>
    <accountid>1</accountid>
    <branchid>4</branchid>
    <branchname>sample string 5</branchname>
    <companyid>3</companyid>
    <customername>sample string 2</customername>
    <programs>
      <detailedprogramsoldmodel>
        <programannualvalue>7</programannualvalue>
        <programemployeeid>1</programemployeeid>
        <programid>1</programid>
        <programname>sample string 2</programname>
        <programreportcategory>sample string 5</programreportcategory>
        <programreportcategoryid>4</programreportcategoryid>
        <programroute>sample string 10</programroute>
        <programrouteid>9</programrouteid>
        <programsaledate>2025-02-23T06:08:23.5614614+00:00</programsaledate>
        <programsalesperson>sample string 6</programsalesperson>
        <programsalespersonid>1</programsalespersonid>
        <programsalevalue>8</programsalevalue>
        <programstartdate>2025-02-23T06:08:23.5614614+00:00</programstartdate>
        <programtypeid>3</programtypeid>
      </detailedprogramsoldmodel>
      <detailedprogramsoldmodel>
        <programannualvalue>7</programannualvalue>
        <programemployeeid>1</programemployeeid>
        <programid>1</programid>
        <programname>sample string 2</programname>
        <programreportcategory>sample string 5</programreportcategory>
        <programreportcategoryid>4</programreportcategoryid>
        <programroute>sample string 10</programroute>
        <programrouteid>9</programrouteid>
        <programsaledate>2025-02-23T06:08:23.5614614+00:00</programsaledate>
        <programsalesperson>sample string 6</programsalesperson>
        <programsalespersonid>1</programsalespersonid>
        <programsalevalue>8</programsalevalue>
        <programstartdate>2025-02-23T06:08:23.5614614+00:00</programstartdate>
        <programtypeid>3</programtypeid>
      </detailedprogramsoldmodel>
    </programs>
  </detailedaccountwithactiveprograms>
  <detailedaccountwithactiveprograms>
    <accountid>1</accountid>
    <branchid>4</branchid>
    <branchname>sample string 5</branchname>
    <companyid>3</companyid>
    <customername>sample string 2</customername>
    <programs>
      <detailedprogramsoldmodel>
        <programannualvalue>7</programannualvalue>
        <programemployeeid>1</programemployeeid>
        <programid>1</programid>
        <programname>sample string 2</programname>
        <programreportcategory>sample string 5</programreportcategory>
        <programreportcategoryid>4</programreportcategoryid>
        <programroute>sample string 10</programroute>
        <programrouteid>9</programrouteid>
        <programsaledate>2025-02-23T06:08:23.5614614+00:00</programsaledate>
        <programsalesperson>sample string 6</programsalesperson>
        <programsalespersonid>1</programsalespersonid>
        <programsalevalue>8</programsalevalue>
        <programstartdate>2025-02-23T06:08:23.5614614+00:00</programstartdate>
        <programtypeid>3</programtypeid>
      </detailedprogramsoldmodel>
      <detailedprogramsoldmodel>
        <programannualvalue>7</programannualvalue>
        <programemployeeid>1</programemployeeid>
        <programid>1</programid>
        <programname>sample string 2</programname>
        <programreportcategory>sample string 5</programreportcategory>
        <programreportcategoryid>4</programreportcategoryid>
        <programroute>sample string 10</programroute>
        <programrouteid>9</programrouteid>
        <programsaledate>2025-02-23T06:08:23.5614614+00:00</programsaledate>
        <programsalesperson>sample string 6</programsalesperson>
        <programsalespersonid>1</programsalespersonid>
        <programsalevalue>8</programsalevalue>
        <programstartdate>2025-02-23T06:08:23.5614614+00:00</programstartdate>
        <programtypeid>3</programtypeid>
      </detailedprogramsoldmodel>
    </programs>
  </detailedaccountwithactiveprograms>
</ArrayOfdetailedaccountwithactiveprograms>