PUT Api/AccountManagement/{mlcid}/Users

Endpoint for updating a MCL user account (ie. edit user information, user password reset, and locking/unlocking user account)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
mlcid

Unique CRA identifier

string

Required

Body Parameters

edit user request data

Request
NameDescriptionTypeAdditional information
userInfo

MCL User Login Information

UserInfo

None.

request

Request Information

RequestDetails

None.

Request Formats

application/json, text/json

Sample:
{
  "userInfo": {
    "login": "sample string 1",
    "password": "sample string 2"
  },
  "request": {
    "requestType": "sample string 1",
    "userIdentification": {
      "login": "sample string 1"
    },
    "userDetails": {
      "fullName": "sample string 1",
      "email": "sample string 2",
      "department": "sample string 3",
      "forceResetPassword": "sample string 4",
      "phone": "sample string 5",
      "cellPhone": "sample string 6",
      "fax": "sample string 7",
      "passwordAssignType": "sample string 8",
      "changePassword": "sample string 9",
      "password": "sample string 10",
      "ResetPassword": "sample string 11",
      "Login": "sample string 12"
    },
    "mclUserTemplate": "sample string 2",
    "automaticallyPrintReport": "sample string 3",
    "accountStatus": {
      "locked": "sample string 1",
      "lockMessage": "sample string 2"
    },
    "permissions": {
      "administrator": "sample string 1",
      "seeOtherFiles": "sample string 2",
      "viewInvoices": "sample string 3",
      "viewCharges": "sample string 4"
    },
    "creditOrderingSettings": {
      "reportOrdering": "sample string 1",
      "supplementOrderingScope": "sample string 2",
      "rescoreOrdering": "sample string 3",
      "allowReorderDaysAfter": "sample string 4"
    },
    "specialOptions": "sample string 4",
    "billing": {
      "SeparateInvoice": "sample string 1",
      "billingDetails": {
        "streetAddress": "sample string 1",
        "city": "sample string 2",
        "state": "sample string 3",
        "zipCode": "sample string 4",
        "phone": "sample string 5",
        "fax": "sample string 6"
      },
      "creditCardDetails": {
        "RequireCCPayment": "sample string 1",
        "UserCanEdit": "sample string 2",
        "creditCard": {
          "CardHolderName": "sample string 1",
          "streetAddress": "sample string 2",
          "city": "sample string 3",
          "state": "sample string 4",
          "zipCode": "sample string 5",
          "number": "sample string 6",
          "expMonth": "sample string 7",
          "expYear": "sample string 8"
        }
      }
    },
    "restrictions": {
      "allowedIP": [
        "sample string 1",
        "sample string 2"
      ],
      "restrictRegisterNewIps": "sample string 1",
      "disableEXP": "sample string 2",
      "disableTUC": "sample string 3",
      "disableEQF": "sample string 4",
      "disableCX": "sample string 5",
      "disableIDV": "sample string 6",
      "disableFLD": "sample string 7",
      "disableFNMA": "sample string 8",
      "disableAVM": "sample string 9",
      "disableTaxTranscript": "sample string 10",
      "disableBIZ": "sample string 11",
      "disableWeb": "sample string 12",
      "disableLOrder": "sample string 13",
      "disableWOrder": "sample string 14",
      "disableWUpgrade": "sample string 15",
      "disableAutoSelect": "sample string 16",
      "disableVOE": "sample string 17",
      "disablePKG": "sample string 18",
      "disableCRIM": "sample string 19",
      "disableEVCT": "sample string 20",
      "disableVOD": "sample string 21",
      "disableUDN": "sample string 22",
      "disableLJ": "sample string 23",
      "disableCLADJUST": "sample string 24",
      "disableTRV": "sample string 25",
      "disableWVOE": "sample string 26"
    },
    "resetSecurityCertificate": "sample string 5",
    "resetLoginFailures": "sample string 6",
    "generateAuthCode": "sample string 7",
    "notes": "sample string 8",
    "monthlyCreditLimit": {
      "limitAmount": "sample string 1",
      "excludeCCCharges": "sample string 2",
      "resetCreditToLimit": "sample string 3"
    }
  }
}

application/xml, text/xml

