POST customers

Create Customers. Roles: ApiRole+DealerRole

Request Information

URI Parameters

None.

Body Parameters

Collection of all CustomerCreateData objects

Collection of CustomerCreateData
NameDescriptionTypeAdditional information
Name

Customer name.

string

Required

Max length: 45

BillingStart

Customer Billing start date.

date

None.

BillingEnd

Customer Billing end date

date

None.

LevelID

Customer Level or Dealer ID

integer

Required

Comment

Customer comment.

string

None.

NewDeviceBehavior

Customer NewDeviceBehavior. MANAGED by default.

NewDeviceBehavior

None.

MailTo

Receiver/s E-Mail IDs separated by ';'. If not present, then no e-mail is sent.

Collection of string

None.

MailCC

CC Email-IDs separated by ';'.

Collection of string

None.

MailBCC

BCC Email-IDs separated by ';'.

Collection of string

None.

MailMessage

Message for body in E-Mail.

string

None.

MailCulture

E-Mail culture. Default is User's culture.

string

None.

ContractID

Customer ContractID. Could be used to map JA Customer ID with Client Contract ID.

string

None.

MonoPageCost

Account Mono page cost

decimal number

None.

ColorPageCost

Account Color page cost

decimal number

None.

DataFieldValues

Customer DataField values, if any.

