sfgboxapi

<back to all web services

UsersDetailsAdd

Requires Authentication
The following routes are available for this service:
POST/users_details
"use strict";
export class UsersDetailsAddResponse {
    /** @param {{appUserId?:number,approved?:boolean,identificationNumber?:string,passportNumber?:string,address?:string,latitude?:number,longitude?:number,age?:number,ethnicGroup?:string,gender?:string,isDisabled?:boolean,documentUrl?:string,applicationDate?:string,approvalDate?:string,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    appUserId;
    /** @type {boolean} */
    approved;
    /** @type {string} */
    identificationNumber;
    /** @type {string} */
    passportNumber;
    /** @type {string} */
    address;
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
    /** @type {number} */
    age;
    /** @type {string} */
    ethnicGroup;
    /** @type {string} */
    gender;
    /** @type {boolean} */
    isDisabled;
    /** @type {string} */
    documentUrl;
    /** @type {string} */
    applicationDate;
    /** @type {string} */
    approvalDate;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class UsersDetailsAdd {
    /** @param {{appUserId?:number,approved?:boolean,identificationNumber?:string,passportNumber?:string,address?:string,latitude?:number,longitude?:number,age?:number,ethnicGroup?:string,gender?:string,isDisabled?:boolean,documentUrl?:string,applicationDate?:string,approvalDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    appUserId;
    /** @type {boolean} */
    approved;
    /** @type {string} */
    identificationNumber;
    /** @type {string} */
    passportNumber;
    /** @type {string} */
    address;
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
    /** @type {number} */
    age;
    /** @type {string} */
    ethnicGroup;
    /** @type {string} */
    gender;
    /** @type {boolean} */
    isDisabled;
    /** @type {string} */
    documentUrl;
    /** @type {string} */
    applicationDate;
    /** @type {string} */
    approvalDate;
}

JavaScript UsersDetailsAdd 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_details HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	appUserId: 0,
	approved: False,
	identificationNumber: String,
	passportNumber: String,
	address: String,
	latitude: 0,
	longitude: 0,
	age: 0,
	ethnicGroup: String,
	gender: String,
	isDisabled: False,
	documentUrl: String,
	applicationDate: 0001-01-01,
	approvalDate: 0001-01-01
}

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

{
	appUserId: 0,
	approved: False,
	identificationNumber: String,
	passportNumber: String,
	address: String,
	latitude: 0,
	longitude: 0,
	age: 0,
	ethnicGroup: String,
	gender: String,
	isDisabled: False,
	documentUrl: String,
	applicationDate: 0001-01-01,
	approvalDate: 0001-01-01,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}