Schemas

category

  • object
    Example: {"catId":"4535d2ec-cc45-41b2-abed-91f98ba4f269","name":"string"}
    Properties:
    • catId
      string:uuid
      id
      Category ID
      Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    • name
      string
      Category name
      Example: "string"
      Deprecated

id

id
  • string:uuid
    Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"

person

  • object
    Example: {"primaryEmail":"user@example.com","dob":"2019-08-24","id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","category":{"catId":"4535d2ec-cc45-41b2-abed-91f98ba4f269","name":"string"},"country":{"countryCode":"string","countryName":"string"},"dependentIds":[278,279,280,281],"name":"string","photoUrls":["string"],"tags":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"string"}],"maritalStatus":"married","phone":"+1-202-555-0192"}
    Properties:
    • primaryEmail
      string:email
      Example: "user@example.com"
    • dob
      string:date
      Date of Birth
      Example: "2019-08-24"
    • id
      string:uuid
      Unique ID
      SSN
      Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    • category
      object
      Person Category
      Categories this person belongs to
      Example: {"catId":"4535d2ec-cc45-41b2-abed-91f98ba4f269","name":"string"}
    • country
      object
      Example: {"countryCode":"string","countryName":"string"}
      Deprecated
    • dependentIds
      array<integer>
      IDs of Dependents .
      Example: [278,279,280,281]
      Deprecated
      Items:
      • integer
        Example: 0
    • name
      string
      Required
      Name of the person
      Example: "string"
      Minimum string length: 4
    • photoUrls
      array<string:url>
      Required
      The list of URL to a cute photos featuring pet
      Example: ["string"]
      Maximum number of items: 20
      Items:
      • string:url
        Example: "string"
    • tags
      array
      TAGS
      Tags attached to the person
      Example: [{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"string"}]
      Maximum number of items: 1
      Items:
      • object
        tag
        Example: {"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"string"}
    • maritalStatus
      string
      Marital status in case of adult
      Example: "married"
      Enum: married unmarried widowed
    • phone
      string or null
      phone number in international format
      Example: "+1-202-555-0192"
      Pattern: /^\+(?:[0-9]-?){6,14}[0-9]$/

tag

tag
  • object
    Example: {"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"string"}
    Properties:
    • id
      string:uuid
      id
      Tag ID
      Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    • name
      string
      Tag name
      Example: "string"
      Minimum string length: 1