SSMapServices.CreateUserAgent Method

SSMapServicesCreateUserAgent Method

Ingeniux CMS Web Services API

Creates a new User Agent based on provided information

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<UserAgentMgrInfo> CreateUserAgent(
	UserAgentMgrInfo data
)

Public Function CreateUserAgent ( 
	data As UserAgentMgrInfo
) As XHRServiceResponseGeneric(Of UserAgentMgrInfo)

public:
virtual XHRServiceResponseGeneric<UserAgentMgrInfo^>^ CreateUserAgent(
	UserAgentMgrInfo^ data
) sealed

abstract CreateUserAgent : 
        data : UserAgentMgrInfo -> XHRServiceResponseGeneric<UserAgentMgrInfo> 
override CreateUserAgent : 
        data : UserAgentMgrInfo -> XHRServiceResponseGeneric<UserAgentMgrInfo>

Parameters

data

Type: UserAgentMgrInfo

Information of new User Agent to create

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "Name": "Safari",
        "SearchString": "safari",
        "ContentType": "text/html",
        "FileExtension": "xml"
    }
}

Return Value

Type: XHRServiceResponseGenericUserAgentMgrInfo

Information of the created User Agent

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "ContentType": "text\/html",
        "FileExtension": "xml",
        "Name": "Safari",
        "SearchString": "safari"
    }
}

Remarks

If another User Agent with the same name already exists, returns error status

Reference

SSMapServices Class

IngeniuxCMService Namespace