sfgboxapi

<back to all web services

GrowersListLookup

Requires Authentication
The following routes are available for this service:
GET/growerslist
"use strict";
export class Paging {
    /** @param {{pageNumber?:number,pageSize?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    pageNumber;
    /** @type {number} */
    pageSize;
}
export class GrowersListLookup {
    /** @param {{id?:number,tenantsId?:number,displayName?:string,firstName?:string,lastName?:string,email?:string,phoneNumber?:string,appUserId?:number,approved?:boolean,approvalDate?:string,applicationDate?:string,identificationNumber?:string,passportNumber?:string,address?:string,ethnicGroup?:string,gender?:string,isDisabled?:boolean,latitude?:number,longitude?:number,documentUrl?:string,isZoneMain?:boolean,paging?:Paging}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    tenantsId;
    /** @type {string} */
    displayName;
    /** @type {string} */
    firstName;
    /** @type {string} */
    lastName;
    /** @type {string} */
    email;
    /** @type {string} */
    phoneNumber;
    /** @type {number} */
    appUserId;
    /** @type {?boolean} */
    approved;
    /** @type {string} */
    approvalDate;
    /** @type {string} */
    applicationDate;
    /** @type {string} */
    identificationNumber;
    /** @type {string} */
    passportNumber;
    /** @type {string} */
    address;
    /** @type {string} */
    ethnicGroup;
    /** @type {string} */
    gender;
    /** @type {boolean} */
    isDisabled;
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
    /** @type {string} */
    documentUrl;
    /** @type {?boolean} */
    isZoneMain;
    /** @type {Paging} */
    paging;
}

JavaScript GrowersListLookup 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 /growerslist HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml

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

<ArrayOfGrowersListLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <GrowersListLookupResponse>
    <Address>String</Address>
    <AppUserId>0</AppUserId>
    <ApplicationDate>0001-01-01T00:00:00</ApplicationDate>
    <ApprovalDate>0001-01-01T00:00:00</ApprovalDate>
    <Approved>false</Approved>
    <DisplayName>String</DisplayName>
    <DocumentUrl>String</DocumentUrl>
    <Email>String</Email>
    <EthnicGroup>String</EthnicGroup>
    <FirstName>String</FirstName>
    <Gender>String</Gender>
    <Id>0</Id>
    <IdentificationNumber>String</IdentificationNumber>
    <IsDisabled>false</IsDisabled>
    <IsZoneMain>false</IsZoneMain>
    <LastName>String</LastName>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
    <PassportNumber>String</PassportNumber>
    <PhoneNumber>String</PhoneNumber>
    <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>
    <TenantsId>0</TenantsId>
  </GrowersListLookupResponse>
</ArrayOfGrowersListLookupResponse>