Collection of DataFieldValue

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "BillingStart": "2018-05-24T17:50:11.3058975+00:00",
    "BillingEnd": "2018-05-24T17:50:11.3058975+00:00",
    "LevelID": 2,
    "Comment": "sample string 3",
    "NewDeviceBehavior": "Managed",
    "MailTo": [
      "sample string 1",
      "sample string 2"
    ],
    "MailCC": [
      "sample string 1",
      "sample string 2"
    ],
    "MailBCC": [
      "sample string 1",
      "sample string 2"
    ],
    "MailMessage": "sample string 4",
    "MailCulture": "sample string 5",
    "ContractID": "sample string 6",
    "MonoPageCost": 1.1,
    "ColorPageCost": 1.1,
    "DataFieldValues": [
      {
        "DataFieldName": "sample string 1",
        "VD": 1.1,
        "VS": "sample string 2",
        "VT": "2018-05-24T17:50:11.3058975+00:00"
      },
      {
        "DataFieldName": "sample string 1",
        "VD": 1.1,
        "VS": "sample string 2",
        "VT": "2018-05-24T17:50:11.3058975+00:00"
      }
    ]
  },
  {
    "Name": "sample string 1",
    "BillingStart": "2018-05-24T17:50:11.3058975+00:00",
    "BillingEnd": "2018-05-24T17:50:11.3058975+00:00",
    "LevelID": 2,
    "Comment": "sample string 3",
    "NewDeviceBehavior": "Managed",
    "MailTo": [
      "sample string 1",
      "sample string 2"
    ],
    "MailCC": [
      "sample string 1",
      "sample string 2"
    ],
    "MailBCC": [
      "sample string 1",
      "sample string 2"
    ],
    "MailMessage": "sample string 4",
    "MailCulture": "sample string 5",
    "ContractID": "sample string 6",
    "MonoPageCost": 1.1,
    "ColorPageCost": 1.1,
    "DataFieldValues": [
      {
        "DataFieldName": "sample string 1",
        "VD": 1.1,
        "VS": "sample string 2",
        "VT": "2018-05-24T17:50:11.3058975+00:00"
      },
      {
        "DataFieldName": "sample string 1",
        "VD": 1.1,
        "VS": "sample string 2",
        "VT": "2018-05-24T17:50:11.3058975+00:00"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfCustomerCreateData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomerCreateData>
    <Name>sample string 1</Name>
    <BillingStart>2018-05-24T17:50:11.3058975+00:00</BillingStart>
    <BillingEnd>2018-05-24T17:50:11.3058975+00:00</BillingEnd>
    <LevelID>2</LevelID>
    <Comment>sample string 3</Comment>
    <NewDeviceBehavior>Managed</NewDeviceBehavior>
    <MailTo>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </MailTo>
    <MailCC>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </MailCC>
    <MailBCC>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </MailBCC>
    <MailMessage>sample string 4</MailMessage>
    <MailCulture>sample string 5</MailCulture>
    <ContractID>sample string 6</ContractID>
    <MonoPageCost>1.1</MonoPageCost>
    <ColorPageCost>1.1</ColorPageCost>
    <DataFieldValues>
      <DataFieldValue>
        <DataFieldName>sample string 1</DataFieldName>
        <VD>1.1</VD>
        <VS>sample string 2</VS>
        <VT>2018-05-24T17:50:11.3058975+00:00</VT>
      </DataFieldValue>
      <DataFieldValue>
        <DataFieldName>sample string 1</DataFieldName>
        <VD>1.1</VD>
        <VS>sample string 2</VS>
        <VT>2018-05-24T17:50:11.3058975+00:00</VT>
      </DataFieldValue>
    </DataFieldValues>
  </CustomerCreateData>
  <CustomerCreateData>
    <Name>sample string 1</Name>
    <BillingStart>2018-05-24T17:50:11.3058975+00:00</BillingStart>
    <BillingEnd>2018-05-24T17:50:11.3058975+00:00</BillingEnd>
    <LevelID>2</LevelID>
    <Comment>sample string 3</Comment>
    <NewDeviceBehavior>Managed</NewDeviceBehavior>
    <MailTo>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </MailTo>
    <MailCC>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </MailCC>
    <MailBCC>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </MailBCC>
    <MailMessage>sample string 4</MailMessage>
    <MailCulture>sample string 5</MailCulture>
    <ContractID>sample string 6</ContractID>
    <MonoPageCost>1.1</MonoPageCost>
    <ColorPageCost>1.1</ColorPageCost>
    <DataFieldValues>
      <DataFieldValue>
        <DataFieldName>sample string 1</DataFieldName>
        <VD>1.1</VD>
        <VS>sample string 2</VS>
        <VT>2018-05-24T17:50:11.3058975+00:00</VT>
      </DataFieldValue>
      <DataFieldValue>
        <DataFieldName>sample string 1</DataFieldName>
        <VD>1.1</VD>
        <VS>sample string 2</VS>
        <VT>2018-05-24T17:50:11.3058975+00:00</VT>
      </DataFieldValue>
    </DataFieldValues>
  </CustomerCreateData>
</ArrayOfCustomerCreateData>

Response Information

Resource Description

Returns all newly created customers as a queryable object.

Collection of Customer
NameDescriptionTypeAdditional information
CustomerID

CustomerID or AccountID of the customer/account.

integer

None.

Name

Customer name.

string

None.

JAName

Customer's JetAdvice account name.

string

None.

CreatedDate

Customer created date.

date

None.

BillingStart

Customer Billing start date.

date

None.

BillingEnd

Customer Billing end date

date

None.

LevelID

Customer Level or Dealer ID

integer

None.

ContractID

Customer ContractID. Could be used to map JA Customer ID with Client Contract ID.

string

None.

DataFieldValues

Customer DataField values, if any.

Collection of DataFieldValue

None.

Comment

Customer comment.

string

None.

NewDeviceBehavior

Customer NewDeviceBehavior. MANAGED by default.

NewDeviceBehavior

None.

StatusMessage

Customer status message.

string

None.

StatusCode

Customer status code.

CustomerStatusCode

None.

StatusFromUsername

Username who put the status message.

string

None.

StatusFromDate

Date on which status message was entered.

date

None.

MonoPageCost

Account Mono page cost

decimal number

None.

ColorPageCost

Account Color page cost

decimal number

None.

LastCollect

Last collected datetime on the account.

date

None.

LogoUrl

Logo url

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CustomerID": 1,
    "Name": "sample string 2",
    "JAName": "sample string 3",
    "CreatedDate": "2018-05-24T17:50:11.3360508+00:00",
    "BillingStart": "2018-05-24T17:50:11.3360508+00:00",
    "BillingEnd": "2018-05-24T17:50:11.3360508+00:00",
    "LevelID": 5,
    "ContractID": "sample string 6",
    "DataFieldValues": [
      {
        "DataFieldName": "sample string 1",
        "VD": 1.1,
        "VS": "sample string 2",
        "VT": "2018-05-24T17:50:11.3360508+00:00"
      },
      {
        "DataFieldName": "sample string 1",
        "VD": 1.1,
        "VS": "sample string 2",
        "VT": "2018-05-24T17:50:11.3360508+00:00"
      }
    ],
    "Comment": "sample string 7",
    "NewDeviceBehavior": "Managed",
    "StatusMessage": "sample string 8",
    "StatusCode": "Created",
    "StatusFromUsername": "sample string 9",
    "StatusFromDate": "2018-05-24T17:50:11.3360508+00:00",
    "MonoPageCost": 1.1,
    "ColorPageCost": 1.1,
    "LastCollect": "2018-05-24T17:50:11.3360508+00:00",
    "LogoUrl": "sample string 11"
  },
  {
    "CustomerID": 1,
    "Name": "sample string 2",
    "JAName": "sample string 3",
    "CreatedDate": "2018-05-24T17:50:11.3360508+00:00",
    "BillingStart": "2018-05-24T17:50:11.3360508+00:00",
    "BillingEnd": "2018-05-24T17:50:11.3360508+00:00",
    "LevelID": 5,
    "ContractID": "sample string 6",
    "DataFieldValues": [
      {
        "DataFieldName": "sample string 1",
        "VD": 1.1,
        "VS": "sample string 2",
        "VT": "2018-05-24T17:50:11.3360508+00:00"
      },
      {
        "DataFieldName": "sample string 1",
        "VD": 1.1,
        "VS": "sample string 2",
        "VT": "2018-05-24T17:50:11.3360508+00:00"
      }
    ],
    "Comment": "sample string 7",
    "NewDeviceBehavior": "Managed",
    "StatusMessage": "sample string 8",
    "StatusCode": "Created",
    "StatusFromUsername": "sample string 9",
    "StatusFromDate": "2018-05-24T17:50:11.3360508+00:00",
    "MonoPageCost": 1.1,
    "ColorPageCost": 1.1,
    "LastCollect": "2018-05-24T17:50:11.3360508+00:00",
    "LogoUrl": "sample string 11"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCustomer xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Customer>
    <CustomerID>1</CustomerID>
    <Name>sample string 2</Name>
    <JAName>sample string 3</JAName>
    <CreatedDate>2018-05-24T17:50:11.3360508+00:00</CreatedDate>
    <BillingStart>2018-05-24T17:50:11.3360508+00:00</BillingStart>
    <BillingEnd>2018-05-24T17:50:11.3360508+00:00</BillingEnd>
    <LevelID>5</LevelID>
    <ContractID>sample string 6</ContractID>
    <DataFieldValues>
      <DataFieldValue>
        <DataFieldName>sample string 1</DataFieldName>
        <VD>1.1</VD>
        <VS>sample string 2</VS>
        <VT>2018-05-24T17:50:11.3360508+00:00</VT>
      </DataFieldValue>
      <DataFieldValue>
        <DataFieldName>sample string 1</DataFieldName>
        <VD>1.1</VD>
        <VS>sample string 2</VS>
        <VT>2018-05-24T17:50:11.3360508+00:00</VT>
      </DataFieldValue>
    </DataFieldValues>
    <Comment>sample string 7</Comment>
    <NewDeviceBehavior>Managed</NewDeviceBehavior>
    <StatusMessage>sample string 8</StatusMessage>
    <StatusCode>Created</StatusCode>
    <StatusFromUsername>sample string 9</StatusFromUsername>
    <StatusFromDate>2018-05-24T17:50:11.3360508+00:00</StatusFromDate>
    <MonoPageCost>1.1</MonoPageCost>
    <ColorPageCost>1.1</ColorPageCost>
    <LastCollect>2018-05-24T17:50:11.3360508+00:00</LastCollect>
    <LogoUrl>sample string 11</LogoUrl>
  </Customer>
  <Customer>
    <CustomerID>1</CustomerID>
    <Name>sample string 2</Name>
    <JAName>sample string 3</JAName>
    <CreatedDate>2018-05-24T17:50:11.3360508+00:00</CreatedDate>
    <BillingStart>2018-05-24T17:50:11.3360508+00:00</BillingStart>
    <BillingEnd>2018-05-24T17:50:11.3360508+00:00</BillingEnd>
    <LevelID>5</LevelID>
    <ContractID>sample string 6</ContractID>
    <DataFieldValues>
      <DataFieldValue>
        <DataFieldName>sample string 1</DataFieldName>
        <VD>1.1</VD>
        <VS>sample string 2</VS>
        <VT>2018-05-24T17:50:11.3360508+00:00</VT>
      </DataFieldValue>
      <DataFieldValue>
        <DataFieldName>sample string 1</DataFieldName>
        <VD>1.1</VD>
        <VS>sample string 2</VS>
        <VT>2018-05-24T17:50:11.3360508+00:00</VT>
      </DataFieldValue>
    </DataFieldValues>
    <Comment>sample string 7</Comment>
    <NewDeviceBehavior>Managed</NewDeviceBehavior>
    <StatusMessage>sample string 8</StatusMessage>
    <StatusCode>Created</StatusCode>
    <StatusFromUsername>sample string 9</StatusFromUsername>
    <StatusFromDate>2018-05-24T17:50:11.3360508+00:00</StatusFromDate>
    <MonoPageCost>1.1</MonoPageCost>
    <ColorPageCost>1.1</ColorPageCost>
    <LastCollect>2018-05-24T17:50:11.3360508+00:00</LastCollect>
    <LogoUrl>sample string 11</LogoUrl>
  </Customer>
</ArrayOfCustomer>