Sample:
<Request xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EndUserSystemApi.Models.AccountManagement">
  <request>
    <accountStatus>
      <lockMessage>sample string 2</lockMessage>
      <locked>sample string 1</locked>
    </accountStatus>
    <automaticallyPrintReport>sample string 3</automaticallyPrintReport>
    <billing>
      <SeparateInvoice>sample string 1</SeparateInvoice>
      <billingDetails>
        <city>sample string 2</city>
        <fax>sample string 6</fax>
        <phone>sample string 5</phone>
        <state>sample string 3</state>
        <streetAddress>sample string 1</streetAddress>
        <zipCode>sample string 4</zipCode>
      </billingDetails>
      <creditCardDetails>
        <RequireCCPayment>sample string 1</RequireCCPayment>
        <UserCanEdit>sample string 2</UserCanEdit>
        <creditCard>
          <CardHolderName>sample string 1</CardHolderName>
          <city>sample string 3</city>
          <expMonth>sample string 7</expMonth>
          <expYear>sample string 8</expYear>
          <number>sample string 6</number>
          <state>sample string 4</state>
          <streetAddress>sample string 2</streetAddress>
          <zipCode>sample string 5</zipCode>
        </creditCard>
      </creditCardDetails>
    </billing>
    <creditOrderingSettings>
      <allowReorderDaysAfter>sample string 4</allowReorderDaysAfter>
      <reportOrdering>sample string 1</reportOrdering>
      <rescoreOrdering>sample string 3</rescoreOrdering>
      <supplementOrderingScope>sample string 2</supplementOrderingScope>
    </creditOrderingSettings>
    <generateAuthCode>sample string 7</generateAuthCode>
    <mclUserTemplate>sample string 2</mclUserTemplate>
    <monthlyCreditLimit>
      <excludeCCCharges>sample string 2</excludeCCCharges>
      <limitAmount>sample string 1</limitAmount>
      <resetCreditToLimit>sample string 3</resetCreditToLimit>
    </monthlyCreditLimit>
    <notes>sample string 8</notes>
    <permissions>
      <administrator>sample string 1</administrator>
      <seeOtherFiles>sample string 2</seeOtherFiles>
      <viewCharges>sample string 4</viewCharges>
      <viewInvoices>sample string 3</viewInvoices>
    </permissions>
    <requestType>sample string 1</requestType>
    <resetLoginFailures>sample string 6</resetLoginFailures>
    <resetSecurityCertificate>sample string 5</resetSecurityCertificate>
    <restrictions>
      <allowedIP xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </allowedIP>
      <disableAVM>sample string 9</disableAVM>
      <disableAutoSelect>sample string 16</disableAutoSelect>
      <disableBIZ>sample string 11</disableBIZ>
      <disableCLADJUST>sample string 24</disableCLADJUST>
      <disableCRIM>sample string 19</disableCRIM>
      <disableCX>sample string 5</disableCX>
      <disableEQF>sample string 4</disableEQF>
      <disableEVCT>sample string 20</disableEVCT>
      <disableEXP>sample string 2</disableEXP>
      <disableFLD>sample string 7</disableFLD>
      <disableFNMA>sample string 8</disableFNMA>
      <disableIDV>sample string 6</disableIDV>
      <disableLJ>sample string 23</disableLJ>
      <disableLOrder>sample string 13</disableLOrder>
      <disablePKG>sample string 18</disablePKG>
      <disableTRV>sample string 25</disableTRV>
      <disableTUC>sample string 3</disableTUC>
      <disableTaxTranscript>sample string 10</disableTaxTranscript>
      <disableUDN>sample string 22</disableUDN>
      <disableVOD>sample string 21</disableVOD>
      <disableVOE>sample string 17</disableVOE>
      <disableWOrder>sample string 14</disableWOrder>
      <disableWUpgrade>sample string 15</disableWUpgrade>
      <disableWVOE>sample string 26</disableWVOE>
      <disableWeb>sample string 12</disableWeb>
      <restrictRegisterNewIps>sample string 1</restrictRegisterNewIps>
    </restrictions>
    <specialOptions>sample string 4</specialOptions>
    <userDetails>
      <Login>sample string 12</Login>
      <ResetPassword>sample string 11</ResetPassword>
      <cellPhone>sample string 6</cellPhone>
      <changePassword>sample string 9</changePassword>
      <department>sample string 3</department>
      <email>sample string 2</email>
      <fax>sample string 7</fax>
      <forceResetPassword>sample string 4</forceResetPassword>
      <fullName>sample string 1</fullName>
      <password>sample string 10</password>
      <passwordAssignType>sample string 8</passwordAssignType>
      <phone>sample string 5</phone>
    </userDetails>
    <userIdentification>
      <login>sample string 1</login>
    </userIdentification>
  </request>
  <userInfo>
    <login>sample string 1</login>
    <password>sample string 2</password>
  </userInfo>
</Request>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.