developer portal

Assets

Get asset by Id

Returns an asset by its Id.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work",
    "Code": "012345",
    "Type": "012345",
    "Brand": "012345",
    "TypeNumber": "012345",
    "SerialNumber": "012345",
    "Description": "012345",
    "Quantity": 1,
    "CommissioningDate": "2019-01-25T07:29:37",
    "Category": 0,
    "AdministrativeLocations": [
      {
        "Location": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345",
          "Country": 0,
          "Description": "Work",
          "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
          "HouseNumber": "9",
          "LonMin": 3.145219,
          "LonMax": 3.244998,
          "LatMin": 50.81309,
          "LatMax": 50.91806,
          "MarkerLon": 3.145219,
          "MarkerLat": 50.81309,
          "IsAssetLocation": false,
          "PostalCode": "8500",
          "Street": "Dumolinlaan",
          "Submunicipality": "Kortrijk",
          "City": "Kortrijk"
        },
        "Quantity": 1
      }
    ],
    "LastSeen": {
      "Address": "Dumolinlaan 9, 8500 Kortrijk, BE",
      "DateTime": "2019-01-25T08:29:37+02:00",
      "DetectedBy": "Vehicle 1"
    },
    "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg",
    "Responsible": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "CreatedOn": "2019-01-25T08:29:37+02:00"
  }
}
401Unauthorized
403Forbidden

Delete asset

Deletes an asset by its Id.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work",
    "Code": "012345",
    "Type": "012345",
    "Brand": "012345",
    "TypeNumber": "012345",
    "SerialNumber": "012345",
    "Description": "012345",
    "Quantity": 1,
    "CommissioningDate": "2019-01-25T07:29:37",
    "Category": 0,
    "AdministrativeLocations": [
      {
        "Location": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345",
          "Country": 0,
          "Description": "Work",
          "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
          "HouseNumber": "9",
          "LonMin": 3.145219,
          "LonMax": 3.244998,
          "LatMin": 50.81309,
          "LatMax": 50.91806,
          "MarkerLon": 3.145219,
          "MarkerLat": 50.81309,
          "IsAssetLocation": false,
          "PostalCode": "8500",
          "Street": "Dumolinlaan",
          "Submunicipality": "Kortrijk",
          "City": "Kortrijk"
        },
        "Quantity": 1
      }
    ],
    "LastSeen": {
      "Address": "Dumolinlaan 9, 8500 Kortrijk, BE",
      "DateTime": "2019-01-25T08:29:37+02:00",
      "DetectedBy": "Vehicle 1"
    },
    "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg",
    "Responsible": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "CreatedOn": "2019-01-25T08:29:37+02:00"
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work",
    "Code": "012345",
    "Type": "012345",
    "Brand": "012345",
    "TypeNumber": "012345",
    "SerialNumber": "012345",
    "Description": "012345",
    "Quantity": 1,
    "CommissioningDate": "2019-01-25T07:29:37",
    "Category": 0,
    "AdministrativeLocations": [
      {
        "Location": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345",
          "Country": 0,
          "Description": "Work",
          "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
          "HouseNumber": "9",
          "LonMin": 3.145219,
          "LonMax": 3.244998,
          "LatMin": 50.81309,
          "LatMax": 50.91806,
          "MarkerLon": 3.145219,
          "MarkerLat": 50.81309,
          "IsAssetLocation": false,
          "PostalCode": "8500",
          "Street": "Dumolinlaan",
          "Submunicipality": "Kortrijk",
          "City": "Kortrijk"
        },
        "Quantity": 1
      }
    ],
    "LastSeen": {
      "Address": "Dumolinlaan 9, 8500 Kortrijk, BE",
      "DateTime": "2019-01-25T08:29:37+02:00",
      "DetectedBy": "Vehicle 1"
    },
    "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg",
    "Responsible": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "CreatedOn": "2019-01-25T08:29:37+02:00"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden

Update asset

Updates an asset.

Request body

object

