Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

3.0.0

The FlexAttribute API is used to create, update or delete flex attribute definitions. A flex attribute is a custom data input field that is used to collect additional information that was not originally designed into the mobile application.

Pushing Flex Attribute Updates to Mobile Devices

By default, calling the FlexAttribute API will not cause any updates to be used to the mobile devices. This is by design and is intended to allow for multiple updates (API calls) to be made before pushing out any changes. Updates will be pushed to the mobile device only when a GET request is made with the RefreshMobile URL parameter set to 1 as shown below.

On this page:

Related pages:

Resource URL

Retrieve the details of a specific Flex Attribute

GET /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

Insert a specific Flex Attribute

PUT /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

Update a specific Flex Attribute

POST /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

Push Flex Attribute changes to mobile device

GET /seiapi/v3/trans/FlexAttribute/${FlexAttrID}?RefreshMobile=1

Delete a specific Flex Attribute

DELETE  /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

API Specific Parameters

ParameterDescription

${FlexAttrID}

Identifies the unique flex attribute object.
RefreshMobile=1Add this parameter with a value of 1 to push updates to mobile devices.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.


API Specifics

Retrieve the details of a specific Flex Attribute

URL

GET /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain a REST Object Definitions Configuration Related Objects FlexAttr Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

JSON Format 
 {
    "SysCatID": "1",
    "Desc" : {
        "en" : "English description",
        "es" : "Spanish description"
    },
    "FlexForms" : [
        "${FlexFormID}",
        "${FlexFormID}"
    ],
    "SysActs" : [
        {
            "SysActID" : "",
            "IsActive" : true,
            "Desc" : {
                "en" : "English description",
                "es" : "Spanish description"
            },
            "FlexForms" : [
                "${FlexFormID}",
                "${FlexFormID}"
            ]
        }
    ],
    "SubCats" : []
}

Insert a specific Flex Attribute

This REST API will insert a new Flex Attribute with the specified ID into the system, if a Flex Attribute with the specified ID does not already exist in the system. The system will return error in case Flex Attribute with specific ID exists.

URL

PUT /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions Configuration Related Objects FlexAttr Object.

HTTP Response

On success the API will return a response code of 200.

Update a specific Flex Attribute

This REST API will update a Flex Attribute with the specified ID in the system. The Flex Attribute with the specified ID must already exist in the system.

URL

POST /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions Configuration Related Objects FlexAttr Object.

HTTP Response

On success the API will return a response code of 200.

Push Flex Attribute changes to mobile device

URL

GET /seiapi/v3/trans/FlexAttribute/${FlexAttrID}?RefreshMobile=1

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success the API will return a response code of 200.

Delete a specific Flex Attribute

This REST API will delete a Flex Attribute with the specified ID from the system. The Flex Attribute with the specified ID must already exist in the system.

URL

DELETE /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success the API will return a response code of 200.

  • No labels