GET api/travel/day/search/name?name={name}&travelDateId={travelDateId}

Searches for persons by name within a specific travel date context. Performs a name-based search and returns matching persons associated with the travel date.

Request Information

URI Parameters

Name	Description	Type	Additional information
name	The name or partial name to search for. Query string parameter. Required.	string	Required
travelDateId	The unique identifier of the travel date to search within. Query string parameter. Required.	integer	Required

Body Parameters

None.

Response Information

Resource Description

Returns HTTP 200 (OK) with an array of SearchResult objects matching the name criteria.

Collection of SearchResult

Name	Type	Additional information
PersonID	integer	None.
Name	PersonName	None.
ObjectType	ObjectTypeFlag	None.
BunkName	string	None.
DivisionName	string	None.
AssignmentList	Collection of TransportationAssignment	None.
Age	string	None.
Gender	Gender	None.
IsSummerAddress	boolean	None.
FamilyID	integer	None.
IsFamily1	boolean	None.
IsPrincipalFamily	boolean	None.
AddressID	integer	None.
CommonBusStopID	integer	None.
CommonBusStopName	string	None.
Address	BLAddress	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PersonID": 1,
    "Name": {
      "LastName": "sample string 1",
      "FirstName": "sample string 2",
      "NickName": "sample string 3",
      "MaidenName": "sample string 4",
      "MiddleName": "sample string 5",
      "FullName": "sample string 2 sample string 1"
    },
    "ObjectType": 0,
    "BunkName": "sample string 1",
    "DivisionName": "sample string 2",
    "AssignmentList": null,
    "Age": "sample string 3",
    "Gender": 0,
    "IsSummerAddress": true,
    "FamilyID": 1,
    "IsFamily1": true,
    "IsPrincipalFamily": true,
    "AddressID": 1,
    "CommonBusStopID": 1,
    "CommonBusStopName": "sample string 5",
    "Address": {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "StateProvince": "sample string 4",
      "PostalCode": "sample string 5",
      "Country": "sample string 6",
      "Modified": true
    }
  },
  {
    "PersonID": 1,
    "Name": {
      "LastName": "sample string 1",
      "FirstName": "sample string 2",
      "NickName": "sample string 3",
      "MaidenName": "sample string 4",
      "MiddleName": "sample string 5",
      "FullName": "sample string 2 sample string 1"
    },
    "ObjectType": 0,
    "BunkName": "sample string 1",
    "DivisionName": "sample string 2",
    "AssignmentList": null,
    "Age": "sample string 3",
    "Gender": 0,
    "IsSummerAddress": true,
    "FamilyID": 1,
    "IsFamily1": true,
    "IsPrincipalFamily": true,
    "AddressID": 1,
    "CommonBusStopID": 1,
    "CommonBusStopName": "sample string 5",
    "Address": {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "StateProvince": "sample string 4",
      "PostalCode": "sample string 5",
      "Country": "sample string 6",
      "Modified": true
    }
  }
]

application/javascript

Sample:

[{"PersonID":1,"Name":{"LastName":"sample string 1","FirstName":"sample string 2","NickName":"sample string 3","MaidenName":"sample string 4","MiddleName":"sample string 5","FullName":"sample string 2 sample string 1"},"ObjectType":0,"BunkName":"sample string 1","DivisionName":"sample string 2","AssignmentList":null,"Age":"sample string 3","Gender":0,"IsSummerAddress":true,"FamilyID":1,"IsFamily1":true,"IsPrincipalFamily":true,"AddressID":1,"CommonBusStopID":1,"CommonBusStopName":"sample string 5","Address":{"AddressLine1":"sample string 1","AddressLine2":"sample string 2","City":"sample string 3","StateProvince":"sample string 4","PostalCode":"sample string 5","Country":"sample string 6","Modified":true}},{"PersonID":1,"Name":{"LastName":"sample string 1","FirstName":"sample string 2","NickName":"sample string 3","MaidenName":"sample string 4","MiddleName":"sample string 5","FullName":"sample string 2 sample string 1"},"ObjectType":0,"BunkName":"sample string 1","DivisionName":"sample string 2","AssignmentList":null,"Age":"sample string 3","Gender":0,"IsSummerAddress":true,"FamilyID":1,"IsFamily1":true,"IsPrincipalFamily":true,"AddressID":1,"CommonBusStopID":1,"CommonBusStopName":"sample string 5","Address":{"AddressLine1":"sample string 1","AddressLine2":"sample string 2","City":"sample string 3","StateProvince":"sample string 4","PostalCode":"sample string 5","Country":"sample string 6","Modified":true}}]