FieldTypeRequired
Idstringrequired
Namestringoptional
Code(default = null)stringoptional
Type(default = null)stringoptional
Brand(default = null)stringoptional
Type number(default = null)stringoptional
Serial number(default = null)stringoptional
Description(default = null)stringoptional
Categorynumberoptional
Quantity(default = `1`)numberoptional
CommissioningDate(default = null)stringoptional
_typeDescriptorstringoptional

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work",
    "Code": "012345",
    "Type": "012345",
    "Brand": "012345",
    "TypeNumber": "012345",
    "SerialNumber": "012345",
    "Description": "012345",
    "Quantity": 1,
    "CommissioningDate": "2019-01-25T07:29:37",
    "Category": 0,
    "AdministrativeLocations": [
      {
        "Location": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345",
          "Country": 0,
          "Description": "Work",
          "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
          "HouseNumber": "9",
          "LonMin": 3.145219,
          "LonMax": 3.244998,
          "LatMin": 50.81309,
          "LatMax": 50.91806,
          "MarkerLon": 3.145219,
          "MarkerLat": 50.81309,
          "IsAssetLocation": false,
          "PostalCode": "8500",
          "Street": "Dumolinlaan",
          "Submunicipality": "Kortrijk",
          "City": "Kortrijk"
        },
        "Quantity": 1
      }
    ],
    "LastSeen": {
      "Address": "Dumolinlaan 9, 8500 Kortrijk, BE",
      "DateTime": "2019-01-25T08:29:37+02:00",
      "DetectedBy": "Vehicle 1"
    },
    "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg",
    "Responsible": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "CreatedOn": "2019-01-25T08:29:37+02:00"
  }
}
400BadRequest
401Unauthorized
403Forbidden
417ExpectationFailed

Create asset

Creates a new asset.

Request body

object

FieldTypeRequired
Namestringrequired
Code(default = null)stringoptional
Type(default = null)stringoptional
Brand(default = null)stringoptional
TypeNumber(default = null)stringoptional
SerialNumber(default = null)stringoptional
Description(default = null)stringoptional
Categorynumberoptional
Quantity(default = `1`)numberoptional
CommissioningDate(default = null)stringoptional
_typeDescriptorstringoptional

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work",
    "Code": "012345",
    "Type": "012345",
    "Brand": "012345",
    "TypeNumber": "012345",
    "SerialNumber": "012345",
    "Description": "012345",
    "Quantity": 1,
    "CommissioningDate": "2019-01-25T07:29:37",
    "Category": 0,
    "AdministrativeLocations": [
      {
        "Location": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345",
          "Country": 0,
          "Description": "Work",
          "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
          "HouseNumber": "9",
          "LonMin": 3.145219,
          "LonMax": 3.244998,
          "LatMin": 50.81309,
          "LatMax": 50.91806,
          "MarkerLon": 3.145219,
          "MarkerLat": 50.81309,
          "IsAssetLocation": false,
          "PostalCode": "8500",
          "Street": "Dumolinlaan",
          "Submunicipality": "Kortrijk",
          "City": "Kortrijk"
        },
        "Quantity": 1
      }
    ],
    "LastSeen": {
      "Address": "Dumolinlaan 9, 8500 Kortrijk, BE",
      "DateTime": "2019-01-25T08:29:37+02:00",
      "DetectedBy": "Vehicle 1"
    },
    "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg",
    "Responsible": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "CreatedOn": "2019-01-25T08:29:37+02:00"
  }
}
400BadRequest
401Unauthorized
403Forbidden
417ExpectationFailed

Link responsible user to asset

Links a responsible user to an asset by id.

Path parameters

NameTypeRequiredExample
assetIdstringrequired00000000-0000-0000-0000-000000000000
userIdstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work",
    "Code": "012345",
    "Type": "012345",
    "Brand": "012345",
    "TypeNumber": "012345",
    "SerialNumber": "012345",
    "Description": "012345",
    "Quantity": 1,
    "CommissioningDate": "2019-01-25T07:29:37",
    "Category": 0,
    "AdministrativeLocations": [
      {
        "Location": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345",
          "Country": 0,
          "Description": "Work",
          "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
          "HouseNumber": "9",
          "LonMin": 3.145219,
          "LonMax": 3.244998,
          "LatMin": 50.81309,
          "LatMax": 50.91806,
          "MarkerLon": 3.145219,
          "MarkerLat": 50.81309,
          "IsAssetLocation": false,
          "PostalCode": "8500",
          "Street": "Dumolinlaan",
          "Submunicipality": "Kortrijk",
          "City": "Kortrijk"
        },
        "Quantity": 1
      }
    ],
    "LastSeen": {
      "Address": "Dumolinlaan 9, 8500 Kortrijk, BE",
      "DateTime": "2019-01-25T08:29:37+02:00",
      "DetectedBy": "Vehicle 1"
    },
    "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg",
    "Responsible": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "CreatedOn": "2019-01-25T08:29:37+02:00"
  }
}
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed

Unlink responsible user from asset

Unlinks a responsible user from an asset by id.

Path parameters

