POST api/General/SetIntegratorProfileSettings

Request Information

URI Parameters

None.

Body Parameters

SetIntegratorProfileSettingsRequest
NameDescriptionTypeAdditional information
Settings

Collection of IntegratorProfileSetting

None.

UserId

string

None.

IntegratorProfileId

string

None.

ApiStatusId

integer

None.

Token

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Settings": [
    {
      "IntegratorProfileSettingId": "sample string 1",
      "UserId": "sample string 2",
      "IntegratorProfileId": "sample string 3",
      "SettingValue": "sample string 4",
      "IntegratorSettingId": 5,
      "IntegratorCompanyId": 6,
      "SettingName": "sample string 7",
      "IsUnique": true,
      "Optional": true,
      "IntegratorSettingTypeId": 64,
      "SettingType": "sample string 11",
      "Description": "sample string 12",
      "Parameters": "sample string 13",
      "SettingOrder": 14
    },
    {
      "IntegratorProfileSettingId": "sample string 1",
      "UserId": "sample string 2",
      "IntegratorProfileId": "sample string 3",
      "SettingValue": "sample string 4",
      "IntegratorSettingId": 5,
      "IntegratorCompanyId": 6,
      "SettingName": "sample string 7",
      "IsUnique": true,
      "Optional": true,
      "IntegratorSettingTypeId": 64,
      "SettingType": "sample string 11",
      "Description": "sample string 12",
      "Parameters": "sample string 13",
      "SettingOrder": 14
    }
  ],
  "UserId": "sample string 1",
  "IntegratorProfileId": "sample string 2",
  "ApiStatusId": 3,
  "Token": "sample string 4"
}

application/xml, text/xml

Sample:
<SetIntegratorProfileSettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Integrator.Request">
  <Token xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 4</Token>
  <ApiStatusId>3</ApiStatusId>
  <IntegratorProfileId>sample string 2</IntegratorProfileId>
  <Settings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Integrator">
    <d2p1:IntegratorProfileSetting>
      <d2p1:Description>sample string 12</d2p1:Description>
      <d2p1:IntegratorCompanyId>6</d2p1:IntegratorCompanyId>
      <d2p1:IntegratorSettingId>5</d2p1:IntegratorSettingId>
      <d2p1:IntegratorSettingTypeId>64</d2p1:IntegratorSettingTypeId>
      <d2p1:IsUnique>true</d2p1:IsUnique>
      <d2p1:Optional>true</d2p1:Optional>
      <d2p1:Parameters>sample string 13</d2p1:Parameters>
      <d2p1:SettingName>sample string 7</d2p1:SettingName>
      <d2p1:SettingOrder>14</d2p1:SettingOrder>
      <d2p1:SettingType>sample string 11</d2p1:SettingType>
      <d2p1:IntegratorProfileId>sample string 3</d2p1:IntegratorProfileId>
      <d2p1:IntegratorProfileSettingId>sample string 1</d2p1:IntegratorProfileSettingId>
      <d2p1:SettingValue>sample string 4</d2p1:SettingValue>
      <d2p1:UserId>sample string 2</d2p1:UserId>
    </d2p1:IntegratorProfileSetting>
    <d2p1:IntegratorProfileSetting>
      <d2p1:Description>sample string 12</d2p1:Description>
      <d2p1:IntegratorCompanyId>6</d2p1:IntegratorCompanyId>
      <d2p1:IntegratorSettingId>5</d2p1:IntegratorSettingId>
      <d2p1:IntegratorSettingTypeId>64</d2p1:IntegratorSettingTypeId>
      <d2p1:IsUnique>true</d2p1:IsUnique>
      <d2p1:Optional>true</d2p1:Optional>
      <d2p1:Parameters>sample string 13</d2p1:Parameters>
      <d2p1:SettingName>sample string 7</d2p1:SettingName>
      <d2p1:SettingOrder>14</d2p1:SettingOrder>
      <d2p1:SettingType>sample string 11</d2p1:SettingType>
      <d2p1:IntegratorProfileId>sample string 3</d2p1:IntegratorProfileId>
      <d2p1:IntegratorProfileSettingId>sample string 1</d2p1:IntegratorProfileSettingId>
      <d2p1:SettingValue>sample string 4</d2p1:SettingValue>
      <d2p1:UserId>sample string 2</d2p1:UserId>
    </d2p1:IntegratorProfileSetting>
  </Settings>
  <UserId>sample string 1</UserId>
</SetIntegratorProfileSettingsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SetIntegratorProfileSettingsResponse
NameDescriptionTypeAdditional information
IntegratorProfile

IntegratorProfile

None.

ErrorCode

string

None.

ErrorMessage

string

None.

ErrorCategory

string

None.

