POST Setup/UserAvailableServices

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:

<UserAvailableServicesRequest 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>
</UserAvailableServicesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UserAvailableServicesResponse

Name	Type	Additional information
Services	Collection of CourierService	None.
ErrorMessage	string	None.
IsError	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Services": [
    {
      "ServiceName": "sample string 1",
      "ServiceCode": "sample string 2",
      "ServiceTag": "sample string 3",
      "ServiceGroup": "sample string 4",
      "ServiceUniqueId": "8efce8cd-1167-42f4-b863-3bf1f1f2fff2",
      "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
        }
      ],
      "ServiceProperty": [
        {
          "PropertyName": "sample string 1",
          "PropertyValue": "sample string 2"
        },
        {
          "PropertyName": "sample string 1",
          "PropertyValue": "sample string 2"
        }
      ]
    },
    {
      "ServiceName": "sample string 1",
      "ServiceCode": "sample string 2",
      "ServiceTag": "sample string 3",
      "ServiceGroup": "sample string 4",
      "ServiceUniqueId": "8efce8cd-1167-42f4-b863-3bf1f1f2fff2",
      "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
        }
      ],
      "ServiceProperty": [
        {
          "PropertyName": "sample string 1",
          "PropertyValue": "sample string 2"
        },
        {
          "PropertyName": "sample string 1",
          "PropertyValue": "sample string 2"
        }
      ]
    }
  ],
  "ErrorMessage": "sample string 1",
  "IsError": true
}

application/xml, text/xml

Sample:

<UserAvailableServicesResponse 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 1</ErrorMessage>
  <IsError xmlns="http://schemas.datacontract.org/2004/07/Transglobal.Entities.Objects.Linnworks.RequestAndResponse.Base">true</IsError>
  <Services xmlns:d2p1="http://schemas.datacontract.org/2004/07/Transglobal.Entities.Objects.Linnworks.Classes.UserConfig">
    <d2p1:CourierService>
      <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:ServiceCode>sample string 2</d2p1:ServiceCode>
      <d2p1:ServiceGroup>sample string 4</d2p1:ServiceGroup>
      <d2p1:ServiceName>sample string 1</d2p1:ServiceName>
      <d2p1:ServiceProperty>
        <d2p1:ServiceProperty>
          <d2p1:PropertyName>sample string 1</d2p1:PropertyName>
          <d2p1:PropertyValue>sample string 2</d2p1:PropertyValue>
        </d2p1:ServiceProperty>
        <d2p1:ServiceProperty>
          <d2p1:PropertyName>sample string 1</d2p1:PropertyName>
          <d2p1:PropertyValue>sample string 2</d2p1:PropertyValue>
        </d2p1:ServiceProperty>
      </d2p1:ServiceProperty>
      <d2p1:ServiceTag>sample string 3</d2p1:ServiceTag>
      <d2p1:ServiceUniqueId>8efce8cd-1167-42f4-b863-3bf1f1f2fff2</d2p1:ServiceUniqueId>
    </d2p1:CourierService>
    <d2p1:CourierService>
      <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:ServiceCode>sample string 2</d2p1:ServiceCode>
      <d2p1:ServiceGroup>sample string 4</d2p1:ServiceGroup>
      <d2p1:ServiceName>sample string 1</d2p1:ServiceName>
      <d2p1:ServiceProperty>
        <d2p1:ServiceProperty>
          <d2p1:PropertyName>sample string 1</d2p1:PropertyName>
          <d2p1:PropertyValue>sample string 2</d2p1:PropertyValue>
        </d2p1:ServiceProperty>
        <d2p1:ServiceProperty>
          <d2p1:PropertyName>sample string 1</d2p1:PropertyName>
          <d2p1:PropertyValue>sample string 2</d2p1:PropertyValue>
        </d2p1:ServiceProperty>
      </d2p1:ServiceProperty>
      <d2p1:ServiceTag>sample string 3</d2p1:ServiceTag>
      <d2p1:ServiceUniqueId>8efce8cd-1167-42f4-b863-3bf1f1f2fff2</d2p1:ServiceUniqueId>
    </d2p1:CourierService>
  </Services>
</UserAvailableServicesResponse>