InternshipTypes

Details of routes to handle internshipTypes

List of all internship types

GET /api/v1/internshipTypes

200 - List of internship types

[{
    "id": 1,
    "label": "Sed quaerat culpa saepe fuga velit distinctio ea deleniti.",
    "createdAt": "2019-10-13T16:21:25.000Z",
    "updatedAt": "2019-10-13T16:21:25.000Z"
}]

204 - Not content

If the API doesn't have any internship in his database, we return a status 204 - No content

Create a new internship

POST /api/v1/internshipTypes

Headers

KeyValueDescription
Content-Typeapplication/x-www-form-urlencodedBody encoding

Body

KeyTypeOptionalDescription
labelStringnoInternship label

200 - Created

Return created internship

{
    "id": 1,
    "label": "Sed quaerat culpa saepe fuga velit distinctio ea deleniti.",
    "createdAt": "2019-10-13T16:21:25.000Z",
    "updatedAt": "2019-10-13T16:21:25.000Z"
}

400 - Bad request

API return Bad Request status with 400 code when request validation fail.

{
  "code": 11103,
  "status": 400,
  "errors": [
    {
      "msg": "Label must be of type string",
      "param": "city",
      "location": "body"
    },
    {
      "msg": "Label must be defined",
      "param": "city",
      "location": "body"
    }
  ],
  "name": "BAD REQUEST"
}

Get a internship type by ID

GET /api/v1/internshipTypes/:id

Paths variables

KeyTypeDescription
idStringInternship ID

200 - Internship type

{
    "id": 1,
    "label": "Sed quaerat culpa saepe fuga velit distinctio ea deleniti.",
    "createdAt": "2019-10-13T16:21:25.000Z",
    "updatedAt": "2019-10-13T16:21:25.000Z"
}

204 - No content

If the API doesn't have any internship type in his database, we return a status 204 - No content

400 - Bad request

API return Bad Request status with 400 code when request validation fail.

{
  "code": 11103,
  "status": 400,
  "errors": [
    {
      "msg": "Identifier must be an integer",
      "param": "city",
      "location": "body"
    },
    {
      "msg": "Identifier must be defined",
      "param": "city",
      "location": "body"
    }
  ],
  "name": "BAD REQUEST"
}

Update a internship type by ID

PUT /api/v1/internshipTypes/:id

Paths variables

KeyTypeDescription
idStringInternship ID

Headers

KeyValueDescription
Content-Typeapplication/x-www-form-urlencodedBody encoding

Body

KeyTypeOptionalDescription
labelStringyesInternship label

200 - Updated internship type

{
    "id": 1,
    "label": "Sed quaerat culpa saepe fuga velit distinctio ea deleniti.",
    "createdAt": "2019-10-13T16:21:25.000Z",
    "updatedAt": "2019-10-13T16:21:25.000Z"
}

204 - No content

If the API doesn't have any internship type in his database, we return a status 204 - No content

400 - Bad request

API return Bad Request status with 400 code when request validation fail.

{
  "code": 11103,
  "status": 400,
  "errors": [
    {
      "msg": "Label must be of type string",
      "param": "city",
      "location": "body"
    }
  ],
  "name": "BAD REQUEST"
}

Remove a internship type by ID

DELETE /api/v1/internshipTypes/:id

Paths variables

KeyTypeDescription
idStringInternship ID

200 - Removed

Return a status 200 without data when delete succeed

204 - No content

If the API doesn't have any internship type in his database, we return a status 204 - No content

Get internships related to a category by giving his ID

GET /api/v1/internshipTypes/:id/internships

Paths variables

KeyTypeDescription
idStringInternshipType ID

Params

KeyTypeOptionalDescription
limitNumbernoPage expected (By default 1)
pageNumbernoNumber of row expected (By default 20)

200 - Internships list

