Virima API Specification - PropertyGroupService Services

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

Contents

1 editPropertyGroup POST Interface
2 addPropertyGroup POST Interface
3 deletePropertyGroup POST Interface
4 getPropertyGroupRecord GET Interface

editPropertyGroup POST Interface

Method: POST

Relative URL: property-groups/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
propertyGroup	PropertyGroup

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITPROPERTYGROUP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "groupName":"?",
   "groupOrder":?,
   "archive":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "createdOn":?,
   "defaultColumn":?,
   "uniqueId":"?"
}

Example Response:

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

addPropertyGroup POST Interface

Method: POST

Relative URL: property-groups/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
propertyGroup	PropertyGroup

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDPROPERTYGROUP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "groupName":"?",
   "groupOrder":?,
   "archive":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "createdOn":?,
   "defaultColumn":?,
   "uniqueId":"?"
}

Example Response:

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

deletePropertyGroup POST Interface

Method: POST

Relative URL: property-groups/delete

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
propertyGroup	PropertyGroup

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEPROPERTYGROUP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "groupName":"?",
   "groupOrder":?,
   "archive":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "createdOn":?,
   "defaultColumn":?,
   "uniqueId":"?"
}

Example Response:

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

getPropertyGroupRecord GET Interface

Method: GET

Relative URL: property-groups/get-record-id/record-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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