GetCustomersResponse

SpecificationC# ClassSchema

Properties

• data (['array', 'null'])Optional. Array of customer data objects.

  • Items (object)Cannot contain additional properties.

    • id (['string', 'null'])Optional. Unique customer identifier.
    • parentId (['string', 'null'])Optional. Parent customer identifier.
    • name (['string', 'null'])Optional. Customer name.

• failureMessages (array)

  • Items (string)

• informationalMessages (array)

  • Items (string)

• operationWasSuccessful (boolean)

Examples

{
    "data": [
        {
            "id": "CUST-002",
            "parentId": null,
            "name": "Customer 2"
        },
        {
            "id": "CUST-007",
            "parentId": "CUST-023",
            "name": "Customer 7"
        },
        {
            "id": "CUST-008",
            "parentId": "CUST-019",
            "name": "Customer 8"
        }
    ],
    "failureMessages": [],
    "informationalMessages": [],
    "operationWasSuccessful": true
}

Quicktype Command

quicktype \
    --framework SystemTextJson  \
    --lang cs  \
    --number-type double  \
    --src-lang schema  \
    --no-check-required  \
    --density dense  \
    --features complete  \
    --namespace OtpSchema.Api.CustomerBroker.GetCustomersResponse  \
    --src .working/build/internal/json-schema-for-cs/GetCustomersResponse.json -o .working/build/internal/csharp/OtpSchema/Api/CustomerBroker/GetCustomersResponse.cs

GetCustomersResponse

// <auto-generated />
//
// To parse this JSON data, add NuGet 'System.Text.Json' then do:
//
//    using OtpSchema.Api.CustomerBroker.GetCustomersResponse;
//
//    var getCustomersResponse = GetCustomersResponse.FromJson(jsonString);
#nullable enable
#pragma warning disable CS8618
#pragma warning disable CS8601
#pragma warning disable CS8603

namespace OtpSchema.Api.CustomerBroker.GetCustomersResponse
{
    using System;
    using System.Collections.Generic;

    using System.Text.Json;
    using System.Text.Json.Serialization;
    using System.Globalization;
    using J = System.Text.Json.Serialization.JsonPropertyNameAttribute;
    using N = System.Text.Json.Serialization.JsonIgnoreCondition;

    public partial class GetCustomersResponse
    {
        [J("data")]                   public Datum[] Data { get; set; }                   // Optional. Array of customer data objects.
        [J("failureMessages")]        public string[] FailureMessages { get; set; }      
        [J("informationalMessages")]  public string[] InformationalMessages { get; set; }
        [J("operationWasSuccessful")] public bool OperationWasSuccessful { get; set; }   
    }

    public partial class Datum
    {
        [J("id")]       public string Id { get; set; }       // Optional. Unique customer identifier.
        [J("name")]     public string Name { get; set; }     // Optional. Customer name.
        [J("parentId")] public string ParentId { get; set; } // Optional. Parent customer identifier.
    }

    public partial class GetCustomersResponse
    {
        public static GetCustomersResponse FromJson(string json) => JsonSerializer.Deserialize<GetCustomersResponse>(json, OtpSchema.Api.CustomerBroker.GetCustomersResponse.Converter.Settings);
    }

    public static class Serialize
    {
        public static string ToJson(this GetCustomersResponse self) => JsonSerializer.Serialize(self, OtpSchema.Api.CustomerBroker.GetCustomersResponse.Converter.Settings);
    }

    internal static class Converter
    {
        public static readonly JsonSerializerOptions Settings = new(JsonSerializerDefaults.General)
        {
            Converters =
            {
                new DateOnlyConverter(),
                new TimeOnlyConverter(),
                IsoDateTimeOffsetConverter.Singleton
            },
        };
    }

    public class DateOnlyConverter : JsonConverter<DateOnly>
    {
        private readonly string serializationFormat;
        public DateOnlyConverter() : this(null) { }

        public DateOnlyConverter(string? serializationFormat)
        {
                this.serializationFormat = serializationFormat ?? "yyyy-MM-dd";
        }

        public override DateOnly Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        {
                var value = reader.GetString();
                return DateOnly.Parse(value!);
        }

        public override void Write(Utf8JsonWriter writer, DateOnly value, JsonSerializerOptions options)
                => writer.WriteStringValue(value.ToString(serializationFormat));
    }

