Virima API Specification - StockRoomTypeService Services

The requests documented in this section are directed to StockRoomTypeService resources, which represent .

Contents

1 addStockRoomType POST Interface
2 editStockRoomType POST Interface
3 getAllStockRoomType GET Interface

addStockRoomType POST Interface

Method: POST

Relative URL: stock-room-type/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
stockRoomType	StockRoomType

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDSTOCKROOMTYPE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "displayName":"?",
   "value":"?",
   "isShipmentRequired":?,
   "isExternalStockroom":?,
   "description":?,
   "priority":"?",
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdOn":?,
   "archive":?,
   "lastModifiedOn":?,
   "uniqueId":"?"
}

Example Response:

{
   "id":2104591666,
   "response":"?"
}

editStockRoomType POST Interface

Method: POST

Relative URL: stock-room-type/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
stockRoomType	StockRoomType

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITSTOCKROOMTYPE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "displayName":"?",
   "value":"?",
   "isShipmentRequired":?,
   "isExternalStockroom":?,
   "description":?,
   "priority":"?",
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdOn":?,
   "archive":?,
   "lastModifiedOn":?,
   "uniqueId":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllStockRoomType GET Interface

Method: GET

Relative URL: stock-room-type/get

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
stockRoomTypeList	ValueList

Example Request:

Example Response:

{
   "id":2147483647,
   "StringList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "projectList":[
      {
         "id":2147483647,
         "name":"?",
         "description":?,
         "plannedStart":?,
         "plannedEnd":?,
         "actualStart":?,
         "actualEnd":?,
         "baselineStart":?,
         "baselineEnd":?,
         "status":"?",
         "billingCode":"?",
         "costCenter": {
               "id":1905180042,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "percentageComplete":?,
         "duration":?,
         "archive":?,
         "projectManager": {
               "id":1682496714,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "isTemplate":?,
         "templateName":"?",
         "createdFromTemplate":?,
         "createdFromTemplateName":"?",
         "validationError":?,
         "programs":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "associatedCis":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}