GET api/partner/audit?limit={limit}&skip={skip}
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
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| limit | integer |
Required |
|
| skip | integer |
Required |
Body Parameters
None.
Response Information
Successful Response:Resource Description
Collection of Partner (Basic Info)| Name | Description | Type | Additional information |
|---|---|---|---|
| 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:
[
{
"partnerId": "11111111-zzzz-yyyy-xxxx-1234567890ab",
"remoteId": "84957345703003845",
"partnerToken": "pppppppppppppppppppppppppppppp",
"name": "My Partner",
"status": "Active",
"settlementCurrency": "Undefined",
"feeCurrencySetting": "AlwaysUSD"
},
{
"partnerId": "22222222-xxxx-yyyy-zzzz-1234567890ab",
"remoteId": "n8yh898h887h7h98yu98",
"partnerToken": "qqqqqqqqqqqqqqqqqqqqqqqqqqqqqq",
"name": "My Partner 2",
"status": "Active",
"settlementCurrency": "Undefined",
"feeCurrencySetting": "MatchSpend"
}
]
application/xml, text/xml
Sample:
<ArrayOfPartnerInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels">
<PartnerInfo>
<feeCurrencySetting xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">AlwaysUSD</feeCurrencySetting>
<name xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">My Partner</name>
<partnerId xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">11111111-zzzz-yyyy-xxxx-1234567890ab</partnerId>
<partnerToken xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">pppppppppppppppppppppppppppppp</partnerToken>
<remoteId xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">84957345703003845</remoteId>
<settlementCurrency xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Undefined</settlementCurrency>
<status xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Active</status>
</PartnerInfo>
<PartnerInfo>
<feeCurrencySetting xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">MatchSpend</feeCurrencySetting>
<name xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">My Partner 2</name>
<partnerId xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">22222222-xxxx-yyyy-zzzz-1234567890ab</partnerId>
<partnerToken xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">qqqqqqqqqqqqqqqqqqqqqqqqqqqqqq</partnerToken>
<remoteId xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">n8yh898h887h7h98yu98</remoteId>
<settlementCurrency xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Undefined</settlementCurrency>
<status xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Active</status>
</PartnerInfo>
</ArrayOfPartnerInfo>
