sfgboxapi

<back to all web services

CompanionsDelete

Requires Authentication
The following routes are available for this service:
DELETE/companions/{Id}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class CompanionsDelete
    {
        @DataMember(Order=1)
        @Validate(Validator="NotNull")
        public Long id = null;
        
        public Long getId() { return id; }
        public CompanionsDelete setId(Long value) { this.id = value; return this; }
    }

    public static class CompanionsDeleteResponse
    {
        @DataMember(Order=1)
        public Long id = null;

        @DataMember(Order=7)
        public ResponseStatus responseStatus = null;
        
        public Long getId() { return id; }
        public CompanionsDeleteResponse setId(Long value) { this.id = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public CompanionsDeleteResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java CompanionsDelete DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

DELETE /companions/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}