POST api/Partner/GetIntegratorSetting

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
IntegratorCompanyId		integer	None.
Token		string	None.

Request Formats

application/json, text/json

Sample:

{
  "IntegratorCompanyId": 1,
  "Token": "sample string 2"
}

application/xml, text/xml

Sample:

<GetIntegratorSettingRequest 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 2</Token>
  <IntegratorCompanyId>1</IntegratorCompanyId>
</GetIntegratorSettingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetIntegratorSettingResponse

Name	Type	Additional information
Settings	Collection of IntegratorSetting	None.
ErrorCode	string	None.
ErrorMessage	string	None.
ErrorCategory	string	None.
Result	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Settings": [
    {
      "IntegratorSettingId": 1,
      "IntegratorCompanyId": 2,
      "SettingName": "sample string 3",
      "IsUnique": true,
      "Optional": true,
      "IntegratorSettingTypeId": 64,
      "SettingType": "sample string 7",
      "Description": "sample string 8",
      "Parameters": "sample string 9",
      "SettingOrder": 10
    },
    {
      "IntegratorSettingId": 1,
      "IntegratorCompanyId": 2,
      "SettingName": "sample string 3",
      "IsUnique": true,
      "Optional": true,
      "IntegratorSettingTypeId": 64,
      "SettingType": "sample string 7",
      "Description": "sample string 8",
      "Parameters": "sample string 9",
      "SettingOrder": 10
    }
  ],
  "ErrorCode": "sample string 1",
  "ErrorMessage": "sample string 2",
  "ErrorCategory": "sample string 3",
  "Result": true
}

application/xml, text/xml

Sample:

<GetIntegratorSettingResponse 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>
  <Settings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Integrator">
    <d2p1:IntegratorSetting>
      <d2p1:Description>sample string 8</d2p1:Description>
      <d2p1:IntegratorCompanyId>2</d2p1:IntegratorCompanyId>
      <d2p1:IntegratorSettingId>1</d2p1:IntegratorSettingId>
      <d2p1:IntegratorSettingTypeId>64</d2p1:IntegratorSettingTypeId>
      <d2p1:IsUnique>true</d2p1:IsUnique>
      <d2p1:Optional>true</d2p1:Optional>
      <d2p1:Parameters>sample string 9</d2p1:Parameters>
      <d2p1:SettingName>sample string 3</d2p1:SettingName>
      <d2p1:SettingOrder>10</d2p1:SettingOrder>
      <d2p1:SettingType>sample string 7</d2p1:SettingType>
    </d2p1:IntegratorSetting>
    <d2p1:IntegratorSetting>
      <d2p1:Description>sample string 8</d2p1:Description>
      <d2p1:IntegratorCompanyId>2</d2p1:IntegratorCompanyId>
      <d2p1:IntegratorSettingId>1</d2p1:IntegratorSettingId>
      <d2p1:IntegratorSettingTypeId>64</d2p1:IntegratorSettingTypeId>
      <d2p1:IsUnique>true</d2p1:IsUnique>
      <d2p1:Optional>true</d2p1:Optional>
      <d2p1:Parameters>sample string 9</d2p1:Parameters>
      <d2p1:SettingName>sample string 3</d2p1:SettingName>
      <d2p1:SettingOrder>10</d2p1:SettingOrder>
      <d2p1:SettingType>sample string 7</d2p1:SettingType>
    </d2p1:IntegratorSetting>
  </Settings>
</GetIntegratorSettingResponse>