GET api/Partner

Retrieves the information for a given Partner. No parameters are needed for this function. The partner to retrieve is defined by the 3rd parameter in the Partner Authnetication request.

Request Information

Authentication Method

Sub Partner Authentication

URI Parameters

None.

Body Parameters

None.

Response Information

Successful Response:

Resource Description

Partner

Name	Description	Type
address	Address of partner	Address
whiteLabelSettings	Settings for white label site	White Label Settings
partnerId	Partner identifier. Used for subsequent requests made on the partner's behalf	string
remoteId	Parent partner's internal identifier for this sub-partner	string
partnerToken	Partner secret token. Used for subsequent requests made on the partner's behalf	string
name	Name of partner	string
status	Partner's status	string
settlementCurrency	The default currency new accounts will settle their Campaign spend in if none is defined at time of account creation.	string
feeCurrencySetting	Defines how the currency is chosen when determining the correct fee item for a subscription	string

Response Formats

application/json, text/json

Sample:

{
  "address": {
    "street1": "123 Baxter Ct.",
    "street2": "Apt. 100",
    "city": "Coolsville",
    "stateProv": "FL",
    "postalCode": "55555-5555",
    "countryCode": "US"
  },
  "whiteLabelSettings": {
    "headerBgColor": "cccccc",
    "headerTextColor": "000000",
    "headerLogoUrl": "https://www.partner.com/resources/sw-wl-logo.png",
    "topBarBgColor": null,
    "topBarTextColor": null,
    "supportPhone": "800-555-0001",
    "supportEmail": "support@partner.com",
    "supportUrl": "https://support.partner.com",
    "mobileAppSplashScreenColor": "ffffff",
    "mobileAppPrimaryColor": "cccccc",
    "mobileAppPrimaryTextColor": "000000",
    "mobileAppSecondaryColor": "222222",
    "mobileAppSecondaryTextColor": "000000",
    "mobileAppLogoUrl": "https://www.partner.com/resources/sw-wl-logo-mobile.png",
    "features": [
      "SEM",
      "Analytics"
    ],
    "uiSettings": null,
    "partnerActions": [
      {
        "actionType": "DisplayBudget",
        "data": "display/[CAMPAIGN_ID]/modify"
      },
      {
        "actionType": "DisplayPurchase",
        "data": "display/[CAMPAIGN_ID]/purchase"
      },
      {
        "actionType": "DisplayCancel",
        "data": "display/[CAMPAIGN_ID]/cancel"
      },
      {
        "actionType": "DisplayReinstate",
        "data": "display/[CAMPAIGN_ID]/reinstate"
      }
    ],
    "platformPlugins": [
      {
        "platform": "WordPress",
        "url": "https://partner.com/plugin/wordpress"
      }
    ]
  },
  "partnerId": "11111111-zzzz-yyyy-xxxx-1234567890ab",
  "remoteId": "84957345703003845",
  "partnerToken": "pppppppppppppppppppppppppppppp",
  "name": "My Partner",
  "status": "Active",
  "settlementCurrency": "Undefined",
  "feeCurrencySetting": "AlwaysUSD"
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'SiteWit.PartnerAPI.Models.ReturnModels.PartnerAction' with data contract name 'PartnerAction:http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'SiteWit.PartnerAPI.Models.ReturnModels.PartnerAction' with data contract name 'PartnerAction:http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.