GET api/contactstatuses?inactive={inactive}

Get all ContactStatuses optionally filtered by any of the arguments specified in the query string.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
inactive

Filter indicating whether to retrieve active or inactive records.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

ContactStatusDto
NameDescriptionTypeAdditional information
Id

The primary key of the record in the Hobsons database.

integer

None.

Name

string

Required

String length: inclusive between 0 and 100

Code

The client's system code for this record.

string

Required

String length: inclusive between 0 and 100

IsDefault

Indicates if this record represents the default status.

boolean

Required

Inactive

boolean

Required

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "Code": "sample string 3",
  "IsDefault": true,
  "Inactive": true
}