DigiOffice Gateway Web Services

GetEntitySummary

Get the summary of an entity.

The following routes are available for this service:
GET	/api/entities/{EntityName}/{EntityID}/summary

import Foundation
import ServiceStack

/**
* Get the summary of an entity.
*/
// @Api(Description="Get the summary of an entity.")
public class GetEntitySummary : Codable
{
    /**
    * ID of the entity
    */
    // @ApiMember(Description="ID of the entity", IsRequired=true)
    public var entityID:String?

    /**
    * Name of the entity
    */
    // @ApiMember(Description="Name of the entity", IsRequired=true)
    public var entityName:String?

    required public init(){}
}

public class EntitySummaryResponse : Codable
{
    public var summary:String?

    required public init(){}
}

Swift GetEntitySummary DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/entities/{EntityName}/{EntityID}/summary HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv

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

{
	Summary: String
}