Documentation for GET api/users/customer/MiscFieldSearch

GET api/users/customer/MiscFieldSearch

This API method will allow you to search customers for a specified Misc field and return a list of matching Customer IDs

Request Information

URI Parameters

None.

Body Parameters

Model to hold misc field information tos earch (name and value).

MiscFieldSearch

Name	Description	Type	Additional information
FieldName		string	None.
ValueToSearch		string	None.

Request Formats

application/xml, text/xml

Sample:

<MiscFieldSearch>
  <FieldName>sample string 1</FieldName>
  <ValueToSearch>sample string 2</ValueToSearch>
</MiscFieldSearch>

application/json, text/json

Sample:

{
  "FieldName": "sample string 1",
  "ValueToSearch": "sample string 2"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'MiscFieldSearch'.

Response Information

Resource Description

Collection of GenericEntity

Name	Description	Type	Additional information
ID	The ID that was found	integer	None.
EntityID	The Entity # that was found	string	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfGenericEntity>
  <GenericEntity>
    <ID>1</ID>
    <EntityID>sample string 2</EntityID>
  </GenericEntity>
  <GenericEntity>
    <ID>1</ID>
    <EntityID>sample string 2</EntityID>
  </GenericEntity>
</ListOfGenericEntity>

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "EntityID": "sample string 2"
  },
  {
    "ID": 1,
    "EntityID": "sample string 2"
  }
]