Table of contents

    Overview

    A Document Category endpoint is used to manage the categories that a Document can belong to. To call this endpoint, use one of the URLs from the following table:

    URL GET PUT POST DELETE
    https://api.mypcorp.com/documentcategory
    https://api.mypcorp.com/documentcategory/{Guid}

    NB: Currently, the MYP API only accepts GET requests for this endpoint. POST and PUT requests will be available in the future.

    GET

    The following table illustrates which fields can be included when receiving a GET response.

    DocumentCategory
    Field Name Description
    DocumentCategoryGuid
    Guid (Identifier)
    Id of the document category.
    Name
    string
    Name of the document category.
    ArchiveDate
    DateTime
    Date when the document category was archived, if it has been archived.

    Example JSON response:

    {
      "@odata.context": "https://api.mypcorp.com/documentcategory/$metadata#DocumentCategory",
      "value": [
        {
          "DocumentCategoryGuid": "84ce9db6-bfd6-4551-a0b5-aa84174e3f38",
          "Name": "Photography",
          "ArchiveDate": null
        }
      ]
    }


    Previous article Return home