NameTypeRequiredExample
assetIdstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work",
    "Code": "012345",
    "Type": "012345",
    "Brand": "012345",
    "TypeNumber": "012345",
    "SerialNumber": "012345",
    "Description": "012345",
    "Quantity": 1,
    "CommissioningDate": "2019-01-25T07:29:37",
    "Category": 0,
    "AdministrativeLocations": [
      {
        "Location": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345",
          "Country": 0,
          "Description": "Work",
          "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
          "HouseNumber": "9",
          "LonMin": 3.145219,
          "LonMax": 3.244998,
          "LatMin": 50.81309,
          "LatMax": 50.91806,
          "MarkerLon": 3.145219,
          "MarkerLat": 50.81309,
          "IsAssetLocation": false,
          "PostalCode": "8500",
          "Street": "Dumolinlaan",
          "Submunicipality": "Kortrijk",
          "City": "Kortrijk"
        },
        "Quantity": 1
      }
    ],
    "LastSeen": {
      "Address": "Dumolinlaan 9, 8500 Kortrijk, BE",
      "DateTime": "2019-01-25T08:29:37+02:00",
      "DetectedBy": "Vehicle 1"
    },
    "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg",
    "Responsible": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "CreatedOn": "2019-01-25T08:29:37+02:00"
  }
}
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed

Mutate asset

Mutates a quantity of an asset from a location to another location.

The quantity of unique assets is limited to one!

The quantity of collective assets is limited to the number of assets at the source location.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Request body

object

FieldTypeRequired
FromLocationIdstringrequired
ToLocationIdstringrequired
Quantity(default = `1`)numberoptional

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "TimeStamp": "2019-01-25T08:06:45+01:00",
    "Asset": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work",
      "Code": "012345",
      "Type": "012345",
      "Brand": "012345",
      "TypeNumber": "012345",
      "SerialNumber": "012345",
      "Description": "012345",
      "Quantity": 1,
      "CommissioningDate": "2019-01-25T07:29:37",
      "Category": 0,
      "AdministrativeLocations": [
        {
          "Location": {
            "Id": "00000000-0000-0000-0000-000000000000",
            "Name": "Work",
            "Code": "012345",
            "Country": 0,
            "Description": "Work",
            "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
            "HouseNumber": "9",
            "LonMin": 3.145219,
            "LonMax": 3.244998,
            "LatMin": 50.81309,
            "LatMax": 50.91806,
            "MarkerLon": 3.145219,
            "MarkerLat": 50.81309,
            "IsAssetLocation": false,
            "PostalCode": "8500",
            "Street": "Dumolinlaan",
            "Submunicipality": "Kortrijk",
            "City": "Kortrijk"
          },
          "Quantity": 1
        }
      ],
      "LastSeen": {
        "Address": "Dumolinlaan 9, 8500 Kortrijk, BE",
        "DateTime": "2019-01-25T08:29:37+02:00",
        "DetectedBy": "Vehicle 1"
      },
      "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg",
      "Responsible": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Code": "012345",
        "Name": "John Doe",
        "Type": 0
      },
      "CreatedOn": "2019-01-25T08:29:37+02:00"
    },
    "FromLocation": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work",
      "Code": "012345",
      "Country": 0,
      "Description": "Work",
      "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
      "HouseNumber": "9",
      "LonMin": 3.145219,
      "LonMax": 3.244998,
      "LatMin": 50.81309,
      "LatMax": 50.91806,
      "MarkerLon": 3.145219,
      "MarkerLat": 50.81309,
      "IsAssetLocation": false,
      "PostalCode": "8500",
      "Street": "Dumolinlaan",
      "Submunicipality": "Kortrijk",
      "City": "Kortrijk"
    },
    "ToLocation": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work",
      "Code": "012345",
      "Country": 0,
      "Description": "Work",
      "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
      "HouseNumber": "9",
      "LonMin": 3.145219,
      "LonMax": 3.244998,
      "LatMin": 50.81309,
      "LatMax": 50.91806,
      "MarkerLon": 3.145219,
      "MarkerLat": 50.81309,
      "IsAssetLocation": false,
      "PostalCode": "8500",
      "Street": "Dumolinlaan",
      "Submunicipality": "Kortrijk",
      "City": "Kortrijk"
    },
    "Quantity": 1,
    "By": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    }
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "TimeStamp": "2019-01-25T08:06:45+01:00",
    "Asset": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work",
      "Code": "012345",
      "Type": "012345",
      "Brand": "012345",
      "TypeNumber": "012345",
      "SerialNumber": "012345",
      "Description": "012345",
      "Quantity": 1,
      "CommissioningDate": "2019-01-25T07:29:37",
      "Category": 0,
      "AdministrativeLocations": [
        {
          "Location": {
            "Id": "00000000-0000-0000-0000-000000000000",
            "Name": "Work",
            "Code": "012345",
            "Country": 0,
            "Description": "Work",
            "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
            "HouseNumber": "9",
            "LonMin": 3.145219,
            "LonMax": 3.244998,
            "LatMin": 50.81309,
            "LatMax": 50.91806,
            "MarkerLon": 3.145219,
            "MarkerLat": 50.81309,
            "IsAssetLocation": false,
            "PostalCode": "8500",
            "Street": "Dumolinlaan",
            "Submunicipality": "Kortrijk",
            "City": "Kortrijk"
          },
          "Quantity": 1
        }
      ],
      "LastSeen": {
        "Address": "Dumolinlaan 9, 8500 Kortrijk, BE",
        "DateTime": "2019-01-25T08:29:37+02:00",
        "DetectedBy": "Vehicle 1"
      },
      "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg",
      "Responsible": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Code": "012345",
        "Name": "John Doe",
        "Type": 0
      },
      "CreatedOn": "2019-01-25T08:29:37+02:00"
    },
    "FromLocation": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work",
      "Code": "012345",
      "Country": 0,
      "Description": "Work",
      "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
      "HouseNumber": "9",
      "LonMin": 3.145219,
      "LonMax": 3.244998,
      "LatMin": 50.81309,
      "LatMax": 50.91806,
      "MarkerLon": 3.145219,
      "MarkerLat": 50.81309,
      "IsAssetLocation": false,
      "PostalCode": "8500",
      "Street": "Dumolinlaan",
      "Submunicipality": "Kortrijk",
      "City": "Kortrijk"
    },
    "ToLocation": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work",
      "Code": "012345",
      "Country": 0,
      "Description": "Work",
      "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
      "HouseNumber": "9",
      "LonMin": 3.145219,
      "LonMax": 3.244998,
      "LatMin": 50.81309,
      "LatMax": 50.91806,
      "MarkerLon": 3.145219,
      "MarkerLat": 50.81309,
      "IsAssetLocation": false,
      "PostalCode": "8500",
      "Street": "Dumolinlaan",
      "Submunicipality": "Kortrijk",
      "City": "Kortrijk"
    },
    "Quantity": 1,
    "By": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    }
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Get asset location by Id

