POST Agents/ForeignSystem/SaveDeviceByIdentifier

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/ForeignSystem/SaveDeviceByIdentifier

Updates a ForeignDevice with deviceName that belongs to the application with applicationName.

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/ForeignSystem/SaveDeviceByIdentifier?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

ApplicationName, DeviceName, DeviceIdentifier, ForeignDevice

Property Name Type Description
ApplicationName String
DeviceName String
DeviceIdentifier String
ForeignDevice ForeignDevice Saves a foreign device belonging to the ForeignDevice and application name specified. Carrier object for ForeignDevice. Services for the ForeignDevice Carrier is available from the ForeignSystem Agent.

Response:

OK

Response Description
200 OK

Response body: ForeignDevice

Property Name Type Description
ForeignDeviceId int32 Primary key
Name string Name of device
CreatedDate date-time Registered when in UTC.
UpdatedDate date-time Last updated when in UTC.
AssociateFullName string The person owning the Foreign Device
CreatedBy string The person that created the device.
UpdatedBy string The person that last updated this device.
DeviceIdentifier string Optional unique id of device (Palm pilot device ID, etc)
ForeignAppId int32 Reference to foregin application (device type)
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/ForeignSystem/SaveDeviceByIdentifier
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "ApplicationName": "Boyle Inc and Sons",
  "DeviceName": "Dibbert-Nicolas",
  "DeviceIdentifier": "dolor",
  "ForeignDevice": null
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "ForeignDeviceId": 458,
  "Name": "Dickens, Huel and Howe",
  "CreatedDate": "2024-09-17T17:54:03.1639551+02:00",
  "UpdatedDate": "2014-10-02T17:54:03.1639551+02:00",
  "AssociateFullName": "Jason D'Amore",
  "CreatedBy": "occaecati",
  "UpdatedBy": "laboriosam",
  "DeviceIdentifier": "accusantium",
  "ForeignAppId": 580,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 916
    }
  }
}