POST api/AutomaticOnBoarding/Agency

Agency creation

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Denomination	string	Required Max length: 150
Address	string	Required Max length: 250
Cap	string	Required Matching regular expression pattern: ^\d{5}$
City	string	Required Max length: 150
Province	string	Required Matching regular expression pattern: ^[A-Za-z]{2,4}$
Country	string	Required Max length: 2 String length: inclusive between 0 and 2
Region	string	Max length: 150
Email	string	Required Matching regular expression pattern: ^[a-zA-Z0-9._-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}$
Mobile	string	Required Matching regular expression pattern: ^\+?[0-9]*$
Telephone	string	Required Matching regular expression pattern: ^\+?[0-9]*$
FiscalCode	string	Matching regular expression pattern: ^[A-Za-z0-9]{16}$
VatNumber	string	Required Matching regular expression pattern: ^[0-9]{11}$
Ateco	string	Matching regular expression pattern: ^[0-9]{2}(\.[0-9]{1,2}){0,2}$
NetworkId	integer	Required
OperationalAgencies	Collection of OperationalAgency	None.
Referal	Refereral	Required

Request Formats

application/json, text/json

Sample:

{
  "Denomination": "sample string 1",
  "Address": "sample string 2",
  "Cap": "sample string 3",
  "City": "sample string 4",
  "Province": "sample string 5",
  "Country": "sample string 6",
  "Region": "sample string 7",
  "Email": "sample string 8",
  "Mobile": "sample string 9",
  "Telephone": "sample string 10",
  "FiscalCode": "sample string 11",
  "VatNumber": "sample string 12",
  "Ateco": "sample string 13",
  "NetworkId": 14,
  "OperationalAgencies": [
    {
      "Denomination": "sample string 1",
      "Email": "sample string 2",
      "Telephone": "sample string 3",
      "Address": "sample string 4",
      "Cap": "sample string 5",
      "City": "sample string 6",
      "Province": "sample string 7",
      "Country": "sample string 8",
      "Region": "sample string 9",
      "TwoLetterISOLanguageName": "sample string 10",
      "Referal": {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "FiscalCode": "sample string 3",
        "Email": "sample string 4",
        "Telephone": "sample string 5",
        "Mobile": "sample string 6"
      }
    },
    {
      "Denomination": "sample string 1",
      "Email": "sample string 2",
      "Telephone": "sample string 3",
      "Address": "sample string 4",
      "Cap": "sample string 5",
      "City": "sample string 6",
      "Province": "sample string 7",
      "Country": "sample string 8",
      "Region": "sample string 9",
      "TwoLetterISOLanguageName": "sample string 10",
      "Referal": {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "FiscalCode": "sample string 3",
        "Email": "sample string 4",
        "Telephone": "sample string 5",
        "Mobile": "sample string 6"
      }
    }
  ],
  "Referal": {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "FiscalCode": "sample string 3",
    "Email": "sample string 4",
    "Telephone": "sample string 5",
    "Mobile": "sample string 6"
  }
}

application/xml, text/xml

Sample:

<AgencyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutomaticOnboarding.Models">
  <Address>sample string 2</Address>
  <Ateco>sample string 13</Ateco>
  <Cap>sample string 3</Cap>
  <City>sample string 4</City>
  <Country>sample string 6</Country>
  <Denomination>sample string 1</Denomination>
  <Email>sample string 8</Email>
  <FiscalCode>sample string 11</FiscalCode>
  <Mobile>sample string 9</Mobile>
  <NetworkId>14</NetworkId>
  <OperationalAgencies>
    <OperationalAgency>
      <Address>sample string 4</Address>
      <Cap>sample string 5</Cap>
      <City>sample string 6</City>
      <Country>sample string 8</Country>
      <Denomination>sample string 1</Denomination>
      <Email>sample string 2</Email>
      <Province>sample string 7</Province>
      <Referal>
        <Email>sample string 4</Email>
        <FirstName>sample string 1</FirstName>
        <FiscalCode>sample string 3</FiscalCode>
        <LastName>sample string 2</LastName>
        <Mobile>sample string 6</Mobile>
        <Telephone>sample string 5</Telephone>
      </Referal>
      <Region>sample string 9</Region>
      <Telephone>sample string 3</Telephone>
      <TwoLetterISOLanguageName>sample string 10</TwoLetterISOLanguageName>
    </OperationalAgency>
    <OperationalAgency>
      <Address>sample string 4</Address>
      <Cap>sample string 5</Cap>
      <City>sample string 6</City>
      <Country>sample string 8</Country>
      <Denomination>sample string 1</Denomination>
      <Email>sample string 2</Email>
      <Province>sample string 7</Province>
      <Referal>
        <Email>sample string 4</Email>
        <FirstName>sample string 1</FirstName>
        <FiscalCode>sample string 3</FiscalCode>
        <LastName>sample string 2</LastName>
        <Mobile>sample string 6</Mobile>
        <Telephone>sample string 5</Telephone>
      </Referal>
      <Region>sample string 9</Region>
      <Telephone>sample string 3</Telephone>
      <TwoLetterISOLanguageName>sample string 10</TwoLetterISOLanguageName>
    </OperationalAgency>
  </OperationalAgencies>
  <Province>sample string 5</Province>
  <Referal>
    <Email>sample string 4</Email>
    <FirstName>sample string 1</FirstName>
    <FiscalCode>sample string 3</FiscalCode>
    <LastName>sample string 2</LastName>
    <Mobile>sample string 6</Mobile>
    <Telephone>sample string 5</Telephone>
  </Referal>
  <Region>sample string 7</Region>
  <Telephone>sample string 10</Telephone>
  <VatNumber>sample string 12</VatNumber>
</AgencyRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AgencyResponse

Name	Description	Type	Additional information
agencyId		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "agencyId": 1
}

application/xml, text/xml

Sample:

<AgencyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutomaticOnboarding.Models">
  <AgencyId>1</AgencyId>
</AgencyResponse>