Returns an asset location by its Id.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Idstring
Namestring
Code(default = null)string
Country(default = 0)number
Description(default = null)string
GeographyWkt(default = null) The coordinates of all points that define the shape of the POI.string
HouseNumber(default = null)string
LonMin(default = 0.0) Lowest longitude coordinate of the shape of the POI.number
LonMax(default = 0.0) Highest longitude coordinate of the shape of the POI.number
LatMin(default = 0.0) Lowest latitude coordinate of the shape of the POI.number
LatMax(default = 0.0) Highest latitude coordinate of the shape of the POI.number
MarkerLon(default = null) Longitude coordinate of the marker.number
MarkerLat(default = null) Latitude coordinate of the marker.number
IsAssetLocationboolean
PostalCode(default = null)string
Street(default = null)string
Submunicipality(default = null)string
City(default = null)string
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Work",
  "Code": "012345",
  "Country": 0,
  "Description": "Work",
  "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
  "HouseNumber": "9",
  "LonMin": 3.145219,
  "LonMax": 3.244998,
  "LatMin": 50.81309,
  "LatMax": 50.91806,
  "MarkerLon": 3.145219,
  "MarkerLat": 50.81309,
  "PostalCode": "8500",
  "Street": "Dumolinlaan",
  "Submunicipality": "Kortrijk",
  "City": "Kortrijk"
}
401Unauthorized
403Forbidden

Mutate assets

Mutates quantities of assets from a location to another location.

The quantity of unique assets is limited to one!

The quantity of collective assets is limited to the number of assets at the source location.

Request body

object

FieldTypeRequired
AssetQuantities(default = null)arrayrequired
ToLocationIdstringrequired

Responses

