Bombshell Agency Platform Service

<back to all web services

ContactManagementSearchRequest

The following routes are available for this service:
GET,OPTIONS/v1/ContactManagement/Search/{SearchTerm}
GET,OPTIONS/v1/ContactManagement/Search

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/ContactManagementSearchRequest HTTP/1.1 
Host: api.exactbenefits.com 
Content-Type: application/xml
Content-Length: length

<ContactManagementSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal.Routes">
  <SearchTerm>String</SearchTerm>
</ContactManagementSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContactManagementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal.Routes">
  <ConflictDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal.Objects">
    <d2p1:ContactMergeConflictDetail>
      <d2p1:ConflictingProperty>String</d2p1:ConflictingProperty>
      <d2p1:GroupKey>String</d2p1:GroupKey>
    </d2p1:ContactMergeConflictDetail>
  </ConflictDetails>
  <Contacts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal.Objects">
    <d2p1:ContactManagementViewModel>
      <d2p1:Address_City>String</d2p1:Address_City>
      <d2p1:Address_Line1>String</d2p1:Address_Line1>
      <d2p1:Address_State>String</d2p1:Address_State>
      <d2p1:Address_Zip>String</d2p1:Address_Zip>
      <d2p1:ContactId>0</d2p1:ContactId>
      <d2p1:ContactType>0</d2p1:ContactType>
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
      <d2p1:Deleted>false</d2p1:Deleted>
      <d2p1:District>String</d2p1:District>
      <d2p1:DoNotContact>false</d2p1:DoNotContact>
      <d2p1:EmailPersonal>String</d2p1:EmailPersonal>
      <d2p1:EmailWork>String</d2p1:EmailWork>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:FullName>String</d2p1:FullName>
      <d2p1:GroupKey>String</d2p1:GroupKey>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:MID>String</d2p1:MID>
      <d2p1:MedicareIdNumber>String</d2p1:MedicareIdNumber>
      <d2p1:MiddleInitial>String</d2p1:MiddleInitial>
      <d2p1:Phone>String</d2p1:Phone>
      <d2p1:PhoneAlt>String</d2p1:PhoneAlt>
      <d2p1:SSN>String</d2p1:SSN>
      <d2p1:School>String</d2p1:School>
      <d2p1:State>String</d2p1:State>
      <d2p1:Suffix>String</d2p1:Suffix>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:ContactManagementViewModel>
  </Contacts>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
</ContactManagementResponse>