Api/CommAgencies

From RPM Wiki

Table of contents

1 Summary

2 Request

2.1 Options for Var
2.2 Options for Run
2.3 Example

3 Response

3.1 Example

4 Errors

[edit]

Summary

API: Get a commission metric report for all agencies

[edit]

Request

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

[edit]

Options for Var

NetBilled
GrossComm
AgentComm
GrossProfit
Referral
ReferralTo
ContractVal
Margin
Wholesale

[edit]

Options for Run

yyyymm (A commission run described in the year/month format)
yyyy (Commission runs for the year)
all (All commission runs)
this (The currently open run)
prev (The previous run)
closed (The most recently closed run)

[edit]

Example

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

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

[edit]

Response

Returns agencies sorted A-Z by agency name

{"Result":
  {
    "Agencies": [
      {
        "Agency": "{agency name}",
        "AgencyID": "{agency id}",
        "Value": "{value}"
      },
      {repeat as needed}
    ]
  }
}

[edit]

Example

{"Result":
   {"Agencies":[
        {"Agency":"24Unet","AgencyID":493,"Value":1052429.04},
        {"Agency":"5280 Networks, LLC","AgencyID":388,"Value":10}
                ]
    }
}

[edit]

Errors

"Unrecognized Var parameter"
"Unrecognized Run parameter"
"User lacks permission"

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

This page was last modified 18:45, 25 Oct 2010.
This page has been accessed 985 times.

History