Billiecart API

<back to all web services

AssignRolesRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/users/{Id}/roles/assign
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class AssignRolesRequest extends PostOperationUnTenanted<AssignRolesResponse>
    {
        public String id = null;
        public ArrayList<String> roles = null;
        
        public String getId() { return id; }
        public AssignRolesRequest setId(String value) { this.id = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public AssignRolesRequest setRoles(ArrayList<String> value) { this.roles = value; return this; }
    }

    public static class PostOperationUnTenanted<TResponse> implements IPost
    {
        
    }

    public static class AssignRolesResponse
    {
        public ResponseStatus responseStatus = null;
        public UserAccount userAccount = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public AssignRolesResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public UserAccount getUserAccount() { return userAccount; }
        public AssignRolesResponse setUserAccount(UserAccount value) { this.userAccount = value; return this; }
    }

    public static class UserAccount implements IIdentifiableResource
    {
        public UserAccountName name = null;
        public String displayName = null;
        public String email = null;
        public ArrayList<String> roles = null;
        public AccountStatus status = null;
        public String defaultOrganisationId = null;
        public String id = null;
        
        public UserAccountName getName() { return name; }
        public UserAccount setName(UserAccountName value) { this.name = value; return this; }
        public String getDisplayName() { return displayName; }
        public UserAccount setDisplayName(String value) { this.displayName = value; return this; }
        public String getEmail() { return email; }
        public UserAccount setEmail(String value) { this.email = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public UserAccount setRoles(ArrayList<String> value) { this.roles = value; return this; }
        public AccountStatus getStatus() { return status; }
        public UserAccount setStatus(AccountStatus value) { this.status = value; return this; }
        public String getDefaultOrganisationId() { return defaultOrganisationId; }
        public UserAccount setDefaultOrganisationId(String value) { this.defaultOrganisationId = value; return this; }
        public String getId() { return id; }
        public UserAccount setId(String value) { this.id = value; return this; }
    }

    public static class UserAccountName
    {
        public String firstName = null;
        public String lastName = null;
        
        public String getFirstName() { return firstName; }
        public UserAccountName setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public UserAccountName setLastName(String value) { this.lastName = value; return this; }
    }

    public static enum AccountStatus
    {
        Shadowed,
        Registered;
    }

}

Java AssignRolesRequest 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 /users/{Id}/roles/assign HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AssignRolesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.UserAccounts">
  <Id>String</Id>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
</AssignRolesRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AssignRolesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.UserAccounts">
  <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>
  <UserAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:DefaultOrganisationId>String</d2p1:DefaultOrganisationId>
    <d2p1:DisplayName>String</d2p1:DisplayName>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:Name>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:LastName>String</d2p1:LastName>
    </d2p1:Name>
    <d2p1:Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Roles>
    <d2p1:Status>Shadowed</d2p1:Status>
  </UserAccount>
</AssignRolesResponse>