200OK
FieldType
Data(default = null)array
{
  "Data": [
    {
      "TimeStamp": "2019-01-25T08:06:45+01:00",
      "Asset": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "Work",
        "Code": "012345",
        "Type": "012345",
        "Brand": "012345",
        "TypeNumber": "012345",
        "SerialNumber": "012345",
        "Description": "012345",
        "Quantity": 1,
        "CommissioningDate": "2019-01-25T07:29:37",
        "Category": 0,
        "AdministrativeLocations": [
          {
            "Location": {
              "Id": "00000000-0000-0000-0000-000000000000",
              "Name": "Work",
              "Code": "012345",
              "Country": 0,
              "Description": "Work",
              "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
              "HouseNumber": "9",
              "LonMin": 3.145219,
              "LonMax": 3.244998,
              "LatMin": 50.81309,
              "LatMax": 50.91806,
              "MarkerLon": 3.145219,
              "MarkerLat": 50.81309,
              "IsAssetLocation": false,
              "PostalCode": "8500",
              "Street": "Dumolinlaan",
              "Submunicipality": "Kortrijk",
              "City": "Kortrijk"
            },
            "Quantity": 1
          }
        ],
        "LastSeen": {
          "Address": "Dumolinlaan 9, 8500 Kortrijk, BE",
          "DateTime": "2019-01-25T08:29:37+02:00",
          "DetectedBy": "Vehicle 1"
        },
        "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg",
        "Responsible": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Code": "012345",
          "Name": "John Doe",
          "Type": 0
        },
        "CreatedOn": "2019-01-25T08:29:37+02:00"
      },
      "FromLocation": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "Work",
        "Code": "012345",
        "Country": 0,
        "Description": "Work",
        "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
        "HouseNumber": "9",
        "LonMin": 3.145219,
        "LonMax": 3.244998,
        "LatMin": 50.81309,
        "LatMax": 50.91806,
        "MarkerLon": 3.145219,
        "MarkerLat": 50.81309,
        "IsAssetLocation": false,
        "PostalCode": "8500",
        "Street": "Dumolinlaan",
        "Submunicipality": "Kortrijk",
        "City": "Kortrijk"
      },
      "ToLocation": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "Work",
        "Code": "012345",
        "Country": 0,
        "Description": "Work",
        "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
        "HouseNumber": "9",
        "LonMin": 3.145219,
        "LonMax": 3.244998,
        "LatMin": 50.81309,
        "LatMax": 50.91806,
        "MarkerLon": 3.145219,
        "MarkerLat": 50.81309,
        "IsAssetLocation": false,
        "PostalCode": "8500",
        "Street": "Dumolinlaan",
        "Submunicipality": "Kortrijk",
        "City": "Kortrijk"
      },
      "Quantity": 1,
      "By": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Code": "012345",
        "Name": "John Doe",
        "Type": 0
      }
    }
  ]
}
400BadRequest
FieldType
Data(default = null)array
{
  "Data": [
    {
      "Entity": {
        "TimeStamp": "2019-01-25T08:06:45+01:00",
        "Asset": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345",
          "Type": "012345",
          "Brand": "012345",
          "TypeNumber": "012345",
          "SerialNumber": "012345",
          "Description": "012345",
          "Quantity": 1,
          "CommissioningDate": "2019-01-25T07:29:37",
          "Category": 0,
          "AdministrativeLocations": [
            {
              "Location": {
                "Id": "00000000-0000-0000-0000-000000000000",
                "Name": "Work",
                "Code": "012345",
                "Country": 0,
                "Description": "Work",
                "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
                "HouseNumber": "9",
                "LonMin": 3.145219,
                "LonMax": 3.244998,
                "LatMin": 50.81309,
                "LatMax": 50.91806,
                "MarkerLon": 3.145219,
                "MarkerLat": 50.81309,
                "IsAssetLocation": false,
                "PostalCode": "8500",
                "Street": "Dumolinlaan",
                "Submunicipality": "Kortrijk",
                "City": "Kortrijk"
              },
              "Quantity": 1
            }
          ],
          "LastSeen": {
            "Address": "Dumolinlaan 9, 8500 Kortrijk, BE",
            "DateTime": "2019-01-25T08:29:37+02:00",
            "DetectedBy": "Vehicle 1"
          },
          "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg",
          "Responsible": {
            "Id": "00000000-0000-0000-0000-000000000000",
            "Code": "012345",
            "Name": "John Doe",
            "Type": 0
          },
          "CreatedOn": "2019-01-25T08:29:37+02:00"
        },
        "FromLocation": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345",
          "Country": 0,
          "Description": "Work",
          "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
          "HouseNumber": "9",
          "LonMin": 3.145219,
          "LonMax": 3.244998,
          "LatMin": 50.81309,
          "LatMax": 50.91806,
          "MarkerLon": 3.145219,
          "MarkerLat": 50.81309,
          "IsAssetLocation": false,
          "PostalCode": "8500",
          "Street": "Dumolinlaan",
          "Submunicipality": "Kortrijk",
          "City": "Kortrijk"
        },
        "ToLocation": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345",
          "Country": 0,
          "Description": "Work",
          "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
          "HouseNumber": "9",
          "LonMin": 3.145219,
          "LonMax": 3.244998,
          "LatMin": 50.81309,
          "LatMax": 50.91806,
          "MarkerLon": 3.145219,
          "MarkerLat": 50.81309,
          "IsAssetLocation": false,
          "PostalCode": "8500",
          "Street": "Dumolinlaan",
          "Submunicipality": "Kortrijk",
          "City": "Kortrijk"
        },
        "Quantity": 1,
        "By": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Code": "012345",
          "Name": "John Doe",
          "Type": 0
        }
      },
      "ValidationResult": [
        {
          "Message": "",
          "SourceMemberNames": []
        }
      ]
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Link administrative location to unique asset

