sfgboxapi

<back to all web services

UsersIntendedAdd

The following routes are available for this service:
POST/users_intended
"use strict";
export class UsersIntendedAddResponse {
    /** @param {{firstName?:string,lastName?:string,identificationNumber?:string,phoneNumber?:string,latitude?:number,longitude?:number,usersDetailsId?:number,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    firstName;
    /** @type {string} */
    lastName;
    /** @type {string} */
    identificationNumber;
    /** @type {string} */
    phoneNumber;
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
    /** @type {?number} */
    usersDetailsId;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class UsersIntendedAdd {
    /** @param {{firstName?:string,lastName?:string,identificationNumber?:string,phoneNumber?:string,latitude?:number,longitude?:number,usersDetailsId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    firstName;
    /** @type {string} */
    lastName;
    /** @type {string} */
    identificationNumber;
    /** @type {string} */
    phoneNumber;
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
    /** @type {?number} */
    usersDetailsId;
}

JavaScript UsersIntendedAdd 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 /users_intended HTTP/1.1 
Host: api.sfgtec.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"firstName":"String","lastName":"String","identificationNumber":"String","phoneNumber":"String","latitude":0,"longitude":0,"usersDetailsId":0}

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

{"firstName":"String","lastName":"String","identificationNumber":"String","phoneNumber":"String","latitude":0,"longitude":0,"usersDetailsId":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}