GET api/Assembly

Retrieve Assembly Items

Request Information

URI Parameters

None.

Body Parameters

AssemblyReq
NameDescriptionTypeAdditional information
Company

The company code

string

Required

String length: inclusive between 0 and 6

AssemblyCode

Optional filter: The assembly item code

string

String length: inclusive between 0 and 30

LastSyncDate

Retrieve assembly items that were modified since LastSyncDate

date

Required

PageSize

Optional paging parameter. Return x records per page

integer

None.

PageNumber

Optional paging parameter. Number of page to return

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Company": "EPM",
  "AssemblyCode": "100100100",
  "LastSyncDate": null,
  "PageSize": 0,
  "PageNumber": 0
}

Response Information

Resource Description

AssemblyRes
NameDescriptionTypeAdditional information
msgControl

Message control - Will contain information about the response. If paging is enabled GenMsg1 equals the total pages

MsgControl

None.

AssemblyItemsList

List of assemblies

Collection of Assemblies

None.

Response Formats

application/json, text/json

Sample:
{
  "msgControl": {
    "result": 0,
    "Message": "Corresponding success and error message",
    "MethodName": "api/<Request Name>",
    "AppName": "EsoftWebApi",
    "EsoftUser": "Web API",
    "User": "Username",
    "Password": "Password",
    "SystemDate": "2019-12-25T00:00:00",
    "GenList": [],
    "GenMsg1": "",
    "GenMsg2": "",
    "GenMsg3": ""
  },
  "AssemblyItemsList": [
    {
      "Assembly": "100100100",
      "AssemblyComponentsList": [
        {
          "Component": "100100100A",
          "Quantity": 1
        },
        {
          "Component": "100100100B",
          "Quantity": 1
        }
      ]
    },
    {
      "Assembly": "100100101",
      "AssemblyComponentsList": [
        {
          "Component": "100100101A",
          "Quantity": 1
        },
        {
          "Component": "100100101B",
          "Quantity": 1
        }
      ]
    }
  ]
}