POST Setup/UserConfig

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
AuthorizationToken		string	None.

Request Formats

application/json, text/json

Sample:

{
  "AuthorizationToken": "sample string 1"
}

application/xml, text/xml

Sample:

<UserConfigRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Transglobal.Entities.Objects.Linnworks.RequestAndResponse.UserSetup">
  <AuthorizationToken xmlns="http://schemas.datacontract.org/2004/07/Transglobal.Entities.Objects.Linnworks.RequestAndResponse.Base">sample string 1</AuthorizationToken>
</UserConfigRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UserConfigResponse

Name	Type	Additional information
IsConfigActive	boolean	None.
ConfigStage	ConfigStage	None.
ConfigStatus	string	None.
ErrorMessage	string	None.
IsError	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "IsConfigActive": true,
  "ConfigStage": {
    "ConfigItems": [
      {
        "ConfigItemId": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3",
        "GroupName": "sample string 4",
        "ListValues": [
          {
            "Display": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Display": "sample string 1",
            "Value": "sample string 2"
          }
        ],
        "MustBeSpecified": true,
        "SortOrder": 6,
        "SelectedValue": "sample string 7",
        "ReadOnly": true,
        "RegExValidation": "sample string 9",
        "RegExError": "sample string 10",
        "ValueType": 0
      },
      {
        "ConfigItemId": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3",
        "GroupName": "sample string 4",
        "ListValues": [
          {
            "Display": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Display": "sample string 1",
            "Value": "sample string 2"
          }
        ],
        "MustBeSpecified": true,
        "SortOrder": 6,
        "SelectedValue": "sample string 7",
        "ReadOnly": true,
        "RegExValidation": "sample string 9",
        "RegExError": "sample string 10",
        "ValueType": 0
      }
    ],
    "WizardStepDescription": "sample string 1",
    "WizardStepTitle": "sample string 2"
  },
  "ConfigStatus": "sample string 2",
  "ErrorMessage": "sample string 3",
  "IsError": true
}

application/xml, text/xml

Sample:

<UserConfigResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Transglobal.Entities.Objects.Linnworks.RequestAndResponse.UserSetup">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Transglobal.Entities.Objects.Linnworks.RequestAndResponse.Base">sample string 3</ErrorMessage>
  <IsError xmlns="http://schemas.datacontract.org/2004/07/Transglobal.Entities.Objects.Linnworks.RequestAndResponse.Base">true</IsError>
  <ConfigStage xmlns:d2p1="http://schemas.datacontract.org/2004/07/Transglobal.Entities.Objects.Linnworks.Classes.UserConfig">
    <d2p1:ConfigItems>
      <d2p1:ConfigItem>
        <d2p1:ConfigItemId>sample string 1</d2p1:ConfigItemId>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:GroupName>sample string 4</d2p1:GroupName>
        <d2p1:ListValues>
          <d2p1:ConfigItemListItem>
            <d2p1:Display>sample string 1</d2p1:Display>
            <d2p1:Value>sample string 2</d2p1:Value>
          </d2p1:ConfigItemListItem>
          <d2p1:ConfigItemListItem>
            <d2p1:Display>sample string 1</d2p1:Display>
            <d2p1:Value>sample string 2</d2p1:Value>
          </d2p1:ConfigItemListItem>
        </d2p1:ListValues>
        <d2p1:MustBeSpecified>true</d2p1:MustBeSpecified>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:ReadOnly>true</d2p1:ReadOnly>
        <d2p1:RegExError>sample string 10</d2p1:RegExError>
        <d2p1:RegExValidation>sample string 9</d2p1:RegExValidation>
        <d2p1:SelectedValue>sample string 7</d2p1:SelectedValue>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:ValueType>String</d2p1:ValueType>
      </d2p1:ConfigItem>
      <d2p1:ConfigItem>
        <d2p1:ConfigItemId>sample string 1</d2p1:ConfigItemId>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:GroupName>sample string 4</d2p1:GroupName>
        <d2p1:ListValues>
          <d2p1:ConfigItemListItem>
            <d2p1:Display>sample string 1</d2p1:Display>
            <d2p1:Value>sample string 2</d2p1:Value>
          </d2p1:ConfigItemListItem>
          <d2p1:ConfigItemListItem>
            <d2p1:Display>sample string 1</d2p1:Display>
            <d2p1:Value>sample string 2</d2p1:Value>
          </d2p1:ConfigItemListItem>
        </d2p1:ListValues>
        <d2p1:MustBeSpecified>true</d2p1:MustBeSpecified>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:ReadOnly>true</d2p1:ReadOnly>
        <d2p1:RegExError>sample string 10</d2p1:RegExError>
        <d2p1:RegExValidation>sample string 9</d2p1:RegExValidation>
        <d2p1:SelectedValue>sample string 7</d2p1:SelectedValue>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:ValueType>String</d2p1:ValueType>
      </d2p1:ConfigItem>
    </d2p1:ConfigItems>
    <d2p1:WizardStepDescription>sample string 1</d2p1:WizardStepDescription>
    <d2p1:WizardStepTitle>sample string 2</d2p1:WizardStepTitle>
  </ConfigStage>
  <ConfigStatus>sample string 2</ConfigStatus>
  <IsConfigActive>true</IsConfigActive>
</UserConfigResponse>