Six4Win.WebApi

<back to all web services

ConfigureLocalCodePot

Requires Authentication
The following routes are available for this service:
POST/cmd/configure/lcp
# frozen_string_literal: true
# encoding: utf-8


require 'json'
require 'servicestack'


class ThresholdInterval
    include ServiceStack::DTO

    # @return [BigDecimal]
    attr_accessor :start
    # @return [BigDecimal]
    attr_accessor :end

    def self.properties
        {
            start: { name: 'start' },
            end: { name: 'end' },
        }
    end

end

class LCPConfiguration
    include ServiceStack::DTO

    # @return [TrueClass]
    attr_accessor :is_active
    # @return [ThresholdInterval]
    attr_accessor :interval
    # @return [BigDecimal]
    attr_accessor :pct

    def self.properties
        {
            is_active: { name: 'isActive' },
            interval: { name: 'interval', type: ThresholdInterval },
            pct: { name: 'pct' },
        }
    end

end

class ConfigureLocalCodePot
    include ServiceStack::DTO

    # @return [String]
    attr_accessor :id
    # @return [String]
    attr_accessor :scope_id
    # @return [String]
    attr_accessor :scope_name
    # @return [LCPConfiguration]
    attr_accessor :configuration

    def self.properties
        {
            id: { name: 'id' },
            scope_id: { name: 'scopeId' },
            scope_name: { name: 'scopeName' },
            configuration: { name: 'configuration', type: LCPConfiguration },
        }
    end

    def response_type() = ServiceStack::ResponseStatus
    def get_type_name() = 'ConfigureLocalCodePot'
end

Ruby ConfigureLocalCodePot DTOs

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.

POST /cmd/configure/lcp HTTP/1.1 
Host: s4w2.api.bettor.webhop.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ConfigureLocalCodePot xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Six4Win.WebApi.ServiceModel">
  <Configuration xmlns:d2p1="http://schemas.datacontract.org/2004/07/Six4Win">
    <d2p1:Interval>
      <d2p1:End>0</d2p1:End>
      <d2p1:Start>0</d2p1:Start>
    </d2p1:Interval>
    <d2p1:IsActive>false</d2p1:IsActive>
    <d2p1:Pct>0</d2p1:Pct>
  </Configuration>
  <Id>String</Id>
  <ScopeId>String</ScopeId>
  <ScopeName>String</ScopeName>
</ConfigureLocalCodePot>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>