BokaMera.API.Host

<back to all web services

CreateUserAgreement

Requires Authentication
The following routes are available for this service:
POST/users/agreementMarks agreement as agreed for user
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 CreateUserAgreement
    {
        public UUID UserId = null;
        public UUID AgreementId = null;
        
        public UUID getUserId() { return UserId; }
        public CreateUserAgreement setUserId(UUID value) { this.UserId = value; return this; }
        public UUID getAgreementId() { return AgreementId; }
        public CreateUserAgreement setAgreementId(UUID value) { this.AgreementId = value; return this; }
    }

    public static class CreateUserAgreementResponse
    {
        public UUID UserId = null;
        public UUID AgreementId = null;
        public Date UserAgreementCreated = null;
        public Object ResponseStatus = null;
        
        public UUID getUserId() { return UserId; }
        public CreateUserAgreementResponse setUserId(UUID value) { this.UserId = value; return this; }
        public UUID getAgreementId() { return AgreementId; }
        public CreateUserAgreementResponse setAgreementId(UUID value) { this.AgreementId = value; return this; }
        public Date getUserAgreementCreated() { return UserAgreementCreated; }
        public CreateUserAgreementResponse setUserAgreementCreated(Date value) { this.UserAgreementCreated = value; return this; }
        public Object getResponseStatus() { return ResponseStatus; }
        public CreateUserAgreementResponse setResponseStatus(Object value) { this.ResponseStatus = value; return this; }
    }

}

Java CreateUserAgreement 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/agreement HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateUserAgreement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AgreementId>00000000-0000-0000-0000-000000000000</AgreementId>
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
</CreateUserAgreement>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateUserAgreementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AgreementId>00000000-0000-0000-0000-000000000000</AgreementId>
  <ResponseStatus />
  <UserAgreementCreated>0001-01-01T00:00:00</UserAgreementCreated>
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
</CreateUserAgreementResponse>