GET api/v1/organizations/config

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

SingleResultResponseOfOrganizationConfigDto
NameDescriptionTypeAdditional information
Meta

MetaSingleResult

None.

Notifications

None.

Response Formats

application/json, text/json

Sample:
{
  "meta": {},
  "notifications": [
    {},
    {}
  ],
  "result": {
    "emailIsRequired": true,
    "dniIsRequired": true,
    "mobilePhoneIsRequired": true,
    "emailIsUnique": true,
    "dniIsUnique": true,
    "mobilePhoneIsUnique": true,
    "smsCreditActivated": true,
    "emailCreditActivated": true,
    "pushCreditActivated": true,
    "subscriptionPlanId": "bd948a55-bd39-4739-b9c3-84310c6b6321",
    "subscriptionPlan": {
      "id": "0cd7f845-d3db-4208-9bfd-2e3135575ec6",
      "name": "sample string 2",
      "code": "sample string 3",
      "maxCommunicationRecipients": 4,
      "allowExportData": true,
      "maxCampaigns": 6,
      "recipientOverrideCost": 7.0,
      "changeCost": 8.0,
      "campaignProgrammingAllowed": true,
      "campaignTypeCategories": [
        {
          "id": "337450df-ccfb-413e-bff8-163d0db736ce",
          "code": "sample string 1",
          "name": "sample string 2"
        },
        {
          "id": "337450df-ccfb-413e-bff8-163d0db736ce",
          "code": "sample string 1",
          "name": "sample string 2"
        }
      ],
      "subscriptionPlanAutoCommunicationConfigsDto": [
        {
          "subscriptionPlanId": "3a5a6b5c-500b-4a93-a8df-72160d25b3e9",
          "autoCommunicationConfigCode": "sample string 2"
        },
        {
          "subscriptionPlanId": "3a5a6b5c-500b-4a93-a8df-72160d25b3e9",
          "autoCommunicationConfigCode": "sample string 2"
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:
<SingleResultResponseOfOrganizationConfigDtoaM_S85dVU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response">
  <Meta />
  <Notifications>
    <Notification />
    <Notification />
  </Notifications>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Domain.Dtos">
    <d2p1:DniIsRequired>true</d2p1:DniIsRequired>
    <d2p1:DniIsUnique>true</d2p1:DniIsUnique>
    <d2p1:EmailCreditActivated>true</d2p1:EmailCreditActivated>
    <d2p1:EmailIsRequired>true</d2p1:EmailIsRequired>
    <d2p1:EmailIsUnique>true</d2p1:EmailIsUnique>
    <d2p1:MobilePhoneIsRequired>true</d2p1:MobilePhoneIsRequired>
    <d2p1:MobilePhoneIsUnique>true</d2p1:MobilePhoneIsUnique>
    <d2p1:PushCreditActivated>true</d2p1:PushCreditActivated>
    <d2p1:SmsCreditActivated>true</d2p1:SmsCreditActivated>
    <d2p1:SubscriptionPlan>
      <d2p1:AllowExportData>true</d2p1:AllowExportData>
      <d2p1:CampaignProgrammingAllowed>true</d2p1:CampaignProgrammingAllowed>
      <d2p1:CampaignTypeCategories>
        <d2p1:CampaignTypeCategoryDto>
          <d2p1:Code>sample string 1</d2p1:Code>
          <d2p1:Id>337450df-ccfb-413e-bff8-163d0db736ce</d2p1:Id>
          <d2p1:Name>sample string 2</d2p1:Name>
        </d2p1:CampaignTypeCategoryDto>
        <d2p1:CampaignTypeCategoryDto>
          <d2p1:Code>sample string 1</d2p1:Code>
          <d2p1:Id>337450df-ccfb-413e-bff8-163d0db736ce</d2p1:Id>
          <d2p1:Name>sample string 2</d2p1:Name>
        </d2p1:CampaignTypeCategoryDto>
      </d2p1:CampaignTypeCategories>
      <d2p1:ChangeCost>8</d2p1:ChangeCost>
      <d2p1:Code>sample string 3</d2p1:Code>
      <d2p1:Id>0cd7f845-d3db-4208-9bfd-2e3135575ec6</d2p1:Id>
      <d2p1:MaxCampaigns>6</d2p1:MaxCampaigns>
      <d2p1:MaxCommunicationRecipients>4</d2p1:MaxCommunicationRecipients>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:RecipientOverrideCost>7</d2p1:RecipientOverrideCost>
      <d2p1:SubscriptionPlanAutoCommunicationConfigsDto>
        <d2p1:SubscriptionPlanAutoCommunicationConfigDto>
          <d2p1:AutoCommunicationConfigCode>sample string 2</d2p1:AutoCommunicationConfigCode>
          <d2p1:SubscriptionPlanId>3a5a6b5c-500b-4a93-a8df-72160d25b3e9</d2p1:SubscriptionPlanId>
        </d2p1:SubscriptionPlanAutoCommunicationConfigDto>
        <d2p1:SubscriptionPlanAutoCommunicationConfigDto>
          <d2p1:AutoCommunicationConfigCode>sample string 2</d2p1:AutoCommunicationConfigCode>
          <d2p1:SubscriptionPlanId>3a5a6b5c-500b-4a93-a8df-72160d25b3e9</d2p1:SubscriptionPlanId>
        </d2p1:SubscriptionPlanAutoCommunicationConfigDto>
      </d2p1:SubscriptionPlanAutoCommunicationConfigsDto>
    </d2p1:SubscriptionPlan>
    <d2p1:SubscriptionPlanId>bd948a55-bd39-4739-b9c3-84310c6b6321</d2p1:SubscriptionPlanId>
  </Result>
</SingleResultResponseOfOrganizationConfigDtoaM_S85dVU>