Api/CommAgency

From RPM Wiki

Table of contents

1 Summary

2 Request

2.1 Options for Var
2.2 Example

3 Response

3.1 Example

4 Errors

[edit]

Summary

API: Get a commission metric report for an agency for all commission months.

[edit]

Request

{
  "Key":"{api key}",
  "Var":"{the variable}",
}

[edit]

Options for Var

NetBilled
GrossComm
AgentComm
GrossProfit
Referral
ReferralTo
ContractVal
Margin
Wholesale

[edit]

Example

http://demo.rpmsoftware.com/rpm/Api.svc/CommAgency

{
   "Key":"abcdefg",
   Var: "NetBilled",
}

[edit]

Response

Returns a property showing the Var passed into the api call as well as a list of commission month, value pairs.

{"Result":
  {
    "Val":"NetBilled",
    "Values": [
      {
        "Run": "{comm month (yyyymm)}",
        "Value": "{value}"
      },
      {repeat as needed}
    ]
  }
}

[edit]

Example

{"Result":
  {"Val":"NetBilled",
   "Values":[
      {"Run":"200507","Value":12562.79},
      {"Run":"200508","Value":16366.83},
      {"Run":"200509","Value":19041.51}
   ]
  }
}

[edit]

Errors

"Unrecognized Var parameter"
"User lacks permission"

Retrieved from "http://www.rpmsoftware.com/wiki/index.php/Api/CommAgency"

This page was last modified 16:09, 28 Oct 2010.
This page has been accessed 510 times.

History