VitalWare API

Entity

To override the Content-type in your clients, use the 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/Entity HTTP/1.1 
Host: api.vitalware.com 
Content-Type: application/xml
Content-Length: length

<Entity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">
  <AddressSecond>String</AddressSecond>
  <AddressStreet>String</AddressStreet>
  <City>String</City>
  <EmailAddress>String</EmailAddress>
  <EntityName>String</EntityName>
  <IsTest>false</IsTest>
  <IsTrial>false</IsTrial>
  <ParentEntityId>0</ParentEntityId>
  <PhoneExt>String</PhoneExt>
  <PhoneNumber>String</PhoneNumber>
  <PostalCode>String</PostalCode>
  <State>String</State>
  <Url>String</Url>
</Entity>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EntityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">
  <EntityId>0</EntityId>
  <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>
</EntityResponse>