sfgboxapi

CompanionsAdd

The following routes are available for this service:
POST	/companions


export class CompanionsAddResponse
{
    // @DataMember(Order=2)
    public tenantsId: number;

    // @DataMember(Order=3)
    public zonesId: number;

    // @DataMember(Order=4)
    public cropsId: number;

    // @DataMember(Order=5)
    public companionCropsId: number;

    // @DataMember(Order=7)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<CompanionsAddResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class CompanionsAdd
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public tenantsId: number;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public zonesId: number;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public cropsId: number;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public companionCropsId: number;

    public constructor(init?: Partial<CompanionsAdd>) { (Object as any).assign(this, init); }
}

TypeScript CompanionsAdd 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 /companions HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CompanionsAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <TenantsId>0</TenantsId>
  <ZonesId>0</ZonesId>
  <CropsId>0</CropsId>
  <CompanionCropsId>0</CompanionCropsId>
</CompanionsAdd>

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

<CompanionsAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <CompanionCropsId>0</CompanionCropsId>
  <CropsId>0</CropsId>
  <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>
  <TenantsId>0</TenantsId>
  <ZonesId>0</ZonesId>
</CompanionsAddResponse>