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

export class UserAgreementQueryResponse
{
    public UserId: string;
    public AgreementId: string;
    public UserAgreementCreated?: string;
    public AgreedToLatest: boolean;
    public Documents: string[];
    public ResponseStatus: Object;

    public constructor(init?: Partial<UserAgreementQueryResponse>) { (Object as any).assign(this, init); }
}

// @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")
export class UserAgreementQuery
{
    public UserId: string;

    public constructor(init?: Partial<UserAgreementQuery>) { (Object as any).assign(this, init); }
}

TypeScript 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: api.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":{}}