Customer Management

Get Customers

GET https://[customer].testresults.io/api/management/customers

Gets all active (without archive) customers.

Headers

Name	Type	Description
Authentication	string	Authentication token

200 Cake successfully retrieved.

[
  {
    "Name": "System",
    "AccountNumber": null,
    "Address": null,
    "CostCenter": null,
    "Currency": "CHF",
    "Tax": 770,
    "Discounts": null,
    "MinimumConsumptionInH": 40,
    "DueDays": 30,
    "TechnicalName": "System",
    "Subdomain": "stage",
    "Appliances": null,
    "DataVersion": "AAAAAAAmCP8=",
    "Archived": false,
    "Id": "00000000-0000-0000-0000-000000000001"
  },
  {
    "Name": "Test & Demo GmbH",
    "AccountNumber": "INT-PRG-01",
    "Address": "progile GmbH;Riedwiesenstr. 23;8305 Dietlikon;Schweiz",
    "CostCenter": "TRIO-RUN",
    "Currency": "CHF",
    "Tax": 770,
    "Discounts": null,
    "MinimumConsumptionInH": 40,
    "DueDays": 90,
    "TechnicalName": "testanddemo",
    "Subdomain": "stage",
    "Appliances": "Development (Oleg):oleglocal,Dummy:dummyProbe,Stage Box:b8aeed7fa02a",
    "DataVersion": "AAAAAAAq+HI=",
    "Archived": false,
    "Id": "00000000-0000-0000-0000-000000000010"
  }
]

Get archive Customers

GET https://[customer].testresults.io/api/management/customers/archive

Get archive customers.

Headers

Name	Type	Description
Authentication	string	Authentication token

200

[
  {
    "Name": "System",
    "AccountNumber": null,
    "Address": null,
    "CostCenter": null,
    "Currency": "CHF",
    "Tax": 770,
    "Discounts": null,
    "MinimumConsumptionInH": 40,
    "DueDays": 30,
    "TechnicalName": "System",
    "Subdomain": "stage",
    "Appliances": null,
    "DataVersion": "AAAAAAAmCP8=",
    "Archived": false,
    "Id": "00000000-0000-0000-0000-000000000001"
  },
  {
    "Name": "Test & Demo GmbH",
    "AccountNumber": "INT-PRG-01",
    "Address": "progile GmbH;Riedwiesenstr. 23;8305 Dietlikon;Schweiz",
    "CostCenter": "TRIO-RUN",
    "Currency": "CHF",
    "Tax": 770,
    "Discounts": null,
    "MinimumConsumptionInH": 40,
    "DueDays": 90,
    "TechnicalName": "testanddemo",
    "Subdomain": "stage",
    "Appliances": "Development (Oleg):oleglocal,Dummy:dummyProbe,Stage Box:b8aeed7fa02a",
    "DataVersion": "AAAAAAAq+HI=",
    "Archived": false,
    "Id": "00000000-0000-0000-0000-000000000010"
  }
]

Get Customer details

GET https://[customer].testresults.io/api/management/customers/:cId

Gets customer details.

Path Parameters

Name	Type	Description
cId	string	Customer ID

Headers

Name	Type	Description
Authentication	string	Authentication token

200

{
  "UserGroups": [
    {
      "Name": "@SystemEngineers@",
      "Description": "@SystemEngineers@",
      "UsagePermission": "Login, Read, Write, Execute, Accept, Reject, UserSettings, UserManagement, Automation, ClaimManagement, CustomerManagement, AccessSecrets, Invoicing, ExecutionTimes, Reserved3, Reserved4, Reserved5, Reserved6, Reserved7, Reserved8, Reserved9, Reserved10, Reserved11, Reserved12, Reserved13, Reserved14, Reserved15, Reserved16, Reserved17, Reserved18, Reserved19",
      "DataVersion": null,
      "Archived": false,
      "Id": "00000000-0000-0000-0000-000000000001"
    }
  ],
  "Name": "System",
  "AccountNumber": null,
  "Address": null,
  "CostCenter": null,
  "Currency": "CHF",
  "Tax": 770,
  "Discounts": null,
  "MinimumConsumptionInH": 40,
  "DueDays": 30,
  "TechnicalName": "System",
  "Subdomain": "stage",
  "Appliances": null,
  "DataVersion": "AAAAAAAmCP8=",
  "Archived": false,
  "Id": "00000000-0000-0000-0000-000000000001"
}

Create new Customer

POST https://[customer].testresults.io/api/management/customers

Creates new Customer.

Headers

Name	Type	Description
Authentication	string	Authentication token

Request Body

Name	Type	Description
Name	string	Customer Name
Subdomain	string	Customer Subdomain
Appliances	string	Target groups, comma separated

200

{
  "UserGroups": [],
  "Name": "new test cust",
  "AccountNumber": null,
  "Address": null,
  "CostCenter": null,
  "Currency": "CHF",
  "Tax": 770,
  "Discounts": null,
  "MinimumConsumptionInH": 40,
  "DueDays": 30,
  "TechnicalName": null,
  "Subdomain": "test",
  "Appliances": "asdasd,ttt",
  "DataVersion": "AAAAAAAzlHg=",
  "Archived": false,
  "Id": "9c0b0f5a-fb5a-41ac-b614-55fa262a9dff"
}

Update Customer

PUT https://[customer].testresults.io/api/management/customers/:cId

Updates an existing Customer.

Path Parameters

Name	Type	Description
cId	string	Customer ID

Headers

Name	Type	Description
Authentication	string	Authentication token

Request Body

Name	Type	Description
Archived	boolean	Archive flag
Name	string	Customer Name
Subdomain	string	Customer Subdomain
Appliances	string	Target groups, comma separated

200

{
  "UserGroups": [
    {
      "Name": "@SystemEngineers@",
      "Description": "@SystemEngineers@",
      "UsagePermission": "Login, Read, Write, Execute, Accept, Reject, UserSettings, UserManagement, Automation, ClaimManagement, CustomerManagement, AccessSecrets, Invoicing, ExecutionTimes, Reserved3, Reserved4, Reserved5, Reserved6, Reserved7, Reserved8, Reserved9, Reserved10, Reserved11, Reserved12, Reserved13, Reserved14, Reserved15, Reserved16, Reserved17, Reserved18, Reserved19",
      "DataVersion": null,
      "Archived": false,
      "Id": "00000000-0000-0000-0000-000000000001"
    }
  ],
  "Name": "System",
  "AccountNumber": null,
  "Address": null,
  "CostCenter": null,
  "Currency": "CHF",
  "Tax": 770,
  "Discounts": null,
  "MinimumConsumptionInH": 40,
  "DueDays": 30,
  "TechnicalName": "System",
  "Subdomain": "stage",
  "Appliances": "[e-mail],[e-mail]",
  "DataVersion": "AAAAAAAzlG0=",
  "Archived": false,
  "Id": "00000000-0000-0000-0000-000000000001"
}

Delete Customer

DELETE https://[customer].testresults.io/api/management/customers/:cId

Deletes Customer

Path Parameters

Name	Type	Description
cId	string	Customer ID

Headers

Name	Type	Description
Authentication	string	Authentication token

200