sfgboxapi

<back to all web services

DistributedBoxesViewLookup

The following routes are available for this service:
GET/distributed_boxes_view
DistributedBoxesViewLookup Parameters:
NameParameterData TypeRequiredDescription
IdquerylongNo
TenantsIdquerylongNo
AppUserIdquerylongNo
AuthAppUserIdquerylongNo
deploymentDatequeryDateTimeNo
NumberBoxesqueryintNo
RecipientTypequerystringNo
FoodGardensIdquerylongNo
OtherDescriptionquerystringNo
LatitudequerydoubleNo
LongitudequerydoubleNo
PhoneNumberquerystringNo
DisplayNamequerystringNo
EmailquerystringNo
ApplicationDatequeryDateTimeNo
IsZoneMainqueryboolNo
IsDisabledqueryboolNo
GenderquerystringNo
EthnicGroupquerystringNo
AgequeryintNo
ApprovalDatequeryDateTimeNo
ApprovedqueryboolNo
AuthorizedByquerystringNo
MediaPathquerystringNo
NamequerystringNo
DescriptionquerystringNo

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 /distributed_boxes_view HTTP/1.1 
Host: api.sfgtec.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfDistributedBoxesViewLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <DistributedBoxesViewLookupResponse>
    <Age>0</Age>
    <AppUserId>0</AppUserId>
    <ApplicationDate>0001-01-01T00:00:00</ApplicationDate>
    <ApprovalDate>0001-01-01T00:00:00</ApprovalDate>
    <Approved>false</Approved>
    <AuthAppUserId>0</AuthAppUserId>
    <AuthorizedBy>String</AuthorizedBy>
    <Description>String</Description>
    <DisplayName>String</DisplayName>
    <Email>String</Email>
    <EthnicGroup>String</EthnicGroup>
    <FoodGardensId>0</FoodGardensId>
    <Gender>String</Gender>
    <Id>0</Id>
    <IsDisabled>false</IsDisabled>
    <IsZoneMain>false</IsZoneMain>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
    <MediaPath>String</MediaPath>
    <Name>String</Name>
    <NumberBoxes>0</NumberBoxes>
    <OtherDescription>String</OtherDescription>
    <PhoneNumber>String</PhoneNumber>
    <RecipientType>String</RecipientType>
    <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>
    <deploymentDate>0001-01-01T00:00:00</deploymentDate>
  </DistributedBoxesViewLookupResponse>
</ArrayOfDistributedBoxesViewLookupResponse>