Profileset

Prev Next

Profileset

/v1/profileset

Retrieves profileset details.


Example for calling:

http://server/v1/profileset?id=1 - Retrieves profileset having id = 1.
http://server/v1/profileset?owner=SAFRANSA - Retrieves profileset owned by SAFRANSA.
http://server/v1/profileset?name=MyProfileset - Retrieves profileset with the name MyProfileset.

Allowed Methods:

[GET]
API Controller: Profileset

Description:

Retrieves the profileset details for specified set or by owner.

Request Fields:

Name Type Description Notes
id integer Id of the profileset [Optional]
owner string Owner of the profileset Relates to "SafranWebApiOwnerVerificationDuringApiCalls" in Application Settings
name string The name of the profileset [Optional]
  • When "SafranWebAPIOwnerVerificationDuringApiCalls" is in use the id is mandatory.
  • Specifying name and id, will have the id take priority.


Response Fields

profileset

Name Type Description Notes
id integer Unique profileset Id
name string The profileset name
owner string The owners of the profileset
profile structure See profile


profile

Name Type Description Notes
id integer Unique profile Id
name string The profile name
profileinterval structure see profileinterval


profileinterval

Name Type Description Notes
value_x double The x value
value_y double The y value


Sample JSON Response

json result

[
    {
        "id": 1,
        "name": "Default profileset",
        "owner": "SAFRANSA",
        "profile": [
            {
                "id": 1,
                "name": "Default",
                "profileinterval": [
                    {
                        "value_x": 100,
                        "value_y": 100
                    }
                ]
            }
        ]
    }
]