sfgboxapi

<back to all web services

UsersBoxesAdd

The following routes are available for this service:
POST/users_boxes
"use strict";
export class UsersBoxesAddResponse {
    /** @param {{appUserId?:number,authAppUserId?:number,deploymentDate?:string,numberBoxes?:number,recipientType?:string,foodGardensId?:number,otherDescription?:string,publicAccessGuid?:string,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    appUserId;
    /** @type {number} */
    authAppUserId;
    /** @type {string} */
    deploymentDate;
    /** @type {number} */
    numberBoxes;
    /** @type {string} */
    recipientType;
    /** @type {?number} */
    foodGardensId;
    /** @type {string} */
    otherDescription;
    /** @type {string} */
    publicAccessGuid;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class UsersBoxesAdd {
    /** @param {{appUserId?:number,authAppUserId?:number,deploymentDate?:string,numberBoxes?:number,recipientType?:string,foodGardensId?:number,otherDescription?:string,publicAccessGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    appUserId;
    /** @type {number} */
    authAppUserId;
    /** @type {string} */
    deploymentDate;
    /** @type {number} */
    numberBoxes;
    /** @type {string} */
    recipientType;
    /** @type {?number} */
    foodGardensId;
    /** @type {string} */
    otherDescription;
    /** @type {string} */
    publicAccessGuid;
}

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

POST /users_boxes HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	appUserId: 0,
	authAppUserId: 0,
	deploymentDate: 0001-01-01,
	numberBoxes: 0,
	recipientType: String,
	foodGardensId: 0,
	otherDescription: String,
	publicAccessGuid: 00000000000000000000000000000000
}

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

{
	appUserId: 0,
	authAppUserId: 0,
	deploymentDate: 0001-01-01,
	numberBoxes: 0,
	recipientType: String,
	foodGardensId: 0,
	otherDescription: String,
	publicAccessGuid: 00000000000000000000000000000000,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}