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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.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 Partial Class UserAgreementQuery
            Public Overridable Property UserId As Guid
        End Class

        Public Partial Class UserAgreementQueryResponse
            Public Sub New()
                Documents = New List(Of String)
            End Sub

            Public Overridable Property UserId As Guid
            Public Overridable Property AgreementId As Guid
            Public Overridable Property UserAgreementCreated As Nullable(Of Date)
            Public Overridable Property AgreedToLatest As Boolean
            Public Overridable Property Documents As List(Of String)
            Public Overridable Property ResponseStatus As Object
        End Class
    End Namespace
End Namespace

VB.NET UserAgreementQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"UserAgreementCreated":"0001-01-01T00:00:00","AgreedToLatest":false,"Documents":["String"],"ResponseStatus":{}}