sfgboxapi

<back to all web services

RolesEdit

Requires Authentication
Required role:SystemAdmin
The following routes are available for this service:
PUT/roles/{Id}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

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

        @DataMember(Order=2)
        @Validate(Validator="NotNull")
        public Long tenantsId = null;

        @DataMember(Order=3)
        @Validate(Validator="NotNull")
        public String name = null;
        
        public Long getId() { return id; }
        public RolesEdit setId(Long value) { this.id = value; return this; }
        public Long getTenantsId() { return tenantsId; }
        public RolesEdit setTenantsId(Long value) { this.tenantsId = value; return this; }
        public String getName() { return name; }
        public RolesEdit setName(String value) { this.name = value; return this; }
    }

    public static class RolesEditResponse
    {
        @DataMember(Order=1)
        public Long id = null;

        @DataMember(Order=2)
        public Long tenantsId = null;

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

        @DataMember(Order=5)
        public ResponseStatus responseStatus = null;
        
        public Long getId() { return id; }
        public RolesEditResponse setId(Long value) { this.id = value; return this; }
        public Long getTenantsId() { return tenantsId; }
        public RolesEditResponse setTenantsId(Long value) { this.tenantsId = value; return this; }
        public String getName() { return name; }
        public RolesEditResponse setName(String value) { this.name = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public RolesEditResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java RolesEdit 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 /roles/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	tenantsId: 0,
	name: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	tenantsId: 0,
	name: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}