NameSvc

Click here for a complete list of operations.

FormatPersonName

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /SingleView/Common/Formatting/NameSvc.asmx HTTP/1.1
Host: www.simplicitycrm.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://services.simplicitycrm.com/passport/FormatPersonName"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FormatPersonName xmlns="http://services.simplicitycrm.com/passport">
      <Token>string</Token>
      <Name>string</Name>
    </FormatPersonName>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FormatPersonNameResponse xmlns="http://services.simplicitycrm.com/passport">
      <FormatPersonNameResult>
        <ErrorCode>int</ErrorCode>
        <Result>
          <DisplayValue>string</DisplayValue>
          <FirstName>string</FirstName>
          <PreferredNameOrFirstName>string</PreferredNameOrFirstName>
          <MiddleName>string</MiddleName>
          <Surname>string</Surname>
          <NameBadge>string</NameBadge>
          <Initials>string</Initials>
          <PreferredNameInitials>string</PreferredNameInitials>
          <Title>string</Title>
          <Salutation>string</Salutation>
          <PreferredNameSalutation>string</PreferredNameSalutation>
          <LetterCarrier>string</LetterCarrier>
          <PreferredNameLetterCarrier>string</PreferredNameLetterCarrier>
          <InitialisedLetterCarrier>string</InitialisedLetterCarrier>
          <PreferredNameInitialisedLetterCarrier>string</PreferredNameInitialisedLetterCarrier>
          <PreferredName>string</PreferredName>
          <PreferredNameDisplayValue>string</PreferredNameDisplayValue>
          <PreferredNameInBracketsDisplayValue>string</PreferredNameInBracketsDisplayValue>
          <FullLetterCarrier>string</FullLetterCarrier>
          <PreferredNameFullLetterCarrier>string</PreferredNameFullLetterCarrier>
          <Decoration>string</Decoration>
          <Gender>Male or Female or Unknown</Gender>
        </Result>
      </FormatPersonNameResult>
    </FormatPersonNameResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /SingleView/Common/Formatting/NameSvc.asmx HTTP/1.1
Host: www.simplicitycrm.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FormatPersonName xmlns="http://services.simplicitycrm.com/passport">
      <Token>string</Token>
      <Name>string</Name>
    </FormatPersonName>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FormatPersonNameResponse xmlns="http://services.simplicitycrm.com/passport">
      <FormatPersonNameResult>
        <ErrorCode>int</ErrorCode>
        <Result>
          <DisplayValue>string</DisplayValue>
          <FirstName>string</FirstName>
          <PreferredNameOrFirstName>string</PreferredNameOrFirstName>
          <MiddleName>string</MiddleName>
          <Surname>string</Surname>
          <NameBadge>string</NameBadge>
          <Initials>string</Initials>
          <PreferredNameInitials>string</PreferredNameInitials>
          <Title>string</Title>
          <Salutation>string</Salutation>
          <PreferredNameSalutation>string</PreferredNameSalutation>
          <LetterCarrier>string</LetterCarrier>
          <PreferredNameLetterCarrier>string</PreferredNameLetterCarrier>
          <InitialisedLetterCarrier>string</InitialisedLetterCarrier>
          <PreferredNameInitialisedLetterCarrier>string</PreferredNameInitialisedLetterCarrier>
          <PreferredName>string</PreferredName>
          <PreferredNameDisplayValue>string</PreferredNameDisplayValue>
          <PreferredNameInBracketsDisplayValue>string</PreferredNameInBracketsDisplayValue>
          <FullLetterCarrier>string</FullLetterCarrier>
          <PreferredNameFullLetterCarrier>string</PreferredNameFullLetterCarrier>
          <Decoration>string</Decoration>
          <Gender>Male or Female or Unknown</Gender>
        </Result>
      </FormatPersonNameResult>
    </FormatPersonNameResponse>
  </soap12:Body>
</soap12:Envelope>

JSON

The following is a sample JSON request and response. The placeholders shown need to be replaced with actual values.

POST /SingleView/api/Common/Formatting/NameSvc/FormatPersonName HTTP/1.1
Host: www.simplicitycrm.com
Content-Type: application/json; charset=utf-8
Content-Length: length
Authorization: Token string

{
  "Name":string,
},

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

{
  "ErrorCode":int,
  "Result":{
    "DisplayValue":string,
    "FirstName":string,
    "PreferredNameOrFirstName":string,
    "MiddleName":string,
    "Surname":string,
    "NameBadge":string,
    "Initials":string,
    "PreferredNameInitials":string,
    "Title":string,
    "Salutation":string,
    "PreferredNameSalutation":string,
    "LetterCarrier":string,
    "PreferredNameLetterCarrier":string,
    "InitialisedLetterCarrier":string,
    "PreferredNameInitialisedLetterCarrier":string,
    "PreferredName":string,
    "PreferredNameDisplayValue":string,
    "PreferredNameInBracketsDisplayValue":string,
    "FullLetterCarrier":string,
    "PreferredNameFullLetterCarrier":string,
    "Decoration":string,
    "Gender":"Male" or "Female" or "Unknown",
  },
},