{
    "page": "1",
    "data": [
        {
            "id": 1,
            "subject": "Sed quaerat culpa saepe fuga velit distinctio ea deleniti.",
            "description": "Atque officia consectetur. Eum molestiae rerum qui et. Nostrum fuga molestiae voluptate. Eius omnis nihil non eveniet sed ut. Voluptate provident et voluptate provident illo voluptatem enim ea et. Voluptatem qui reiciendis molestiae rerum blanditiis rem. Ut qui dolor nostrum consequatur accusantium ex esse mollitia atque.",
            "country": "Russian Federation",
            "city": "New Rocky",
            "postalCode": "30636-9003",
            "address": "15486 Genoveva Isle",
            "additional": "Suite 755",
            "isInternshipAbroad": false,
            "isValidated": false,
            "isProposition": true,
            "isPublish": false,
            "publishAt": "2019-10-13T16:21:25.000Z",
            "createdAt": "2019-10-13T16:21:25.000Z",
            "updatedAt": "2019-10-13T16:21:25.000Z"
        },
    ],
    "length": 1,
    "max": 1
}

204 - No content

If the API doesn't have any category linked to given ID in his database, we return a status 204 - No content

400 - Bad request

API return Bad Request status with 400 code when request validation fail.

{
  "code": 11103,
  "status": 400,
  "errors": [
    {
      "msg": "Identifier must be an integer",
      "param": "city",
      "location": "body"
    },
    {
      "msg": "Identifier must be defined",
      "param": "city",
      "location": "body"
    }
  ],
  "name": "BAD REQUEST"
}

Link internship to category

GET /api/v1/internshipTypes/:id/internships/:internship_id/link

Paths variables

KeyTypeDescription
idStringInternshipType ID
internship_idStringInternship ID

200 - OK

Ok appears on two occasions

  • If entries have been linked
  • If internship haven't been found
OK

204 - No content

If the API doesn't have any category linked to given ID in his database, we return a status 204 - No content

400 - Bad request

API return Bad Request status with 400 code when request validation fail.

{
  "code": 11103,
  "status": 400,
  "errors": [
    {
      "msg": "Identifier must be an integer",
      "param": "city",
      "location": "body"
    },
    {
      "msg": "Identifier must be defined",
      "param": "city",
      "location": "body"
    }
  ],
  "name": "BAD REQUEST"
}

Get campaigns related to a category by giving his ID

GET /api/v1/internshipTypes/:id/campaigns

Paths variables

KeyTypeDescription
idStringInternshipType ID

Params

KeyTypeOptionalDescription
limitNumbernoPage expected (By default 1)
pageNumbernoNumber of row expected (By default 20)

200 - Campaigns list

{
    "page": "1",
    "data": [
        {
            "id": 1,
            "name": "test",
            "maxProposition": 2,
            "description": "Sed quaerat culpa saepe fuga velit distinctio ea deleniti.",
            "category": {
              "id": 1,
              "label": "Stage ouvrier"
            },
            "semester": "S5",
            "isPublish": false,
            "startAt": 0,
            "endAt": 0,
            "updatedAt": "2019-09-19T22:21:24.365Z",
            "createdAt": "2019-09-19T22:21:24.365Z"
        },
    ],
    "length": 1,
    "max": 1
}

204 - No content

If the API doesn't have any category linked to given ID in his database, we return a status 204 - No content

400 - Bad request

API return Bad Request status with 400 code when request validation fail.

{
  "code": 11103,
  "status": 400,
  "errors": [
    {
      "msg": "Identifier must be an integer",
      "param": "city",
      "location": "body"
    },
    {
      "msg": "Identifier must be defined",
      "param": "city",
      "location": "body"
    }
  ],
  "name": "BAD REQUEST"
}

Link campaign to category

GET /api/v1/internshipTypes/:id/campaigns/:campaign_id/link

Paths variables

KeyTypeDescription
idStringInternshipType ID
campaign_idStringCampaign ID

200 - OK

Ok appears on two occasions

  • If entries have been linked
  • If campaign haven't been found
OK

204 - No content

If the API doesn't have any category linked to given ID in his database, we return a status 204 - No content

400 - Bad request

API return Bad Request status with 400 code when request validation fail.

{
  "code": 11103,
  "status": 400,
  "errors": [
    {
      "msg": "Identifier must be an integer",
      "param": "city",
      "location": "body"
    },
    {
      "msg": "Identifier must be defined",
      "param": "city",
      "location": "body"
    }
  ],
  "name": "BAD REQUEST"
}
← InternshipsMentors →