Cdn API - CPG Source

<back to all web services

IapPlanMapRequest

Cdn.Api

The following routes are available for this service:
GET/IapPlanMapRequest
IapPlanMapResponse Parameters:
NameParameterData TypeRequiredDescription
PlansformList<IapPlanDto>No
SourceformstringNo
StatusformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
IapPlanDto Parameters:
NameParameterData TypeRequiredDescription
PlanIdformstringNo
NameformstringNo
TaglineformstringNo
LevelformintNo
BadgeformstringNo
BenefitsformList<string>No
RequiresShippingAddressformboolNo
VisibleInAppformboolNo
SortOrderformintNo
EntitlementLookupKeyformstringNo
ProductCategoryIdformlongNo
MonthlySkuformstringNo
AnnualSkuformstringNo
MonthlyLocalProductIdformlongNo
AnnualLocalProductIdformlongNo
UnlocksRetailformboolNo
UnlocksWholesaleformboolNo
RetailCatalogIdsformstringNo
WholesaleCatalogIdsformstringNo
IncludesPrintformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /IapPlanMapRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IapPlanMapResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.ResponseObjects">
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <Plans>
    <IapPlanDto>
      <AnnualLocalProductId>0</AnnualLocalProductId>
      <AnnualSku>String</AnnualSku>
      <Badge>String</Badge>
      <Benefits xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Benefits>
      <EntitlementLookupKey>String</EntitlementLookupKey>
      <IncludesPrint>false</IncludesPrint>
      <Level>0</Level>
      <MonthlyLocalProductId>0</MonthlyLocalProductId>
      <MonthlySku>String</MonthlySku>
      <Name>String</Name>
      <PlanId>String</PlanId>
      <ProductCategoryId>0</ProductCategoryId>
      <RequiresShippingAddress>false</RequiresShippingAddress>
      <RetailCatalogIds>String</RetailCatalogIds>
      <SortOrder>0</SortOrder>
      <Tagline>String</Tagline>
      <UnlocksRetail>false</UnlocksRetail>
      <UnlocksWholesale>false</UnlocksWholesale>
      <VisibleInApp>false</VisibleInApp>
      <WholesaleCatalogIds>String</WholesaleCatalogIds>
    </IapPlanDto>
  </Plans>
  <Source>String</Source>
  <Status>String</Status>
</IapPlanMapResponse>