Antel Merchandiser App API

<back to all web services

IncompleteUpliftRequestList

The following routes are available for this service:
GET/sync/incompleteupliftrequests
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
IncompleteUpliftRequestListResponse Parameters:
NameParameterData TypeRequiredDescription
IncompleteUpliftRequestsformList<IncompleteUpliftRequestData>Yes
AllowLoginformboolNo
AssignedOutletsformList<OutletData>Yes
ArchivedformboolNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusYes
IncompleteUpliftRequestData Parameters:
NameParameterData TypeRequiredDescription
SystemUserIdformintNo
IncompleteUpliftRequestIdformGuidNo
UpliftRequestOnDeviceIdformGuidNo
OutletIdformintNo
LastSyncedformDateTimeNo
IsSubmittedformboolNo
DeleteFromDeviceformboolNo
CreatedByMerchandiserNameformstringYes
OutletData Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringYes
LastRequestedDateformstringYes
HasGeneralUpliftRequestformboolNo
UpliftRequestCountformintNo
AssignedPrincipalIdsformList<int>Yes
AssignedRegionsformList<OutletRegionData>Yes
ChannelformstringYes
NextScheduledDateformstringYes
OutletRegionData Parameters:
NameParameterData TypeRequiredDescription
PrincipalIdformintNo
RegionformstringYes

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /sync/incompleteupliftrequests HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IncompleteUpliftRequests":[{}],"AllowLogin":false,"AssignedOutlets":[{}],"Archived":false,"Description":"String","Heading":"String","WasSuccessful":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}