Links an administrative location to a unique asset. A unique asset means an asset with the property Category set to 0.

In this case, only one administrative location can be linked. An administrative location is a point of interest with IsAssetLocation set to true.

Path parameters

NameTypeRequiredExample
assetIdstringrequired00000000-0000-0000-0000-000000000000
locationIdstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work",
    "Code": "012345",
    "Type": "012345",
    "Brand": "012345",
    "TypeNumber": "012345",
    "SerialNumber": "012345",
    "Description": "012345",
    "Quantity": 1,
    "CommissioningDate": "2019-01-25T07:29:37",
    "Category": 0,
    "AdministrativeLocations": [
      {
        "Location": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345",
          "Country": 0,
          "Description": "Work",
          "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
          "HouseNumber": "9",
          "LonMin": 3.145219,
          "LonMax": 3.244998,
          "LatMin": 50.81309,
          "LatMax": 50.91806,
          "MarkerLon": 3.145219,
          "MarkerLat": 50.81309,
          "IsAssetLocation": false,
          "PostalCode": "8500",
          "Street": "Dumolinlaan",
          "Submunicipality": "Kortrijk",
          "City": "Kortrijk"
        },
        "Quantity": 1
      }
    ],
    "LastSeen": {
      "Address": "Dumolinlaan 9, 8500 Kortrijk, BE",
      "DateTime": "2019-01-25T08:29:37+02:00",
      "DetectedBy": "Vehicle 1"
    },
    "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg",
    "Responsible": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "CreatedOn": "2019-01-25T08:29:37+02:00"
  }
}
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed

Unlink administrative location from asset

Unlinks an administrative location from an asset.

An administrative location is a point of interest with IsAssetLocation set to true.

Path parameters

NameTypeRequiredExample
assetIdstringrequired00000000-0000-0000-0000-000000000000
locationIdstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work",
    "Code": "012345",
    "Type": "012345",
    "Brand": "012345",
    "TypeNumber": "012345",
    "SerialNumber": "012345",
    "Description": "012345",
    "Quantity": 1,
    "CommissioningDate": "2019-01-25T07:29:37",
    "Category": 0,
    "AdministrativeLocations": [
      {
        "Location": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345",
          "Country": 0,
          "Description": "Work",
          "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
          "HouseNumber": "9",
          "LonMin": 3.145219,
          "LonMax": 3.244998,
          "LatMin": 50.81309,
          "LatMax": 50.91806,
          "MarkerLon": 3.145219,
          "MarkerLat": 50.81309,
          "IsAssetLocation": false,
          "PostalCode": "8500",
          "Street": "Dumolinlaan",
          "Submunicipality": "Kortrijk",
          "City": "Kortrijk"
        },
        "Quantity": 1
      }
    ],
    "LastSeen": {
      "Address": "Dumolinlaan 9, 8500 Kortrijk, BE",
      "DateTime": "2019-01-25T08:29:37+02:00",
      "DetectedBy": "Vehicle 1"
    },
    "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg",
    "Responsible": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "CreatedOn": "2019-01-25T08:29:37+02:00"
  }
}
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed

Link administrative location to collective asset

Links administrative locations to a collective asset. A collective asset means an asset with the property Category set to 1.

In this case, multiple administrative locations can be linked, each with their own amount of items. An administrative location is a point of interest with IsAssetLocation set to true.

Request body

object

FieldTypeRequired
Data(default = null)arrayoptional

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work",
    "Code": "012345",
    "Type": "012345",
    "Brand": "012345",
    "TypeNumber": "012345",
    "SerialNumber": "012345",
    "Description": "012345",
    "Quantity": 1,
    "CommissioningDate": "2019-01-25T07:29:37",
    "Category": 0,
    "AdministrativeLocations": [
      {
        "Location": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345",
          "Country": 0,
          "Description": "Work",
          "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
          "HouseNumber": "9",
          "LonMin": 3.145219,
          "LonMax": 3.244998,
          "LatMin": 50.81309,
          "LatMax": 50.91806,
          "MarkerLon": 3.145219,
          "MarkerLat": 50.81309,
          "IsAssetLocation": false,
          "PostalCode": "8500",
          "Street": "Dumolinlaan",
          "Submunicipality": "Kortrijk",
          "City": "Kortrijk"
        },
        "Quantity": 1
      }
    ],
    "LastSeen": {
      "Address": "Dumolinlaan 9, 8500 Kortrijk, BE",
      "DateTime": "2019-01-25T08:29:37+02:00",
      "DetectedBy": "Vehicle 1"
    },
    "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg",
    "Responsible": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "CreatedOn": "2019-01-25T08:29:37+02:00"
  }
}
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed

