sfgboxapi

<back to all web services

UsersDetailsLookup

Requires Authentication
The following routes are available for this service:
GET/users_details
"use strict";
export class UsersDetailsLookup {
    /** @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 UsersDetailsLookup 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.

GET /users_details HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml

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

<ArrayOfUsersDetailsLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <UsersDetailsLookupResponse>
    <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:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
  </UsersDetailsLookupResponse>
</ArrayOfUsersDetailsLookupResponse>