Provider

get

Returns the relationship provider

Path parameters

organizationIdstringRequired

organization Identifier

Query parameters

filter[provider]stringOptional

Filters the collection of provider using a 'disjoint' RSQL expression

page[number]integer · int32Optional

Number of pages to return. Can be used with page[size]

page[size]integer · int32Optional

Number of elements per page. Can be used with page[number]

page[offset]integer · int32Optional

Offset from 0 to start paginating. Can be used with page[limit]

page[limit]integer · int32Optional

Maximum number of items to return. Can be used with page[offset]

page[totals]stringOptional

For requesting total pages/records be included in the response page meta data

Responses

200

Successful response

application/vnd.api+json

get

HTTPcURLJavaScriptPython

GET /api/v1/organization/{organizationId}/provider HTTP/1.1
Host: 
Accept: */*

200

Successful response

{
  "data": [
    {
      "type": "text",
      "id": "text",
      "attributes": {
        "description": null,
        "name": null
      },
      "relationships": {
        "organization": {
          "data": [
            null
          ]
        },
        "version": {
          "data": [
            null
          ]
        }
      }
    }
  ],
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}

post

Creates an item of type provider and adds it to provider

Path parameters

organizationIdstringRequired

organization Identifier

Body

Responses

201

Successful response

application/vnd.api+json

post

HTTPcURLJavaScriptPython

POST /api/v1/organization/{organizationId}/provider HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 233

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "description": null,
      "name": null
    },
    "relationships": {
      "organization": {
        "data": [
          null
        ]
      },
      "version": {
        "data": [
          null
        ]
      }
    }
  },
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}

201

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "description": null,
      "name": null
    },
    "relationships": {
      "organization": {
        "data": [
          null
        ]
      },
      "version": {
        "data": [
          null
        ]
      }
    }
  },
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}

get

Returns an instance of type provider

Path parameters

organizationIdstringRequired

organization Identifier

providerIdstringRequired

provider Identifier

Query parameters

Responses

200

Successful response

application/vnd.api+json

get

HTTPcURLJavaScriptPython

GET /api/v1/organization/{organizationId}/provider/{providerId} HTTP/1.1
Host: 
Accept: */*

200

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "description": null,
      "name": null
    },
    "relationships": {
      "organization": {
        "data": [
          null
        ]
      },
      "version": {
        "data": [
          null
        ]
      }
    }
  },
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}

delete

Deletes an instance of type provider

Path parameters

organizationIdstringRequired

organization Identifier

providerIdstringRequired

provider Identifier

Responses

204

Successful response

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/organization/{organizationId}/provider/{providerId} HTTP/1.1
Host: 
Accept: */*

204

Successful response

No content

patch

Modifies an instance of type provider

Path parameters

organizationIdstringRequired

organization Identifier

providerIdstringRequired

provider Identifier

Body

Responses

204

Successful response

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/organization/{organizationId}/provider/{providerId} HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 233

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "description": null,
      "name": null
    },
    "relationships": {
      "organization": {
        "data": [
          null
        ]
      },
      "version": {
        "data": [
          null
        ]
      }
    }
  },
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}

204

Successful response

No content