Rental APIs

GET system/reports/110087/result-set?includeScrapped={includeScrapped}

Available Rental Articles with ObjektId and Specification

Report name	Available Rental Articles with ObjektId and Specification
Report identifier	110087
HTTP method	GET
URI	https://api.rambase.net/system/reports/110087/result-set?includeScrapped={includeScrapped}
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	5484, version 14

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

includeScrapped Boolean, optional	Scrapped Default: False
$showDomainDescriptions Boolean, optional	Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional	After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional	Set the database/company for the request
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional	Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional	Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional	Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional	Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional	Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional	Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

ObjektId String	Custom company fields.
OriginalSno String	Custom company fields.
ProductDescription String	Description of the product.
ProductName String	Name of the product.
ProductUnitId Integer	Product unit identifier.
Scrapped Boolean	Custom company fields.
SerialNumber String	Serial number.
Specification String	Custom company fields.

Read more about filters and sorting on how to use sortable parameters

ObjektId String	Custom company fields
OriginalSno String	Custom company fields
ProductDescription String	Description of the product
ProductName String	Name of the product
ProductUnitId Integer	Product unit identifier
Scrapped Boolean	Custom company fields
SerialNumber String	Serial number
Specification String	Custom company fields

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:

                                        <Report>
                                    

                                             <Rows>
                                    

                                                  <Row>
                                    

<ProductUnit

ProductUnit

Product unit reference

<ProductUnitId

ProductUnitId

Product unit identifier

>{Integer}</ProductUnitId>

<ProductUnitLink

ProductUnitLink

Product unit reference

>{String}</ProductUnitLink>

                                                       </ProductUnit>
                                    

<Product

Product

Product reference

<Name

Name

Name of the product

>{String}</Name>

<Description

Description

Description of the product

>{String}</Description>

<ProductLink

ProductLink

Product reference

>{String}</ProductLink>

                                                       </Product>
                                    

<SerialNumber

SerialNumber

Serial number

>{String}</SerialNumber>

<ServiceOrder

ServiceOrder

Service order reference

<ServiceOrderId

ServiceOrderId

Service order identifier

>{Integer}</ServiceOrderId>

<ServiceOrderLink

ServiceOrderLink

Service order reference

>{String}</ServiceOrderLink>

                                                       </ServiceOrder>
                                    

<ServiceOrderStatus

ServiceOrderStatus

Status of service order

>{Integer}</ServiceOrderStatus>

<ProductionWorkOrder

ProductionWorkOrder

Production work order reference

<ProductionWorkOrderId

ProductionWorkOrderId

Production work order identifier

>{Integer}</ProductionWorkOrderId>

<ProductionWorkOrderLink

ProductionWorkOrderLink

Production work order reference

>{String}</ProductionWorkOrderLink>

                                                       </ProductionWorkOrder>
                                    

<ScheduledProductionPeriod

ScheduledProductionPeriod

Scheduled/planned production period

<StartDate

StartDate

Scheduled/planned date of production start

>{Date}</StartDate>

<EndDate

EndDate

Scheduled/planned date of production completion

>{Date}</EndDate>

                                                       </ScheduledProductionPeriod>
                                    

<ShippingAdvice

ShippingAdvice

Shipping advice reference

<ShippingAdviceId

ShippingAdviceId

Shipping advice identifier

>{Integer}</ShippingAdviceId>

<ShippingAdviceLink

ShippingAdviceLink

Shipping advice reference

>{String}</ShippingAdviceLink>

                                                       </ShippingAdvice>
                                    

<RecurringInvoicePlan

RecurringInvoicePlan

Recurring invoice plan

<RecurringInvoicePlanId

RecurringInvoicePlanId

Rental plan identifier

>{Integer}</RecurringInvoicePlanId>

<RecurringInvoicePlanLink

RecurringInvoicePlanLink

Recurring invoice plan refrence

>{String}</RecurringInvoicePlanLink>

                                                       </RecurringInvoicePlan>
                                    

<RecurringInvoicePlanStatus

RecurringInvoicePlanStatus

Status of recurring invoice plan

Possible domain values can be found here

>{Integer}</RecurringInvoicePlanStatus>

<RecurringInvoicePlanPeriod

RecurringInvoicePlanPeriod

Recurring invoice plan period

<StartDate

StartDate

Start date of the rental plan

>{Date}</StartDate>

<DueDate

DueDate

Expected end date of the rental plan

>{Date}</DueDate>

                                                       </RecurringInvoicePlanPeriod>
                                    

<StockLocation

StockLocation

Stock location reference

<Name

Name

Name of stock location

>{String}</Name>

<StockLocationId

StockLocationId

Stock location identifier

>{Integer}</StockLocationId>

<StockLocationLink

StockLocationLink

Stock location identifier

>{String}</StockLocationLink>

                                                       </StockLocation>
                                    

<Location

Location

Location reference

