GET api/v{version}/contacttypes

Gets the list of all available contact types in the paratransit application.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

The requested API version

 string

Required

Default value is 2.0

Body Parameters

None.

Response Information

Resource Description

Returns the list of contact types.

Collection of ContactType
NameDescriptionTypeAdditional information
Code

Gets or sets the code that can be used to identify the contact method.

 string

None.
Name

Gets or sets the friendly name of the contact method.

 string

None.
Type

Gets or sets whether this kind of contact method is through phone or email.

 CommunicationMethod

None.

Response Formats

application/json, text/json, application/problem+json

Sample: 
[
  {
    "code": "Work",
    "name": "Work Phone",
    "type": 0
  },
  {
    "code": "Home",
    "name": "Home Phone",
    "type": 0
  },
  {
    "code": "Cell",
    "name": "Personal Mobile",
    "type": 0
  },
  {
    "code": "Email",
    "name": "E-mail",
    "type": 1
  }
]

application/xml, text/xml

Sample: 
<ArrayOfContactType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <ContactType>
    <Code>Work</Code>
    <Name>Work Phone</Name>
    <Type>Phone</Type>
  </ContactType>
  <ContactType>
    <Code>Home</Code>
    <Name>Home Phone</Name>
    <Type>Phone</Type>
  </ContactType>
  <ContactType>
    <Code>Cell</Code>
    <Name>Personal Mobile</Name>
    <Type>Phone</Type>
  </ContactType>
  <ContactType>
    <Code>Email</Code>
    <Name>E-mail</Name>
    <Type>Email</Type>
  </ContactType>
</ArrayOfContactType>