ves-io-schema-signup-CustomAPI-Get

Examples of performing signup CustomAPI Get

Usecase:

Get signup

Request:

Request using vesctl:

vesctl request rpc signup.CustomAPI.Get -i request.yaml --uri /no_auth/signup/signup-1234-5678-9012-3456 --http-method GET

where file request.yaml has following contents:

name: signup-1234-5678-9012-3456

vesctl yaml response:

object:
  metadata:
    annotations: {}
    labels: {}
    name: signup-1234-5678-9012-3456
    namespace: system
    uid: ab24f2f5-f865-4509-a7f7-9bce6fa2aa54
  spec:
    gcSpec:
      billingAddress: {}
      company:
        contacts: []
      companyContact: {}
      companyName: test
      contactNumber: "123456789"
      currency: USD
      customer:
        contacts: []
      customerContact: {}
      domain: testdomain
      email: test@test.com
      firstName: Test
      lastName: Test
      locale: en_US
      paymentProviderToken: tok_1234567899
      supportPlanName: support-plan-1
      token: ed865e78-fafc-4b64-a65d-cf7fa2e9d776
      tosAccepted: "1234567"
      tosVersion: v1.2
      usagePlanName: usage-plan-1
  systemMetadata:
    finalizers: []
    namespace: []
    tenant: ves-io
    uid: ab24f2f5-f865-4509-a7f7-9bce6fa2aa54
status: []

Request using curl:

curl -X 'GET' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build743694289_b001_apidocs.test/host=docker-desktop' 'https://localhost:40661/no_auth/signup/signup-1234-5678-9012-3456?name=signup-1234-5678-9012-3456'

curl response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Thu, 02 Jul 2020 15:53:32 GMT
Vary: Accept-Encoding

{
  "object": {
    "metadata": {
      "name": "signup-1234-5678-9012-3456",
      "namespace": "system",
      "uid": "ab24f2f5-f865-4509-a7f7-9bce6fa2aa54",
      "labels": {
      },
      "annotations": {
      },
      "description": "",
      "disable": false
    },
    "system_metadata": {
      "uid": "ab24f2f5-f865-4509-a7f7-9bce6fa2aa54",
      "creation_timestamp": null,
      "deletion_timestamp": null,
      "modification_timestamp": null,
      "initializers": null,
      "finalizers": [
      ],
      "tenant": "ves-io",
      "creator_class": "",
      "creator_id": "",
      "creator_cookie": "",
      "trace_info": "",
      "object_index": 0,
      "namespace": [
      ],
      "owner_view": null
    },
    "spec": {
      "gc_spec": {
        "locale": "en_US",
        "type": "UNKNOWN",
        "first_name": "Test",
        "last_name": "Test",
        "email": "test@test.com",
        "contact_number": "123456789",
        "domain": "testdomain",
        "currency": "USD",
        "payment_provider_token": "tok_1234567899",
        "billing_address": {
          "contact_type": "MAILING",
          "phone_number": "",
          "address1": "",
          "address2": "",
          "city": "",
          "county": "",
          "state": "",
          "country": "",
          "zip_code": ""
        },
        "tos_accepted": "1234567",
        "customer": {
          "type": "USER",
          "locale": "",
          "first_name": "",
          "last_name": "",
          "email": "",
          "contacts": [
          ],
          "tos_accepted": "",
          "domain_owner": false,
          "idm_type": "SSO"
        },
        "customer_contact": {
          "contact_type": "MAILING",
          "phone_number": "",
          "address1": "",
          "address2": "",
          "city": "",
          "county": "",
          "state": "",
          "country": "",
          "zip_code": ""
        },
        "company_name": "test",
        "company": {
          "type": "USER",
          "locale": "",
          "first_name": "",
          "last_name": "",
          "email": "",
          "contacts": [
          ],
          "tos_accepted": "",
          "domain_owner": false,
          "idm_type": "SSO"
        },
        "company_contact": {
          "contact_type": "MAILING",
          "phone_number": "",
          "address1": "",
          "address2": "",
          "city": "",
          "county": "",
          "state": "",
          "country": "",
          "zip_code": ""
        },
        "token": "ed865e78-fafc-4b64-a65d-cf7fa2e9d776",
        "support_plan_name": "support-plan-1",
        "usage_plan_name": "usage-plan-1",
        "tos_version": "v1.2"
      }
    }
  },
  "status": [
  ]
}