<LocationId

LocationId

Location identifier

>{Integer}</LocationId>

<ShortName

ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>

<LocationLink

LocationLink

Location reference

>{String}</LocationLink>

                                                       </Location>
                                    

<GoodsReception

GoodsReception

Goods reception reference

<GoodsReceptionId

GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>

<GoodsReceptionLink

GoodsReceptionLink

Goods reception reference

>{String}</GoodsReceptionLink>

                                                       </GoodsReception>
                                    

<Scrapped

Scrapped

Scrapped

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Scrapped in your request URI to get this field

>{Boolean}</Scrapped>

<ObjektId

ObjektId

Object id

>{String}</ObjektId>

<Specification

Specification

Specification

>{String}</Specification>

<OriginalSno

OriginalSno

Original SNo

>{String}</OriginalSno>

                                                  </Row>
                                    

                                             </Rows>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<FirstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>

<FirstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>

<PreviousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>

<PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>

<NextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>

<NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>

<LastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>

<LastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>

<Size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>

                                             </Paging>
                                    

                                        </Report>
                                    

{

                                             "report": {
                                    

                                                  "rows": [
                                    

{

"productUnit

ProductUnit

Product unit reference

": {

"productUnitId

ProductUnitId

Product unit identifier

": "{Integer}",

"productUnitLink

ProductUnitLink

Product unit reference

": "{String}"

},

"product

Product

Product reference

": {

"name

Name

Name of the product

": "{String}",

"description

Description

Description of the product

": "{String}",

"productLink

ProductLink

Product reference

": "{String}"

},

"serialNumber

SerialNumber

Serial number

": "{String}",

"serviceOrder

ServiceOrder

Service order reference

": {

"serviceOrderId

ServiceOrderId

Service order identifier

": "{Integer}",

"serviceOrderLink

ServiceOrderLink

Service order reference

": "{String}"

},

"serviceOrderStatus

ServiceOrderStatus

Status of service order

": "{Integer}",

"productionWorkOrder

ProductionWorkOrder

Production work order reference

": {

"productionWorkOrderId

ProductionWorkOrderId

Production work order identifier

": "{Integer}",

"productionWorkOrderLink

ProductionWorkOrderLink

Production work order reference

": "{String}"

},

"scheduledProductionPeriod

ScheduledProductionPeriod

Scheduled/planned production period

": {

"startDate

StartDate

Scheduled/planned date of production start

": "{Date}",

"endDate

EndDate

Scheduled/planned date of production completion

": "{Date}"

},

"shippingAdvice

ShippingAdvice

Shipping advice reference

": {

"shippingAdviceId

ShippingAdviceId

Shipping advice identifier

": "{Integer}",

"shippingAdviceLink

ShippingAdviceLink

Shipping advice reference

": "{String}"

},

"recurringInvoicePlan

RecurringInvoicePlan

Recurring invoice plan

": {

"recurringInvoicePlanId

RecurringInvoicePlanId

Rental plan identifier

": "{Integer}",

"recurringInvoicePlanLink

RecurringInvoicePlanLink

Recurring invoice plan refrence

": "{String}"

},

"recurringInvoicePlanStatus

RecurringInvoicePlanStatus

Status of recurring invoice plan

Possible domain values can be found here

": "{Integer}",

"recurringInvoicePlanPeriod

RecurringInvoicePlanPeriod

Recurring invoice plan period

": {

"startDate

StartDate

Start date of the rental plan

": "{Date}",

"dueDate

DueDate

Expected end date of the rental plan

": "{Date}"

},

"stockLocation

StockLocation

Stock location reference

": {

"name

Name

Name of stock location

": "{String}",

"stockLocationId

StockLocationId

Stock location identifier

": "{Integer}",

"stockLocationLink

StockLocationLink

Stock location identifier

": "{String}"

},

"location

Location

Location reference

": {

"locationId

LocationId

Location identifier

": "{Integer}",

"shortName

ShortName

Unique abbreviation/short name of the location

": "{String}",

"locationLink

LocationLink

Location reference

": "{String}"

},

"goodsReception

GoodsReception

Goods reception reference

": {

"goodsReceptionId

GoodsReceptionId

Goods reception identifier

": "{Integer}",

"goodsReceptionLink

GoodsReceptionLink

Goods reception reference

": "{String}"

},

"scrapped

Scrapped

Scrapped

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Scrapped in your request URI to get this field

": "{Boolean}",

"objektId

ObjektId

Object id

": "{String}",

"specification

Specification

Specification

": "{String}",

"originalSno

OriginalSno

Original SNo

": "{String}"

}

]

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 104920 HTTP 400	Log text is required
Error 104921 HTTP 400	Invalid log category
Error 101281 HTTP 400	Too many {0} parameters. Maximum is {1}.
Error 100175 HTTP 400	To date must be equal to, or later than from date.
Error 105710 HTTP 400	Invalid output type