Six4Win.WebApi

<back to all web services

ConfigureLocalCodePot

Requires Authentication
The following routes are available for this service:
POST/cmd/configure/lcp
"use strict";
export class ThresholdInterval {
    /** @param {{start?:number,end?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    start;
    /** @type {number} */
    end;
}
export class LCPConfiguration {
    /** @param {{isActive?:boolean,interval?:ThresholdInterval,pct?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    isActive;
    /** @type {ThresholdInterval} */
    interval;
    /** @type {number} */
    pct;
}
export class ConfigureLocalCodePot {
    /** @param {{id?:string,scopeId?:string,scopeName?:string,configuration?:LCPConfiguration}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    scopeId;
    /** @type {string} */
    scopeName;
    /** @type {LCPConfiguration} */
    configuration;
}

JavaScript 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.cc 
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>