ResourceGroupService Resource

A set of end point that concerns resource resource groups.

POST /v1/resourcegroup/resultfile

This service returns the resource group a Vehicle belonged to when the provided result file was created.

Request Parameters
name type description
auth-token header The authentication token.
Request Body
media type data type description
application/json array of number (JSON) A list of identifiers (max 1000) for the result files of interest.
Response Codes
code condition
401 If no or an invalid authentication token is supplied.
400 If no or more than 1000 identifiers supplied.
Response Body
media type data type description
application/json array of ResultFileResourceGroup (JSON) a list of ResultFileResourceGroup

Example

Request
POST /v1/resourcegroup/resultfile
Content-Type: application/json
Accept: application/json
auth-token: ...

                
[ 12345, 678910 ]
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "result-file-identifier" : 12345,
  "resource-group" : "..."
} ]

GET /v1/resourcegroup/{resource-group}/members

Returns all WCUs that belongs to the provided resource group.

Request Parameters
name type description
auth-token header The authentication token.
resource-group path The resource group of interest.
Response Codes
code condition
401 If no or an invalid authentication token is supplied.
Response Body
media type data type description
application/json array of string (JSON) a distinct list of wcu identifiers.

Example

Request
GET /v1/resourcegroup/{resource-group}/members
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ "04-1B-94-00-0D-17", "04-1B-94-00-0C-CD", "04-1B-94-00-0C-A3" ]

GET /v1/resourcegroup/{resource-group}/members/history

This service returns all WCUs that have belonged to the provided resource group.

Request Parameters
name type description constraints
auth-token header The authentication token.  
resource-group path The resource group of interest. required
Response Codes
code condition
401 If no or an invalid authentication token is supplied.
Response Body
media type data type description
application/json ResourceGroupMembersHistory (JSON)

Example

Request
GET /v1/resourcegroup/{resource-group}/members/history
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "resources" : [ {
    "wcuId" : "...",
    "vin" : "...",
    "from" : 12345,
    "to" : 12345
  }, {
    "wcuId" : "...",
    "vin" : "...",
    "from" : 12345,
    "to" : 12345
  } ],
  "resource-group" : "..."
}