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


@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")
open class UserAgreementQuery
{
    var UserId:UUID? = null
}

open class UserAgreementQueryResponse
{
    var UserId:UUID? = null
    var AgreementId:UUID? = null
    var UserAgreementCreated:Date? = null
    var AgreedToLatest:Boolean? = null
    var Documents:ArrayList<String> = ArrayList<String>()
    var ResponseStatus:Object? = null
}

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