sfgboxapi

<back to all web services

CropsCompanionsLookup

The following routes are available for this service:
GET/cropscompanions
"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 CropsCompanionsLookup {
    /** @param {{id?:number,tenantsId?:number,cropsId?:number,companionCropsId?:number,cropsName?:string,companionName?:string,paging?:Paging}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    tenantsId;
    /** @type {number} */
    cropsId;
    /** @type {number} */
    companionCropsId;
    /** @type {string} */
    cropsName;
    /** @type {string} */
    companionName;
    /** @type {Paging} */
    paging;
}

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

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

<ArrayOfCropsCompanionsLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <CropsCompanionsLookupResponse>
    <CompanionCropsId>0</CompanionCropsId>
    <CompanionName>String</CompanionName>
    <CropsId>0</CropsId>
    <CropsName>String</CropsName>
    <Id>0</Id>
    <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>
  </CropsCompanionsLookupResponse>
</ArrayOfCropsCompanionsLookupResponse>