POST api/General/GetIntegratorCompany

Request Information

URI Parameters

None.

Body Parameters

GetIntegratorCompanyRequest
NameDescriptionTypeAdditional information
IntegratorCompanyTypeId

integer

None.

Token

string

None.

Request Formats

application/json, text/json

Sample:
{
  "IntegratorCompanyTypeId": 1,
  "Token": "sample string 2"
}

application/xml, text/xml

Sample:
<GetIntegratorCompanyRequest 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>
  <IntegratorCompanyTypeId>1</IntegratorCompanyTypeId>
</GetIntegratorCompanyRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetIntegratorCompanyResponse
NameDescriptionTypeAdditional information
Companies

Collection of IntegratorCompany

None.

ErrorCode

string

None.

ErrorMessage

string

None.

ErrorCategory

string

None.

Result

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Companies": [
    {
      "IntegratorCompanyId": 1,
      "IntegratorCompanyTypeId": 2,
      "Name": "sample string 3",
      "DisplayName": "sample string 4",
      "IntegratorCompanyStatusId": 64
    },
    {
      "IntegratorCompanyId": 1,
      "IntegratorCompanyTypeId": 2,
      "Name": "sample string 3",
      "DisplayName": "sample string 4",
      "IntegratorCompanyStatusId": 64
    }
  ],
  "ErrorCode": "sample string 1",
  "ErrorMessage": "sample string 2",
  "ErrorCategory": "sample string 3",
  "Result": true
}

application/xml, text/xml

Sample:
<GetIntegratorCompanyResponse 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>
  <Companies xmlns:d2p1="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Integrator">
    <d2p1:IntegratorCompany>
      <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
      <d2p1:IntegratorCompanyId>1</d2p1:IntegratorCompanyId>
      <d2p1:IntegratorCompanyStatusId>64</d2p1:IntegratorCompanyStatusId>
      <d2p1:IntegratorCompanyTypeId>2</d2p1:IntegratorCompanyTypeId>
      <d2p1:Name>sample string 3</d2p1:Name>
    </d2p1:IntegratorCompany>
    <d2p1:IntegratorCompany>
      <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
      <d2p1:IntegratorCompanyId>1</d2p1:IntegratorCompanyId>
      <d2p1:IntegratorCompanyStatusId>64</d2p1:IntegratorCompanyStatusId>
      <d2p1:IntegratorCompanyTypeId>2</d2p1:IntegratorCompanyTypeId>
      <d2p1:Name>sample string 3</d2p1:Name>
    </d2p1:IntegratorCompany>
  </Companies>
</GetIntegratorCompanyResponse>