GET api/Zone/{zone_handle}/Contact?user={user}

Get contacts allocated to the zone object

Request Information

URI Parameters

NameDescriptionTypeAdditional information
zone_handle

Handle of the zone

 string

Required
user

Optional user handle - if empty logged in user will be used

 string

None.

Body Parameters

None.

Response Information

Resource Description

List of contacts on success
Collection of errors on failure
Return codes
200 - ok
401 - unauthorized
404 - not found
500 - internal server error

Collection of ZoneContact
NameDescriptionTypeAdditional information
RegName

Registrant name

string

None.
Type

Contact type

string

None.
Handle

Contact handle

string

None.
Entity

Entity type, 1 organization, 2 individual

integer

None.
OrgName

Organization name

string

Matching regular expression pattern: [A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&@[\]\/^_`|}{]{1,150}

String length: inclusive between 1 and 150
LastName

Last name

string

Matching regular expression pattern: [A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&@[\]\/^_`|}{]{1,150}

String length: inclusive between 1 and 150
FirstName

First name

string

Matching regular expression pattern: [A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&@[\]\/^_`|}{]{1,150}

String length: inclusive between 1 and 150
Address

Address line 1

string

Matching regular expression pattern: ^(?![A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&[\]\/^_`|}{]*\b([bB][pP]|[cC][eE][dD][eE][xX])\b)[A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&[\]\/^_`|}{]*$

String length: inclusive between 1 and 250
Address2

Address line 2

string

Matching regular expression pattern: ^(?![A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&[\]\/^_`|}{]*\b([bB][pP]|[cC][eE][dD][eE][xX])\b)[A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&[\]\/^_`|}{]*$

String length: inclusive between 1 and 250
City

string

Matching regular expression pattern: ^(?![A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&[\]\/^_`|}{]*\b([bB][pP]|[cC][eE][dD][eE][xX])\b)[A-Za-z0-9áàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀÂÄÃÅÇÉÈÊËÍÌÎÏÑÓÒÔÖÕÚÙÛÜÝŸÆŒß \.!#$%'()*+,:;=\-?&[\]\/^_`|}{]*$

String length: inclusive between 1 and 150
Pc

Post code

string

Matching regular expression pattern: [ a-zA-Z0-9._/-]{1,30}

String length: inclusive between 1 and 30
Cc

ISO 2 char country code

string

Matching regular expression pattern: [A-Za-z]{2}

String length: inclusive between 2 and 2
Sp

string

Matching regular expression pattern: [A-Za-z0-9 \.\-!#$%'()*+,:;=?@[\]\/^_`|}{]{0,80}

String length: inclusive between 1 and 80
Phone

Phone number

string

Matching regular expression pattern: \+[0-9]{1,3}\.[0-9]{1,15}
Fax

Fax number

string

Matching regular expression pattern: \+[0-9]{1,3}\.[0-9]{1,15}
MailAddress

Email address

string

Matching regular expression pattern: [0-9a-zA-Z_\.-]+@(([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-zA-Z][A-Z0-9a-z-]*[0-9a-zA-Z]\.)+[a-zA-Z]{2,20})

String length: inclusive between 1 and 200
groupePrixID

Price group id

decimal number

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "RegName": "sample string 1",
    "Type": "sample string 2",
    "Handle": "sample string 3",
    "Entity": 4,
    "OrgName": "sample string 5",
    "LastName": "sample string 6",
    "FirstName": "sample string 7",
    "Address": "sample string 8",
    "Address2": "sample string 9",
    "City": "sample string 10",
    "Pc": "sample string 11",
    "Cc": "sample string 12",
    "Sp": "sample string 13",
    "Phone": "sample string 14",
    "Fax": "sample string 15",
    "MailAddress": "sample string 16",
    "groupePrixID": 1.0
  },
  {
    "RegName": "sample string 1",
    "Type": "sample string 2",
    "Handle": "sample string 3",
    "Entity": 4,
    "OrgName": "sample string 5",
    "LastName": "sample string 6",
    "FirstName": "sample string 7",
    "Address": "sample string 8",
    "Address2": "sample string 9",
    "City": "sample string 10",
    "Pc": "sample string 11",
    "Cc": "sample string 12",
    "Sp": "sample string 13",
    "Phone": "sample string 14",
    "Fax": "sample string 15",
    "MailAddress": "sample string 16",
    "groupePrixID": 1.0
  }
]

application/xml, text/xml

Sample: 
<ArrayOfContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Zone">
  <Contact>
    <Address xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 8</Address>
    <Address2 xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 9</Address2>
    <Cc xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 12</Cc>
    <City xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 10</City>
    <Entity xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">4</Entity>
    <Fax xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 15</Fax>
    <FirstName xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 7</FirstName>
    <Handle xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 3</Handle>
    <LastName xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 6</LastName>
    <MailAddress xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 16</MailAddress>
    <OrgName xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 5</OrgName>
    <Pc xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 11</Pc>
    <Phone xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 14</Phone>
    <Sp xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 13</Sp>
    <groupePrixID xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">1</groupePrixID>
    <RegName>sample string 1</RegName>
    <Type>sample string 2</Type>
  </Contact>
  <Contact>
    <Address xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 8</Address>
    <Address2 xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 9</Address2>
    <Cc xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 12</Cc>
    <City xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 10</City>
    <Entity xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">4</Entity>
    <Fax xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 15</Fax>
    <FirstName xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 7</FirstName>
    <Handle xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 3</Handle>
    <LastName xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 6</LastName>
    <MailAddress xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 16</MailAddress>
    <OrgName xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 5</OrgName>
    <Pc xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 11</Pc>
    <Phone xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 14</Phone>
    <Sp xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">sample string 13</Sp>
    <groupePrixID xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Contact">1</groupePrixID>
    <RegName>sample string 1</RegName>
    <Type>sample string 2</Type>
  </Contact>
</ArrayOfContact>