    public class TimeOnlyConverter : JsonConverter<TimeOnly>
    {
        private readonly string serializationFormat;

        public TimeOnlyConverter() : this(null) { }

        public TimeOnlyConverter(string? serializationFormat)
        {
                this.serializationFormat = serializationFormat ?? "HH:mm:ss.fff";
        }

        public override TimeOnly Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        {
                var value = reader.GetString();
                return TimeOnly.Parse(value!);
        }

        public override void Write(Utf8JsonWriter writer, TimeOnly value, JsonSerializerOptions options)
                => writer.WriteStringValue(value.ToString(serializationFormat));
    }

    internal class IsoDateTimeOffsetConverter : JsonConverter<DateTimeOffset>
    {
        public override bool CanConvert(Type t) => t == typeof(DateTimeOffset);

        private const string DefaultDateTimeFormat = "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK";

        private DateTimeStyles _dateTimeStyles = DateTimeStyles.RoundtripKind;
        private string? _dateTimeFormat;
        private CultureInfo? _culture;

        public DateTimeStyles DateTimeStyles
        {
                get => _dateTimeStyles;
                set => _dateTimeStyles = value;
        }

        public string? DateTimeFormat
        {
                get => _dateTimeFormat ?? string.Empty;
                set => _dateTimeFormat = (string.IsNullOrEmpty(value)) ? null : value;
        }

        public CultureInfo Culture
        {
                get => _culture ?? CultureInfo.CurrentCulture;
                set => _culture = value;
        }

        public override void Write(Utf8JsonWriter writer, DateTimeOffset value, JsonSerializerOptions options)
        {
                string text;


                if ((_dateTimeStyles & DateTimeStyles.AdjustToUniversal) == DateTimeStyles.AdjustToUniversal
                        || (_dateTimeStyles & DateTimeStyles.AssumeUniversal) == DateTimeStyles.AssumeUniversal)
                {
                        value = value.ToUniversalTime();
                }

                text = value.ToString(_dateTimeFormat ?? DefaultDateTimeFormat, Culture);

                writer.WriteStringValue(text);
        }

        public override DateTimeOffset Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        {
                string? dateText = reader.GetString();

                if (string.IsNullOrEmpty(dateText) == false)
                {
                        if (!string.IsNullOrEmpty(_dateTimeFormat))
                        {
                                return DateTimeOffset.ParseExact(dateText, _dateTimeFormat, Culture, _dateTimeStyles);
                        }
                        else
                        {
                                return DateTimeOffset.Parse(dateText, Culture, _dateTimeStyles);
                        }
                }
                else
                {
                        return default(DateTimeOffset);
                }
        }


        public static readonly IsoDateTimeOffsetConverter Singleton = new IsoDateTimeOffsetConverter();
    }
}
#pragma warning restore CS8618
#pragma warning restore CS8601
#pragma warning restore CS8603

GetCustomersResponse

{
  "$schema": "http://json-schema.org/draft-07/schema#", 
  "$id": "GetCustomersResponse.json", 
  "type": "object", 
  "additionalProperties": false, 
  "properties": {
    "data": {
      "description": "Optional. Array of customer data objects.", 
      "type": ["array", "null"], 
      "items": {
        "type": "object", 
        "additionalProperties": false, 
        "properties": {
          "id": {
            "description": "Optional. Unique customer identifier.", 
            "type": ["string", "null"]
          }, 
          "parentId": {
            "description": "Optional. Parent customer identifier.", 
            "type": ["string", "null"]
          }, 
          "name": { "description": "Optional. Customer name.", "type": ["string", "null"] }
        }
      }
    }, 
    "failureMessages": { "type": "array", "items": {"type": "string"} }, 
    "informationalMessages": { "type": "array", "items": {"type": "string"} }, 
    "operationWasSuccessful": {"type": "boolean"}
  }, 
  "required": ["failureMessages", "informationalMessages", "operationWasSuccessful", "data"], 
  "examples": [
    {
      "data": [
        { "id": "CUST-002", "parentId": null      , "name": "Customer 2" }, 
        { "id": "CUST-007", "parentId": "CUST-023", "name": "Customer 7" }, 
        { "id": "CUST-008", "parentId": "CUST-019", "name": "Customer 8" }
      ], 
      "failureMessages": [], 
      "informationalMessages": [], 
      "operationWasSuccessful": true
    }
  ]
}