POST api/ids/smsuser

Request Information

URI Parameters

None.

Body Parameters

SMSUserDTO
NameDescriptionTypeAdditional information
UserGuid

globally unique identifier

None.

CarrierId

globally unique identifier

None.

UserName

string

None.

Password

string

None.

FirstName

string

None.

LastName

string

None.

EmailAddress

string

None.

CompanyName

string

None.

GroupId

integer

None.

MonthId

integer

None.

CreditsAdded

integer

None.

PdfAnalysisAllowed

integer

None.

PdfAnalysisRemaining

integer

None.

PdfAnalysisUsed

integer

None.

ExcelAnalysisAllowed

integer

None.

ExcelAnalysisRemaining

integer

None.

ExcelAnalysisUsed

integer

None.

CanExportData

boolean

None.

IsAdmin

boolean

None.

IsActive

boolean

None.

ComparisonReport

boolean

None.

CrashData

boolean

None.

SeriousViolations

boolean

None.

CustomLevel1

boolean

None.

CustomLevel2

boolean

None.

ExcelHeader

string

None.

CoverImagePath

string

None.

Page2ImagePath

string

None.

BackImagePath

string

None.

PINVersion

boolean

None.

TerminalAnalysis

boolean

None.

IPChecking

boolean

None.

IPAddresses

string

None.

NonTimeWeightedPoints

boolean

None.

PredictedMeasures

boolean

None.

HazMat

boolean

None.

EnhancedCharts

boolean

None.

ExcerptExcelTable

boolean

None.

DailyData

boolean

None.

Groups

Collection of GroupDTO

None.

Months

Collection of TupleOfInt32AndInt32

None.

Request Formats

application/json, text/json

Sample:
{
  "UserGuid": "1d8e2651-67be-412b-9704-dad9b05e2b68",
  "CarrierId": "be86eadd-eae8-4301-8f5b-3cc7fe24c563",
  "UserName": "sample string 3",
  "Password": "sample string 4",
  "FirstName": "sample string 5",
  "LastName": "sample string 6",
  "EmailAddress": "sample string 7",
  "CompanyName": "sample string 8",
  "GroupId": 9,
  "MonthId": 10,
  "CreditsAdded": 11,
  "PdfAnalysisAllowed": 12,
  "PdfAnalysisRemaining": 13,
  "PdfAnalysisUsed": 14,
  "ExcelAnalysisAllowed": 15,
  "ExcelAnalysisRemaining": 16,
  "ExcelAnalysisUsed": 17,
  "CanExportData": true,
  "IsAdmin": true,
  "IsActive": true,
  "ComparisonReport": true,
  "CrashData": true,
  "SeriousViolations": true,
  "CustomLevel1": true,
  "CustomLevel2": true,
  "ExcelHeader": "sample string 26",
  "CoverImagePath": "sample string 27",
  "Page2ImagePath": "sample string 28",
  "BackImagePath": "sample string 29",
  "PINVersion": true,
  "TerminalAnalysis": true,
  "IPChecking": true,
  "IPAddresses": "sample string 33",
  "NonTimeWeightedPoints": true,
  "PredictedMeasures": true,
  "HazMat": true,
  "EnhancedCharts": true,
  "ExcerptExcelTable": true,
  "DailyData": true,
  "Groups": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SearchesUsed": 3,
      "SearchesRemaining": 4,
      "ApplicationId": 5,
      "DotNumber": "sample string 6",
      "PortalAccountName": "sample string 7",
      "PortalAccountPassword": "sample string 8"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SearchesUsed": 3,
      "SearchesRemaining": 4,
      "ApplicationId": 5,
      "DotNumber": "sample string 6",
      "PortalAccountName": "sample string 7",
      "PortalAccountPassword": "sample string 8"
    }
  ],
  "Months": [
    {
      "m_Item1": 1,
      "m_Item2": 2
    },
    {
      "m_Item1": 1,
      "m_Item2": 2
    }
  ]
}

application/xml, text/xml

Sample:
<SMSUserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartnersDTO.IDS">
  <BackImagePath>sample string 29</BackImagePath>
  <CanExportData>true</CanExportData>
  <CarrierId>be86eadd-eae8-4301-8f5b-3cc7fe24c563</CarrierId>
  <CompanyName>sample string 8</CompanyName>
  <ComparisonReport>true</ComparisonReport>
  <CoverImagePath>sample string 27</CoverImagePath>
  <CrashData>true</CrashData>
  <CreditsAdded>11</CreditsAdded>
  <CustomLevel1>true</CustomLevel1>
  <CustomLevel2>true</CustomLevel2>
  <DailyData>true</DailyData>
  <EmailAddress>sample string 7</EmailAddress>
  <EnhancedCharts>true</EnhancedCharts>
  <ExcelAnalysisAllowed>15</ExcelAnalysisAllowed>
  <ExcelAnalysisRemaining>16</ExcelAnalysisRemaining>
  <ExcelAnalysisUsed>17</ExcelAnalysisUsed>
  <ExcelHeader>sample string 26</ExcelHeader>
  <ExcerptExcelTable>true</ExcerptExcelTable>
  <FirstName>sample string 5</FirstName>
  <GroupId>9</GroupId>
  <Groups>
    <GroupDTO>
      <ApplicationId>5</ApplicationId>
      <DotNumber>sample string 6</DotNumber>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <PortalAccountName>sample string 7</PortalAccountName>
      <PortalAccountPassword>sample string 8</PortalAccountPassword>
      <SearchesRemaining>4</SearchesRemaining>
      <SearchesUsed>3</SearchesUsed>
    </GroupDTO>
    <GroupDTO>
      <ApplicationId>5</ApplicationId>
      <DotNumber>sample string 6</DotNumber>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <PortalAccountName>sample string 7</PortalAccountName>
      <PortalAccountPassword>sample string 8</PortalAccountPassword>
      <SearchesRemaining>4</SearchesRemaining>
      <SearchesUsed>3</SearchesUsed>
    </GroupDTO>
  </Groups>
  <HazMat>true</HazMat>
  <IPAddresses>sample string 33</IPAddresses>
  <IPChecking>true</IPChecking>
  <IsActive>true</IsActive>
  <IsAdmin>true</IsAdmin>
  <LastName>sample string 6</LastName>
  <MonthId>10</MonthId>
  <Months xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:TupleOfintint>
      <d2p1:m_Item1>1</d2p1:m_Item1>
      <d2p1:m_Item2>2</d2p1:m_Item2>
    </d2p1:TupleOfintint>
    <d2p1:TupleOfintint>
      <d2p1:m_Item1>1</d2p1:m_Item1>
      <d2p1:m_Item2>2</d2p1:m_Item2>
    </d2p1:TupleOfintint>
  </Months>
  <NonTimeWeightedPoints>true</NonTimeWeightedPoints>
  <PINVersion>true</PINVersion>
  <Page2ImagePath>sample string 28</Page2ImagePath>
  <Password>sample string 4</Password>
  <PdfAnalysisAllowed>12</PdfAnalysisAllowed>
  <PdfAnalysisRemaining>13</PdfAnalysisRemaining>
  <PdfAnalysisUsed>14</PdfAnalysisUsed>
  <PredictedMeasures>true</PredictedMeasures>
  <SeriousViolations>true</SeriousViolations>
  <TerminalAnalysis>true</TerminalAnalysis>
  <UserGuid>1d8e2651-67be-412b-9704-dad9b05e2b68</UserGuid>
  <UserName>sample string 3</UserName>
</SMSUserDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.