Get linked inspection types by asset

Returns a list of asset inspection types linked to a particular asset.

Path parameters

NameTypeRequiredExample
assetIdstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Inspection",
    "Description": "Description",
    "Responsible": 0,
    "WarningThresholdDays": 0,
    "IntervalYears": 0,
    "IntervalMonths": 6,
    "IntervalDays": 0
  }
]
401Unauthorized
403Forbidden

Update asset inspection type

Updates an existing asset inspection type.

Request body

object

FieldTypeRequired
Idstringrequired
Name(default = null)stringrequired
Description(default = null)stringoptional
Responsiblenumberoptional
WarningThresholdDays(default = null)numberoptional
IntervalYears(default = null)numberoptional
IntervalMonths(default = null)numberoptional
IntervalDays(default = null)numberoptional

Responses

200OK
FieldType
Idstring
Name(default = null)string
Description(default = null)string
Responsiblenumber
WarningThresholdDays(default = null)number
IntervalYears(default = null)number
IntervalMonths(default = null)number
IntervalDays(default = null)number
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Inspection",
  "Description": "Description",
  "Responsible": 0,
  "WarningThresholdDays": 0,
  "IntervalYears": 0,
  "IntervalMonths": 6,
  "IntervalDays": 0
}
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed

Create asset inspection type

Creates a new asset inspection.

Request body

object

FieldTypeRequired
Name(default = null)stringrequired
Description(default = null)stringoptional
Responsiblenumberoptional
WarningThresholdDays(default = null)numberoptional
IntervalYears(default = null)numberoptional
IntervalMonths(default = null)numberoptional
IntervalDays(default = null)numberoptional

Responses

200OK
FieldType
Idstring
Name(default = null)string
Description(default = null)string
Responsiblenumber
WarningThresholdDays(default = null)number
IntervalYears(default = null)number
IntervalMonths(default = null)number
IntervalDays(default = null)number
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Inspection",
  "Description": "Description",
  "Responsible": 0,
  "WarningThresholdDays": 0,
  "IntervalYears": 0,
  "IntervalMonths": 6,
  "IntervalDays": 0
}
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed

Get asset inspections by Asset Id

Get all asset inspections for a specific Asset Id.

Path parameters

NameTypeRequiredExample
assetIdstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Idstring
AssetIdstring
Typeobject
Status(default = 0)number
Comments(default = null)string
DateCompleted(default = null)string
Picture(default = null)string
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "AssetId": "00000000-0000-0000-0000-000000000000",
  "Type": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Inspection",
    "Description": "Description",
    "Responsible": 0,
    "WarningThresholdDays": 0,
    "IntervalYears": 0,
    "IntervalMonths": 6,
    "IntervalDays": 0
  },
  "Status": 0,
  "Comments": "Comments",
  "DateCompleted": "2019-09-10",
  "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg"
}
401Unauthorized
403Forbidden

Get asset inspections by Date

Get all asset inspections that occurred on or after a specific date.

Path parameters

NameTypeRequiredExample
datestringrequired2020-01-01

Responses

200OK
FieldType
Idstring
AssetIdstring
Typeobject
Status(default = 0)number
Comments(default = null)string
DateCompleted(default = null)string
Picture(default = null)string
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "AssetId": "00000000-0000-0000-0000-000000000000",
  "Type": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Inspection",
    "Description": "Description",
    "Responsible": 0,
    "WarningThresholdDays": 0,
    "IntervalYears": 0,
    "IntervalMonths": 6,
    "IntervalDays": 0
  },
  "Status": 0,
  "Comments": "Comments",
  "DateCompleted": "2019-09-10",
  "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg"
}
401Unauthorized
403Forbidden

Update asset inspection

Updates an existing asset inspection.

Request body

object

FieldTypeRequired
Idstringrequired
AssetIdstringrequired
TypeIdstringoptional
Status(default = 0)numberoptional
Comments(default = null)stringoptional
DateCompleted(default = null)stringoptional
Picture(default = null)stringoptional