Result

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "IntegratorProfile": {
    "IntegratorProfileId": "sample string 1",
    "UserId": "sample string 2",
    "IntegratorCompanyId": 3,
    "Name": "sample string 4",
    "Note": "sample string 5",
    "IntegratorProfileStatusId": 64,
    "ApiStatusId": 64,
    "AddressId": "sample string 8",
    "TestMode": true,
    "Verified": 10,
    "TaxNumber": "sample string 11",
    "ProfileSettings": [
      {
        "IntegratorProfileSettingId": "sample string 1",
        "UserId": "sample string 2",
        "IntegratorProfileId": "sample string 3",
        "SettingValue": "sample string 4",
        "IntegratorSettingId": 5,
        "IntegratorCompanyId": 6,
        "SettingName": "sample string 7",
        "IsUnique": true,
        "Optional": true,
        "IntegratorSettingTypeId": 64,
        "SettingType": "sample string 11",
        "Description": "sample string 12",
        "Parameters": "sample string 13",
        "SettingOrder": 14
      },
      {
        "IntegratorProfileSettingId": "sample string 1",
        "UserId": "sample string 2",
        "IntegratorProfileId": "sample string 3",
        "SettingValue": "sample string 4",
        "IntegratorSettingId": 5,
        "IntegratorCompanyId": 6,
        "SettingName": "sample string 7",
        "IsUnique": true,
        "Optional": true,
        "IntegratorSettingTypeId": 64,
        "SettingType": "sample string 11",
        "Description": "sample string 12",
        "Parameters": "sample string 13",
        "SettingOrder": 14
      }
    ],
    "CompanyName": "sample string 12",
    "IntegratorCompanyTypeId": 13,
    "InvoiceIdGenerationMethod": 14
  },
  "ErrorCode": "sample string 1",
  "ErrorMessage": "sample string 2",
  "ErrorCategory": "sample string 3",
  "Result": true
}

application/xml, text/xml

Sample:
<SetIntegratorProfileSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Integrator.Response">
  <ErrorCategory xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 3</ErrorCategory>
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 1</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 2</ErrorMessage>
  <Result xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">true</Result>
  <IntegratorProfile xmlns:d2p1="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Integrator">
    <d2p1:AddressId>sample string 8</d2p1:AddressId>
    <d2p1:ApiStatusId>64</d2p1:ApiStatusId>
    <d2p1:CompanyName>sample string 12</d2p1:CompanyName>
    <d2p1:IntegratorCompanyId>3</d2p1:IntegratorCompanyId>
    <d2p1:IntegratorCompanyTypeId>13</d2p1:IntegratorCompanyTypeId>
    <d2p1:IntegratorProfileId>sample string 1</d2p1:IntegratorProfileId>
    <d2p1:IntegratorProfileStatusId>64</d2p1:IntegratorProfileStatusId>
    <d2p1:InvoiceIdGenerationMethod>14</d2p1:InvoiceIdGenerationMethod>
    <d2p1:Name>sample string 4</d2p1:Name>
    <d2p1:Note>sample string 5</d2p1:Note>
    <d2p1:ProfileSettings>
      <d2p1:IntegratorProfileSetting>
        <d2p1:Description>sample string 12</d2p1:Description>
        <d2p1:IntegratorCompanyId>6</d2p1:IntegratorCompanyId>
        <d2p1:IntegratorSettingId>5</d2p1:IntegratorSettingId>
        <d2p1:IntegratorSettingTypeId>64</d2p1:IntegratorSettingTypeId>
        <d2p1:IsUnique>true</d2p1:IsUnique>
        <d2p1:Optional>true</d2p1:Optional>
        <d2p1:Parameters>sample string 13</d2p1:Parameters>
        <d2p1:SettingName>sample string 7</d2p1:SettingName>
        <d2p1:SettingOrder>14</d2p1:SettingOrder>
        <d2p1:SettingType>sample string 11</d2p1:SettingType>
        <d2p1:IntegratorProfileId>sample string 3</d2p1:IntegratorProfileId>
        <d2p1:IntegratorProfileSettingId>sample string 1</d2p1:IntegratorProfileSettingId>
        <d2p1:SettingValue>sample string 4</d2p1:SettingValue>
        <d2p1:UserId>sample string 2</d2p1:UserId>
      </d2p1:IntegratorProfileSetting>
      <d2p1:IntegratorProfileSetting>
        <d2p1:Description>sample string 12</d2p1:Description>
        <d2p1:IntegratorCompanyId>6</d2p1:IntegratorCompanyId>
        <d2p1:IntegratorSettingId>5</d2p1:IntegratorSettingId>
        <d2p1:IntegratorSettingTypeId>64</d2p1:IntegratorSettingTypeId>
        <d2p1:IsUnique>true</d2p1:IsUnique>
        <d2p1:Optional>true</d2p1:Optional>
        <d2p1:Parameters>sample string 13</d2p1:Parameters>
        <d2p1:SettingName>sample string 7</d2p1:SettingName>
        <d2p1:SettingOrder>14</d2p1:SettingOrder>
        <d2p1:SettingType>sample string 11</d2p1:SettingType>
        <d2p1:IntegratorProfileId>sample string 3</d2p1:IntegratorProfileId>
        <d2p1:IntegratorProfileSettingId>sample string 1</d2p1:IntegratorProfileSettingId>
        <d2p1:SettingValue>sample string 4</d2p1:SettingValue>
        <d2p1:UserId>sample string 2</d2p1:UserId>
      </d2p1:IntegratorProfileSetting>
    </d2p1:ProfileSettings>
    <d2p1:TaxNumber>sample string 11</d2p1:TaxNumber>
    <d2p1:TestMode>true</d2p1:TestMode>
    <d2p1:UserId>sample string 2</d2p1:UserId>
    <d2p1:Verified>10</d2p1:Verified>
  </IntegratorProfile>
</SetIntegratorProfileSettingsResponse>