sfgboxapi

<back to all web services

ZonesAdd

Requires Authentication
The following routes are available for this service:
POST/zones

export class ZonesAddResponse
{
    // @DataMember(Order=2)
    public tenantsId: number;

    // @DataMember(Order=3)
    public name: string;

    // @DataMember(Order=4)
    public isMain: boolean;

    // @DataMember(Order=5)
    public isDefault: boolean;

    // @DataMember(Order=7)
    public responseStatus: ResponseStatus;

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

// @DataContract
export class ZonesAdd
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public tenantsId: number;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public name: string;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public isMain: boolean;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public isDefault: boolean;

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

TypeScript ZonesAdd 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.

POST /zones HTTP/1.1 
Host: api.sfgtec.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"tenantsId":0,"name":"String","isMain":false,"isDefault":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"tenantsId":0,"name":"String","isMain":false,"isDefault":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}