BokaMera.API.Host

<back to all web services

UserAgreementQuery

Requires Authentication
The following routes are available for this service:
GET/users/agreementGets latest not agreed agreement with optional history
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
    // @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
    @ValidateRequest(Validator="IsAuthenticated")
    public static class UserAgreementQuery
    {
        public UUID UserId = null;
        
        public UUID getUserId() { return UserId; }
        public UserAgreementQuery setUserId(UUID value) { this.UserId = value; return this; }
    }

    public static class UserAgreementQueryResponse
    {
        public UUID UserId = null;
        public UUID AgreementId = null;
        public Date UserAgreementCreated = null;
        public Boolean AgreedToLatest = null;
        public ArrayList<String> Documents = null;
        public Object ResponseStatus = null;
        
        public UUID getUserId() { return UserId; }
        public UserAgreementQueryResponse setUserId(UUID value) { this.UserId = value; return this; }
        public UUID getAgreementId() { return AgreementId; }
        public UserAgreementQueryResponse setAgreementId(UUID value) { this.AgreementId = value; return this; }
        public Date getUserAgreementCreated() { return UserAgreementCreated; }
        public UserAgreementQueryResponse setUserAgreementCreated(Date value) { this.UserAgreementCreated = value; return this; }
        public Boolean isAgreedToLatest() { return AgreedToLatest; }
        public UserAgreementQueryResponse setAgreedToLatest(Boolean value) { this.AgreedToLatest = value; return this; }
        public ArrayList<String> getDocuments() { return Documents; }
        public UserAgreementQueryResponse setDocuments(ArrayList<String> value) { this.Documents = value; return this; }
        public Object getResponseStatus() { return ResponseStatus; }
        public UserAgreementQueryResponse setResponseStatus(Object value) { this.ResponseStatus = value; return this; }
    }

}

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

GET /users/agreement HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserAgreementQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AgreedToLatest>false</AgreedToLatest>
  <AgreementId>00000000-0000-0000-0000-000000000000</AgreementId>
  <Documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Documents>
  <ResponseStatus />
  <UserAgreementCreated>0001-01-01T00:00:00</UserAgreementCreated>
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
</UserAgreementQueryResponse>