digitaluapi

<back to all web services

SegmentsEdit

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

public class dtos
{

    @DataContract
    public static class SegmentsEdit
    {
        @DataMember(Order=1)
        @Validate(Validator="NotNull")
        public Long Id = null;

        @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 Long getId() { return Id; }
        public SegmentsEdit setId(Long value) { this.Id = value; return this; }
        public Integer getTenantsId() { return TenantsId; }
        public SegmentsEdit setTenantsId(Integer value) { this.TenantsId = value; return this; }
        public String getName() { return Name; }
        public SegmentsEdit setName(String value) { this.Name = value; return this; }
        public Boolean getIsCustom() { return IsCustom; }
        public SegmentsEdit setIsCustom(Boolean value) { this.IsCustom = value; return this; }
    }

    public static class SegmentsEditResponse
    {
        @DataMember(Order=1)
        public Long Id = null;

        @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 Long getId() { return Id; }
        public SegmentsEditResponse setId(Long value) { this.Id = value; return this; }
        public Integer getTenantsId() { return TenantsId; }
        public SegmentsEditResponse setTenantsId(Integer value) { this.TenantsId = value; return this; }
        public String getName() { return Name; }
        public SegmentsEditResponse setName(String value) { this.Name = value; return this; }
        public Boolean getIsCustom() { return IsCustom; }
        public SegmentsEditResponse setIsCustom(Boolean value) { this.IsCustom = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public SegmentsEditResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java SegmentsEdit DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /segments/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	TenantsId: 0,
	Name: String,
	IsCustom: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	TenantsId: 0,
	Name: String,
	IsCustom: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}