BRAppraisal ServiceStack

<back to all web services

AgentRequest

The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Agent
GET/v1/Agent/{AgentId}

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/AgentRequest HTTP/1.1 
Host: api.batonrougeappraisal.com 
Content-Type: application/xml
Content-Length: length

<AgentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BRAppraisalServiceStackLibrary">
  <Agent>
    <Agent>
      <AcceptAllAppts>false</AcceptAllAppts>
      <AgentId>0</AgentId>
      <AgentLevel>0</AgentLevel>
      <AgreementContent>String</AgreementContent>
      <AgreementDate>0001-01-01T00:00:00</AgreementDate>
      <AgreementValue>String</AgreementValue>
      <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
      <ApptDetailVisibilityMinutes>0</ApptDetailVisibilityMinutes>
      <AsapLockOut>false</AsapLockOut>
      <AsapLockOutDate>0001-01-01T00:00:00</AsapLockOutDate>
      <AsapOptIn>false</AsapOptIn>
      <AsapOptOut>false</AsapOptOut>
      <AsapOptOutNote>String</AsapOptOutNote>
      <AsapOptOutReturnDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </AsapOptOutReturnDate>
      <AsapOptOutStatewide>false</AsapOptOutStatewide>
      <AsapWeeklyAppts>0</AsapWeeklyAppts>
      <CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
      <CompanyAssociation>String</CompanyAssociation>
      <CompanyId>0</CompanyId>
      <Customer>false</Customer>
      <DOB>String</DOB>
      <Email>String</Email>
      <EmailSignature>String</EmailSignature>
      <FaceToFaceAppts>false</FaceToFaceAppts>
      <FirstName>String</FirstName>
      <GoogleCalendar>String</GoogleCalendar>
      <HasNewAgreement>false</HasNewAgreement>
      <IsAsapRestricted>false</IsAsapRestricted>
      <LastName>String</LastName>
      <Latitude>0</Latitude>
      <Longitude>0</Longitude>
      <OptOutDate>0001-01-01T00:00:00</OptOutDate>
      <PaymentPlan>String</PaymentPlan>
      <ProfileImage>AA==</ProfileImage>
      <ReferredBy>String</ReferredBy>
      <RegistrantNumber>String</RegistrantNumber>
      <SSN>String</SSN>
      <SaturdayAppts>false</SaturdayAppts>
      <SplitAgentId>0</SplitAgentId>
      <StatusFollowUpDate>0001-01-01T00:00:00</StatusFollowUpDate>
      <StatusId>0</StatusId>
      <StatusNote>String</StatusNote>
      <Subscription>String</Subscription>
      <SubscriptionFee>0</SubscriptionFee>
      <SundayAppts>false</SundayAppts>
      <TimeZone>String</TimeZone>
      <UserId>00000000-0000-0000-0000-000000000000</UserId>
      <VCAppts>false</VCAppts>
      <VendorType>String</VendorType>
    </Agent>
  </Agent>
  <AgentId>0</AgentId>
</AgentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BRAppraisalServiceStackLibrary">
  <Agent>
    <Agent>
      <AcceptAllAppts>false</AcceptAllAppts>
      <AgentId>0</AgentId>
      <AgentLevel>0</AgentLevel>
      <AgreementContent>String</AgreementContent>
      <AgreementDate>0001-01-01T00:00:00</AgreementDate>
      <AgreementValue>String</AgreementValue>
      <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
      <ApptDetailVisibilityMinutes>0</ApptDetailVisibilityMinutes>
      <AsapLockOut>false</AsapLockOut>
      <AsapLockOutDate>0001-01-01T00:00:00</AsapLockOutDate>
      <AsapOptIn>false</AsapOptIn>
      <AsapOptOut>false</AsapOptOut>
      <AsapOptOutNote>String</AsapOptOutNote>
      <AsapOptOutReturnDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </AsapOptOutReturnDate>
      <AsapOptOutStatewide>false</AsapOptOutStatewide>
      <AsapWeeklyAppts>0</AsapWeeklyAppts>
      <CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
      <CompanyAssociation>String</CompanyAssociation>
      <CompanyId>0</CompanyId>
      <Customer>false</Customer>
      <DOB>String</DOB>
      <Email>String</Email>
      <EmailSignature>String</EmailSignature>
      <FaceToFaceAppts>false</FaceToFaceAppts>
      <FirstName>String</FirstName>
      <GoogleCalendar>String</GoogleCalendar>
      <HasNewAgreement>false</HasNewAgreement>
      <IsAsapRestricted>false</IsAsapRestricted>
      <LastName>String</LastName>
      <Latitude>0</Latitude>
      <Longitude>0</Longitude>
      <OptOutDate>0001-01-01T00:00:00</OptOutDate>
      <PaymentPlan>String</PaymentPlan>
      <ProfileImage>AA==</ProfileImage>
      <ReferredBy>String</ReferredBy>
      <RegistrantNumber>String</RegistrantNumber>
      <SSN>String</SSN>
      <SaturdayAppts>false</SaturdayAppts>
      <SplitAgentId>0</SplitAgentId>
      <StatusFollowUpDate>0001-01-01T00:00:00</StatusFollowUpDate>
      <StatusId>0</StatusId>
      <StatusNote>String</StatusNote>
      <Subscription>String</Subscription>
      <SubscriptionFee>0</SubscriptionFee>
      <SundayAppts>false</SundayAppts>
      <TimeZone>String</TimeZone>
      <UserId>00000000-0000-0000-0000-000000000000</UserId>
      <VCAppts>false</VCAppts>
      <VendorType>String</VendorType>
    </Agent>
  </Agent>
  <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>
</AgentResponse>