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

PUT /roles/{Id} HTTP/1.1 
Host: api.sfgtec.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<RolesEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Id>0</Id>
  <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>
</RolesEditResponse>