POST api/SaveCompanyCredential

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Type	string	None.
Code	string	None.
IsActive	boolean	None.
Credential	NotificationCredentialVm	None.
RawCredential	Object	None.
UserCompanyCredentials	Collection of UserCompanyCredentialsVm	None.

Request Formats

application/json, text/json

Sample:

{
  "Type": "sample string 1",
  "Code": "sample string 2",
  "IsActive": true,
  "Credential": {
    "ApiKey": "sample string 1",
    "FromNumber": "sample string 2",
    "Sender": "sample string 3",
    "AppId": "sample string 4",
    "AccessToken": "sample string 5",
    "ApiEndpoint": "sample string 6",
    "ApiToken": "sample string 7",
    "ApiSubDomain": "sample string 8",
    "AccountSID": "sample string 9",
    "CallerId": "sample string 10",
    "HasUserWiseEmail": true,
    "FromEmail": "sample string 12",
    "FromEmailName": "sample string 13",
    "ReplyToEmail": "sample string 14",
    "HostUrl": "sample string 15",
    "HostPort": 16,
    "Password": "sample string 17",
    "VirtualNumber": "sample string 18",
    "id": "sample string 19",
    "name": "sample string 20",
    "email": "sample string 21",
    "authToken": "sample string 22"
  },
  "RawCredential": {},
  "UserCompanyCredentials": [
    {
      "CompanyCredentialId": 1,
      "Type": "sample string 2",
      "TypeId": "sample string 3",
      "SubType": "sample string 4",
      "SubTypeId": "sample string 5",
      "IsActive": true
    },
    {
      "CompanyCredentialId": 1,
      "Type": "sample string 2",
      "TypeId": "sample string 3",
      "SubType": "sample string 4",
      "SubTypeId": "sample string 5",
      "IsActive": true
    }
  ]
}

application/xml, text/xml

Sample:

<SaveCompanyCredentialVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Services.SuperAdmin">
  <Code>sample string 2</Code>
  <Credential xmlns:d2p1="http://schemas.datacontract.org/2004/07/BrokerServer.Api">
    <d2p1:AccessToken>sample string 5</d2p1:AccessToken>
    <d2p1:AccountSID>sample string 9</d2p1:AccountSID>
    <d2p1:ApiEndpoint>sample string 6</d2p1:ApiEndpoint>
    <d2p1:ApiKey>sample string 1</d2p1:ApiKey>
    <d2p1:ApiSubDomain>sample string 8</d2p1:ApiSubDomain>
    <d2p1:ApiToken>sample string 7</d2p1:ApiToken>
    <d2p1:AppId>sample string 4</d2p1:AppId>
    <d2p1:CallerId>sample string 10</d2p1:CallerId>
    <d2p1:FromEmail>sample string 12</d2p1:FromEmail>
    <d2p1:FromEmailName>sample string 13</d2p1:FromEmailName>
    <d2p1:FromNumber>sample string 2</d2p1:FromNumber>
    <d2p1:HasUserWiseEmail>true</d2p1:HasUserWiseEmail>
    <d2p1:HostPort>16</d2p1:HostPort>
    <d2p1:HostUrl>sample string 15</d2p1:HostUrl>
    <d2p1:Password>sample string 17</d2p1:Password>
    <d2p1:ReplyToEmail>sample string 14</d2p1:ReplyToEmail>
    <d2p1:Sender>sample string 3</d2p1:Sender>
    <d2p1:VirtualNumber>sample string 18</d2p1:VirtualNumber>
    <d2p1:authToken>sample string 22</d2p1:authToken>
    <d2p1:email>sample string 21</d2p1:email>
    <d2p1:id>sample string 19</d2p1:id>
    <d2p1:name>sample string 20</d2p1:name>
  </Credential>
  <IsActive>true</IsActive>
  <RawCredential />
  <Type>sample string 1</Type>
  <UserCompanyCredentials>
    <UserCompanyCredentialsVm>
      <CompanyCredentialId>1</CompanyCredentialId>
      <IsActive>true</IsActive>
      <SubType>sample string 4</SubType>
      <SubTypeId>sample string 5</SubTypeId>
      <Type>sample string 2</Type>
      <TypeId>sample string 3</TypeId>
    </UserCompanyCredentialsVm>
    <UserCompanyCredentialsVm>
      <CompanyCredentialId>1</CompanyCredentialId>
      <IsActive>true</IsActive>
      <SubType>sample string 4</SubType>
      <SubTypeId>sample string 5</SubTypeId>
      <Type>sample string 2</Type>
      <TypeId>sample string 3</TypeId>
    </UserCompanyCredentialsVm>
  </UserCompanyCredentials>
</SaveCompanyCredentialVm>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SaveCompanyCredentialVm'.

Response Information

Resource Description

Response

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Description	string	None.
Data	Object	None.
Count	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Description": "sample string 3",
  "Data": {},
  "Count": 5
}

application/xml, text/xml

Sample:

<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Models">
  <Count>5</Count>
  <Data />
  <Description>sample string 3</Description>
  <Message>sample string 2</Message>
  <Success>true</Success>
</Response>