POST api/SetupMarketplace/RegisterMarketPlaceStep

Proxy setup. fields will correspond to fields in the MarketPlaceSetupStep data structure. Initial fields in request will come from the response to GetInitialMarketplaceSetupInfo. Subsequent fields in the requet will correspond to the RegisterMarketPlaceStep. Calls to RegisterMarketPlaceStep will be repeated until the value of the RegistrationIsComplete property is true.

Request Information

URI Parameters

None.

Body Parameters

UserMarketplaceProxyInfo corresponding to a specific MarketPlaceSetupStep instance.

RegisterMarketPlaceStepRequest

Name	Type	Additional information
CurrentlyCompletedStep	integer	None.
PassbackFields	Collection of KeyValue	None.
MarketplaceID	string	None.
Token	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CurrentlyCompletedStep": 1,
  "PassbackFields": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "MarketplaceID": "sample string 2",
  "Token": "sample string 3"
}

application/xml, text/xml

Sample:

<RegisterMarketPlaceStepRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.Mef">
  <CurrentlyCompletedStep>1</CurrentlyCompletedStep>
  <MarketplaceID>sample string 2</MarketplaceID>
  <PassbackFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.General">
    <d2p1:KeyValue>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValue>
    <d2p1:KeyValue>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValue>
  </PassbackFields>
  <Token>sample string 3</Token>
</RegisterMarketPlaceStepRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns a MarketPlaceSetupStep instance. Process is not complete until the RegistrationIsComplete property returns as true.

ExtendedRegisterMarketPlaceStep

Name	Type	Additional information
Instructions	string	None.
StepNumber	integer	None.
StepsTotal	integer	None.
OAuthRedirectInfo	OAuthRedirect	None.
RegistrationIsComplete	boolean	None.
PassBackField	Collection of KeyValue	None.
InputFields	Collection of InputField	None.
MarketplaceInstanceID	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Instructions": "sample string 1",
  "StepNumber": 2,
  "StepsTotal": 3,
  "OAuthRedirectInfo": {
    "OAuthURL": "sample string 1",
    "Protocol": "sample string 2",
    "Headers": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "FormFields": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  },
  "RegistrationIsComplete": true,
  "PassBackField": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "InputFields": [
    {
      "isMultiSelect": true,
      "FieldName": "sample string 2",
      "InitialValue": "sample string 3",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Type": "sample string 6",
      "DisplayOrder": 7,
      "FieldIsRequired": true,
      "AppicableFor": 0,
      "OptionList": [
        {
          "Key": "sample string 1",
          "Display": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Display": "sample string 2"
        }
      ]
    },
    {
      "isMultiSelect": true,
      "FieldName": "sample string 2",
      "InitialValue": "sample string 3",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Type": "sample string 6",
      "DisplayOrder": 7,
      "FieldIsRequired": true,
      "AppicableFor": 0,
      "OptionList": [
        {
          "Key": "sample string 1",
          "Display": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Display": "sample string 2"
        }
      ]
    }
  ],
  "MarketplaceInstanceID": "sample string 5"
}

application/xml, text/xml

Sample:

<ExtendedRegisterMarketPlaceStep xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.Mef">
  <InputFields>
    <InputField>
      <AppicableFor>NotSet</AppicableFor>
      <Description>sample string 5</Description>
      <DisplayOrder>7</DisplayOrder>
      <FieldIsRequired>true</FieldIsRequired>
      <FieldName>sample string 2</FieldName>
      <InitialValue>sample string 3</InitialValue>
      <Name>sample string 4</Name>
      <OptionList>
        <Option>
          <Display>sample string 2</Display>
          <Key>sample string 1</Key>
        </Option>
        <Option>
          <Display>sample string 2</Display>
          <Key>sample string 1</Key>
        </Option>
      </OptionList>
      <Type>sample string 6</Type>
      <isMultiSelect>true</isMultiSelect>
    </InputField>
    <InputField>
      <AppicableFor>NotSet</AppicableFor>
      <Description>sample string 5</Description>
      <DisplayOrder>7</DisplayOrder>
      <FieldIsRequired>true</FieldIsRequired>
      <FieldName>sample string 2</FieldName>
      <InitialValue>sample string 3</InitialValue>
      <Name>sample string 4</Name>
      <OptionList>
        <Option>
          <Display>sample string 2</Display>
          <Key>sample string 1</Key>
        </Option>
        <Option>
          <Display>sample string 2</Display>
          <Key>sample string 1</Key>
        </Option>
      </OptionList>
      <Type>sample string 6</Type>
      <isMultiSelect>true</isMultiSelect>
    </InputField>
  </InputFields>
  <Instructions>sample string 1</Instructions>
  <MarketplaceInstanceID>sample string 5</MarketplaceInstanceID>
  <OAuthRedirectInfo>
    <FormFields xmlns:d3p1="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.General">
      <d3p1:KeyValue>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValue>
      <d3p1:KeyValue>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValue>
    </FormFields>
    <Headers xmlns:d3p1="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.General">
      <d3p1:KeyValue>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValue>
      <d3p1:KeyValue>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValue>
    </Headers>
    <OAuthURL>sample string 1</OAuthURL>
    <Protocol>sample string 2</Protocol>
  </OAuthRedirectInfo>
  <PassBackField xmlns:d2p1="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.General">
    <d2p1:KeyValue>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValue>
    <d2p1:KeyValue>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValue>
  </PassBackField>
  <RegistrationIsComplete>true</RegistrationIsComplete>
  <StepNumber>2</StepNumber>
  <StepsTotal>3</StepsTotal>
</ExtendedRegisterMarketPlaceStep>