BokaMera.API.Host

<back to all web services

AgreementQuery

The following routes are available for this service:
GET/agreementsGets agreements
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type AgreementQueryResponse() = 
        member val AgreementId:Guid = new Guid() with get,set
        member val AgreementCreated:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Documents:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val ResponseStatus:Object = null with get,set

    [<ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)>]
    [<AllowNullLiteral>]
    type AgreementQuery() = 
        class end

F# AgreementQuery 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 /agreements HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgreementQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AgreementCreated>0001-01-01T00:00:00</AgreementCreated>
  <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 />
</AgreementQueryResponse>