AbodeONE

<back to all web services

CreateGuestEvent

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/guest_event
CreateGuestEvent Parameters:
NameParameterData TypeRequiredDescription
TermIdbodyint?No
NamebodystringNo
DescriptionbodystringNo
HostingTextbodystringNo
OpenDtbodyDateTime?No
CloseDtbodyDateTime?No
StartDtbodyDateTime?No
EndDtbodyDateTime?No
RegistrationOpenDtbodyDateTime?No
RegistrationLateDtbodyDateTime?No
RegistrationCloseDtbodyDateTime?No
RegistrationAmountbodydecimal?No
RegistrationLateAmountbodydecimal?No
DefaultAutoMoveoutbodyshort?No
DefaultHostPaymentbodydecimal?No
OverrideWarningsbodybool?No
GuestEventResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformGuestEventDTONo
ResponseStatusformResponseStatusNo
GuestEventDTO Parameters:
NameParameterData TypeRequiredDescription
GuestEventIdformintNo
TermIdformint?No
NameformstringNo
DescriptionformstringNo
HostingTextformstringNo
OpenDtformDateTime?No
CloseDtformDateTime?No
StartDtformDateTime?No
EndDtformDateTime?No
DefaultAutoMoveoutformshort?No
DefaultHostPaymentformdecimal?No
RegistrationOpenDtformDateTime?No
RegistrationLateDtformDateTime?No
RegistrationCloseDtformDateTime?No

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 //guest_event HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateGuestEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <CloseDt>0001-01-01T00:00:00</CloseDt>
  <DefaultAutoMoveout>0</DefaultAutoMoveout>
  <DefaultHostPayment>0</DefaultHostPayment>
  <Description>String</Description>
  <EndDt>0001-01-01T00:00:00</EndDt>
  <HostingText>String</HostingText>
  <Name>String</Name>
  <OpenDt>0001-01-01T00:00:00</OpenDt>
  <OverrideWarnings>false</OverrideWarnings>
  <RegistrationAmount>0</RegistrationAmount>
  <RegistrationCloseDt>0001-01-01T00:00:00</RegistrationCloseDt>
  <RegistrationLateAmount>0</RegistrationLateAmount>
  <RegistrationLateDt>0001-01-01T00:00:00</RegistrationLateDt>
  <RegistrationOpenDt>0001-01-01T00:00:00</RegistrationOpenDt>
  <StartDt>0001-01-01T00:00:00</StartDt>
  <TermId>0</TermId>
</CreateGuestEvent>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GuestEventResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <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:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <CloseDt>0001-01-01T00:00:00</CloseDt>
    <DefaultAutoMoveout>0</DefaultAutoMoveout>
    <DefaultHostPayment>0</DefaultHostPayment>
    <Description>String</Description>
    <EndDt>0001-01-01T00:00:00</EndDt>
    <GuestEventId>0</GuestEventId>
    <HostingText>String</HostingText>
    <Name>String</Name>
    <OpenDt>0001-01-01T00:00:00</OpenDt>
    <RegistrationCloseDt>0001-01-01T00:00:00</RegistrationCloseDt>
    <RegistrationLateDt>0001-01-01T00:00:00</RegistrationLateDt>
    <RegistrationOpenDt>0001-01-01T00:00:00</RegistrationOpenDt>
    <StartDt>0001-01-01T00:00:00</StartDt>
    <TermId>0</TermId>
  </Result>
</GuestEventResponse>