ASP.NET Web API Help Page

GET nano/communication-methods?appId={appId}&employerId={employerId}&personId={personId}&userId={userId}&communicationMethodTypeId={communicationMethodTypeId}

Retrieves all communication methods associated with the account.

Request Information

URI Parameters

Name	Description	Type	Additional information
appId	The application identifier.	integer	None.
employerId	The employer identifier.	integer	None.
personId	The person identifier.	integer	None.
userId	The user identifier.	integer	None.
communicationMethodTypeId	The communication method type identifier.	integer	None.

Body Parameters

None.

Response Information

Resource Description

A list of communication methods.

Collection of Nano.CommunicationMethod

Name	Description	Type	Additional information
order	Gets or sets the order.	integer	None.
value	Gets or sets the value.	string	None.
id	Gets or sets the communication method identifier.	integer	None.
communicationMethodType	Gets or sets the communication method type identifier.	integer	None.
employer	Gets or sets the employer identifier.	integer	None.
person	Gets or sets the person identifier.	integer	None.
user	Gets or sets the user identifier.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "order": 1,
    "value": "sample String 1",
    "id": "2",
    "communicationMethodType": "3",
    "employer": "1",
    "person": "1",
    "user": "1"
  },
  {
    "order": 1,
    "value": "sample String 1",
    "id": "2",
    "communicationMethodType": "3",
    "employer": "1",
    "person": "1",
    "user": "1"
  }
]

text/html

Sample:

[{"order":1,"value":"sample String 1","id":"2","communicationMethodType":"3","employer":"1","person":"1","user":"1"},{"order":1,"value":"sample String 1","id":"2","communicationMethodType":"3","employer":"1","person":"1","user":"1"}]

application/xml, text/xml

Sample:

<ArrayOfCommunicationMethod xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CommunicationMethod>
    <Order>1</Order>
    <Value>sample String 1</Value>
    <CommunicationMethodId>2</CommunicationMethodId>
    <CommunicationMethodTypeId>3</CommunicationMethodTypeId>
    <EmployerId>1</EmployerId>
    <PersonId>1</PersonId>
    <UserId>1</UserId>
  </CommunicationMethod>
  <CommunicationMethod>
    <Order>1</Order>
    <Value>sample String 1</Value>
    <CommunicationMethodId>2</CommunicationMethodId>
    <CommunicationMethodTypeId>3</CommunicationMethodTypeId>
    <EmployerId>1</EmployerId>
    <PersonId>1</PersonId>
    <UserId>1</UserId>
  </CommunicationMethod>
</ArrayOfCommunicationMethod>

application/vnd.api+json

Sample:

Sample not available.