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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<UsersDetailsAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <AppUserId>0</AppUserId>
  <Approved>false</Approved>
  <IdentificationNumber>String</IdentificationNumber>
  <PassportNumber>String</PassportNumber>
  <Address>String</Address>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <Age>0</Age>
  <EthnicGroup>String</EthnicGroup>
  <Gender>String</Gender>
  <IsDisabled>false</IsDisabled>
  <DocumentUrl>String</DocumentUrl>
  <ApplicationDate>0001-01-01T00:00:00</ApplicationDate>
  <ApprovalDate>0001-01-01T00:00:00</ApprovalDate>
</UsersDetailsAdd>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UsersDetailsAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Address>String</Address>
  <Age>0</Age>
  <AppUserId>0</AppUserId>
  <ApplicationDate>0001-01-01T00:00:00</ApplicationDate>
  <ApprovalDate>0001-01-01T00:00:00</ApprovalDate>
  <Approved>false</Approved>
  <DocumentUrl>String</DocumentUrl>
  <EthnicGroup>String</EthnicGroup>
  <Gender>String</Gender>
  <IdentificationNumber>String</IdentificationNumber>
  <IsDisabled>false</IsDisabled>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <PassportNumber>String</PassportNumber>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</UsersDetailsAddResponse>