POST Api/GetInitialCustomerMarketPlaceSetupInfo_ForNewSetup/Post

Request Information

URI Parameters

None.

Body Parameters

ClientOnlyProxyInformationWithMarketPlaceIDAndUseSandBox

Name	Type	Additional information
UseSandBox	boolean	None.
MarketPlaceID	string	None.
ProxyInformation	ClientOnlyProxyInformation	None.

Request Formats

application/json, text/json

Sample:

{
  "UseSandBox": true,
  "MarketPlaceID": "sample string 2",
  "ProxyInformation": {
    "ProxyFields": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ClientOnlyProxyInformationWithMarketPlaceIDAndUseSandBox xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MarketPlaceWorkflowWebAPI.Controllers">
  <MarketPlaceID>sample string 2</MarketPlaceID>
  <ProxyInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.Mef">
    <d2p1:ProxyFields 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>
    </d2p1:ProxyFields>
  </ProxyInformation>
  <UseSandBox>true</UseSandBox>
</ClientOnlyProxyInformationWithMarketPlaceIDAndUseSandBox>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RegisterMarketPlaceStepResponse

Name	Type	Additional information
UseExtendedMarketPlaceStep	boolean	None.
Extended	ExtendedRegisterMarketPlaceStep	None.
Simple	SimpleRegisterMarketPlaceStep	None.
MarketplaceInstanceID	string	None.

Response Formats

application/json, text/json

Sample:

{
  "UseExtendedMarketPlaceStep": true,
  "Extended": {
    "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"
  },
  "Simple": {
    "Instructions": "sample string 1",
    "StepNumber": 2,
    "StepsTotal": 3,
    "RegistrationIsComplete": true,
    "PassBackFields": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "InputFields": [
      {
        "Description": "sample string 1",
        "Label": "sample string 2",
        "PassBackFieldKey": "sample string 3",
        "InitialValue": "sample string 4"
      },
      {
        "Description": "sample string 1",
        "Label": "sample string 2",
        "PassBackFieldKey": "sample string 3",
        "InitialValue": "sample string 4"
      }
    ]
  },
  "MarketplaceInstanceID": "sample string 2"
}

application/xml, text/xml

Sample:

<RegisterMarketPlaceStepResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.Mef">
  <Extended>
    <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:d4p1="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.General">
        <d4p1:KeyValue>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValue>
        <d4p1:KeyValue>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValue>
      </FormFields>
      <Headers xmlns:d4p1="http://schemas.datacontract.org/2004/07/MarketplaceDataContracts.General">
        <d4p1:KeyValue>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValue>
        <d4p1:KeyValue>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValue>
      </Headers>
      <OAuthURL>sample string 1</OAuthURL>
      <Protocol>sample string 2</Protocol>
    </OAuthRedirectInfo>
    <PassBackField 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>
    </PassBackField>
    <RegistrationIsComplete>true</RegistrationIsComplete>
    <StepNumber>2</StepNumber>
    <StepsTotal>3</StepsTotal>
  </Extended>
  <MarketplaceInstanceID>sample string 2</MarketplaceInstanceID>
  <Simple>
    <InputFields>
      <SimpleField>
        <Description>sample string 1</Description>
        <InitialValue>sample string 4</InitialValue>
        <Label>sample string 2</Label>
        <PassBackFieldKey>sample string 3</PassBackFieldKey>
      </SimpleField>
      <SimpleField>
        <Description>sample string 1</Description>
        <InitialValue>sample string 4</InitialValue>
        <Label>sample string 2</Label>
        <PassBackFieldKey>sample string 3</PassBackFieldKey>
      </SimpleField>
    </InputFields>
    <Instructions>sample string 1</Instructions>
    <PassBackFields 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>
    </PassBackFields>
    <RegistrationIsComplete>true</RegistrationIsComplete>
    <StepNumber>2</StepNumber>
    <StepsTotal>3</StepsTotal>
  </Simple>
  <UseExtendedMarketPlaceStep>true</UseExtendedMarketPlaceStep>
</RegisterMarketPlaceStepResponse>