getContractSummaryList
    • PDF

    getContractSummaryList

    • PDF

    Article Summary

    Overview

    Search a list of user contract summaries. A contract summary includes region code, contract type code, and number of contracts.

    Requests

    Request parameters

    ParametersRequirement statusTypeRestrictionsDescription
    pageNoNoIntegerPage number
    pageSizeNoInteger- Page size
    default: 1000
    max: 1000
    isOrganizationNoBoolean- Whether to conduct integrated search for Organization accounts
    (available to Organization masters)
    An error is returned if both isOrganization and isPartner are true
    isPartnerNoBoolean- Whether to search partner accounts
    (available to representative accounts of partners)
    An error is returned if both isOrganization and isPartner are true
    memberNoListNoList<String>List of member numbers
    (available to Organization masters or representative accounts of partners)
    contractMonthYesStringContract month to search (yyyyMM)
    e.g., 202001
    contractTypeCodeNoStringContract type code
    regionCodeNoStringRegion code
    contractStatusCodeNoString- Contract status code
    ALL
    responseFormatTypeNoString- Format type of the response result
    Options: xml | json
    Default: xml

    Responses

    Response bodies

    Examples

    Request examples

    GET {API_URL}/cost/getContractSummaryList
    ?contractMonth=202009
    

    Response examples

    <?xml version="1.0" encoding="UTF-8"?>
    <getContractSummaryListResponse>
      <requestId>d3b77f2a-304e-407b-b1de-1704614148d4</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>3</totalRows>
      <contractSummaryList>
        <contractSummary>
          <memberNo>*****</memberNo>
          <regionCode>KR</regionCode>
          <contractCount>2</contractCount>
          <contractType>
            <code>BST</code>
            <codeName>Block Storage</codeName>
          </contractType>
          <contractStatus>
            <code>ALL</code>
            <codeName>ALL</codeName>
          </contractStatus>
        </contractSummary>
        <contractSummary>
          <memberNo>*****</memberNo>
          <regionCode>KR</regionCode>
          <contractCount>1</contractCount>
          <contractType>
            <code>SW</code>
            <codeName>Software</codeName>
          </contractType>
          <contractStatus>
            <code>ALL</code>
            <codeName>ALL</codeName>
          </contractStatus>
        </contractSummary>
        <contractSummary>
          <memberNo>*****</memberNo>
          <regionCode>KR</regionCode>
          <contractCount>1</contractCount>
          <contractType>
            <code>VSVR</code>
            <codeName>Server(VPC)</codeName>
          </contractType>
          <contractStatus>
            <code>ALL</code>
            <codeName>ALL</codeName>
          </contractStatus>
        </contractSummary>
      </contractSummaryList>
    </getContractSummaryListResponse>
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.