Responses

200OK
FieldType
Idstring
AssetIdstring
Typeobject
Status(default = 0)number
Comments(default = null)string
DateCompleted(default = null)string
Picture(default = null)string
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "AssetId": "00000000-0000-0000-0000-000000000000",
  "Type": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Inspection",
    "Description": "Description",
    "Responsible": 0,
    "WarningThresholdDays": 0,
    "IntervalYears": 0,
    "IntervalMonths": 6,
    "IntervalDays": 0
  },
  "Status": 0,
  "Comments": "Comments",
  "DateCompleted": "2019-09-10",
  "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg"
}
400BadRequest
401Unauthorized
403Forbidden
417ExpectationFailed

Create asset inspection

Creates a new asset inspection.

Request body

object

FieldTypeRequired
AssetIdstringrequired
TypeIdstringrequired
Status(default = 0)numberoptional
Comments(default = null)stringoptional
DateCompleted(default = null)stringoptional
Picture(default = null)stringoptional

Responses

200OK
FieldType
Idstring
AssetIdstring
Typeobject
Status(default = 0)number
Comments(default = null)string
DateCompleted(default = null)string
Picture(default = null)string
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "AssetId": "00000000-0000-0000-0000-000000000000",
  "Type": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Inspection",
    "Description": "Description",
    "Responsible": 0,
    "WarningThresholdDays": 0,
    "IntervalYears": 0,
    "IntervalMonths": 6,
    "IntervalDays": 0
  },
  "Status": 0,
  "Comments": "Comments",
  "DateCompleted": "2019-09-10",
  "Picture": "https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg"
}
400BadRequest
401Unauthorized
403Forbidden
417ExpectationFailed

Get asset identifications by badge id

Returns all asset identifications for an asset by badge id.

Path parameters

NameTypeRequiredExample
assetIdstringrequired00000000-0000-0000-0000-000000000000
badgeIdstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Data(default = null)array
{
  "Data": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "BadgeId": "00000000-0000-0000-0000-000000000000",
      "Value": "123ABC",
      "Type": 0
    }
  ]
}
401Unauthorized
403Forbidden

Delete asset identifications by badge id

Deletes all asset identifications for an asset by badge id.

Path parameters

NameTypeRequiredExample
assetIdstringrequired00000000-0000-0000-0000-000000000000
badgeIdstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Data(default = null)array
{
  "Data": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "BadgeId": "00000000-0000-0000-0000-000000000000",
      "Value": "123ABC",
      "Type": 0
    }
  ]
}
401Unauthorized
403Forbidden

Get asset identification by custom value

Returns an asset identification for an asset by custom value.

Path parameters

NameTypeRequiredExample
assetIdstringrequired00000000-0000-0000-0000-000000000000
valuestringrequired123ABC

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "BadgeId": "00000000-0000-0000-0000-000000000000",
    "Value": "123ABC",
    "Type": 0
  }
}
401Unauthorized
403Forbidden

Delete asset identification by custom value

Deletes an asset identification for an asset by custom value.

Path parameters

NameTypeRequiredExample
assetIdstringrequired00000000-0000-0000-0000-000000000000
valuestringrequired123ABC

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "BadgeId": "00000000-0000-0000-0000-000000000000",
    "Value": "123ABC",
    "Type": 0
  }
}
401Unauthorized
403Forbidden

Create asset identification by badge id

Creates a new asset identification by badge id.

Path parameters

NameTypeRequiredExample
assetIdstringrequired00000000-0000-0000-0000-000000000000

Request body

object

FieldTypeRequired
BadgeIdstringrequired

Responses

200OK
FieldType
Data(default = null)array
{
  "Data": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "BadgeId": "00000000-0000-0000-0000-000000000000",
      "Value": "123ABC",
      "Type": 0
    }
  ]
}
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed

Update asset identification by custom value

Updates an existing asset identification by custom value. Only personalized assets can be updated.

Path parameters

NameTypeRequiredExample
assetIdstringrequired00000000-0000-0000-0000-000000000000

Request body

object

FieldTypeRequired
Idstringrequired
Valuestringrequired

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "BadgeId": "00000000-0000-0000-0000-000000000000",
    "Value": "123ABC",
    "Type": 0
  }
}
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed

Create asset identification by custom value

Creates a new asset identification by custom value.

Path parameters

NameTypeRequiredExample
assetIdstringrequired00000000-0000-0000-0000-000000000000

Request body

object

FieldTypeRequired
Valuestringrequired

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "BadgeId": "00000000-0000-0000-0000-000000000000",
    "Value": "123ABC",
    "Type": 0
  }
}
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed