GET api/kpi/GPDigital/Agreement

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of GPDigitalAgreement

Name	Type	Additional information
agrHeaderRecID	integer	None.
agrName	string	None.
companyID	integer	None.
companyName	string	None.
agrDateStart	string	None.
agrDateEnd	string	None.
agrDateCancel	string	None.
billingCycle	string	None.
billingStartDate	string	None.
prorate	boolean	None.
amount	decimal number	None.
annualAmount	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "agrHeaderRecID": 1,
    "agrName": "sample string 2",
    "companyID": 3,
    "companyName": "sample string 4",
    "agrDateStart": "sample string 5",
    "agrDateEnd": "sample string 6",
    "agrDateCancel": "sample string 7",
    "billingCycle": "sample string 8",
    "billingStartDate": "sample string 9",
    "prorate": true,
    "amount": 11.1,
    "annualAmount": 12.1
  },
  {
    "agrHeaderRecID": 1,
    "agrName": "sample string 2",
    "companyID": 3,
    "companyName": "sample string 4",
    "agrDateStart": "sample string 5",
    "agrDateEnd": "sample string 6",
    "agrDateCancel": "sample string 7",
    "billingCycle": "sample string 8",
    "billingStartDate": "sample string 9",
    "prorate": true,
    "amount": 11.1,
    "annualAmount": 12.1
  }
]

application/xml, text/xml

Sample:

<ArrayOfGPDigitalAgreement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPIGP.Models.KPI">
  <GPDigitalAgreement>
    <agrDateCancel>sample string 7</agrDateCancel>
    <agrDateEnd>sample string 6</agrDateEnd>
    <agrDateStart>sample string 5</agrDateStart>
    <agrHeaderRecID>1</agrHeaderRecID>
    <agrName>sample string 2</agrName>
    <amount>11.1</amount>
    <annualAmount>12.1</annualAmount>
    <billingCycle>sample string 8</billingCycle>
    <billingStartDate>sample string 9</billingStartDate>
    <companyID>3</companyID>
    <companyName>sample string 4</companyName>
    <prorate>true</prorate>
  </GPDigitalAgreement>
  <GPDigitalAgreement>
    <agrDateCancel>sample string 7</agrDateCancel>
    <agrDateEnd>sample string 6</agrDateEnd>
    <agrDateStart>sample string 5</agrDateStart>
    <agrHeaderRecID>1</agrHeaderRecID>
    <agrName>sample string 2</agrName>
    <amount>11.1</amount>
    <annualAmount>12.1</annualAmount>
    <billingCycle>sample string 8</billingCycle>
    <billingStartDate>sample string 9</billingStartDate>
    <companyID>3</companyID>
    <companyName>sample string 4</companyName>
    <prorate>true</prorate>
  </GPDigitalAgreement>
</ArrayOfGPDigitalAgreement>