POST OneStop/v3/Customers

Add new customer

Request Information

URI Parameters

None.

Body Parameters

Customer to be created

Name	Description	Type	Additional information
ID	ID of the customer.	globally unique identifier	None.
Name	Customer name	string	None.
Description	Description of customer	string	None.
Address	Customer address	Address	None.
Contacts	Customer contacts	Collection of Contact	None.
ScanSchedule	Details of client scan settings, used for device discovery	ScanSchedule	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": "912a12a4-9096-4f9a-8034-ac7afe76f9bb",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Address": {
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "AddressLine3": "sample string 3",
    "AddressLine4": "sample string 4",
    "Town": "sample string 5",
    "County": "sample string 6",
    "Country": "sample string 7",
    "PostCode": "sample string 8"
  },
  "Contacts": null,
  "ScanSchedule": {
    "ScheduleType": 1,
    "RunDays": "sample string 1",
    "RunDate": 1,
    "RunTime": "2026-07-07T14:50:15.9133207+01:00",
    "Ranges": [
      "sample string 1",
      "sample string 2"
    ],
    "Devices": [
      "sample string 1",
      "sample string 2"
    ],
    "Description": "sample string 2",
    "Excluded": [
      "sample string 1",
      "sample string 2"
    ],
    "SNMPVersion": 1,
    "SNMPv3SecurityLevel": 1,
    "SNMPv3AuthenticationEncryption": 1,
    "SNMPv3PrivacyEncryption": 1,
    "SNMPv3UserName": "sample string 3",
    "SNMPv3AuthenticationPassword": "sample string 4",
    "SNMPv3PrivacyPassword": "sample string 5",
    "SNMPv3ContextNames": "sample string 6",
    "Community": "sample string 7"
  }
}

application/xml, text/xml

Sample:

<NewCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneStopWebAPI.DTO.v3">
  <Address>
    <AddressLine1>sample string 1</AddressLine1>
    <AddressLine2>sample string 2</AddressLine2>
    <AddressLine3>sample string 3</AddressLine3>
    <AddressLine4>sample string 4</AddressLine4>
    <Country>sample string 7</Country>
    <County>sample string 6</County>
    <PostCode>sample string 8</PostCode>
    <Town>sample string 5</Town>
  </Address>
  <Contacts i:nil="true" />
  <Description>sample string 3</Description>
  <Name>sample string 2</Name>
  <ScanSchedule>
    <Community>sample string 7</Community>
    <Description>sample string 2</Description>
    <Devices xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Devices>
    <Excluded xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Excluded>
    <Ranges xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Ranges>
    <RunDate>1</RunDate>
    <RunDays>sample string 1</RunDays>
    <RunTime>2026-07-07T14:50:15.9133207+01:00</RunTime>
    <SNMPVersion>1</SNMPVersion>
    <SNMPv3AuthenticationEncryption>1</SNMPv3AuthenticationEncryption>
    <SNMPv3AuthenticationPassword>sample string 4</SNMPv3AuthenticationPassword>
    <SNMPv3ContextNames>sample string 6</SNMPv3ContextNames>
    <SNMPv3PrivacyEncryption>1</SNMPv3PrivacyEncryption>
    <SNMPv3PrivacyPassword>sample string 5</SNMPv3PrivacyPassword>
    <SNMPv3SecurityLevel>1</SNMPv3SecurityLevel>
    <SNMPv3UserName>sample string 3</SNMPv3UserName>
    <ScheduleType>1</ScheduleType>
  </ScanSchedule>
</NewCustomer>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Customer

Name	Description	Type	Additional information
ID	ID of the customer.	globally unique identifier	None.
Name	Customer name	string	None.
Description	Description of customer	string	None.
Address	Customer address	Address	None.
Contacts	Customer contacts	Collection of Contact	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": "9a08d1c2-97bf-44cf-a03c-8f3c9ce3aad8",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Address": {
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "AddressLine3": "sample string 3",
    "AddressLine4": "sample string 4",
    "Town": "sample string 5",
    "County": "sample string 6",
    "Country": "sample string 7",
    "PostCode": "sample string 8"
  },
  "Contacts": null
}

application/xml, text/xml

Sample:

<Customer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneStopWebAPI.DTO.v3">
  <Address>
    <AddressLine1>sample string 1</AddressLine1>
    <AddressLine2>sample string 2</AddressLine2>
    <AddressLine3>sample string 3</AddressLine3>
    <AddressLine4>sample string 4</AddressLine4>
    <Country>sample string 7</Country>
    <County>sample string 6</County>
    <PostCode>sample string 8</PostCode>
    <Town>sample string 5</Town>
  </Address>
  <Contacts i:nil="true" />
  <Description>sample string 3</Description>
  <Name>sample string 2</Name>
</Customer>