BokaMera.API.Host

<back to all web services

AgreementQuery

The following routes are available for this service:
GET/agreementsGets agreements

export class AgreementQueryResponse
{
    public AgreementId: string;
    public AgreementCreated?: string;
    public Documents: string[];
    public ResponseStatus: Object;

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

// @ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
export class AgreementQuery
{

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

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