sfgboxapi

<back to all web services

CompanionsAdd

Requires Authentication
The following routes are available for this service:
POST/companions
CompanionsAdd Parameters:
NameParameterData TypeRequiredDescription
TenantsIdbodylongYes
ZonesIdbodylongYes
CropsIdbodylongYes
CompanionCropsIdbodylongYes
CompanionsAddResponse Parameters:
NameParameterData TypeRequiredDescription
TenantsIdformlongNo
ZonesIdformlongNo
CropsIdformlongNo
CompanionCropsIdformlongNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /companions HTTP/1.1 
Host: api.sfgtec.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"tenantsId":0,"zonesId":0,"cropsId":0,"companionCropsId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"tenantsId":0,"zonesId":0,"cropsId":0,"companionCropsId":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}