Jump to

• Request
• Response

Add a new device in user profile

post

https://oaainstall-host/risk-analyzer/device/v1/{requestId}

Add new device in user profile. Multiple devices can be added in the single request. Also device can be marked as safe while adding

Request

Path Parameters

• requestId(required): string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

User device create request

Show Source

• friendlyName: string
  friendly name of the device.
• markSafe: boolean
  mark the device, associated with request id, safe or unsafe based in the true or false value.

{
    "description":"User device create request",
    "properties":{
        "markSafe":{
            "type":"boolean",
            "description":"mark the device, associated with request id, safe or unsafe based in the true or false value."
        },
        "friendlyName":{
            "type":"string",
            "description":"friendly name of the device."
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

User device create request

Show Source

• friendlyName: string
  friendly name of the device.
• markSafe: boolean
  mark the device, associated with request id, safe or unsafe based in the true or false value.

{
    "description":"User device create request",
    "properties":{
        "markSafe":{
            "type":"boolean",
            "description":"mark the device, associated with request id, safe or unsafe based in the true or false value."
        },
        "friendlyName":{
            "type":"string",
            "description":"friendly name of the device."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json
• text/plain

201 Response

User devices are created and added to user profile.

Body ()

Root Schema : UserDeviceApiResponse

Type: object

User device API response for status of the rest call

Show Source

• responseCode: string
  status code of the request
• responseMessage: string
  response message related to the response code if needed.
• success: boolean
  status of the operation.

{
    "type":"object",
    "description":"User device API response for status of the rest call",
    "properties":{
        "success":{
            "type":"boolean",
            "description":"status of the operation."
        },
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        }
    }
}

401 Response

Unauthorized

405 Response

Invalid input

Body ()

Root Schema : UserDeviceApiResponse

Type: object

User device API response for status of the rest call

Show Source

• responseCode: string
  status code of the request
• responseMessage: string
  response message related to the response code if needed.
• success: boolean
  status of the operation.

{
    "type":"object",
    "description":"User device API response for status of the rest call",
    "properties":{
        "success":{
            "type":"boolean",
            "description":"status of the operation."
        },
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        }
    }
}

500 Response

Internal server error

503 Response

Service Unavailable

Back to Top