Partner

Last updated on 2022-06-16 11:15:51

URI	/v1/partners/{username}
URI Parameters	username (string)
Methods	GET, PUT

GET /v1/partners/{username}

Gets a partner's information.

Scope	partners_read
Request Body Parameters	n/a
Response Attributes	partner_id (int) username (string) signup_date (date) status (string const) – ACTIVE\|TEST\|FROZEN\|CANCELED usage (int) type (string const) – REFERRAL\|RESELLER\|VOLUME addresses (link object) cancellation (link object) plans (link object) signups (link object) users (link object) usage_history (link object) reports (link object) password (link_object) installer URL (link object) software name (link object)

Example JSON

Request:

GET /v1/partners/barracuda HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/json

Response:

HTTP/1.1 200 OK

Content-Type: application/json

{

"partner_id": 10,

"username": “barracuda”,

"signup_date": "2011-01-01T09:00:00-05:00",

"status": "ACTIVE",

"usage": 1099511627776,

"type": "VOLUME",

"links": [

{

"title": "addresses",

"rel": "related",

"href": "https://api.intronis.com/v1/partners/barracuda/addresses"

{

"title": "cancellation",

"rel": "related",

"href": "https://api.intronis.com/v1/partners/barracuda/cancellation"

{

"title": "plans",

"rel": "related",

"href": "https://api.intronis.com/v1/partners/barracuda/plans"

{

"title": "signups",

"rel": "related",

"href": "https://api.intronis.com/v1/partners/barracuda/signups"

{

"title": "users",

"rel": "related",

"href": "https://api.intronis.com/v1/partners/barracuda/users"

{

"title": "usage_history",

"rel": "related",

"href": "https://api.intronis.com/v1/partners/barracuda/usage_history"

{

"title": "reports",

"rel": "related",

"href": "https://api.intronis.com/v1/partners/barracuda/reports"

{

"title": "password",

"rel": "related",

"href": "https://api.intronis.com/v1/partners/barracuda/password"

{

“title”: “installer_url”,

“rel”: “related”,

“href”: “https://manage.barracudamsp.com/Installer.ashx?Name=ECHObackup&SoftwareId=0eb9326d-0eb6-60a4-e9de-deeaf7f55cb1"

{

“title”: “software_name”,

“rel”: “related”,

“href”: “ECHObackup”

}

]

}

Example XML

Request:

GET /v1/partners/barracuda HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/xml

Response:

HTTP/1.1 200 OK

Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>

<partner_id>10</partner_id>

<username>barracuda</username>

<signup_date>2011-01-01T09:00:00-05:00</signup_date>

<status>ACTIVE</status>

<type>VOLUME</type>

</partner>