Sign in

v23

latestOpenAPI 3.0.0raw.githubusercontent.com2018-12-12442338.0 KB
services

Add a new service

Add a new service

post/services

Request body

namestring required

The name of the service

descstring required

Description of the service

publishedinteger required

Boolean if service is published

provider_idstring

ID of the provider

event_idstring

ID of the event

contact_idstring

ID of the service contact

eligibility_idstring

ID of eligibility object

costoption_idstring

ID of cost option object

flaggedboolean

Should this content be reivewed?

Example request

{
  "name": "POSITIVE YOUTH ENGAGEMENT PROGRAMME (PYEP)",
  "desc": "The PYEP provides a huge number of events for youth in your area",
  "provider_id": "dd06b31c-61f6-4612-abca-fd3de120f419S",
  "event_id": "71209163-8f71-49a1-9959-4fbd75a79ac1",
  "contact_id": "22632363-e326-4991-8f10-5483e5047758",
  "eligibility_id": "bcd76798-d811-46d7-b7aa-64bdde71c18c",
  "costoption_id": "03b0a53f-0994-4a30-8988-8aed0dfbb560"
}

Response

Succesfully added a new service

idstring

UUID of service

namestring

The name of the service

descstring

Description of the service

publishedinteger

Boolean if service is published

provider_idstring

ID of the provider

event_idstring

ID of the event

contact_idstring

ID of the service contact

eligibility_idstring

ID of eligibility object

costoption_idstring

ID of cost option object

createdstring date-time

The date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

updatedstring date-time

The date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

flaggedboolean

Should this content be reivewed?

Example response

{
  "id": "7a52060d-be2d-482e-bd9e-0f8041554925",
  "name": "POSITIVE YOUTH ENGAGEMENT PROGRAMME (PYEP)",
  "desc": "The PYEP provides a huge number of events for youth in your area",
  "published": 1,
  "provider_id": "dd06b31c-61f6-4612-abca-fd3de120f419S",
  "event_id": "71209163-8f71-49a1-9959-4fbd75a79ac1",
  "contact_id": "22632363-e326-4991-8f10-5483e5047758",
  "eligibility_id": "bcd76798-d811-46d7-b7aa-64bdde71c18c",
  "costoption_id": "03b0a53f-0994-4a30-8988-8aed0dfbb560",
  "created": "2017-07-21T17:32:28Z",
  "updated": "2017-07-21T18:38:30Z"
}