digitaluapi

<back to all web services

SegmentsAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/segments
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class SegmentsAdd
    {
        @DataMember(Order=2)
        @Validate(Validator="NotNull")
        public Integer TenantsId = null;

        @DataMember(Order=3)
        @Validate(Validator="NotNull")
        public String Name = null;

        @DataMember(Order=4)
        public Boolean IsCustom = null;
        
        public Integer getTenantsId() { return TenantsId; }
        public SegmentsAdd setTenantsId(Integer value) { this.TenantsId = value; return this; }
        public String getName() { return Name; }
        public SegmentsAdd setName(String value) { this.Name = value; return this; }
        public Boolean getIsCustom() { return IsCustom; }
        public SegmentsAdd setIsCustom(Boolean value) { this.IsCustom = value; return this; }
    }

    public static class SegmentsAddResponse
    {
        @DataMember(Order=2)
        public Integer TenantsId = null;

        @DataMember(Order=3)
        public String Name = null;

        @DataMember(Order=4)
        public Boolean IsCustom = null;

        @DataMember(Order=6)
        public ResponseStatus ResponseStatus = null;
        
        public Integer getTenantsId() { return TenantsId; }
        public SegmentsAddResponse setTenantsId(Integer value) { this.TenantsId = value; return this; }
        public String getName() { return Name; }
        public SegmentsAddResponse setName(String value) { this.Name = value; return this; }
        public Boolean getIsCustom() { return IsCustom; }
        public SegmentsAddResponse setIsCustom(Boolean value) { this.IsCustom = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public SegmentsAddResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java SegmentsAdd 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 /segments HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SegmentsAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <TenantsId>0</TenantsId>
  <Name>String</Name>
  <IsCustom>false</IsCustom>
</SegmentsAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SegmentsAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <IsCustom>false</IsCustom>
  <Name>String</Name>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <TenantsId>0</TenantsId>
</SegmentsAddResponse>