Virima API Specification - LocationService Services

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

Contents

1 addLocation POST Interface
2 addLocations POST Interface
3 editLocation POST Interface

addLocation POST Interface

Method: POST

Relative URL: location/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
location	Location

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDLOCATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "createdOn":?,
   "name":"?",
   "locationType":"?",
   "street":"?",
   "city":"?",
   "state":"?",
   "country":"?",
   "postalCode":"?",
   "locationCode":"?",
   "businessUnit":"?",
   "division":"?",
   "siteClass":"?",
   "siteStatus":"?",
   "legacyDomain":"?",
   "phone":"?",
   "archive":?,
   "email":"?",
   "uniqueId":"?"
}

Example Response:

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

addLocations POST Interface

Description: Service to add locations from imported file.

Method: POST

Relative URL: location/add-locations

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
locations	LocationsList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDLOCATIONS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "fileName":"?",
   "arrayofLocation":[
      {
         "lastModifiedBy": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "lastModifiedOn":?,
         "createdOn":?,
         "name":"?",
         "locationType":"?",
         "street":"?",
         "city":"?",
         "state":"?",
         "country":"?",
         "postalCode":"?",
         "locationCode":"?",
         "businessUnit":"?",
         "division":"?",
         "siteClass":"?",
         "siteStatus":"?",
         "legacyDomain":"?",
         "phone":"?",
         "archive":?,
         "email":"?",
         "uniqueId":"?"
      }   ]
}

Example Response:

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

editLocation POST Interface

Method: POST

Relative URL: location/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
location	Location

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITLOCATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "createdOn":?,
   "name":"?",
   "locationType":"?",
   "street":"?",
   "city":"?",
   "state":"?",
   "country":"?",
   "postalCode":"?",
   "locationCode":"?",
   "businessUnit":"?",
   "division":"?",
   "siteClass":"?",
   "siteStatus":"?",
   "legacyDomain":"?",
   "phone":"?",
   "archive":?,
   "email":"?",
   "uniqueId":"?"
}

Example Response:

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