sfgboxapi

<back to all web services

DistributedBoxesViewLookup

The following routes are available for this service:
GET/distributed_boxes_view
"use strict";
export class DistributedBoxesViewLookup {
    /** @param {{id?:number,tenantsId?:number,appUserId?:number,authAppUserId?:number,deploymentDate?:string,numberBoxes?:number,recipientType?:string,foodGardensId?:number,otherDescription?:string,latitude?:number,longitude?:number,phoneNumber?:string,displayName?:string,email?:string,applicationDate?:string,isZoneMain?:boolean,isDisabled?:boolean,gender?:string,ethnicGroup?:string,age?:number,approvalDate?:string,approved?:boolean,authorizedBy?:string,mediaPath?:string,name?:string,description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    tenantsId;
    /** @type {number} */
    appUserId;
    /** @type {number} */
    authAppUserId;
    /** @type {string} */
    deploymentDate;
    /** @type {number} */
    numberBoxes;
    /** @type {string} */
    recipientType;
    /** @type {number} */
    foodGardensId;
    /** @type {string} */
    otherDescription;
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
    /** @type {string} */
    phoneNumber;
    /** @type {string} */
    displayName;
    /** @type {string} */
    email;
    /** @type {string} */
    applicationDate;
    /** @type {boolean} */
    isZoneMain;
    /** @type {boolean} */
    isDisabled;
    /** @type {string} */
    gender;
    /** @type {string} */
    ethnicGroup;
    /** @type {number} */
    age;
    /** @type {string} */
    approvalDate;
    /** @type {boolean} */
    approved;
    /** @type {string} */
    authorizedBy;
    /** @type {string} */
    mediaPath;
    /** @type {string} */
    name;
    /** @type {string} */
    description;
}

JavaScript DistributedBoxesViewLookup 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.

GET /distributed_boxes_view 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,"tenantsId":0,"appUserId":0,"authAppUserId":0,"deploymentDate":"\/Date(-62135596800000-0000)\/","numberBoxes":0,"recipientType":"String","foodGardensId":0,"otherDescription":"String","latitude":0,"longitude":0,"phoneNumber":"String","displayName":"String","email":"String","applicationDate":"\/Date(-62135596800000-0000)\/","isZoneMain":false,"isDisabled":false,"gender":"String","ethnicGroup":"String","age":0,"approvalDate":"\/Date(-62135596800000-0000)\/","approved":false,"authorizedBy":"String","mediaPath":"String","name":"String","description":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}]