API Reference

Get Host Contracts

4.12. Get Host Contracts

POST /cm/hostContracts

Description

For host, this allows you to retrieve contract status.

Body parameter

HostContractInfos

Name : body
Flags : required
Type : AG_HostContractInfoRQ

Responses

HTTP Code Description Schema

200

The successful response with host contract information.

AG_HostContractInfoRS

400

The request content was malformed

AG_HostContractInfoRS

401

The supplier was unauthorized

AG_HostContractInfoRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • Contracts

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/hostContracts
Request body
<?xml version="1.0" encoding="UTF-8"?>
<AG_HostContractInfoRQ>
  <HostContractInfos>
    <HostContractInfo Email="[email protected]"/>
  </HostContractInfos>
</AG_HostContractInfoRQ>

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<AG_HostContractInfoRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Success/>
  <HostContractContents>
    <HostContractContent ContractCode="0" Email="[email protected]" IsSigned="true" SignedAt="2020-01-08T12:37:13.930+07:00" UpdatedAt="2020-01-08T12:37:13.930+07:00">
      <IpAddress>8.8.8.8</IpAddress>
      <UserAgent>Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:10.0) Gecko/20100101 Firefox/10.0</UserAgent>
      <Contract LanguageCode="en-US">
        <Title>Accommodation Property Participation Agreement (1.931)</Title>
        <Content>### **ACCOMMODATION PROPERTY PARTICIPATION AGREEMENT**

          This Accommodation Property Participation Agreement (&amp;quot;APPA&amp;quot;),...
        </Content>
      </Contract>
    </HostContractContent>
  </HostContractContents>
</AG_HostContractInfoRS>
Response 400
<?xml version="1.0" encoding="UTF-8"?>
<AG_HostContractInfoRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
</AG_HostContractInfoRS>
Response 401
<?xml version="1.0" encoding="UTF-8"?>
<AG_HostContractInfoRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Errors>
    <Error Code="321" ShortText="Authorization error" Status="NotProcessed"/>
  </Errors>
</AG_HostContractInfoRS>